1
0
mirror of https://gitlab.com/bramw/baserow.git synced 2024-09-19 11:07:47 +00:00
bramw_baserow/deploy/helm/baserow/charts/baserow-common/README.md
2024-09-05 10:56:27 +02:00

84 lines
36 KiB
Markdown

## Parameters
### Global parameters
| Name | Description | Value |
| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-----------------------------------------------------------------------------------------|
| `global.baserow.imageRegistry` | Global Docker image registry | `baserow` |
| `global.baserow.imagePullSecrets` | Global Docker registry secret names as an array | `[]` |
| `global.baserow.image.tag` | Global Docker image tag | `1.27.2` |
| `global.baserow.serviceAccount.shared` | Set to true to share the service account between all application components. | `true` |
| `global.baserow.serviceAccount.create` | Set to true to create a service account to share between all application components. | `true` |
| `global.baserow.serviceAccount.name` | Configure a name for service account to share between all application components. | `baserow` |
| `global.baserow.serviceAccount.annotations` | Configure annotations for the shared service account. | `{}` |
| `global.baserow.serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount | `false` |
| `global.baserow.backendConfigMap` | Configure a name for the backend configmap. | `backend-config` |
| `global.baserow.backendSecret` | Configure a name for the backend secret. | `backend-secret` |
| `global.baserow.frontendConfigMap` | Configure a name for the frontend configmap. | `frontend-config` |
| `global.baserow.envFrom` | Configure secrets or configMaps to be used as environment variables for all components. | `[]` |
| `global.baserow.domain` | Configure the domain for the application. | `cluster.local` |
| `image.repository` | Baserow image repository | `baserow/baserow` |
| `image.pullPolicy` | Baserow image pull policy | `IfNotPresent` |
| `workingDir` | Application container working directory | `/baserow-saas` |
| `args` | Application container extra arguments | `[]` |
| `imagePullSecrets` | Container image pull secrets | `[]` |
| `podAnnotations` | Map of annotations to add to the pods | `{}` |
| `additionalLabels` | Map of extra labels to add | `{}` |
| `additionalSelectorLabels` | Map of extra selector labels to add to the deployment | `{}` |
| `securityContext.enabled` | Enable security context | `false` |
| `securityContext.fsGroupChangePolicy` | Set filesystem group change policy | `""` |
| `securityContext.sysctls` | Set kernel settings using the sysctl interface | `""` |
| `securityContext.supplementalGroups` | Set filesystem extra groups | `""` |
| `securityContext.fsGroup` | Group ID for the pod | `""` |
| `containerSecurityContext.enabled` | Enabled containers' Security Context | `false` |
| `containerSecurityContext.seLinuxOptions` | Set SELinux options in container | `""` |
| `containerSecurityContext.runAsUser` | Set containers' Security Context runAsUser | `""` |
| `containerSecurityContext.runAsGroup` | Set containers' Security Context runAsGroup | `""` |
| `containerSecurityContext.runAsNonRoot` | Set container's Security Context runAsNonRoot | `""` |
| `containerSecurityContext.privileged` | Set container's Security Context privileged | `false` |
| `containerSecurityContext.readOnlyRootFilesystem` | Set container's Security Context readOnlyRootFilesystem | `false` |
| `containerSecurityContext.allowPrivilegeEscalation` | Set container's Security Context allowPrivilegeEscalation | `false` |
| `containerSecurityContext.capabilities.drop` | List of capabilities to be dropped | `[]` |
| `containerSecurityContext.seccompProfile.type` | Set container's Security Context seccomp profile | `""` |
| `replicaCount` | Number of application pods, ignored when enabling autoscaling. | `1` |
| `revisionHistoryLimit` | Number of old ReplicaSets to retain for rollback | `10` |
| `resources` | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
| `readinessProbe.enabled` | Enable readinessProbe on the application container | `false` |
| `readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `120` |
| `readinessProbe.periodSeconds` | Period seconds for readinessProbe | `5` |
| `readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `5` |
| `readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `3` |
| `readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `readinessProbe.exec.command` | Defines the command to run in the container to determine if the container is running. The command is simply executed, and if it exits with a status code of 0, the container is considered to be alive and functioning. If the command exits with a non-zero status code, the container is considered to have failed. | `["/bin/bash","-c","/baserow/backend/docker/docker-entrypoint.sh backend-healthcheck"]` |
| `livenessProbe.enabled` | Enable livenessProbe on the application container | `false` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `120` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `5` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `5` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `3` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `livenessProbe.exec.command` | Defines the command to run in the container to determine if the container is running. The command is simply executed, and if it exits with a status code of 0, the container is considered to be alive and functioning. If the command exits with a non-zero status code, the container is considered to have failed. | `["/bin/bash","-c","/baserow/backend/docker/docker-entrypoint.sh backend-healthcheck"]` |
| `priorityClassName` | Priority Class to use for each pod | `""` |
| `affinity` | Affinity for the baserow application pods assignment | `{}` |
| `nodeSelector` | Node labels for application pods assignment | `{}` |
| `tolerations` | Tolerations for application pods assignment | `[]` |
| `extraEnv` | Extra environment variables to add to the baserow application container | `[]` |
| `envFrom` | Extra environments variables to add to the baserow application container from configmaps or secrets. | `[]` |
| `serviceAccount.create` | Enable creation of ServiceAccount for the pod | `true` |
| `serviceAccount.name` | The name of the ServiceAccount to use. | `""` |
| `serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount | `false` |
| `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` |
| `autoscaling.enabled` | Enable autoscaling for the application | `false` |
| `autoscaling.minReplicas` | Minimum number of application replicas | `2` |
| `autoscaling.maxReplicas` | Maximum number of application replicas | `10` |
| `autoscaling.targetCPUUtilizationPercentage` | Target CPU utilization percentage | `80` |
| `autoscaling.targetMemoryUtilizationPercentage` | Target Memory utilization percentage | `80` |
| `service.create` | Set to true to create a Kubernetes service | `true` |
| `service.type` | Kubernetes service type | `ClusterIP` |
| `service.port` | Port to expose for the application | `80` |
| `service.targetPort` | Port to expose for the application | `8000` |
| `pdb.create` | Enable/disable a Pod Disruption Budget creation | `false` |
| `pdb.minAvailable` | Minimum number/percentage of pods that should remain scheduled | `50%` |
| `pdb.maxUnavailable` | Maximum number/percentage of pods that may be made unavailable. Defaults to `1` if both `readReplicas.pdb.minAvailable` and `readReplicas.pdb.maxUnavailable` are empty. | `50%` |
| `mountConfiguration.backend` | Mount backend configmaps and secrets. | `true` |
| `mountConfiguration.frontend` | Mount frontend configmaps and secrets. | `false` |