Skip to content

Commit

Permalink
chore: add helm chart parameters table (#597)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sp71
sp71 authored Feb 5, 2024
1 parent 2f0ac91 commit 4e639cc
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions docs/basic/try-with-helm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Now we show how to deploy Casdoor on Kubernetes using Helm for easy and scalable
Install the Casdoor chart:

```shell
helm install casdoor oci://registry-1.docker.io/casbin/casdoor-helm-charts --version 1.502.0
helm install casdoor oci://registry-1.docker.io/casbin/casdoor-helm-charts --version 1.524.0
```

### Step 2: Accessing Casdoor
Expand All @@ -30,7 +30,40 @@ Once installed, Casdoor can be accessed at the provided service URL by your Kube

### Customization and Configuration

Customize your Casdoor installation by modifying the Helm chart values. For detailed options, refer to the [values.yaml](https://github.com/casdoor/casdoor-helm/blob/master/charts/casdoor/values.yaml) file in the chart.
Customize your Casdoor installation by modifying the Helm chart values. For detailed options, refer to the [values.yaml](https://github.com/casdoor/casdoor-helm/blob/master/charts/casdoor/values.yaml) file in the chart. The following parameters can be configured.

| Parameter | Description | Default Value |
|--------------------------|-----------------------------------------------------------------------------------------------------------|--------------------------------|
| `replicaCount` | Number of replicas of the Casdoor application to run. | `1` |
| `image.repository` | Repository for the Casdoor Docker image. | `casbin` |
| `image.name` | Name of the Casdoor Docker image. | `casdoor` |
| `image.pullPolicy` | Pull policy for the Casdoor Docker image. | `IfNotPresent` |
| `image.tag` | Tag for the Casdoor Docker image. | `""` |
| `config` | Configuration settings for the Casdoor application. | See [config](https://github.com/casdoor/casdoor-helm/blob/master/charts/casdoor/values.yaml) field |
| `database.driver` | Database driver to use (supports mysql, postgres, cockroachdb, sqlite3). | `sqlite3` |
| `database.user` | Database username. | `""` |
| `database.password` | Database password. | `""` |
| `database.host` | Database host. | `""` |
| `database.port` | Database port. | `""` |
| `database.databaseName` | Name of the database used by Casdoor. | `casdoor` |
| `database.sslMode` | SSL mode for the database connection. | `disable` |
| `service.type` | Type of Kubernetes service to create for Casdoor (ClusterIP, NodePort, LoadBalancer, etc.). | `ClusterIP` |
| `service.port` | Port number for the Casdoor service. | `8000` |
| `ingress.enabled` | Whether to enable Ingress for Casdoor. | `false` |
| `ingress.annotations` | Annotations for the Ingress resource. | `{}` |
| `ingress.hosts` | Hostnames for the Ingress resource. | `[]` |
| `resources` | Resource requests and limits for the Casdoor container. | `{}` |
| `autoscaling.enabled` | Whether to enable Horizontal Pod Autoscaler for Casdoor. | `false` |
| `autoscaling.minReplicas`| Minimum number of replicas for Horizontal Pod Autoscaler. | `1` |
| `autoscaling.maxReplicas`| Maximum number of replicas for Horizontal Pod Autoscaler. | `100` |
| `autoscaling.targetCPUUtilizationPercentage` | Target CPU utilization percentage for Horizontal Pod Autoscaler. | `80` |
| `nodeSelector` | Node labels for pod assignment. | `{}` |
| `tolerations` | Toleration labels for pod assignment. | `[]` |
| `affinity` | Affinity settings for pod assignment. | `{}` |
| `extraContainersEnabled` | Whether to enable additional sidecar containers. | `false` |
| `extraContainers` | Additional sidecar containers. | `""` |
| `extraVolumeMounts` | Additional volume mounts for the Casdoor container. | `[]` |
| `extraVolumes` | Additional volumes for the Casdoor container. | `[]` |

### Managing the Deployment

Expand Down

0 comments on commit 4e639cc

Please sign in to comment.