diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 9ddc8f91..71943c61 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -5,13 +5,17 @@ "image": "mcr.microsoft.com/devcontainers/base:ubuntu-22.04", - "containerEnv": { - "HOME": "/home/vscode", + "containerEnv": { + "HOME": "/home/vscode", "SHELL": "/bin/bash" - }, + }, // Features to add to the dev container. More info: https://containers.dev/features. "features": { + "ghcr.io/devcontainers/features/docker-in-docker:2": { + "enableNonRootDocker": "true", + "moby": "true" + }, "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": { "version": "latest", "helm": "latest", @@ -22,22 +26,25 @@ "ghcr.io/mpriscella/features/helm-chart-testing:1": {} }, - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], // Use 'postCreateCommand' to run commands after the container is created. "postCreateCommand": "/bin/bash .devcontainer/postCreateCommand.sh", - "remoteUser": "vscode", + "remoteUser": "vscode", - // Configure tool-specific properties. - "customizations": { - "vscode": { - "extensions": [ - "ms-kubernetes-tools.vscode-kubernetes-tools", + // Configure tool-specific properties. + "customizations": { + "vscode": { + "extensions": [ + "ms-kubernetes-tools.vscode-kubernetes-tools", "tim-koehler.helm-intellisense" - ] - } - } + ] + } + }, + + "workspaceFolder": "/home/vscode/helm-charts", + "workspaceMount": "source=${localWorkspaceFolder},target=/home/vscode/helm-charts,type=bind" } diff --git a/.devcontainer/postCreateCommand.sh b/.devcontainer/postCreateCommand.sh index 0166add9..e00fcbb6 100755 --- a/.devcontainer/postCreateCommand.sh +++ b/.devcontainer/postCreateCommand.sh @@ -7,9 +7,25 @@ pre-commit install --install-hooks TEMP_COMPLETION_FOLDER="${HOME}/bash_completion.d" COMPLETION_FOLDER="/etc/bash_completion.d" mkdir -p ${TEMP_COMPLETION_FOLDER} -BINARIES=("ct") +BINARIES=("ct" "minikube") for binary in "${BINARIES[@]}" do $binary completion bash > ${TEMP_COMPLETION_FOLDER}/$binary sudo mv ${TEMP_COMPLETION_FOLDER}/$binary ${COMPLETION_FOLDER}/$binary done + +# install helm plugins + +## helm-unittest +helm plugin install https://github.com/helm-unittest/helm-unittest.git + +## helm-schema-gen +helm plugin install https://github.com/KnechtionsCoding/helm-schema-gen.git + +# start minikube +minikube start --addons=ingress --cpus=4 --memory=8g --profile=helm-charts-development +minikube profile helm-charts-development + +# configure git +git config --global user.email "christian@knell.it" +git config --global user.name "christianhuth" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index dc61e46c..cc30c82e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,7 +2,7 @@ # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.0.1 + rev: v5.0.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer @@ -13,6 +13,7 @@ repos: - id: check-yaml args: [--allow-multiple-documents] exclude: ^charts/.*/templates/ + - repo: https://github.com/norwoodj/helm-docs rev: "" hooks: @@ -20,3 +21,8 @@ repos: entry: jnorwood/helm-docs:v1.14.2 args: - --chart-search-root=charts + + - repo: https://github.com/gruntwork-io/pre-commit + rev: v0.1.25 + hooks: + - id: helmlint diff --git a/charts/argocd-metrics-server/README.md b/charts/argocd-metrics-server/README.md index 6063dcde..4da9b182 100644 --- a/charts/argocd-metrics-server/README.md +++ b/charts/argocd-metrics-server/README.md @@ -46,44 +46,44 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| -------------------------------------- | ------ | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| extraEnv | list | `[]` | additional environment variables to be added to the pods | -| fullnameOverride | string | `""` | String to fully override `"argocd-extension-metrics.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.registry | string | `"quay.io"` | image registory | -| image.repository | string | `"argoprojlabs/argocd-extension-metrics"` | image repository | -| image.tag | string | `"v1.0.3"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| nameOverride | string | `""` | Provide a name in place of `argocd-extension-metrics` | -| networkPolicy.additionalAnnotations | object | `{}` | Annotations to be added to the NetworkPolicies | -| networkPolicy.additionalLabels | object | `{}` | Labels to be added to the NetworkPolicies | -| networkPolicy.argocd.enabled | bool | `true` | - allow incoming traffic from Argo CD | -| networkPolicy.argocd.namespaceSelector | object | `{}` | The labels of the namespace where Argo CD is running | -| networkPolicy.argocd.podSelector | object | `{}` | The labels of the Argo CD Pods | -| networkPolicy.dns.enabled | bool | `true` | allow outgoing traffic to the Kubernetes DNS | -| networkPolicy.dns.namespaceSelector | object | `{"kubernetes.io/metadata.name":"kube-system"}` | The labels of the namespace where the Kubernetes DNS is running | -| networkPolicy.dns.podSelector | object | `{"k8s-app":"kube-dns"}` | The labels of the Kubernetes DNS Pods | -| networkPolicy.enabled | bool | `false` | - create a NetworkPolicy resource to limit the allowed traffic | -| networkPolicy.prometheus.enabled | bool | `true` | - allow outgoing traffic to Prometheus | -| networkPolicy.prometheus.podSelector | object | `{"app.kubernetes.io/name":"prometheus"}` | The labels of the Prometheus Pods | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podSecurityContext | object | `{}` | pod-level security context | -| prometheus.dashboards | string | see [values.yaml](./values.yaml) | The dashboards that will be displayed in the Argo CD UI | -| prometheus.namespace | string | `"monitoring"` | The namespace where Prometheus is running | -| prometheus.port | int | `9090` | The port on which the Prometheus service is listening for traffic | -| prometheus.service | string | `"prometheus-operated"` | The name of the Prometheus service | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{"requests":{"cpu":"100m","memory":"100Mi"}}` | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `0` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `9003` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| extraEnv | list | `[]` | additional environment variables to be added to the pods | +| fullnameOverride | string | `""` | String to fully override `"argocd-extension-metrics.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.registry | string | `"quay.io"` | image registory | +| image.repository | string | `"argoprojlabs/argocd-extension-metrics"` | image repository | +| image.tag | string | `"v1.0.3"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| nameOverride | string | `""` | Provide a name in place of `argocd-extension-metrics` | +| networkPolicy.additionalAnnotations | object | `{}` | Annotations to be added to the NetworkPolicies | +| networkPolicy.additionalLabels | object | `{}` | Labels to be added to the NetworkPolicies | +| networkPolicy.argocd.enabled | bool | `true` | - allow incoming traffic from Argo CD | +| networkPolicy.argocd.namespaceSelector | object | `{}` | The labels of the namespace where Argo CD is running | +| networkPolicy.argocd.podSelector | object | `{}` | The labels of the Argo CD Pods | +| networkPolicy.dns.enabled | bool | `true` | allow outgoing traffic to the Kubernetes DNS | +| networkPolicy.dns.namespaceSelector | object | `{"kubernetes.io/metadata.name":"kube-system"}` | The labels of the namespace where the Kubernetes DNS is running | +| networkPolicy.dns.podSelector | object | `{"k8s-app":"kube-dns"}` | The labels of the Kubernetes DNS Pods | +| networkPolicy.enabled | bool | `false` | - create a NetworkPolicy resource to limit the allowed traffic | +| networkPolicy.prometheus.enabled | bool | `true` | - allow outgoing traffic to Prometheus | +| networkPolicy.prometheus.podSelector | object | `{"app.kubernetes.io/name":"prometheus"}` | The labels of the Prometheus Pods | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podSecurityContext | object | `{}` | pod-level security context | +| prometheus.dashboards | string | see [values.yaml](./values.yaml) | The dashboards that will be displayed in the Argo CD UI | +| prometheus.namespace | string | `"monitoring"` | The namespace where Prometheus is running | +| prometheus.port | int | `9090` | The port on which the Prometheus service is listening for traffic | +| prometheus.service | string | `"prometheus-operated"` | The name of the Prometheus service | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{"requests":{"cpu":"100m","memory":"100Mi"}}` | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `0` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `9003` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/baserow/README.md b/charts/baserow/README.md index 9be8eeff..2e931e40 100644 --- a/charts/baserow/README.md +++ b/charts/baserow/README.md @@ -46,254 +46,254 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------------------------ | ------ | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| backend.asgi.affinity | object | `{}` | Affinity settings for pod assignment | -| backend.asgi.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| backend.asgi.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| backend.asgi.autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| backend.asgi.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| backend.asgi.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | -| backend.asgi.extraEnv | list | `[]` | additional environment variables to be added to the pods | -| backend.asgi.image.pullPolicy | string | `"Always"` | image pull policy | -| backend.asgi.image.repository | string | `"baserow/backend"` | image repository | -| backend.asgi.image.tag | string | `"1.26.1"` | Overrides the image tag | -| backend.asgi.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| backend.asgi.livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | -| backend.asgi.livenessProbe.periodSeconds | int | `5` | Period seconds for livenessProbe | -| backend.asgi.livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | -| backend.asgi.livenessProbe.timeoutSeconds | int | `5` | Timeout seconds for livenessProbe | -| backend.asgi.nodeSelector | object | `{}` | Node labels for pod assignment | -| backend.asgi.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | -| backend.asgi.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | -| backend.asgi.priorityClassName | string | `""` | Pod priority class name | -| backend.asgi.readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | -| backend.asgi.readinessProbe.periodSeconds | int | `5` | Period seconds for readinessProbe | -| backend.asgi.readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | -| backend.asgi.readinessProbe.timeoutSeconds | int | `5` | Timeout seconds for readinessProbe | -| backend.asgi.replicaCount | int | `1` | Number of replicas | -| backend.asgi.resources | object | `{}` | Resource limits and requests for the controller pods. | -| backend.asgi.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| backend.asgi.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | -| backend.asgi.selectorLabels | object | `{}` | Additional labels to add to the pod | -| backend.asgi.service.port | int | `8000` | Kubernetes port where service is exposed | -| backend.asgi.service.type | string | `"ClusterIP"` | Kubernetes service type | -| backend.asgi.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| backend.asgi.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| backend.asgi.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| backend.asgi.tolerations | list | `[]` | Toleration labels for pod assignment | -| backend.celery.affinity | object | `{}` | Affinity settings for pod assignment | -| backend.celery.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| backend.celery.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| backend.celery.autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| backend.celery.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| backend.celery.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | -| backend.celery.extraEnv | list | `[]` | additional environment variables to be added to the pods | -| backend.celery.image.pullPolicy | string | `"Always"` | image pull policy | -| backend.celery.image.repository | string | `"baserow/backend"` | image repository | -| backend.celery.image.tag | string | `"1.26.1"` | Overrides the image tag | -| backend.celery.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| backend.celery.livenessProbe.initialDelaySeconds | int | `10` | Initial delay seconds for livenessProbe | -| backend.celery.livenessProbe.periodSeconds | int | `10` | Period seconds for livenessProbe | -| backend.celery.livenessProbe.timeoutSeconds | int | `10` | Timeout seconds for livenessProbe | -| backend.celery.nodeSelector | object | `{}` | Node labels for pod assignment | -| backend.celery.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | -| backend.celery.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | -| backend.celery.priorityClassName | string | `""` | Pod priority class name | -| backend.celery.readinessProbe.initialDelaySeconds | int | `10` | Initial delay seconds for readinessProbe | -| backend.celery.readinessProbe.periodSeconds | int | `10` | Period seconds for readinessProbe | -| backend.celery.readinessProbe.timeoutSeconds | int | `10` | Timeout seconds for readinessProbe | -| backend.celery.replicaCount | int | `1` | Number of replicas | -| backend.celery.resources | object | `{}` | Resource limits and requests for the controller pods. | -| backend.celery.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| backend.celery.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | -| backend.celery.selectorLabels | object | `{}` | Additional labels to add to the pod | -| backend.celery.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| backend.celery.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| backend.celery.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| backend.celery.tolerations | list | `[]` | Toleration labels for pod assignment | -| backend.config.additionalApps | string | `""` | A comma separated list of additional django applications to add to the INSTALLED_APPS django setting | -| backend.config.airtableImportSoftTimeLimit | string | `"1800"` | The maximum amount of seconds an Airtable migration import job can run. | -| backend.config.amountOfGunicornWorkers | string | `""` | The number of concurrent worker processes used by the Baserow backend gunicorn server to process incoming requests | -| backend.config.aws.accessKeyId | string | `""` | The access key for your AWS account. When set to anything other than empty will switch Baserow to use a S3 compatible bucket for storing user file uploads. | -| backend.config.aws.bucketName | string | `""` | Your Amazon Web Services storage bucket name. | -| backend.config.aws.existingSecret | string | `""` | Name of existing secret to use for AWS credentials like backend.config.aws.accessKeyId and backend.config.aws.secretAccessKey. Keys in secret should be called `access-key-id` and `secret-access-key`. | -| backend.config.aws.s3CustomDomain | string | `""` | Your custom domain where the files can be downloaded from. | -| backend.config.aws.s3EndpointUrl | string | `""` | Custom S3 URL to use when connecting to S3, including scheme. | -| backend.config.aws.s3RegionName | string | `""` | Name of the AWS S3 region to use (eg. eu-west-1) | -| backend.config.aws.secretAccessKey | string | `""` | The access secret key for your AWS account. | -| backend.config.batchRowsSizeLimit | string | `"200"` | Controls how many rows can be created, deleted or updated at once using the batch endpoints. | -| backend.config.celery.amountOfWorkers | string | `""` | The number of concurrent celery worker processes used to process asynchronous tasks. If not set will default to the number of available cores. Each celery process uses memory, to reduce Baserow’s memory footprint consider setting and reducing this variable. | -| backend.config.celery.beatDebugLevel | string | `"INFO"` | The logging level for the celery beat service. | -| backend.config.celery.beatStartupDelay | string | `"15"` | The number of seconds the celery beat worker sleeps before starting up. | -| backend.config.celery.runMinimal | string | `""` | When BASEROW_AMOUNT_OF_WORKERS is 1 and this is set to a non empty value Baserow will not run the export-worker but instead run both the celery export and normal tasks on the normal celery worker. Set this to lower the memory usage of Baserow in expense of performance. | -| backend.config.disableAnonymousPublicViewWsConnections | string | `""` | When sharing views publicly a websocket connection is opened to provide realtime updates to viewers of the public link. To disable this set any non empty value. When disabled publicly shared links will need to be refreshed to see any updates to the view. | -| backend.config.disableModelCache | string | `""` | When set to any non empty value the model cache used to speed up Baserow will be disabled. Useful to enable when debugging Baserow errors if they are possibly caused by the model cache itself. | -| backend.config.dontUpdateFormulasAfterMigration | string | `""` | Baserow’s formulas have an internal version number. When upgrading Baserow if the formula language has also changed then after the database migration has run Baserow will also automatically recalculate all formulas if they have a different version. Set this to any non empty value to disable this automatic update if you would prefer to run the update_formulas management command manually yourself. Formulas might break if you forget to do so after an upgrade of Baserow until and so it is recommended to leave this empty. | -| backend.config.email.existingSecret | string | `""` | Name of existing secret to use for the email password. Key in secret should be called `email-password`. | -| backend.config.email.fromEmail | string | `""` | The email address Baserow will send emails from. | -| backend.config.email.smtp | string | `""` | If set to any non empty value then Baserow will start sending emails using the configuration options below. If not set then Baserow will not send emails and just log them to the Celery worker logs instead. | -| backend.config.email.smtpHost | string | `""` | The host of the external SMTP server that Baserow should use to send emails. | -| backend.config.email.smtpPassword | string | `""` | The password to authenticate to the smtp host when sending emails. | -| backend.config.email.smtpPort | string | `""` | The port used to connect to the smtp host. | -| backend.config.email.smtpUseTls | string | `""` | If set to any non empty value then Baserow will attempt to send emails using TLS. | -| backend.config.email.smtpUser | string | `""` | The username to authenticate to the smtp host when sending emails. | -| backend.config.enableSecureProxySslHeader | string | `""` | Set to any non-empty value to ensure Baserow generates https:// next links provided by paginated API endpoints. Baserow will still work correctly if not enabled, this is purely for giving the correct https url for clients of the API. | -| backend.config.existingSecret | string | `""` | Name of existing secret to use for secret configuration values like backend.config.jwtSigningKey and backend.config.secretKey. Keys in secret should be called `jwt-signing-key` and `secret-key`. | -| backend.config.fileUploadSizeLimit | string | `"1048576"` | The max file size in MB allowed to be uploaded by users into a Baserow File Field. | -| backend.config.hoursUntilTrashPermanentlyDeleted | string | `""` | Items from the trash will be permanently deleted after this number of hours. | -| backend.config.initialCreateSyncTableDataLimit | string | `"5000"` | The maximum number of rows you can import in a synchronous way | -| backend.config.initialTableDataLimit | string | `""` | The amount of rows that can be imported when creating a table. Defaults to empty which means unlimited rows. | -| backend.config.jobs.cleanupIntervalMinutes | string | `"5"` | How often the job cleanup task will run. | -| backend.config.jobs.expirationTimeLimit | string | `"43200"` | How long before a Baserow job will be kept before being cleaned up. | -| backend.config.jobs.softTimeLimit | string | `"1800"` | The number of seconds a Baserow job can run before being terminated. | -| backend.config.jwtSigningKey | string | `""` | The signing key that is used to sign the content of generated tokens. For HMAC signing, this should be a random string with at least as many bits of data as is required by the signing protocol. See https://django-rest-framework-simplejwt.readthedocs.io/en/latest/settings.html#signing-key for more details. | -| backend.config.logging.backendDebug | string | `"off"` | If set to “on” then will enable the non production safe debug mode for the Baserow django backend. | -| backend.config.logging.backendLogLevel | string | `"INFO"` | The default log level used by the backend, supports ERROR, WARNING, INFO, DEBUG, TRACE | -| backend.config.logging.databaseLogLevel | string | `"ERROR"` | The default log level used for database related logs in the backend. Supports the same values as the normal log level. If you also enable BASEROW_BACKEND_DEBUG and set this to DEBUG you will be able to see all SQL queries in the backend logs. | -| backend.config.maxFileImportErrorCount | string | `"30"` | The max number of per row errors than can occur in a file import before an overall failure is declared. | -| backend.config.maxRowReportErrorCount | string | `"30"` | The maximum row error count tolerated before a file import fails. Before this max error count the import will continue and the non failing rows will be imported and after it, no rows are imported at all. | -| backend.config.media.root | string | `"/baserow/media"` | The folder in which the backend will store user uploaded files | -| backend.config.media.url | string | `"$PUBLIC_BACKEND_URL/media/"` | The URL at which user uploaded media files will be made available | -| backend.config.migrateOnStartup | string | `"true"` | If set to “true” when the Baserow backend service starts up it will automatically apply database migrations. Set to any other value to disable. If you disable this then you must remember to manually apply the database migrations when upgrading Baserow to a new version. | -| backend.config.minutesUntilActionCleanedUp | string | `"120"` | How long before actions are cleaned up, actions are used to let you undo/redo so this is effectively the max length of time you can undo/redo can action. | -| backend.config.postgresStartupCheckAttempts | string | `"5"` | When Baserow’s Backend service starts up it first checks to see if the postgres database is available. | -| backend.config.rowPageSizeLimit | string | `"200"` | The maximum number of rows that can be requested at once. | -| backend.config.secretKey | string | `""` | The Secret key used by Django for cryptographic signing such as generating secure password reset links and managing sessions. See https://docs.djangoproject.com/en/3.2/ref/settings/#std:setting-SECRET_KEY for more details. | -| backend.config.snapshotExpirationTimeDays | string | `"360"` | Controls when snapshots expire, set in number of days. Expired snapshots will be automatically deleted. | -| backend.config.syncTemplatesTimeLimit | string | `"1800"` | The number of seconds before the background sync templates job will timeout if not yet completed. | -| backend.config.tokens.accessTokenLifetimeMinutes | string | `"10"` | The number of minutes which specifies how long access tokens are valid. This will be converted in a timedelta value and added to the current UTC time during token generation to obtain the token’s default “exp” claim value. | -| backend.config.tokens.refreshTokenLifetimeHours | string | `"168"` | The number of hours which specifies how long refresh tokens are valid. This will be converted in a timedelta value and added to the current UTC time during token generation to obtain the token’s default “exp” claim value. | -| backend.config.triggerSyncTemplatesAfterMigration | string | `"true"` | If set to “true” when after a migration Baserow will automatically sync all builtin Baserow templates in the background. If you are using a postgres database which is constrained to fewer than 10000 rows then we recommend you disable this as the Baserow templates will go over that row limit. To disable this set to any other value than “true” | -| backend.config.waitInsteadOf409ConflictError | string | `""` | When updating or creating various resources in Baserow if another concurrent operation is ongoing (like a snapshot, duplication, import etc) which would be affected by your modification a 409 HTTP error will be returned. If you instead would prefer Baserow to not return a 409 and just block waiting until the operation finishes and then to perform the requested operation set this flag to any non-empty value. | -| backend.config.webhook.allowPrivateAddress | string | `""` | If set to any non empty value allows webhooks to access all addresses. Enabling this flag is a security risk as it will allow users to send webhook requests to internal addresses on your network. Instead consider using the three variables below first to allow access to only some internal network hostnames or IPs. | -| backend.config.webhook.ipBlacklist | string | `""` | Disabled if backend.config.webhook.allowPrivateAddress is set. List of comma seperated IP addresses or ranges that webhooks will be denied from using after the URL has been resolved to an IP using DNS. | -| backend.config.webhook.ipWhitelist | string | `""` | Disabled if backend.config.webhook.allowPrivateAddress is set. List of comma seperated IP addresses or ranges that webhooks will be allowed to use after the webhook URL has been resolved to an IP using DNS. | -| backend.config.webhook.maxCallLogEntries | string | `"10"` | The maximum number of call log entries stored per webhook. | -| backend.config.webhook.maxConsecutiveTriggerFailures | string | `"8"` | The number of consecutive trigger failures that can occur before a webhook is disabled. | -| backend.config.webhook.maxPerTable | string | `"20"` | The max number of webhooks per Baserow table. | -| backend.config.webhook.maxRetriesPerCall | string | `"8"` | The max number of retries per webhook call. | -| backend.config.webhook.requestTimeoutSeconds | string | `"5"` | How long to wait on making the webhook request before timing out. | -| backend.config.webhook.urlCheckTimeoutSecs | string | `"10"` | Disabled if backend.config.webhook.allowPrivateAddress is set. How long to wait before timing out and returning an error when checking if an url can be accessed for a webhook. | -| backend.config.webhook.urlRegexBlacklist | string | `""` | Disabled if backend.config.webhook.allowPrivateAddress is set. List of comma seperated regexes used to validate user configured webhook URLs, will show the user an error if any regexes match their webhook URL and prevent it from running. | -| backend.ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | -| backend.ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | -| backend.ingress.enabled | bool | `false` | Enable ingress record generation for the backend | -| backend.ingress.hostname | string | `""` | The publicly reachable hostname for the backend | -| backend.ingress.paths.asgiPath | string | `"/ws/"` | The path under witch the asgi backend should be reached | -| backend.ingress.paths.wsgiPath | string | `"/"` | The path under witch the wsgi backend should be reached | -| backend.ingress.tls | list | `[]` | An array with the tls configuration | -| backend.persistence.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | -| backend.persistence.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | -| backend.persistence.enabled | bool | `false` | use a PVC to persist file uploads | -| backend.persistence.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | -| backend.persistence.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | -| backend.persistence.storageClassName | string | `""` | Name of the StorageClass required by the claim. | -| backend.wsgi.affinity | object | `{}` | Affinity settings for pod assignment | -| backend.wsgi.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| backend.wsgi.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| backend.wsgi.autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| backend.wsgi.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| backend.wsgi.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | -| backend.wsgi.extraEnv | list | `[]` | additional environment variables to be added to the pods | -| backend.wsgi.image.pullPolicy | string | `"Always"` | image pull policy | -| backend.wsgi.image.repository | string | `"baserow/backend"` | image repository | -| backend.wsgi.image.tag | string | `"1.26.1"` | Overrides the image tag | -| backend.wsgi.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| backend.wsgi.livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | -| backend.wsgi.livenessProbe.periodSeconds | int | `5` | Period seconds for livenessProbe | -| backend.wsgi.livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | -| backend.wsgi.livenessProbe.timeoutSeconds | int | `5` | Timeout seconds for livenessProbe | -| backend.wsgi.nodeSelector | object | `{}` | Node labels for pod assignment | -| backend.wsgi.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | -| backend.wsgi.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | -| backend.wsgi.priorityClassName | string | `""` | Pod priority class name | -| backend.wsgi.readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | -| backend.wsgi.readinessProbe.periodSeconds | int | `5` | Period seconds for readinessProbe | -| backend.wsgi.readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | -| backend.wsgi.readinessProbe.timeoutSeconds | int | `5` | Timeout seconds for readinessProbe | -| backend.wsgi.replicaCount | int | `1` | Number of replicas | -| backend.wsgi.resources | object | `{}` | Resource limits and requests for the controller pods. | -| backend.wsgi.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| backend.wsgi.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | -| backend.wsgi.selectorLabels | object | `{}` | Additional labels to add to the pod | -| backend.wsgi.service.port | int | `8000` | Kubernetes port where service is exposed | -| backend.wsgi.service.type | string | `"ClusterIP"` | Kubernetes service type | -| backend.wsgi.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| backend.wsgi.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| backend.wsgi.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| backend.wsgi.tolerations | list | `[]` | Toleration labels for pod assignment | -| config.maxImportFileSizeMb | string | `"512"` | The maximum file size in mb you can import to create a new table. Default 512Mb. | -| config.maxSnapshotsPerGroup | string | `"-1"` | Controls how many application snapshots can be created per group. | -| config.publicBackendUrl | string | `"http://localhost:8000"` | The publicly accessible URL of the backend. Should include the port if non-standard. | -| config.publicFrontendUrl | string | `"http://localhost:3000"` | The publicly accessible URL of the frontend. Should include the port if non-standard. | -| externalPostgresql.auth.database | string | `"baserow"` | Name of the database to use | -| externalPostgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | -| externalPostgresql.auth.password | string | `"baserow"` | Password to use | -| externalPostgresql.auth.userPasswordKey | string | `""` | Key in the secret containing the password | -| externalPostgresql.auth.username | string | `"baserow"` | Name of the user to use | -| externalPostgresql.hostname | string | `""` | Hostname of the PostgreSQL database | -| externalPostgresql.port | int | `5432` | Port used to connect to PostgreSQL database | -| externalRedis.auth.enabled | bool | `true` | if authentication should be used with external Redis™ | -| externalRedis.auth.existingSecret | string | `""` | Name of existing secret to use for Redis™ credentials | -| externalRedis.auth.password | string | `""` | Password to use | -| externalRedis.auth.userPasswordKey | string | `""` | Key in the secret containing the password | -| externalRedis.hostname | string | `""` | Hostname of Redis™ | -| externalRedis.port | int | `6379` | Port used to connect to Redis | -| frontend.affinity | object | `{}` | Affinity settings for pod assignment | -| frontend.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| frontend.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| frontend.autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| frontend.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| frontend.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | -| frontend.config.additionalModules | string | `""` | A list of file paths to Nuxt module.js files to load as additional Nuxt modules into Baserow on startup. | -| frontend.config.disableGoogleDocsFilePreview | string | `""` | Set to `true` or `1` to disable Google docs file preview. | -| frontend.config.disablePublicUrlCheck | string | `""` | When opening the Baserow login page a check is run to ensure the PUBLIC_BACKEND_URL/BASEROW_PUBLIC_URL variables are set correctly and your browser can correctly connect to the backend. If misconfigured an error is shown. If you wish to disable this check and warning set this to any non empty value. | -| frontend.config.downloadFileViaXhr | string | `"0"` | Set to `1` to force download links to download files via XHR query to bypass `Content-Disposition: inline` that can’t be overridden in another way. If your files are stored under another origin, you also must add CORS headers to your server. | -| frontend.extraEnv | list | `[]` | additional environment variables to be added to the pods | -| frontend.image.pullPolicy | string | `"Always"` | image pull policy | -| frontend.image.repository | string | `"baserow/web-frontend"` | image repository | -| frontend.image.tag | string | `"1.26.1"` | Overrides the image tag | -| frontend.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| frontend.ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | -| frontend.ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | -| frontend.ingress.enabled | bool | `false` | Enable ingress record generation for the frontend | -| frontend.ingress.hostname | string | `"chart-example.local"` | The publicly reachable hostname for the frontend | -| frontend.ingress.path | string | `"/"` | The path under witch the frontend should be reached | -| frontend.ingress.pathType | string | `"Prefix"` | Valid values: ImplementationSpecific, Exact, Prefix | -| frontend.ingress.tls | list | `[]` | An array with the tls configuration | -| frontend.livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | -| frontend.livenessProbe.periodSeconds | int | `5` | Period seconds for livenessProbe | -| frontend.livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | -| frontend.nodeSelector | object | `{}` | Node labels for pod assignment | -| frontend.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | -| frontend.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | -| frontend.priorityClassName | string | `""` | Pod priority class name | -| frontend.readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | -| frontend.readinessProbe.periodSeconds | int | `5` | Period seconds for readinessProbe | -| frontend.readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | -| frontend.replicaCount | int | `1` | Number of replicas | -| frontend.resources | object | `{}` | Resource limits and requests for the controller pods. | -| frontend.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| frontend.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | -| frontend.selectorLabels | object | `{}` | Additional labels to add to the pod | -| frontend.service.port | int | `3000` | Kubernetes port where service is exposed | -| frontend.service.type | string | `"ClusterIP"` | Kubernetes service type | -| frontend.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| frontend.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| frontend.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| frontend.tolerations | list | `[]` | Toleration labels for pod assignment | -| fullnameOverride | string | `""` | String to fully override `"baserow.fullname"` | -| nameOverride | string | `""` | Provide a name in place of `baserow` | -| postgresql.auth.database | string | `"baserow"` | Name for a custom database to create | -| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | -| postgresql.auth.password | string | `"baserow"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | -| postgresql.auth.username | string | `"baserow"` | Name for a custom user to create | -| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | -| redis.architecture | string | `"standalone"` | Redis® architecture. Allowed values: standalone or replication | -| redis.auth.enabled | bool | `true` | Enable password authentication | -| redis.auth.password | string | `"baserow"` | Redis™ password | -| redis.enabled | bool | `true` | enable Redis™ subchart from Bitnami | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| backend.asgi.affinity | object | `{}` | Affinity settings for pod assignment | +| backend.asgi.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| backend.asgi.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| backend.asgi.autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| backend.asgi.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| backend.asgi.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | +| backend.asgi.extraEnv | list | `[]` | additional environment variables to be added to the pods | +| backend.asgi.image.pullPolicy | string | `"Always"` | image pull policy | +| backend.asgi.image.repository | string | `"baserow/backend"` | image repository | +| backend.asgi.image.tag | string | `"1.26.1"` | Overrides the image tag | +| backend.asgi.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| backend.asgi.livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | +| backend.asgi.livenessProbe.periodSeconds | int | `5` | Period seconds for livenessProbe | +| backend.asgi.livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | +| backend.asgi.livenessProbe.timeoutSeconds | int | `5` | Timeout seconds for livenessProbe | +| backend.asgi.nodeSelector | object | `{}` | Node labels for pod assignment | +| backend.asgi.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | +| backend.asgi.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | +| backend.asgi.priorityClassName | string | `""` | Pod priority class name | +| backend.asgi.readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | +| backend.asgi.readinessProbe.periodSeconds | int | `5` | Period seconds for readinessProbe | +| backend.asgi.readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | +| backend.asgi.readinessProbe.timeoutSeconds | int | `5` | Timeout seconds for readinessProbe | +| backend.asgi.replicaCount | int | `1` | Number of replicas | +| backend.asgi.resources | object | `{}` | Resource limits and requests for the controller pods. | +| backend.asgi.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| backend.asgi.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | +| backend.asgi.selectorLabels | object | `{}` | Additional labels to add to the pod | +| backend.asgi.service.port | int | `8000` | Kubernetes port where service is exposed | +| backend.asgi.service.type | string | `"ClusterIP"` | Kubernetes service type | +| backend.asgi.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| backend.asgi.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| backend.asgi.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| backend.asgi.tolerations | list | `[]` | Toleration labels for pod assignment | +| backend.celery.affinity | object | `{}` | Affinity settings for pod assignment | +| backend.celery.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| backend.celery.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| backend.celery.autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| backend.celery.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| backend.celery.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | +| backend.celery.extraEnv | list | `[]` | additional environment variables to be added to the pods | +| backend.celery.image.pullPolicy | string | `"Always"` | image pull policy | +| backend.celery.image.repository | string | `"baserow/backend"` | image repository | +| backend.celery.image.tag | string | `"1.26.1"` | Overrides the image tag | +| backend.celery.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| backend.celery.livenessProbe.initialDelaySeconds | int | `10` | Initial delay seconds for livenessProbe | +| backend.celery.livenessProbe.periodSeconds | int | `10` | Period seconds for livenessProbe | +| backend.celery.livenessProbe.timeoutSeconds | int | `10` | Timeout seconds for livenessProbe | +| backend.celery.nodeSelector | object | `{}` | Node labels for pod assignment | +| backend.celery.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | +| backend.celery.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | +| backend.celery.priorityClassName | string | `""` | Pod priority class name | +| backend.celery.readinessProbe.initialDelaySeconds | int | `10` | Initial delay seconds for readinessProbe | +| backend.celery.readinessProbe.periodSeconds | int | `10` | Period seconds for readinessProbe | +| backend.celery.readinessProbe.timeoutSeconds | int | `10` | Timeout seconds for readinessProbe | +| backend.celery.replicaCount | int | `1` | Number of replicas | +| backend.celery.resources | object | `{}` | Resource limits and requests for the controller pods. | +| backend.celery.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| backend.celery.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | +| backend.celery.selectorLabels | object | `{}` | Additional labels to add to the pod | +| backend.celery.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| backend.celery.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| backend.celery.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| backend.celery.tolerations | list | `[]` | Toleration labels for pod assignment | +| backend.config.additionalApps | string | `""` | A comma separated list of additional django applications to add to the INSTALLED_APPS django setting | +| backend.config.airtableImportSoftTimeLimit | string | `"1800"` | The maximum amount of seconds an Airtable migration import job can run. | +| backend.config.amountOfGunicornWorkers | string | `""` | The number of concurrent worker processes used by the Baserow backend gunicorn server to process incoming requests | +| backend.config.aws.accessKeyId | string | `""` | The access key for your AWS account. When set to anything other than empty will switch Baserow to use a S3 compatible bucket for storing user file uploads. | +| backend.config.aws.bucketName | string | `""` | Your Amazon Web Services storage bucket name. | +| backend.config.aws.existingSecret | string | `""` | Name of existing secret to use for AWS credentials like backend.config.aws.accessKeyId and backend.config.aws.secretAccessKey. Keys in secret should be called `access-key-id` and `secret-access-key`. | +| backend.config.aws.s3CustomDomain | string | `""` | Your custom domain where the files can be downloaded from. | +| backend.config.aws.s3EndpointUrl | string | `""` | Custom S3 URL to use when connecting to S3, including scheme. | +| backend.config.aws.s3RegionName | string | `""` | Name of the AWS S3 region to use (eg. eu-west-1) | +| backend.config.aws.secretAccessKey | string | `""` | The access secret key for your AWS account. | +| backend.config.batchRowsSizeLimit | string | `"200"` | Controls how many rows can be created, deleted or updated at once using the batch endpoints. | +| backend.config.celery.amountOfWorkers | string | `""` | The number of concurrent celery worker processes used to process asynchronous tasks. If not set will default to the number of available cores. Each celery process uses memory, to reduce Baserow’s memory footprint consider setting and reducing this variable. | +| backend.config.celery.beatDebugLevel | string | `"INFO"` | The logging level for the celery beat service. | +| backend.config.celery.beatStartupDelay | string | `"15"` | The number of seconds the celery beat worker sleeps before starting up. | +| backend.config.celery.runMinimal | string | `""` | When BASEROW_AMOUNT_OF_WORKERS is 1 and this is set to a non empty value Baserow will not run the export-worker but instead run both the celery export and normal tasks on the normal celery worker. Set this to lower the memory usage of Baserow in expense of performance. | +| backend.config.disableAnonymousPublicViewWsConnections | string | `""` | When sharing views publicly a websocket connection is opened to provide realtime updates to viewers of the public link. To disable this set any non empty value. When disabled publicly shared links will need to be refreshed to see any updates to the view. | +| backend.config.disableModelCache | string | `""` | When set to any non empty value the model cache used to speed up Baserow will be disabled. Useful to enable when debugging Baserow errors if they are possibly caused by the model cache itself. | +| backend.config.dontUpdateFormulasAfterMigration | string | `""` | Baserow’s formulas have an internal version number. When upgrading Baserow if the formula language has also changed then after the database migration has run Baserow will also automatically recalculate all formulas if they have a different version. Set this to any non empty value to disable this automatic update if you would prefer to run the update_formulas management command manually yourself. Formulas might break if you forget to do so after an upgrade of Baserow until and so it is recommended to leave this empty. | +| backend.config.email.existingSecret | string | `""` | Name of existing secret to use for the email password. Key in secret should be called `email-password`. | +| backend.config.email.fromEmail | string | `""` | The email address Baserow will send emails from. | +| backend.config.email.smtp | string | `""` | If set to any non empty value then Baserow will start sending emails using the configuration options below. If not set then Baserow will not send emails and just log them to the Celery worker logs instead. | +| backend.config.email.smtpHost | string | `""` | The host of the external SMTP server that Baserow should use to send emails. | +| backend.config.email.smtpPassword | string | `""` | The password to authenticate to the smtp host when sending emails. | +| backend.config.email.smtpPort | string | `""` | The port used to connect to the smtp host. | +| backend.config.email.smtpUseTls | string | `""` | If set to any non empty value then Baserow will attempt to send emails using TLS. | +| backend.config.email.smtpUser | string | `""` | The username to authenticate to the smtp host when sending emails. | +| backend.config.enableSecureProxySslHeader | string | `""` | Set to any non-empty value to ensure Baserow generates https:// next links provided by paginated API endpoints. Baserow will still work correctly if not enabled, this is purely for giving the correct https url for clients of the API. | +| backend.config.existingSecret | string | `""` | Name of existing secret to use for secret configuration values like backend.config.jwtSigningKey and backend.config.secretKey. Keys in secret should be called `jwt-signing-key` and `secret-key`. | +| backend.config.fileUploadSizeLimit | string | `"1048576"` | The max file size in MB allowed to be uploaded by users into a Baserow File Field. | +| backend.config.hoursUntilTrashPermanentlyDeleted | string | `""` | Items from the trash will be permanently deleted after this number of hours. | +| backend.config.initialCreateSyncTableDataLimit | string | `"5000"` | The maximum number of rows you can import in a synchronous way | +| backend.config.initialTableDataLimit | string | `""` | The amount of rows that can be imported when creating a table. Defaults to empty which means unlimited rows. | +| backend.config.jobs.cleanupIntervalMinutes | string | `"5"` | How often the job cleanup task will run. | +| backend.config.jobs.expirationTimeLimit | string | `"43200"` | How long before a Baserow job will be kept before being cleaned up. | +| backend.config.jobs.softTimeLimit | string | `"1800"` | The number of seconds a Baserow job can run before being terminated. | +| backend.config.jwtSigningKey | string | `""` | The signing key that is used to sign the content of generated tokens. For HMAC signing, this should be a random string with at least as many bits of data as is required by the signing protocol. See https://django-rest-framework-simplejwt.readthedocs.io/en/latest/settings.html#signing-key for more details. | +| backend.config.logging.backendDebug | string | `"off"` | If set to “on” then will enable the non production safe debug mode for the Baserow django backend. | +| backend.config.logging.backendLogLevel | string | `"INFO"` | The default log level used by the backend, supports ERROR, WARNING, INFO, DEBUG, TRACE | +| backend.config.logging.databaseLogLevel | string | `"ERROR"` | The default log level used for database related logs in the backend. Supports the same values as the normal log level. If you also enable BASEROW_BACKEND_DEBUG and set this to DEBUG you will be able to see all SQL queries in the backend logs. | +| backend.config.maxFileImportErrorCount | string | `"30"` | The max number of per row errors than can occur in a file import before an overall failure is declared. | +| backend.config.maxRowReportErrorCount | string | `"30"` | The maximum row error count tolerated before a file import fails. Before this max error count the import will continue and the non failing rows will be imported and after it, no rows are imported at all. | +| backend.config.media.root | string | `"/baserow/media"` | The folder in which the backend will store user uploaded files | +| backend.config.media.url | string | `"$PUBLIC_BACKEND_URL/media/"` | The URL at which user uploaded media files will be made available | +| backend.config.migrateOnStartup | string | `"true"` | If set to “true” when the Baserow backend service starts up it will automatically apply database migrations. Set to any other value to disable. If you disable this then you must remember to manually apply the database migrations when upgrading Baserow to a new version. | +| backend.config.minutesUntilActionCleanedUp | string | `"120"` | How long before actions are cleaned up, actions are used to let you undo/redo so this is effectively the max length of time you can undo/redo can action. | +| backend.config.postgresStartupCheckAttempts | string | `"5"` | When Baserow’s Backend service starts up it first checks to see if the postgres database is available. | +| backend.config.rowPageSizeLimit | string | `"200"` | The maximum number of rows that can be requested at once. | +| backend.config.secretKey | string | `""` | The Secret key used by Django for cryptographic signing such as generating secure password reset links and managing sessions. See https://docs.djangoproject.com/en/3.2/ref/settings/#std:setting-SECRET_KEY for more details. | +| backend.config.snapshotExpirationTimeDays | string | `"360"` | Controls when snapshots expire, set in number of days. Expired snapshots will be automatically deleted. | +| backend.config.syncTemplatesTimeLimit | string | `"1800"` | The number of seconds before the background sync templates job will timeout if not yet completed. | +| backend.config.tokens.accessTokenLifetimeMinutes | string | `"10"` | The number of minutes which specifies how long access tokens are valid. This will be converted in a timedelta value and added to the current UTC time during token generation to obtain the token’s default “exp” claim value. | +| backend.config.tokens.refreshTokenLifetimeHours | string | `"168"` | The number of hours which specifies how long refresh tokens are valid. This will be converted in a timedelta value and added to the current UTC time during token generation to obtain the token’s default “exp” claim value. | +| backend.config.triggerSyncTemplatesAfterMigration | string | `"true"` | If set to “true” when after a migration Baserow will automatically sync all builtin Baserow templates in the background. If you are using a postgres database which is constrained to fewer than 10000 rows then we recommend you disable this as the Baserow templates will go over that row limit. To disable this set to any other value than “true” | +| backend.config.waitInsteadOf409ConflictError | string | `""` | When updating or creating various resources in Baserow if another concurrent operation is ongoing (like a snapshot, duplication, import etc) which would be affected by your modification a 409 HTTP error will be returned. If you instead would prefer Baserow to not return a 409 and just block waiting until the operation finishes and then to perform the requested operation set this flag to any non-empty value. | +| backend.config.webhook.allowPrivateAddress | string | `""` | If set to any non empty value allows webhooks to access all addresses. Enabling this flag is a security risk as it will allow users to send webhook requests to internal addresses on your network. Instead consider using the three variables below first to allow access to only some internal network hostnames or IPs. | +| backend.config.webhook.ipBlacklist | string | `""` | Disabled if backend.config.webhook.allowPrivateAddress is set. List of comma seperated IP addresses or ranges that webhooks will be denied from using after the URL has been resolved to an IP using DNS. | +| backend.config.webhook.ipWhitelist | string | `""` | Disabled if backend.config.webhook.allowPrivateAddress is set. List of comma seperated IP addresses or ranges that webhooks will be allowed to use after the webhook URL has been resolved to an IP using DNS. | +| backend.config.webhook.maxCallLogEntries | string | `"10"` | The maximum number of call log entries stored per webhook. | +| backend.config.webhook.maxConsecutiveTriggerFailures | string | `"8"` | The number of consecutive trigger failures that can occur before a webhook is disabled. | +| backend.config.webhook.maxPerTable | string | `"20"` | The max number of webhooks per Baserow table. | +| backend.config.webhook.maxRetriesPerCall | string | `"8"` | The max number of retries per webhook call. | +| backend.config.webhook.requestTimeoutSeconds | string | `"5"` | How long to wait on making the webhook request before timing out. | +| backend.config.webhook.urlCheckTimeoutSecs | string | `"10"` | Disabled if backend.config.webhook.allowPrivateAddress is set. How long to wait before timing out and returning an error when checking if an url can be accessed for a webhook. | +| backend.config.webhook.urlRegexBlacklist | string | `""` | Disabled if backend.config.webhook.allowPrivateAddress is set. List of comma seperated regexes used to validate user configured webhook URLs, will show the user an error if any regexes match their webhook URL and prevent it from running. | +| backend.ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | +| backend.ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | +| backend.ingress.enabled | bool | `false` | Enable ingress record generation for the backend | +| backend.ingress.hostname | string | `""` | The publicly reachable hostname for the backend | +| backend.ingress.paths.asgiPath | string | `"/ws/"` | The path under witch the asgi backend should be reached | +| backend.ingress.paths.wsgiPath | string | `"/"` | The path under witch the wsgi backend should be reached | +| backend.ingress.tls | list | `[]` | An array with the tls configuration | +| backend.persistence.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | +| backend.persistence.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | +| backend.persistence.enabled | bool | `false` | use a PVC to persist file uploads | +| backend.persistence.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | +| backend.persistence.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | +| backend.persistence.storageClassName | string | `""` | Name of the StorageClass required by the claim. | +| backend.wsgi.affinity | object | `{}` | Affinity settings for pod assignment | +| backend.wsgi.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| backend.wsgi.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| backend.wsgi.autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| backend.wsgi.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| backend.wsgi.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | +| backend.wsgi.extraEnv | list | `[]` | additional environment variables to be added to the pods | +| backend.wsgi.image.pullPolicy | string | `"Always"` | image pull policy | +| backend.wsgi.image.repository | string | `"baserow/backend"` | image repository | +| backend.wsgi.image.tag | string | `"1.26.1"` | Overrides the image tag | +| backend.wsgi.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| backend.wsgi.livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | +| backend.wsgi.livenessProbe.periodSeconds | int | `5` | Period seconds for livenessProbe | +| backend.wsgi.livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | +| backend.wsgi.livenessProbe.timeoutSeconds | int | `5` | Timeout seconds for livenessProbe | +| backend.wsgi.nodeSelector | object | `{}` | Node labels for pod assignment | +| backend.wsgi.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | +| backend.wsgi.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | +| backend.wsgi.priorityClassName | string | `""` | Pod priority class name | +| backend.wsgi.readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | +| backend.wsgi.readinessProbe.periodSeconds | int | `5` | Period seconds for readinessProbe | +| backend.wsgi.readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | +| backend.wsgi.readinessProbe.timeoutSeconds | int | `5` | Timeout seconds for readinessProbe | +| backend.wsgi.replicaCount | int | `1` | Number of replicas | +| backend.wsgi.resources | object | `{}` | Resource limits and requests for the controller pods. | +| backend.wsgi.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| backend.wsgi.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | +| backend.wsgi.selectorLabels | object | `{}` | Additional labels to add to the pod | +| backend.wsgi.service.port | int | `8000` | Kubernetes port where service is exposed | +| backend.wsgi.service.type | string | `"ClusterIP"` | Kubernetes service type | +| backend.wsgi.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| backend.wsgi.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| backend.wsgi.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| backend.wsgi.tolerations | list | `[]` | Toleration labels for pod assignment | +| config.maxImportFileSizeMb | string | `"512"` | The maximum file size in mb you can import to create a new table. Default 512Mb. | +| config.maxSnapshotsPerGroup | string | `"-1"` | Controls how many application snapshots can be created per group. | +| config.publicBackendUrl | string | `"http://localhost:8000"` | The publicly accessible URL of the backend. Should include the port if non-standard. | +| config.publicFrontendUrl | string | `"http://localhost:3000"` | The publicly accessible URL of the frontend. Should include the port if non-standard. | +| externalPostgresql.auth.database | string | `"baserow"` | Name of the database to use | +| externalPostgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | +| externalPostgresql.auth.password | string | `"baserow"` | Password to use | +| externalPostgresql.auth.userPasswordKey | string | `""` | Key in the secret containing the password | +| externalPostgresql.auth.username | string | `"baserow"` | Name of the user to use | +| externalPostgresql.hostname | string | `""` | Hostname of the PostgreSQL database | +| externalPostgresql.port | int | `5432` | Port used to connect to PostgreSQL database | +| externalRedis.auth.enabled | bool | `true` | if authentication should be used with external Redis™ | +| externalRedis.auth.existingSecret | string | `""` | Name of existing secret to use for Redis™ credentials | +| externalRedis.auth.password | string | `""` | Password to use | +| externalRedis.auth.userPasswordKey | string | `""` | Key in the secret containing the password | +| externalRedis.hostname | string | `""` | Hostname of Redis™ | +| externalRedis.port | int | `6379` | Port used to connect to Redis | +| frontend.affinity | object | `{}` | Affinity settings for pod assignment | +| frontend.autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| frontend.autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| frontend.autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| frontend.autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| frontend.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | +| frontend.config.additionalModules | string | `""` | A list of file paths to Nuxt module.js files to load as additional Nuxt modules into Baserow on startup. | +| frontend.config.disableGoogleDocsFilePreview | string | `""` | Set to `true` or `1` to disable Google docs file preview. | +| frontend.config.disablePublicUrlCheck | string | `""` | When opening the Baserow login page a check is run to ensure the PUBLIC_BACKEND_URL/BASEROW_PUBLIC_URL variables are set correctly and your browser can correctly connect to the backend. If misconfigured an error is shown. If you wish to disable this check and warning set this to any non empty value. | +| frontend.config.downloadFileViaXhr | string | `"0"` | Set to `1` to force download links to download files via XHR query to bypass `Content-Disposition: inline` that can’t be overridden in another way. If your files are stored under another origin, you also must add CORS headers to your server. | +| frontend.extraEnv | list | `[]` | additional environment variables to be added to the pods | +| frontend.image.pullPolicy | string | `"Always"` | image pull policy | +| frontend.image.repository | string | `"baserow/web-frontend"` | image repository | +| frontend.image.tag | string | `"1.26.1"` | Overrides the image tag | +| frontend.imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| frontend.ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | +| frontend.ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | +| frontend.ingress.enabled | bool | `false` | Enable ingress record generation for the frontend | +| frontend.ingress.hostname | string | `"chart-example.local"` | The publicly reachable hostname for the frontend | +| frontend.ingress.path | string | `"/"` | The path under witch the frontend should be reached | +| frontend.ingress.pathType | string | `"Prefix"` | Valid values: ImplementationSpecific, Exact, Prefix | +| frontend.ingress.tls | list | `[]` | An array with the tls configuration | +| frontend.livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | +| frontend.livenessProbe.periodSeconds | int | `5` | Period seconds for livenessProbe | +| frontend.livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | +| frontend.nodeSelector | object | `{}` | Node labels for pod assignment | +| frontend.podAnnotations | object | `{}` | Annotations to be added to the frontend pods | +| frontend.podSecurityContext | object | `{"fsGroup":9999,"runAsGroup":9999,"runAsUser":9999}` | pod-level security context | +| frontend.priorityClassName | string | `""` | Pod priority class name | +| frontend.readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | +| frontend.readinessProbe.periodSeconds | int | `5` | Period seconds for readinessProbe | +| frontend.readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | +| frontend.replicaCount | int | `1` | Number of replicas | +| frontend.resources | object | `{}` | Resource limits and requests for the controller pods. | +| frontend.revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| frontend.securityContext | object | `{"runAsGroup":9999,"runAsNonRoot":true,"runAsUser":9999}` | container-level security context | +| frontend.selectorLabels | object | `{}` | Additional labels to add to the pod | +| frontend.service.port | int | `3000` | Kubernetes port where service is exposed | +| frontend.service.type | string | `"ClusterIP"` | Kubernetes service type | +| frontend.serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| frontend.serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| frontend.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| frontend.tolerations | list | `[]` | Toleration labels for pod assignment | +| fullnameOverride | string | `""` | String to fully override `"baserow.fullname"` | +| nameOverride | string | `""` | Provide a name in place of `baserow` | +| postgresql.auth.database | string | `"baserow"` | Name for a custom database to create | +| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | +| postgresql.auth.password | string | `"baserow"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | +| postgresql.auth.username | string | `"baserow"` | Name for a custom user to create | +| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | +| redis.architecture | string | `"standalone"` | Redis® architecture. Allowed values: standalone or replication | +| redis.auth.enabled | bool | `true` | Enable password authentication | +| redis.auth.password | string | `"baserow"` | Redis™ password | +| redis.enabled | bool | `true` | enable Redis™ subchart from Bitnami | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/cluster-api-visualizer/README.md b/charts/cluster-api-visualizer/README.md index 6db242d6..295397c1 100644 --- a/charts/cluster-api-visualizer/README.md +++ b/charts/cluster-api-visualizer/README.md @@ -44,39 +44,39 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| extraEnv | list | `[]` | additional environment variables to be added to the pods | -| fullnameOverride | string | `""` | String to fully override `"cluster-api-visualizer.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.registry | string | `"ghcr.io"` | image registry | -| image.repository | string | `"jont828/cluster-api-visualizer"` | image repository | -| image.tag | string | `"v1.3.1"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | -| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | -| ingress.enabled | bool | `false` | Enable ingress record generation | -| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with the hosts configuration | -| ingress.tls | list | `[]` | An array with the tls configuration | -| nameOverride | string | `""` | Provide a name in place of `cluster-api-visualizer` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the pods. | -| revisionHistoryLimit | int | `0` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| extraEnv | list | `[]` | additional environment variables to be added to the pods | +| fullnameOverride | string | `""` | String to fully override `"cluster-api-visualizer.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.registry | string | `"ghcr.io"` | image registry | +| image.repository | string | `"jont828/cluster-api-visualizer"` | image repository | +| image.tag | string | `"v1.3.1"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | +| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | +| ingress.enabled | bool | `false` | Enable ingress record generation | +| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with the hosts configuration | +| ingress.tls | list | `[]` | An array with the tls configuration | +| nameOverride | string | `""` | Provide a name in place of `cluster-api-visualizer` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the pods. | +| revisionHistoryLimit | int | `0` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/etcd-defrag/README.md b/charts/etcd-defrag/README.md index b26a4ad8..741168ce 100644 --- a/charts/etcd-defrag/README.md +++ b/charts/etcd-defrag/README.md @@ -48,61 +48,61 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ----------------------------------------- | ------ | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| defrag.config.auth.enabled | bool | `false` | use username and password for authentication against etcd | -| defrag.config.auth.existingSecret | string | `""` | Name of existing secret to use for authentication credentials. Key needs to be called `etcd-password`. | -| defrag.config.auth.password | string | `""` | password for authentication | -| defrag.config.auth.user | string | `""` | username for authentication | -| defrag.config.clusterWide | bool | `true` | Run defragment operations for all endpoints in the cluster associated with the default endpoint. | -| defrag.config.commandTimeout | string | `""` | timeout for short running command (excluding dial timeout) | -| defrag.config.debug | bool | `false` | enable client-side debug logging | -| defrag.config.dialTimeout | string | `""` | dial timeout for client connections | -| defrag.config.endpoints | list | `[]` | gRPC endpoints | -| defrag.config.insecureSkipTlsVerify | bool | `false` | skip server certificate verification | -| defrag.config.insecureTransport | bool | `true` | disable transport security for client connections | -| defrag.config.pki.ca | string | `""` | certificate authority used for the etcd certificates | -| defrag.config.pki.cert | string | `""` | identify secure client using this TLS certificate | -| defrag.config.pki.existingSecret | string | `""` | Name of existing secret with certificates. Keys needs to be called `ca`, `cert` and `key`. | -| defrag.config.pki.hostAccess.caFilePath | string | `"/etc/kubernetes/pki/etcd/ca.crt"` | file on host containing the certificate authority | -| defrag.config.pki.hostAccess.certFilePath | string | `"/etc/kubernetes/pki/etcd/server.crt"` | file on host containing the server certificate | -| defrag.config.pki.hostAccess.enabled | bool | `false` | get certificates directly from host where the Pod is running | -| defrag.config.pki.hostAccess.keyFilePath | string | `"/etc/kubernetes/pki/etcd/server.key"` | file on host containing the server private key | -| defrag.config.pki.key | string | `""` | identify secure client using this TLS key | -| defrag.config.writeOut | string | `"table"` | set the output format: `fields`, `json`, `protobuf`, `simple`, `table`) | -| defrag.cronjob.concurrencyPolicy | string | `"Forbid"` | Specifies how to treat concurrent executions of a Job. Valid values are: `Allow`, `Forbid` and `Replace`. | -| defrag.cronjob.failedJobsHistoryLimit | string | `"1"` | The number of failed finished jobs to retain. | -| defrag.cronjob.schedule | string | `"0 */1 * * *"` | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. | -| defrag.cronjob.startingDeadlineSeconds | string | `"30"` | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. | -| defrag.cronjob.successfulJobsHistoryLimit | string | `"3"` | The number of successful finished jobs to retain. | -| defrag.cronjob.suspend | bool | `false` | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. | -| defrag.enabled | bool | `true` | create a CronJob for defragmentation | -| defrag.job.activeDeadlineSeconds | string | `""` | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. | -| defrag.job.backoffLimit | string | `""` | Specifies the number of retries before marking this job failed. | -| defrag.job.completionMode | string | `""` | CompletionMode specifies how Pod completions are tracked. It can be: `NonIndexed` or `Indexed`. | -| defrag.job.completions | string | `""` | Specifies the desired number of successfully finished pods the job should be run with. | -| defrag.job.parallelism | string | `""` | Specifies the maximum desired number of pods the job should run at any given time. | -| defrag.job.podFailurePolicy | string | `""` | Specifies the policy of handling failed pods. | -| defrag.job.suspend | bool | `false` | Suspend specifies whether the Job controller should create Pods or not. | -| defrag.job.ttlSecondsAfterFinished | string | `""` | limits the lifetime of a Job that has finished execution | -| defrag.pod.restartPolicy | string | `"OnFailure"` | Restart policy for all containers within the pod. One of `Always`, `OnFailure`, `Never`. | -| extraEnv | list | `[]` | additional environment variables to be added to the pods | -| fullnameOverride | string | `""` | String to fully override `"etcd-defrag.fullname"` | -| hostNetwork | bool | `false` | specify if the CronJob should run on the hostNetwork | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"bitnami/etcd"` | image repository | -| image.tag | string | `"3.5.15"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| nameOverride | string | `""` | Provide a name in place of `etcd-defrag` | -| nodeSelector | object | `{"node-role.kubernetes.io/control-plane":""}` | Node labels for pod assignment | -| podSecurityContext | object | `{}` | pod-level security context | -| resources | object | `{}` | Resource limits and requests for the controller pods. | -| securityContext | object | `{}` | container-level security context | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| defrag.config.auth.enabled | bool | `false` | use username and password for authentication against etcd | +| defrag.config.auth.existingSecret | string | `""` | Name of existing secret to use for authentication credentials. Key needs to be called `etcd-password`. | +| defrag.config.auth.password | string | `""` | password for authentication | +| defrag.config.auth.user | string | `""` | username for authentication | +| defrag.config.clusterWide | bool | `true` | Run defragment operations for all endpoints in the cluster associated with the default endpoint. | +| defrag.config.commandTimeout | string | `""` | timeout for short running command (excluding dial timeout) | +| defrag.config.debug | bool | `false` | enable client-side debug logging | +| defrag.config.dialTimeout | string | `""` | dial timeout for client connections | +| defrag.config.endpoints | list | `[]` | gRPC endpoints | +| defrag.config.insecureSkipTlsVerify | bool | `false` | skip server certificate verification | +| defrag.config.insecureTransport | bool | `true` | disable transport security for client connections | +| defrag.config.pki.ca | string | `""` | certificate authority used for the etcd certificates | +| defrag.config.pki.cert | string | `""` | identify secure client using this TLS certificate | +| defrag.config.pki.existingSecret | string | `""` | Name of existing secret with certificates. Keys needs to be called `ca`, `cert` and `key`. | +| defrag.config.pki.hostAccess.caFilePath | string | `"/etc/kubernetes/pki/etcd/ca.crt"` | file on host containing the certificate authority | +| defrag.config.pki.hostAccess.certFilePath | string | `"/etc/kubernetes/pki/etcd/server.crt"` | file on host containing the server certificate | +| defrag.config.pki.hostAccess.enabled | bool | `false` | get certificates directly from host where the Pod is running | +| defrag.config.pki.hostAccess.keyFilePath | string | `"/etc/kubernetes/pki/etcd/server.key"` | file on host containing the server private key | +| defrag.config.pki.key | string | `""` | identify secure client using this TLS key | +| defrag.config.writeOut | string | `"table"` | set the output format: `fields`, `json`, `protobuf`, `simple`, `table`) | +| defrag.cronjob.concurrencyPolicy | string | `"Forbid"` | Specifies how to treat concurrent executions of a Job. Valid values are: `Allow`, `Forbid` and `Replace`. | +| defrag.cronjob.failedJobsHistoryLimit | string | `"1"` | The number of failed finished jobs to retain. | +| defrag.cronjob.schedule | string | `"0 */1 * * *"` | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. | +| defrag.cronjob.startingDeadlineSeconds | string | `"30"` | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. | +| defrag.cronjob.successfulJobsHistoryLimit | string | `"3"` | The number of successful finished jobs to retain. | +| defrag.cronjob.suspend | bool | `false` | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. | +| defrag.enabled | bool | `true` | create a CronJob for defragmentation | +| defrag.job.activeDeadlineSeconds | string | `""` | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. | +| defrag.job.backoffLimit | string | `""` | Specifies the number of retries before marking this job failed. | +| defrag.job.completionMode | string | `""` | CompletionMode specifies how Pod completions are tracked. It can be: `NonIndexed` or `Indexed`. | +| defrag.job.completions | string | `""` | Specifies the desired number of successfully finished pods the job should be run with. | +| defrag.job.parallelism | string | `""` | Specifies the maximum desired number of pods the job should run at any given time. | +| defrag.job.podFailurePolicy | string | `""` | Specifies the policy of handling failed pods. | +| defrag.job.suspend | bool | `false` | Suspend specifies whether the Job controller should create Pods or not. | +| defrag.job.ttlSecondsAfterFinished | string | `""` | limits the lifetime of a Job that has finished execution | +| defrag.pod.restartPolicy | string | `"OnFailure"` | Restart policy for all containers within the pod. One of `Always`, `OnFailure`, `Never`. | +| extraEnv | list | `[]` | additional environment variables to be added to the pods | +| fullnameOverride | string | `""` | String to fully override `"etcd-defrag.fullname"` | +| hostNetwork | bool | `false` | specify if the CronJob should run on the hostNetwork | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"bitnami/etcd"` | image repository | +| image.tag | string | `"3.5.15"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| nameOverride | string | `""` | Provide a name in place of `etcd-defrag` | +| nodeSelector | object | `{"node-role.kubernetes.io/control-plane":""}` | Node labels for pod assignment | +| podSecurityContext | object | `{}` | pod-level security context | +| resources | object | `{}` | Resource limits and requests for the controller pods. | +| securityContext | object | `{}` | container-level security context | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/headwind-mdm/README.md b/charts/headwind-mdm/README.md index 801b2563..8c73c6a3 100644 --- a/charts/headwind-mdm/README.md +++ b/charts/headwind-mdm/README.md @@ -46,64 +46,64 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| externalPostgresql.auth.database | string | `"mychart"` | Name of the database to use | -| externalPostgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | -| externalPostgresql.auth.password | string | `"mychart"` | Password to use | -| externalPostgresql.auth.userPasswordKey | string | `""` | Key in the secret containing the password | -| externalPostgresql.auth.username | string | `"mychart"` | Name of the user to use | -| externalPostgresql.hostname | string | `""` | Hostname of the PostgreSQL database | -| externalPostgresql.port | int | `5432` | Port used to connect to PostgreSQL database | -| fullnameOverride | string | `""` | String to fully override `"headwind-mdm.fullname"` | -| headwind.adminEmail | string | `""` | Email of admin user | -| headwind.baseDomain | string | `""` | URL under which Headwind will be available | -| headwind.forceReconfigure | bool | `false` | Subsequent starts of the container skip this step, but you can force the renewal of the configuration | -| headwind.installLanguage | string | `"en"` | Available values: en, ru (en by default) | -| headwind.sharedSecret.existingSecret | string | `""` | An existing secret that contains the shared secret for a premium setup. If this is provided `headwind.sharedSecret.secretValue` is ignored. Key needs to be `shared-secret``. | -| headwind.sharedSecret.secretValue | string | `""` | The shared secret for a premium setup. Ignored if `headwind.sharedSecret.existingSecret` is provided. | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"headwindmdm/hmdm"` | image repository | -| image.tag | string | `"0.1.4"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.ip | string | `""` | ip to resolve public uri behind reverse proxy | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `headwind-mdm` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| persistence.accessModes[0] | string | `"ReadWriteOnce"` | | -| persistence.annotations | object | `{}` | | -| persistence.enabled | bool | `false` | | -| persistence.existingClaim | string | `""` | | -| persistence.size | string | `"10Gi"` | | -| persistence.storageClass | string | `""` | | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| postgresql.auth.database | string | `"mychart"` | Name for a custom database to create | -| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | -| postgresql.auth.password | string | `"mychart"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | -| postgresql.auth.username | string | `"mychart"` | Name for a custom user to create | -| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `8080` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| externalPostgresql.auth.database | string | `"mychart"` | Name of the database to use | +| externalPostgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | +| externalPostgresql.auth.password | string | `"mychart"` | Password to use | +| externalPostgresql.auth.userPasswordKey | string | `""` | Key in the secret containing the password | +| externalPostgresql.auth.username | string | `"mychart"` | Name of the user to use | +| externalPostgresql.hostname | string | `""` | Hostname of the PostgreSQL database | +| externalPostgresql.port | int | `5432` | Port used to connect to PostgreSQL database | +| fullnameOverride | string | `""` | String to fully override `"headwind-mdm.fullname"` | +| headwind.adminEmail | string | `""` | Email of admin user | +| headwind.baseDomain | string | `""` | URL under which Headwind will be available | +| headwind.forceReconfigure | bool | `false` | Subsequent starts of the container skip this step, but you can force the renewal of the configuration | +| headwind.installLanguage | string | `"en"` | Available values: en, ru (en by default) | +| headwind.sharedSecret.existingSecret | string | `""` | An existing secret that contains the shared secret for a premium setup. If this is provided `headwind.sharedSecret.secretValue` is ignored. Key needs to be `shared-secret``. | +| headwind.sharedSecret.secretValue | string | `""` | The shared secret for a premium setup. Ignored if `headwind.sharedSecret.existingSecret` is provided. | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"headwindmdm/hmdm"` | image repository | +| image.tag | string | `"0.1.4"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.ip | string | `""` | ip to resolve public uri behind reverse proxy | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `headwind-mdm` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| persistence.accessModes[0] | string | `"ReadWriteOnce"` | | +| persistence.annotations | object | `{}` | | +| persistence.enabled | bool | `false` | | +| persistence.existingClaim | string | `""` | | +| persistence.size | string | `"10Gi"` | | +| persistence.storageClass | string | `""` | | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| postgresql.auth.database | string | `"mychart"` | Name for a custom database to create | +| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | +| postgresql.auth.password | string | `"mychart"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | +| postgresql.auth.username | string | `"mychart"` | Name for a custom user to create | +| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `8080` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/kube-ops-view/README.md b/charts/kube-ops-view/README.md index cd81ce25..5d083a2b 100644 --- a/charts/kube-ops-view/README.md +++ b/charts/kube-ops-view/README.md @@ -46,38 +46,38 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ---------------------------------- | ------ | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| args | list | `[]` | | -| fullnameOverride | string | `""` | String to fully override `"kube-ops-view.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"hjacobs/kube-ops-view"` | image repository | -| image.tag | string | `"23.5.0"` | | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `kube-ops-view` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| redis.architecture | string | `"standalone"` | Redis™ architecture. Allowed values: standalone or replication | -| redis.auth.enabled | bool | `false` | Disable password authentication as the kube-ops-view container has no support for password authentication | -| redis.enabled | bool | `false` | enable Redis™ subchart from Bitnami | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":1000}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| args | list | `[]` | | +| fullnameOverride | string | `""` | String to fully override `"kube-ops-view.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"hjacobs/kube-ops-view"` | image repository | +| image.tag | string | `"23.5.0"` | | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `kube-ops-view` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| redis.architecture | string | `"standalone"` | Redis™ architecture. Allowed values: standalone or replication | +| redis.auth.enabled | bool | `false` | Disable password authentication as the kube-ops-view container has no support for password authentication | +| redis.enabled | bool | `false` | enable Redis™ subchart from Bitnami | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":1000}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/kubedoom/README.md b/charts/kubedoom/README.md index 010a861a..68ac2937 100644 --- a/charts/kubedoom/README.md +++ b/charts/kubedoom/README.md @@ -66,37 +66,37 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| --------------------------------------------- | ------ | ------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | -| extraEnv | list | `[]` | additional environment variables to be added to the pods | -| fullnameOverride | string | `""` | String to fully override `"kubedoom.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.registry | string | `"ghcr.io"` | image registry | -| image.repository | string | `"storax/kubedoom"` | image repository | -| image.tag | string | `"0.6.0"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| kubedoom.mode | string | `"pods"` | You can also kill Namespaces instead of Pods. Simply set this to `namespaces`. Allowed values: `pods`, `namespaces`. | -| kubedoom.namespace | string | `""` | You can limit Kubedoom to deleting pods in a single namespace | -| nameOverride | string | `""` | Provide a name in place of `kubedoom` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to the pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `5900` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | +| extraEnv | list | `[]` | additional environment variables to be added to the pods | +| fullnameOverride | string | `""` | String to fully override `"kubedoom.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.registry | string | `"ghcr.io"` | image registry | +| image.repository | string | `"storax/kubedoom"` | image repository | +| image.tag | string | `"0.6.0"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| kubedoom.mode | string | `"pods"` | You can also kill Namespaces instead of Pods. Simply set this to `namespaces`. Allowed values: `pods`, `namespaces`. | +| kubedoom.namespace | string | `""` | You can limit Kubedoom to deleting pods in a single namespace | +| nameOverride | string | `""` | Provide a name in place of `kubedoom` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to the pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `5900` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/kubenav/README.md b/charts/kubenav/README.md index 7b8e66fc..7cbaad35 100644 --- a/charts/kubenav/README.md +++ b/charts/kubenav/README.md @@ -44,16 +44,16 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| -------------------------- | ------ | ------------ | ----------------------------------------------------------------------------------------------------------------------- | -| fullnameOverride | string | `""` | String to fully override `"kubenav.fullname"` | -| nameOverride | string | `""` | Provide a name in place of `kubenav` | -| rbac.customPermissions | list | `[]` | Define the custom permissions to be granted to kubenav | -| rbac.mode | string | `"readonly"` | Decide which access mode should be granted to kubenav: `readonly`, `cluster-admin` or `custom`. | -| rbac.namespaceLimits | list | `[]` | Define a list of namespaces to limit kubenav to only access these namespaces | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname templatev | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| fullnameOverride | string | `""` | String to fully override `"kubenav.fullname"` | +| nameOverride | string | `""` | Provide a name in place of `kubenav` | +| rbac.customPermissions | list | `[]` | Define the custom permissions to be granted to kubenav | +| rbac.mode | string | `"readonly"` | Decide which access mode should be granted to kubenav: `readonly`, `cluster-admin` or `custom`. | +| rbac.namespaceLimits | list | `[]` | Define a list of namespaces to limit kubenav to only access these namespaces | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname templatev | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/kubevirt-manager/README.md b/charts/kubevirt-manager/README.md index e7c6dce9..1df4b9b5 100644 --- a/charts/kubevirt-manager/README.md +++ b/charts/kubevirt-manager/README.md @@ -44,52 +44,52 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| extraEnv | list | `[]` | additional environment variables to be added to the pods | -| fullnameOverride | string | `""` | String to fully override `"kubevirt-manager.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"kubevirtmanager/kubevirt-manager"` | image repository | -| image.tag | string | `"1.4.2"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | -| ingress.basicAuth.enabled | bool | `false` | enable the configuration of basic authentication with nginx | -| ingress.basicAuth.existingSecret | string | `""` | An existing Secret containing the username and password for basic authentication. Username and password have to be base64 encoded in the form username:password. The Secret needs to contain a key `.htpasswd` with the base64 encoded authentication information. If set `ingress.basicAuth.username` and `ingress.basicAuth.password` will be ignored. | -| ingress.basicAuth.password | string | `"password"` | Password for authentication | -| ingress.basicAuth.username | string | `"admin"` | Username for authentication | -| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | -| ingress.enabled | bool | `false` | Enable ingress record generation | -| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with the hosts configuration | -| ingress.tls | list | `[]` | An array with the tls configuration | -| nameOverride | string | `""` | Provide a name in place of `kubevirt-manager` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| prometheus.additionalLabels | object | `{}` | Prometheus ServiceMonitor labels | -| prometheus.enabled | bool | `false` | Enable a Prometheus ServiceMonitor | -| prometheus.interval | string | `"30s"` | Prometheus ServiceMonitor interval | -| prometheus.metricRelabelings | list | `[]` | Prometheus [MetricRelabelConfigs] to apply to samples before ingestion | -| prometheus.namespace | string | `""` | Prometheus ServiceMonitor namespace | -| prometheus.relabelings | list | `[]` | Prometheus [RelabelConfigs] to apply to samples before scraping | -| prometheus.selector | object | `{}` | Prometheus ServiceMonitor selector | -| prometheus.service.name | string | `""` | Name of the Prometheus Service | -| prometheus.service.namespace | string | `""` | Namespace of the Prometheus Service | -| prometheus.service.port | string | `""` | Port of the Prometheus Service | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the pods. | -| revisionHistoryLimit | int | `0` | The number of old ReplicaSets to retain | -| securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsGroup":30000,"runAsNonRoot":true,"runAsUser":10000,"seccompProfile":{"type":"RuntimeDefault"}}` | container-level security context | -| service.port | int | `8080` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| extraEnv | list | `[]` | additional environment variables to be added to the pods | +| fullnameOverride | string | `""` | String to fully override `"kubevirt-manager.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"kubevirtmanager/kubevirt-manager"` | image repository | +| image.tag | string | `"1.4.2"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | +| ingress.basicAuth.enabled | bool | `false` | enable the configuration of basic authentication with nginx | +| ingress.basicAuth.existingSecret | string | `""` | An existing Secret containing the username and password for basic authentication. Username and password have to be base64 encoded in the form username:password. The Secret needs to contain a key `.htpasswd` with the base64 encoded authentication information. If set `ingress.basicAuth.username` and `ingress.basicAuth.password` will be ignored. | +| ingress.basicAuth.password | string | `"password"` | Password for authentication | +| ingress.basicAuth.username | string | `"admin"` | Username for authentication | +| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | +| ingress.enabled | bool | `false` | Enable ingress record generation | +| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with the hosts configuration | +| ingress.tls | list | `[]` | An array with the tls configuration | +| nameOverride | string | `""` | Provide a name in place of `kubevirt-manager` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| prometheus.additionalLabels | object | `{}` | Prometheus ServiceMonitor labels | +| prometheus.enabled | bool | `false` | Enable a Prometheus ServiceMonitor | +| prometheus.interval | string | `"30s"` | Prometheus ServiceMonitor interval | +| prometheus.metricRelabelings | list | `[]` | Prometheus [MetricRelabelConfigs] to apply to samples before ingestion | +| prometheus.namespace | string | `""` | Prometheus ServiceMonitor namespace | +| prometheus.relabelings | list | `[]` | Prometheus [RelabelConfigs] to apply to samples before scraping | +| prometheus.selector | object | `{}` | Prometheus ServiceMonitor selector | +| prometheus.service.name | string | `""` | Name of the Prometheus Service | +| prometheus.service.namespace | string | `""` | Namespace of the Prometheus Service | +| prometheus.service.port | string | `""` | Port of the Prometheus Service | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the pods. | +| revisionHistoryLimit | int | `0` | The number of old ReplicaSets to retain | +| securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsGroup":30000,"runAsNonRoot":true,"runAsUser":10000,"seccompProfile":{"type":"RuntimeDefault"}}` | container-level security context | +| service.port | int | `8080` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/kutt/README.md b/charts/kutt/README.md index 59078e12..67d385db 100644 --- a/charts/kutt/README.md +++ b/charts/kutt/README.md @@ -44,87 +44,87 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| externalPostgresql.auth.database | string | `"kutt"` | Name of the database to use | -| externalPostgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | -| externalPostgresql.auth.password | string | `"kutt"` | Password to use | -| externalPostgresql.auth.userPasswordKey | string | `""` | Key in the secret containing the password | -| externalPostgresql.auth.username | string | `"kutt"` | Name of the user to use | -| externalPostgresql.hostname | string | `""` | Hostname of the PostgreSQL database | -| externalPostgresql.port | int | `5432` | Port used to connect to PostgreSQL database | -| externalRedis.auth.enabled | bool | `true` | if authentication should be used with external Redis™ | -| externalRedis.auth.existingSecret | string | `""` | Name of existing secret to use for Redis™ credentials | -| externalRedis.auth.password | string | `""` | Password to use | -| externalRedis.auth.userPasswordKey | string | `""` | Key in the secret containing the password | -| externalRedis.hostname | string | `""` | Hostname of Redis™ | -| externalRedis.port | int | `6379` | Port used to connect to Redis | -| extraEnv | list | `[]` | additional environment variables to be added to the pods | -| fullnameOverride | string | `""` | String to fully override `"kutt.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"kutt/kutt"` | image repository | -| image.tag | string | `"v2.7.4"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | -| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | -| ingress.enabled | bool | `false` | Enable ingress record generation | -| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with the hosts configuration | -| ingress.tls | list | `[]` | An array with the tls configuration | -| kutt.admin.emails | string | `""` | Comma seperated list of email addresses that can access admin actions on settings page | -| kutt.config.defaultMaxStatsPerLink | string | `"5000"` | Max number of visits for each link to have detailed stats | -| kutt.config.disallowAnonymousLinks | bool | `false` | Disable anonymous link creation | -| kutt.config.disallowRegistration | bool | `false` | Disable registration | -| kutt.config.linkLength | int | `6` | Generated link length | -| kutt.config.nonUserCooldown | int | `0` | Create a cooldown for non-logged in users in minutes. Set 0 to disable. | -| kutt.config.siteName | string | `"Kutt"` | The name of the site where Kutt is hosted | -| kutt.config.userLimitPerDay | int | `50` | The daily limit for each user | -| kutt.domain.customDomainUseHttps | bool | `false` | Use HTTPS for links with custom domain | -| kutt.domain.defaultDomain | string | `"localhost:3000"` | The domain that this website is on | -| kutt.domain.useFirstIngressHost | bool | `false` | If you use an ingress to expose Kutt you can simply set this to true to use the first hostname defined in the ingress. | -| kutt.google.existingSecret | string | `""` | Use existing secret for Google configuration. The secret has to contain the key `GOOGLE_SAFE_BROWSING_KEY`. When it's set the `kutt.google.safeBrowsingKey` is ignored. | -| kutt.google.safeBrowsingKey | string | `""` | Google Cloud API to prevent from users from submitting malware URLs. Get it from https://developers.google.com/safe-browsing/v4/get-started. | -| kutt.jwt.existingSecret | string | `""` | Use existing secret for JWT secret key. The secret has to contain the key `JWT_SECRET`. When it's set the kutt.jwt.key is ignored. | -| kutt.jwt.key | string | `"secret-jwt-key"` | make sure to replace with your own secret key | -| kutt.mail.contactEmail | string | `""` | Support email to show on the app | -| kutt.mail.existingSecret | string | `""` | Use existing secret for password details. The secret has to contain the key `MAIL_PASSWORD`. When it's set the `kutt.mail.password` is ignored. | -| kutt.mail.from | string | `""` | The email address Kutt will send emails from. | -| kutt.mail.host | string | `"smtp.example.com"` | The host of the external SMTP server that Kutt should use to send emails. | -| kutt.mail.password | string | `""` | The password to authenticate to the smtp host when sending emails. | -| kutt.mail.port | int | `465` | The port used to connect to the smtp host. | -| kutt.mail.reportEmail | string | `""` | The email address that will receive submitted reports. | -| kutt.mail.secure | bool | `false` | If true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false | -| kutt.mail.username | string | `"user@example.com"` | The username to authenticate to the smtp host when sending emails. | -| kutt.recaptcha.existingSecret | string | `""` | Use existing secret for ReCaptacha secrets. The secret has to contain the keys `RECAPTCHA_SITE_KEY` and `RECAPTCHA_SECRET_KEY`. When it's set the kutt.recaptcha.siteKey and kutt.recaptcha.secretKey is ignored. | -| kutt.recaptcha.secretKey | string | `""` | Invisible reCaptcha secret key. Create one in https://www.google.com/recaptcha/intro/ | -| kutt.recaptcha.siteKey | string | `""` | Invisible reCaptcha site key. Create one in https://www.google.com/recaptcha/intro/ | -| nameOverride | string | `""` | Provide a name in place of `kutt` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| postgresql.auth.database | string | `"kutt"` | Name for a custom database to create | -| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | -| postgresql.auth.password | string | `"kutt"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | -| postgresql.auth.username | string | `"kutt"` | Name for a custom user to create | -| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | -| redis.architecture | string | `"standalone"` | Redis® architecture. Allowed values: standalone or replication | -| redis.auth.enabled | bool | `true` | Enable password authentication | -| redis.auth.password | string | `"kutt"` | Redis™ password | -| redis.enabled | bool | `true` | enable Redis™ subchart from Bitnami | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| externalPostgresql.auth.database | string | `"kutt"` | Name of the database to use | +| externalPostgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | +| externalPostgresql.auth.password | string | `"kutt"` | Password to use | +| externalPostgresql.auth.userPasswordKey | string | `""` | Key in the secret containing the password | +| externalPostgresql.auth.username | string | `"kutt"` | Name of the user to use | +| externalPostgresql.hostname | string | `""` | Hostname of the PostgreSQL database | +| externalPostgresql.port | int | `5432` | Port used to connect to PostgreSQL database | +| externalRedis.auth.enabled | bool | `true` | if authentication should be used with external Redis™ | +| externalRedis.auth.existingSecret | string | `""` | Name of existing secret to use for Redis™ credentials | +| externalRedis.auth.password | string | `""` | Password to use | +| externalRedis.auth.userPasswordKey | string | `""` | Key in the secret containing the password | +| externalRedis.hostname | string | `""` | Hostname of Redis™ | +| externalRedis.port | int | `6379` | Port used to connect to Redis | +| extraEnv | list | `[]` | additional environment variables to be added to the pods | +| fullnameOverride | string | `""` | String to fully override `"kutt.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"kutt/kutt"` | image repository | +| image.tag | string | `"v2.7.4"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | +| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | +| ingress.enabled | bool | `false` | Enable ingress record generation | +| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with the hosts configuration | +| ingress.tls | list | `[]` | An array with the tls configuration | +| kutt.admin.emails | string | `""` | Comma seperated list of email addresses that can access admin actions on settings page | +| kutt.config.defaultMaxStatsPerLink | string | `"5000"` | Max number of visits for each link to have detailed stats | +| kutt.config.disallowAnonymousLinks | bool | `false` | Disable anonymous link creation | +| kutt.config.disallowRegistration | bool | `false` | Disable registration | +| kutt.config.linkLength | int | `6` | Generated link length | +| kutt.config.nonUserCooldown | int | `0` | Create a cooldown for non-logged in users in minutes. Set 0 to disable. | +| kutt.config.siteName | string | `"Kutt"` | The name of the site where Kutt is hosted | +| kutt.config.userLimitPerDay | int | `50` | The daily limit for each user | +| kutt.domain.customDomainUseHttps | bool | `false` | Use HTTPS for links with custom domain | +| kutt.domain.defaultDomain | string | `"localhost:3000"` | The domain that this website is on | +| kutt.domain.useFirstIngressHost | bool | `false` | If you use an ingress to expose Kutt you can simply set this to true to use the first hostname defined in the ingress. | +| kutt.google.existingSecret | string | `""` | Use existing secret for Google configuration. The secret has to contain the key `GOOGLE_SAFE_BROWSING_KEY`. When it's set the `kutt.google.safeBrowsingKey` is ignored. | +| kutt.google.safeBrowsingKey | string | `""` | Google Cloud API to prevent from users from submitting malware URLs. Get it from https://developers.google.com/safe-browsing/v4/get-started. | +| kutt.jwt.existingSecret | string | `""` | Use existing secret for JWT secret key. The secret has to contain the key `JWT_SECRET`. When it's set the kutt.jwt.key is ignored. | +| kutt.jwt.key | string | `"secret-jwt-key"` | make sure to replace with your own secret key | +| kutt.mail.contactEmail | string | `""` | Support email to show on the app | +| kutt.mail.existingSecret | string | `""` | Use existing secret for password details. The secret has to contain the key `MAIL_PASSWORD`. When it's set the `kutt.mail.password` is ignored. | +| kutt.mail.from | string | `""` | The email address Kutt will send emails from. | +| kutt.mail.host | string | `"smtp.example.com"` | The host of the external SMTP server that Kutt should use to send emails. | +| kutt.mail.password | string | `""` | The password to authenticate to the smtp host when sending emails. | +| kutt.mail.port | int | `465` | The port used to connect to the smtp host. | +| kutt.mail.reportEmail | string | `""` | The email address that will receive submitted reports. | +| kutt.mail.secure | bool | `false` | If true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false | +| kutt.mail.username | string | `"user@example.com"` | The username to authenticate to the smtp host when sending emails. | +| kutt.recaptcha.existingSecret | string | `""` | Use existing secret for ReCaptacha secrets. The secret has to contain the keys `RECAPTCHA_SITE_KEY` and `RECAPTCHA_SECRET_KEY`. When it's set the kutt.recaptcha.siteKey and kutt.recaptcha.secretKey is ignored. | +| kutt.recaptcha.secretKey | string | `""` | Invisible reCaptcha secret key. Create one in https://www.google.com/recaptcha/intro/ | +| kutt.recaptcha.siteKey | string | `""` | Invisible reCaptcha site key. Create one in https://www.google.com/recaptcha/intro/ | +| nameOverride | string | `""` | Provide a name in place of `kutt` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| postgresql.auth.database | string | `"kutt"` | Name for a custom database to create | +| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | +| postgresql.auth.password | string | `"kutt"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | +| postgresql.auth.username | string | `"kutt"` | Name for a custom user to create | +| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | +| redis.architecture | string | `"standalone"` | Redis® architecture. Allowed values: standalone or replication | +| redis.auth.enabled | bool | `true` | Enable password authentication | +| redis.auth.password | string | `"kutt"` | Redis™ password | +| redis.enabled | bool | `true` | enable Redis™ subchart from Bitnami | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. @@ -147,25 +147,24 @@ This major updates the redis subchart to its newest major, 18.0.4. [Here](https: ### 2.0.0 This major updates the way you define environment variables. - -- The section `mail` has been moved to `kutt.mail` -- The section `envSecrets` has been merged into `kutt`: - - `envSecrets.google` is now `kutt.google` - - `envSecrets.jwt` is now `kutt.jwt` - - `envSecrets.recaptcha` is now `kutt.recaptcha` -- The section `env` has been replaced with specific values: - - `ADMIN_EMAILS` is now `kutt.admin.emails` - - `CUSTOM_DOMAIN_USE_HTTPS` is now `kutt.domain.customDomainUseHttps` - - `DEFAULT_DOMAIN` is now `kutt.domain.defaultDomain` - - `DEFAULT_MAX_STATS_PER_LINK` is now `kutt.config.defaultMaxStatsPerLink` - - `DISALLOW_ANONYMOUS_LINKS` is now `kutt.config.disallowAnonymousLinks` - - `DISALLOW_REGISTRATION` is now `kutt.config.disallowRegistration` - - `LINK_LENGTH` is now `kutt.config.linkLength` - - `NON_USER_COOLDOWN` is now `kutt.config.nonUserCooldown` - - `REPORT_EMAIL` is now `kutt.mail.reportEmail` - - `SITE_NAME` is now `kutt.config.siteName` - - `USER_LIMIT_PER_DAY` is now `kutt.config.userLimitPerDay` -- You can define additional environment variables using the extraEnv section. + - The section `mail` has been moved to `kutt.mail` + - The section `envSecrets` has been merged into `kutt`: + - `envSecrets.google` is now `kutt.google` + - `envSecrets.jwt` is now `kutt.jwt` + - `envSecrets.recaptcha` is now `kutt.recaptcha` + - The section `env` has been replaced with specific values: + - `ADMIN_EMAILS` is now `kutt.admin.emails` + - `CUSTOM_DOMAIN_USE_HTTPS` is now `kutt.domain.customDomainUseHttps` + - `DEFAULT_DOMAIN` is now `kutt.domain.defaultDomain` + - `DEFAULT_MAX_STATS_PER_LINK` is now `kutt.config.defaultMaxStatsPerLink` + - `DISALLOW_ANONYMOUS_LINKS` is now `kutt.config.disallowAnonymousLinks` + - `DISALLOW_REGISTRATION` is now `kutt.config.disallowRegistration` + - `LINK_LENGTH` is now `kutt.config.linkLength` + - `NON_USER_COOLDOWN` is now `kutt.config.nonUserCooldown` + - `REPORT_EMAIL` is now `kutt.mail.reportEmail` + - `SITE_NAME` is now `kutt.config.siteName` + - `USER_LIMIT_PER_DAY` is now `kutt.config.userLimitPerDay` + - You can define additional environment variables using the extraEnv section. ### 1.0.0 diff --git a/charts/maildev/README.md b/charts/maildev/README.md index 1d1a6912..01eee708 100644 --- a/charts/maildev/README.md +++ b/charts/maildev/README.md @@ -50,7 +50,6 @@ kubectl port-forward $(kubectl get pod -l "app.kubernetes.io/name=maildev" -o na ``` Create dummy mail.txt file. - ```bash cat <> mail.txt From: Test Maildev @@ -98,86 +97,86 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ----------------------------------------------- | ------ | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | -| extraEnv | list | `[]` | additional environment variables to be added to the pods | -| fullnameOverride | string | `""` | String to fully override `"maildev.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.registry | string | `"docker.io"` | image registry | -| image.repository | string | `"maildev/maildev"` | image repository | -| image.tag | string | `"2.1.0"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | -| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | -| ingress.enabled | bool | `false` | Enable ingress record generation | -| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with hosts and paths | -| ingress.tls | list | `[]` | An array with the tls configuration | -| maildev.config.https.cert | string | `""` | The ssl cert file | -| maildev.config.https.enabled | bool | `false` | Switch from http to https protocol | -| maildev.config.https.key | string | `""` | The ssl private key | -| maildev.config.logMailContents | bool | `false` | Log a JSON representation of each incoming mail | -| maildev.config.mailDirectory | string | `"/home/node/maildev-data"` | Directory for persisting mail | -| maildev.config.modes.silent | bool | `true` | Run maildev in silent mode to disable the startup messages | -| maildev.config.modes.verbose | bool | `false` | Run maildev in verbose mode | -| maildev.config.smtp.hideExtensions | string | `""` | Comma separated list of SMTP extensions to NOT advertise (SMTPUTF8, PIPELINING, 8BITMIME) | -| maildev.config.smtp.incoming.existingSecret | string | `""` | Name of an existing secret containing the password for the incoming SMTP mail. If set `maildev.config.smtp.incoming.password` will be ignored. Key needs to be `smtp-incoming-password`. | -| maildev.config.smtp.incoming.password | string | `""` | SMTP password for incoming mail | -| maildev.config.smtp.incoming.tls.cert | string | `""` | Cert for incoming SSL | -| maildev.config.smtp.incoming.tls.enabled | bool | `false` | Use SMTP SSL for incoming emails | -| maildev.config.smtp.incoming.tls.existingSecret | string | `""` | Name of an existing TLS secret containing the cert and key for the incoming SMTP mail. If set `maildev.config.smtp.incoming.tls.cert` and `maildev.config.smtp.incoming.tls.key` will be ignored. Keys need to be `tls.crt` and `tls.key`. | -| maildev.config.smtp.incoming.tls.key | string | `""` | Key for incoming SSL | -| maildev.config.smtp.incoming.username | string | `""` | SMTP user for incoming mail | -| maildev.config.smtp.outgoing.autoRelay.enabled | bool | `false` | Enabling the auto relay mode will automatically send each email to it's recipient without the need to click the "Relay" button. The outgoing email options are required to enable this feature. | -| maildev.config.smtp.outgoing.autoRelay.mail | string | `""` | Optionally define a single email address which Maildev will forward all emails to instead of the original recipient | -| maildev.config.smtp.outgoing.autoRelay.rules | list | `[]` | The additional configuration for what email addresses you would like to allow or deny. | -| maildev.config.smtp.outgoing.existingSecret | string | `""` | Name of an existing secret containing the password for the outgoing SMTP mail. If set `maildev.config.smtp.outgoing.password` will be ignored. Key needs to be `smtp-outgoing-password`. | -| maildev.config.smtp.outgoing.host | string | `""` | SMTP host for outgoing mail | -| maildev.config.smtp.outgoing.password | string | `""` | SMTP password for outgoing mail | -| maildev.config.smtp.outgoing.port | int | `25` | SMTP port for outgoing mail | -| maildev.config.smtp.outgoing.ssl | bool | `false` | Use SMTP SSL for outgoing mail | -| maildev.config.smtp.outgoing.username | string | `""` | SMTP user for outgoing mail | -| maildev.config.web.disabled | bool | `false` | Disable the use of the web interface. Useful for unit testing | -| maildev.config.web.existingSecret | string | `""` | Name of an existing secret containing the password for the GUI. If set `maildev.config.web.password` will be ignored. Key needs to be `web-password`. | -| maildev.config.web.password | string | `""` | Password for the GUI | -| maildev.config.web.username | string | `""` | Username for the GUI | -| maildev.persistence.accessModes | list | `["ReadWriteOnce"]` | The desired access modes the volume should have. | -| maildev.persistence.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | -| maildev.persistence.cron.config.daysToKeep | int | `15` | How old emails may be before they get deleted | -| maildev.persistence.cron.config.schedule | string | `"0 1 * * *"` | The schedule on which the cronjob should run | -| maildev.persistence.cron.enabled | bool | `false` | Enable the creation of a cronjob to periodically delete old emails | -| maildev.persistence.cron.image.pullPolicy | string | `"Always"` | Image pull policy | -| maildev.persistence.cron.image.registry | string | `"docker.io"` | Image registry | -| maildev.persistence.cron.image.repository | string | `"busybox"` | Image repository | -| maildev.persistence.cron.image.tag | string | `"latest"` | Overrides the image tag | -| maildev.persistence.enabled | bool | `false` | Use a PVC to persist data | -| maildev.persistence.existingClaim | string | `""` | Provide an existing PersistentVolumeClaim | -| maildev.persistence.resources | object | `{"requests":{"storage":"2Gi"}}` | Represents the minimum and maximum resources the volume should have. | -| maildev.persistence.storageClassName | string | `""` | Name of the StorageClass required by the claim. | -| nameOverride | string | `""` | Provide a name in place of `maildev` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to the pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| services.smtp.nodePort | string | `nil` | You can set the node port for the external SMTP server that should be used or leave it blank to get a random node port. Only active if `services.smtp.type == NodePort` | -| services.smtp.podPort | int | `1025` | Pod port to use for the internal SMTP server | -| services.smtp.port | int | `1025` | Kubernetes service port to use for the internal SMTP server | -| services.smtp.type | string | `"ClusterIP"` | Kubernetes service type for the SMTP server | -| services.web.podPort | int | `1080` | Pod port to use for the web GUI | -| services.web.port | int | `1080` | Kubernetes service port to use for the web GUI | -| services.web.type | string | `"ClusterIP"` | Kubernetes service type for the web GUI | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | +| extraEnv | list | `[]` | additional environment variables to be added to the pods | +| fullnameOverride | string | `""` | String to fully override `"maildev.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.registry | string | `"docker.io"` | image registry | +| image.repository | string | `"maildev/maildev"` | image repository | +| image.tag | string | `"2.1.0"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | +| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | +| ingress.enabled | bool | `false` | Enable ingress record generation | +| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with hosts and paths | +| ingress.tls | list | `[]` | An array with the tls configuration | +| maildev.config.https.cert | string | `""` | The ssl cert file | +| maildev.config.https.enabled | bool | `false` | Switch from http to https protocol | +| maildev.config.https.key | string | `""` | The ssl private key | +| maildev.config.logMailContents | bool | `false` | Log a JSON representation of each incoming mail | +| maildev.config.mailDirectory | string | `"/home/node/maildev-data"` | Directory for persisting mail | +| maildev.config.modes.silent | bool | `true` | Run maildev in silent mode to disable the startup messages | +| maildev.config.modes.verbose | bool | `false` | Run maildev in verbose mode | +| maildev.config.smtp.hideExtensions | string | `""` | Comma separated list of SMTP extensions to NOT advertise (SMTPUTF8, PIPELINING, 8BITMIME) | +| maildev.config.smtp.incoming.existingSecret | string | `""` | Name of an existing secret containing the password for the incoming SMTP mail. If set `maildev.config.smtp.incoming.password` will be ignored. Key needs to be `smtp-incoming-password`. | +| maildev.config.smtp.incoming.password | string | `""` | SMTP password for incoming mail | +| maildev.config.smtp.incoming.tls.cert | string | `""` | Cert for incoming SSL | +| maildev.config.smtp.incoming.tls.enabled | bool | `false` | Use SMTP SSL for incoming emails | +| maildev.config.smtp.incoming.tls.existingSecret | string | `""` | Name of an existing TLS secret containing the cert and key for the incoming SMTP mail. If set `maildev.config.smtp.incoming.tls.cert` and `maildev.config.smtp.incoming.tls.key` will be ignored. Keys need to be `tls.crt` and `tls.key`. | +| maildev.config.smtp.incoming.tls.key | string | `""` | Key for incoming SSL | +| maildev.config.smtp.incoming.username | string | `""` | SMTP user for incoming mail | +| maildev.config.smtp.outgoing.autoRelay.enabled | bool | `false` | Enabling the auto relay mode will automatically send each email to it's recipient without the need to click the "Relay" button. The outgoing email options are required to enable this feature. | +| maildev.config.smtp.outgoing.autoRelay.mail | string | `""` | Optionally define a single email address which Maildev will forward all emails to instead of the original recipient | +| maildev.config.smtp.outgoing.autoRelay.rules | list | `[]` | The additional configuration for what email addresses you would like to allow or deny. | +| maildev.config.smtp.outgoing.existingSecret | string | `""` | Name of an existing secret containing the password for the outgoing SMTP mail. If set `maildev.config.smtp.outgoing.password` will be ignored. Key needs to be `smtp-outgoing-password`. | +| maildev.config.smtp.outgoing.host | string | `""` | SMTP host for outgoing mail | +| maildev.config.smtp.outgoing.password | string | `""` | SMTP password for outgoing mail | +| maildev.config.smtp.outgoing.port | int | `25` | SMTP port for outgoing mail | +| maildev.config.smtp.outgoing.ssl | bool | `false` | Use SMTP SSL for outgoing mail | +| maildev.config.smtp.outgoing.username | string | `""` | SMTP user for outgoing mail | +| maildev.config.web.disabled | bool | `false` | Disable the use of the web interface. Useful for unit testing | +| maildev.config.web.existingSecret | string | `""` | Name of an existing secret containing the password for the GUI. If set `maildev.config.web.password` will be ignored. Key needs to be `web-password`. | +| maildev.config.web.password | string | `""` | Password for the GUI | +| maildev.config.web.username | string | `""` | Username for the GUI | +| maildev.persistence.accessModes | list | `["ReadWriteOnce"]` | The desired access modes the volume should have. | +| maildev.persistence.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | +| maildev.persistence.cron.config.daysToKeep | int | `15` | How old emails may be before they get deleted | +| maildev.persistence.cron.config.schedule | string | `"0 1 * * *"` | The schedule on which the cronjob should run | +| maildev.persistence.cron.enabled | bool | `false` | Enable the creation of a cronjob to periodically delete old emails | +| maildev.persistence.cron.image.pullPolicy | string | `"Always"` | Image pull policy | +| maildev.persistence.cron.image.registry | string | `"docker.io"` | Image registry | +| maildev.persistence.cron.image.repository | string | `"busybox"` | Image repository | +| maildev.persistence.cron.image.tag | string | `"latest"` | Overrides the image tag | +| maildev.persistence.enabled | bool | `false` | Use a PVC to persist data | +| maildev.persistence.existingClaim | string | `""` | Provide an existing PersistentVolumeClaim | +| maildev.persistence.resources | object | `{"requests":{"storage":"2Gi"}}` | Represents the minimum and maximum resources the volume should have. | +| maildev.persistence.storageClassName | string | `""` | Name of the StorageClass required by the claim. | +| nameOverride | string | `""` | Provide a name in place of `maildev` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to the pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| services.smtp.nodePort | string | `nil` | You can set the node port for the external SMTP server that should be used or leave it blank to get a random node port. Only active if `services.smtp.type == NodePort` | +| services.smtp.podPort | int | `1025` | Pod port to use for the internal SMTP server | +| services.smtp.port | int | `1025` | Kubernetes service port to use for the internal SMTP server | +| services.smtp.type | string | `"ClusterIP"` | Kubernetes service type for the SMTP server | +| services.web.podPort | int | `1080` | Pod port to use for the web GUI | +| services.web.port | int | `1080` | Kubernetes service port to use for the web GUI | +| services.web.type | string | `"ClusterIP"` | Kubernetes service type for the web GUI | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/netcupscp-exporter/README.md b/charts/netcupscp-exporter/README.md index 5153006a..477c199b 100644 --- a/charts/netcupscp-exporter/README.md +++ b/charts/netcupscp-exporter/README.md @@ -44,50 +44,50 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| env.existingSecret | string | `""` | | -| env.loginName | string | `"admin"` | | -| env.password | string | `"password"` | | -| fullnameOverride | string | `""` | String to fully override `"netcupscp-exporter.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.registry | string | `"ghcr.io"` | image registry | -| image.repository | string | `"mrueg/netcupscp-exporter"` | image repository | -| image.tag | string | `"v0.3.6"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `netcupscp-exporter` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| serviceMonitor.additionalLabels | object | `{}` | Prometheus ServiceMonitor labels | -| serviceMonitor.enabled | bool | `false` | Enable a prometheus ServiceMonitor | -| serviceMonitor.interval | string | `"30s"` | Prometheus ServiceMonitor interval | -| serviceMonitor.metricRelabelings | list | `[]` | Prometheus [MetricRelabelConfigs] to apply to samples before ingestion | -| serviceMonitor.namespace | string | `""` | Prometheus ServiceMonitor namespace | -| serviceMonitor.relabelings | list | `[]` | Prometheus [RelabelConfigs] to apply to samples before scraping | -| serviceMonitor.selector | object | `{}` | Prometheus ServiceMonitor selector | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| env.existingSecret | string | `""` | | +| env.loginName | string | `"admin"` | | +| env.password | string | `"password"` | | +| fullnameOverride | string | `""` | String to fully override `"netcupscp-exporter.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.registry | string | `"ghcr.io"` | image registry | +| image.repository | string | `"mrueg/netcupscp-exporter"` | image repository | +| image.tag | string | `"v0.3.6"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `netcupscp-exporter` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| serviceMonitor.additionalLabels | object | `{}` | Prometheus ServiceMonitor labels | +| serviceMonitor.enabled | bool | `false` | Enable a prometheus ServiceMonitor | +| serviceMonitor.interval | string | `"30s"` | Prometheus ServiceMonitor interval | +| serviceMonitor.metricRelabelings | list | `[]` | Prometheus [MetricRelabelConfigs] to apply to samples before ingestion | +| serviceMonitor.namespace | string | `""` | Prometheus ServiceMonitor namespace | +| serviceMonitor.relabelings | list | `[]` | Prometheus [RelabelConfigs] to apply to samples before scraping | +| serviceMonitor.selector | object | `{}` | Prometheus ServiceMonitor selector | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/node-access/README.md b/charts/node-access/README.md index 1aeb75db..7f073f3c 100644 --- a/charts/node-access/README.md +++ b/charts/node-access/README.md @@ -44,30 +44,30 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| -------------------------------------------------- | ------ | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| fullnameOverride | string | `""` | String to fully override `"node-access.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"busybox"` | image repository | -| image.tag | string | `"1.36.1"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| nameOverride | string | `""` | Provide a name in place of `node-access` | -| nodeAccess.accessMode | string | `"deployment"` | How to deploy the Pods to access the host system: daemonset or deployment | -| nodeAccess.hostPaths | list | `[]` | List of additional paths on the host that should be mounted into the container | -| nodeAccess.nodePlacement.affinity | object | `{}` | Affinity settings for pod assignment | -| nodeAccess.nodePlacement.nodeName | string | `""` | Request to schedule this pod onto a specific node | -| nodeAccess.nodePlacement.nodeSelector | object | `{}` | Node labels for pod assignment | -| nodeAccess.nodePlacement.tolerations | list | `[]` | Toleration labels for pod assignment | -| nodeAccess.nodePlacement.topologySpreadConstraints | list | `[]` | how a group of pods ought to spread across topology domains | -| podAnnotations | object | `{}` | Annotations to be added to the pods | -| podSecurityContext | object | see [values.yaml](./values.yaml) | pod-level security context | -| replicaCount | int | `1` | Number of replicas. Only used if `accessNode.accessMode` equals `deployment` | -| resources | object | see [values.yaml](./values.yaml) | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | see [values.yaml](./values.yaml) | container-level security context | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| fullnameOverride | string | `""` | String to fully override `"node-access.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"busybox"` | image repository | +| image.tag | string | `"1.36.1"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| nameOverride | string | `""` | Provide a name in place of `node-access` | +| nodeAccess.accessMode | string | `"deployment"` | How to deploy the Pods to access the host system: daemonset or deployment | +| nodeAccess.hostPaths | list | `[]` | List of additional paths on the host that should be mounted into the container | +| nodeAccess.nodePlacement.affinity | object | `{}` | Affinity settings for pod assignment | +| nodeAccess.nodePlacement.nodeName | string | `""` | Request to schedule this pod onto a specific node | +| nodeAccess.nodePlacement.nodeSelector | object | `{}` | Node labels for pod assignment | +| nodeAccess.nodePlacement.tolerations | list | `[]` | Toleration labels for pod assignment | +| nodeAccess.nodePlacement.topologySpreadConstraints | list | `[]` | how a group of pods ought to spread across topology domains | +| podAnnotations | object | `{}` | Annotations to be added to the pods | +| podSecurityContext | object | see [values.yaml](./values.yaml) | pod-level security context | +| replicaCount | int | `1` | Number of replicas. Only used if `accessNode.accessMode` equals `deployment` | +| resources | object | see [values.yaml](./values.yaml) | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | see [values.yaml](./values.yaml) | container-level security context | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/passbolt-ha/README.md b/charts/passbolt-ha/README.md index 52ce1aef..ed578210 100644 --- a/charts/passbolt-ha/README.md +++ b/charts/passbolt-ha/README.md @@ -44,76 +44,76 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------- | ------ | ---------------------------- | ----------- | -| mysql.affinity | object | `{}` | | -| mysql.architecture | string | `"replication"` | | -| mysql.auth.database | string | `"passbolt"` | | -| mysql.auth.password | string | `"passbolt"` | | -| mysql.auth.rootPassword | string | `"root"` | | -| mysql.auth.username | string | `"passbolt"` | | -| mysql.enabled | bool | `true` | | -| mysql.fullnameOverride | string | `"passbolt-mysql"` | | -| mysql.global.storageClass | string | `""` | | -| mysql.image.pullPolicy | string | `"Always"` | | -| mysql.metrics.enabled | bool | `false` | | -| mysql.metrics.image.pullPolicy | string | `"Always"` | | -| mysql.metrics.serviceMonitor.enabled | bool | `false` | | -| mysql.metrics.serviceMonitor.labels | object | `{}` | | -| mysql.rbac.create | bool | `true` | | -| mysql.resources.limits.cpu | string | `"200m"` | | -| mysql.resources.limits.memory | string | `"1024Mi"` | | -| mysql.resources.requests.cpu | string | `"10m"` | | -| mysql.resources.requests.memory | string | `"256Mi"` | | -| mysql.secondary.replicaCount | int | `2` | | -| mysql.volumePermissions.enabled | bool | `true` | | -| mysql.volumePermissions.image.pullPolicy | string | `"Always"` | | -| passbolt.db.host | string | `"passbolt-proxysql"` | | -| passbolt.db.name | string | `"passbolt"` | | -| passbolt.db.password | string | `"passbolt"` | | -| passbolt.db.username | string | `"passbolt"` | | -| passbolt.fullnameOverride | string | `"passbolt"` | | -| passbolt.image.pullPolicy | string | `"Always"` | | -| passbolt.ingress.annotations | object | `{}` | | -| passbolt.ingress.className | string | `""` | | -| passbolt.ingress.enabled | bool | `false` | | -| passbolt.ingress.hosts[0].host | string | `"chart-example.local"` | | -| passbolt.ingress.hosts[0].paths[0].path | string | `"/"` | | -| passbolt.ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| passbolt.ingress.tls | list | `[]` | | -| passbolt.mariadb.enabled | bool | `false` | | -| passbolt.passbolt.baseUrl | string | `""` | | -| passbolt.persistence.accessMode | string | `"ReadWriteOnce"` | | -| passbolt.persistence.enabled | bool | `true` | | -| passbolt.persistence.size | string | `"512Mi"` | | -| passbolt.resources.limits.cpu | string | `"100m"` | | -| passbolt.resources.limits.memory | string | `"512Mi"` | | -| passbolt.resources.requests.cpu | string | `"50m"` | | -| passbolt.resources.requests.memory | string | `"256Mi"` | | -| proxysql.affinity | object | `{}` | | -| proxysql.enabled | bool | `true` | | -| proxysql.fullnameOverride | string | `"passbolt-proxysql"` | | -| proxysql.image.pullPolicy | string | `"Always"` | | -| proxysql.proxysql.admin.password | string | `"admin"` | | -| proxysql.proxysql.admin.user | string | `"admin"` | | -| proxysql.proxysql.mysql.servers[0].hostname | string | `"passbolt-mysql-primary"` | | -| proxysql.proxysql.mysql.servers[0].isWriter | bool | `true` | | -| proxysql.proxysql.mysql.servers[0].port | int | `3306` | | -| proxysql.proxysql.mysql.servers[1].hostname | string | `"passbolt-mysql-secondary"` | | -| proxysql.proxysql.mysql.servers[1].isWriter | bool | `false` | | -| proxysql.proxysql.mysql.servers[1].port | int | `3306` | | -| proxysql.proxysql.mysql.users[0].password | string | `"root"` | | -| proxysql.proxysql.mysql.users[0].username | string | `"root"` | | -| proxysql.proxysql.mysql.users[1].password | string | `"passbolt"` | | -| proxysql.proxysql.mysql.users[1].username | string | `"passbolt"` | | -| proxysql.proxysql.mysql.version | string | `"8.0.29"` | | -| proxysql.proxysql.web.password | string | `"admin"` | | -| proxysql.proxysql.web.user | string | `"admin"` | | -| proxysql.replicaCount | int | `3` | | -| proxysql.resources.limits.cpu | string | `"200m"` | | -| proxysql.resources.limits.memory | string | `"512Mi"` | | -| proxysql.resources.requests.cpu | string | `"100m"` | | -| proxysql.resources.requests.memory | string | `"128Mi"` | | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| mysql.affinity | object | `{}` | | +| mysql.architecture | string | `"replication"` | | +| mysql.auth.database | string | `"passbolt"` | | +| mysql.auth.password | string | `"passbolt"` | | +| mysql.auth.rootPassword | string | `"root"` | | +| mysql.auth.username | string | `"passbolt"` | | +| mysql.enabled | bool | `true` | | +| mysql.fullnameOverride | string | `"passbolt-mysql"` | | +| mysql.global.storageClass | string | `""` | | +| mysql.image.pullPolicy | string | `"Always"` | | +| mysql.metrics.enabled | bool | `false` | | +| mysql.metrics.image.pullPolicy | string | `"Always"` | | +| mysql.metrics.serviceMonitor.enabled | bool | `false` | | +| mysql.metrics.serviceMonitor.labels | object | `{}` | | +| mysql.rbac.create | bool | `true` | | +| mysql.resources.limits.cpu | string | `"200m"` | | +| mysql.resources.limits.memory | string | `"1024Mi"` | | +| mysql.resources.requests.cpu | string | `"10m"` | | +| mysql.resources.requests.memory | string | `"256Mi"` | | +| mysql.secondary.replicaCount | int | `2` | | +| mysql.volumePermissions.enabled | bool | `true` | | +| mysql.volumePermissions.image.pullPolicy | string | `"Always"` | | +| passbolt.db.host | string | `"passbolt-proxysql"` | | +| passbolt.db.name | string | `"passbolt"` | | +| passbolt.db.password | string | `"passbolt"` | | +| passbolt.db.username | string | `"passbolt"` | | +| passbolt.fullnameOverride | string | `"passbolt"` | | +| passbolt.image.pullPolicy | string | `"Always"` | | +| passbolt.ingress.annotations | object | `{}` | | +| passbolt.ingress.className | string | `""` | | +| passbolt.ingress.enabled | bool | `false` | | +| passbolt.ingress.hosts[0].host | string | `"chart-example.local"` | | +| passbolt.ingress.hosts[0].paths[0].path | string | `"/"` | | +| passbolt.ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| passbolt.ingress.tls | list | `[]` | | +| passbolt.mariadb.enabled | bool | `false` | | +| passbolt.passbolt.baseUrl | string | `""` | | +| passbolt.persistence.accessMode | string | `"ReadWriteOnce"` | | +| passbolt.persistence.enabled | bool | `true` | | +| passbolt.persistence.size | string | `"512Mi"` | | +| passbolt.resources.limits.cpu | string | `"100m"` | | +| passbolt.resources.limits.memory | string | `"512Mi"` | | +| passbolt.resources.requests.cpu | string | `"50m"` | | +| passbolt.resources.requests.memory | string | `"256Mi"` | | +| proxysql.affinity | object | `{}` | | +| proxysql.enabled | bool | `true` | | +| proxysql.fullnameOverride | string | `"passbolt-proxysql"` | | +| proxysql.image.pullPolicy | string | `"Always"` | | +| proxysql.proxysql.admin.password | string | `"admin"` | | +| proxysql.proxysql.admin.user | string | `"admin"` | | +| proxysql.proxysql.mysql.servers[0].hostname | string | `"passbolt-mysql-primary"` | | +| proxysql.proxysql.mysql.servers[0].isWriter | bool | `true` | | +| proxysql.proxysql.mysql.servers[0].port | int | `3306` | | +| proxysql.proxysql.mysql.servers[1].hostname | string | `"passbolt-mysql-secondary"` | | +| proxysql.proxysql.mysql.servers[1].isWriter | bool | `false` | | +| proxysql.proxysql.mysql.servers[1].port | int | `3306` | | +| proxysql.proxysql.mysql.users[0].password | string | `"root"` | | +| proxysql.proxysql.mysql.users[0].username | string | `"root"` | | +| proxysql.proxysql.mysql.users[1].password | string | `"passbolt"` | | +| proxysql.proxysql.mysql.users[1].username | string | `"passbolt"` | | +| proxysql.proxysql.mysql.version | string | `"8.0.29"` | | +| proxysql.proxysql.web.password | string | `"admin"` | | +| proxysql.proxysql.web.user | string | `"admin"` | | +| proxysql.replicaCount | int | `3` | | +| proxysql.resources.limits.cpu | string | `"200m"` | | +| proxysql.resources.limits.memory | string | `"512Mi"` | | +| proxysql.resources.requests.cpu | string | `"100m"` | | +| proxysql.resources.requests.memory | string | `"128Mi"` | | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/polr/README.md b/charts/polr/README.md index 63b574cd..4016bd2e 100644 --- a/charts/polr/README.md +++ b/charts/polr/README.md @@ -44,66 +44,66 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | -------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| admin.email | string | `""` | | -| admin.existingSecret | string | `""` | | -| admin.password | string | `"admin"` | | -| admin.username | string | `"admin"` | | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| env[0].name | string | `"APP_ADDRESS"` | | -| env[0].value | string | `"polr.local"` | | -| env[1].name | string | `"APP_NAME"` | | -| env[1].value | string | `"Polr"` | | -| externalDatabase.database | string | `"polr"` | | -| externalDatabase.existingSecret | string | `""` | | -| externalDatabase.host | string | `"polr-mysql"` | | -| externalDatabase.password | string | `"polr"` | | -| externalDatabase.port | string | `"3306"` | | -| externalDatabase.username | string | `"polr"` | | -| fullnameOverride | string | `""` | String to fully override `"polr.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"ajanvier/polr"` | image repository | -| image.tag | string | `"2.3.0"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| mail.enabled | bool | `false` | | -| mail.existingSecret | string | `""` | | -| mail.fromAddress | string | `""` | | -| mail.fromName | string | `""` | | -| mail.host | string | `""` | | -| mail.password | string | `""` | | -| mail.port | string | `""` | | -| mail.username | string | `""` | | -| mysql.auth.database | string | `"polr"` | | -| mysql.auth.existingSecret | string | `""` | | -| mysql.auth.password | string | `"polr"` | | -| mysql.auth.username | string | `"polr"` | | -| mysql.enabled | bool | `true` | | -| nameOverride | string | `""` | Provide a name in place of `polr` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| admin.email | string | `""` | | +| admin.existingSecret | string | `""` | | +| admin.password | string | `"admin"` | | +| admin.username | string | `"admin"` | | +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| env[0].name | string | `"APP_ADDRESS"` | | +| env[0].value | string | `"polr.local"` | | +| env[1].name | string | `"APP_NAME"` | | +| env[1].value | string | `"Polr"` | | +| externalDatabase.database | string | `"polr"` | | +| externalDatabase.existingSecret | string | `""` | | +| externalDatabase.host | string | `"polr-mysql"` | | +| externalDatabase.password | string | `"polr"` | | +| externalDatabase.port | string | `"3306"` | | +| externalDatabase.username | string | `"polr"` | | +| fullnameOverride | string | `""` | String to fully override `"polr.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"ajanvier/polr"` | image repository | +| image.tag | string | `"2.3.0"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| mail.enabled | bool | `false` | | +| mail.existingSecret | string | `""` | | +| mail.fromAddress | string | `""` | | +| mail.fromName | string | `""` | | +| mail.host | string | `""` | | +| mail.password | string | `""` | | +| mail.port | string | `""` | | +| mail.username | string | `""` | | +| mysql.auth.database | string | `"polr"` | | +| mysql.auth.existingSecret | string | `""` | | +| mysql.auth.password | string | `"polr"` | | +| mysql.auth.username | string | `"polr"` | | +| mysql.enabled | bool | `true` | | +| nameOverride | string | `""` | Provide a name in place of `polr` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/popeye/README.md b/charts/popeye/README.md index 574aca57..b780f053 100644 --- a/charts/popeye/README.md +++ b/charts/popeye/README.md @@ -44,38 +44,38 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------- | ------ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| cronJob.clusterName | string | `""` | | -| cronJob.history.failedJobsHistoryLimit | int | `1` | | -| cronJob.history.successfulJobsHistoryLimit | int | `1` | | -| cronJob.outputFormat | string | `"standard"` | | -| cronJob.prometheus.basicAuth.enabled | bool | `false` | Use authentication against Prometheus Pushgateway | -| cronJob.prometheus.basicAuth.existingSecret | string | `""` | Name of existing secret to use for authentication against Prometheus Pushgateway, needs to contain the key pushgateway-password | -| cronJob.prometheus.basicAuth.password | string | `""` | Password for authentication against Prometheus Pushgateway | -| cronJob.prometheus.basicAuth.user | string | `""` | Username for authentication against Prometheus Pushgateway | -| cronJob.prometheus.pushgatewayAddress | string | `""` | | -| cronJob.s3.bucket | string | `""` | bucket name can be the URI and the bucket name path s3://example-bucket | -| cronJob.s3.endpoint | string | `""` | example endpoint: "https://s3.us-east-1.amazonaws.com" | -| cronJob.s3.region | string | `""` | example region: "us-east-1" | -| cronJob.schedule | string | `"* */1 * * *"` | | -| cronJob.spinachConfiguration | object | `{}` | | -| fullnameOverride | string | `""` | String to fully override `"popeye.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"derailed/popeye"` | image repository | -| image.tag | string | `"v0.21.3"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| nameOverride | string | `""` | Provide a name in place of `popeye` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| resources | object | `{"limits":{"cpu":"1000m","memory":"1000Mi"}}` | Resource limits and requests for the headwind pods. | -| securityContext | object | `{}` | container-level security context | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| cronJob.clusterName | string | `""` | | +| cronJob.history.failedJobsHistoryLimit | int | `1` | | +| cronJob.history.successfulJobsHistoryLimit | int | `1` | | +| cronJob.outputFormat | string | `"standard"` | | +| cronJob.prometheus.basicAuth.enabled | bool | `false` | Use authentication against Prometheus Pushgateway | +| cronJob.prometheus.basicAuth.existingSecret | string | `""` | Name of existing secret to use for authentication against Prometheus Pushgateway, needs to contain the key pushgateway-password | +| cronJob.prometheus.basicAuth.password | string | `""` | Password for authentication against Prometheus Pushgateway | +| cronJob.prometheus.basicAuth.user | string | `""` | Username for authentication against Prometheus Pushgateway | +| cronJob.prometheus.pushgatewayAddress | string | `""` | | +| cronJob.s3.bucket | string | `""` | bucket name can be the URI and the bucket name path s3://example-bucket | +| cronJob.s3.endpoint | string | `""` | example endpoint: "https://s3.us-east-1.amazonaws.com" | +| cronJob.s3.region | string | `""` | example region: "us-east-1" | +| cronJob.schedule | string | `"* */1 * * *"` | | +| cronJob.spinachConfiguration | object | `{}` | | +| fullnameOverride | string | `""` | String to fully override `"popeye.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"derailed/popeye"` | image repository | +| image.tag | string | `"v0.21.3"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| nameOverride | string | `""` | Provide a name in place of `popeye` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| resources | object | `{"limits":{"cpu":"1000m","memory":"1000Mi"}}` | Resource limits and requests for the headwind pods. | +| securityContext | object | `{}` | container-level security context | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/priority-classes/README.md b/charts/priority-classes/README.md index 9372402e..3410551a 100644 --- a/charts/priority-classes/README.md +++ b/charts/priority-classes/README.md @@ -44,11 +44,11 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ---------------- | ------ | -------------------------------- | ------------------------------------------------------ | -| fullnameOverride | string | `""` | String to fully override `"priority-classes.fullname"` | -| nameOverride | string | `""` | Provide a name in place of `priority-classes` | -| priorityClasses | list | see [values.yaml](./values.yaml) | List of Priority Classes to be created | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| fullnameOverride | string | `""` | String to fully override `"priority-classes.fullname"` | +| nameOverride | string | `""` | Provide a name in place of `priority-classes` | +| priorityClasses | list | see [values.yaml](./values.yaml) | List of Priority Classes to be created | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/prometheus-pve-exporter/README.md b/charts/prometheus-pve-exporter/README.md index 39d6a606..637ac6b4 100644 --- a/charts/prometheus-pve-exporter/README.md +++ b/charts/prometheus-pve-exporter/README.md @@ -46,48 +46,48 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| args | list | `[]` | | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| env.pveAuthType | string | `"token"` | | -| env.pveExistingSecretName | string | `""` | | -| env.pvePassword | string | `"password"` | | -| env.pveTokenName | string | `"tokenName"` | | -| env.pveTokenValue | string | `"tokenValue"` | | -| env.pveUser | string | `"user"` | | -| env.pveVerifySsl | bool | `false` | | -| fullnameOverride | string | `""` | String to fully override `"prometheus-pve-exporter.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"prompve/prometheus-pve-exporter"` | image repository | -| image.tag | string | `"2.3.1"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| nameOverride | string | `""` | Provide a name in place of `prometheus-pve-exporter` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":65534}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| serviceMonitor.additionalLabels | object | `{}` | Prometheus ServiceMonitor labels | -| serviceMonitor.enabled | bool | `false` | Enable a prometheus ServiceMonitor | -| serviceMonitor.interval | string | `"30s"` | Prometheus ServiceMonitor interval | -| serviceMonitor.metricRelabelings | list | `[]` | Prometheus [MetricRelabelConfigs] to apply to samples before ingestion | -| serviceMonitor.namespace | string | `""` | Prometheus ServiceMonitor namespace | -| serviceMonitor.pveTargets | list | `[]` | Prometheus | -| serviceMonitor.relabelings | list | `[]` | Prometheus [RelabelConfigs] to apply to samples before scraping | -| serviceMonitor.selector | object | `{}` | Prometheus ServiceMonitor selector | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| args | list | `[]` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| env.pveAuthType | string | `"token"` | | +| env.pveExistingSecretName | string | `""` | | +| env.pvePassword | string | `"password"` | | +| env.pveTokenName | string | `"tokenName"` | | +| env.pveTokenValue | string | `"tokenValue"` | | +| env.pveUser | string | `"user"` | | +| env.pveVerifySsl | bool | `false` | | +| fullnameOverride | string | `""` | String to fully override `"prometheus-pve-exporter.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"prompve/prometheus-pve-exporter"` | image repository | +| image.tag | string | `"2.3.1"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| nameOverride | string | `""` | Provide a name in place of `prometheus-pve-exporter` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":65534}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| serviceMonitor.additionalLabels | object | `{}` | Prometheus ServiceMonitor labels | +| serviceMonitor.enabled | bool | `false` | Enable a prometheus ServiceMonitor | +| serviceMonitor.interval | string | `"30s"` | Prometheus ServiceMonitor interval | +| serviceMonitor.metricRelabelings | list | `[]` | Prometheus [MetricRelabelConfigs] to apply to samples before ingestion | +| serviceMonitor.namespace | string | `""` | Prometheus ServiceMonitor namespace | +| serviceMonitor.pveTargets | list | `[]` | Prometheus | +| serviceMonitor.relabelings | list | `[]` | Prometheus [RelabelConfigs] to apply to samples before scraping | +| serviceMonitor.selector | object | `{}` | Prometheus ServiceMonitor selector | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/promlens/README.md b/charts/promlens/README.md index 610986e3..664d1c92 100644 --- a/charts/promlens/README.md +++ b/charts/promlens/README.md @@ -44,59 +44,59 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| config.grafana.apiToken | string | `""` | The auth token to pass to the Grafana API, see https://grafana.com/docs/grafana/latest/http_api/auth/ | -| config.grafana.defaultDatasourceId | string | `""` | The default Grafana datasource ID to use (overrides Grafana's own default). | -| config.grafana.enabled | bool | `false` | Enable integration with Grafana | -| config.grafana.existingSecret | string | `""` | An existing secret containing the auth token, key needs to be api-token | -| config.grafana.url | string | `""` | The URL of your Grafana installation | -| config.log.format | string | `"json"` | Output format of log messages. One of: [logfmt, json] | -| config.log.level | string | `"info"` | Only log messages with the given severity or above. One of: [debug, info, warn, error] | -| config.sharedLinks.gcs.bucket | string | `""` | Name of the GCS bucket for storing shared links | -| config.sharedLinks.gcs.enabled | bool | `false` | Enable Link Sharing via Google Storage Bucket | -| config.sharedLinks.gcs.existingSecret | string | `""` | An existing secret containing the credentials for the storage-account as json, key needs to be gcs-cred.json | -| config.sharedLinks.gcs.storageAccount | string | `""` | Google Cloud Storage Account key | -| config.sharedLinks.sql.createTables | bool | `true` | Whether to automatically create the required tables when using a SQL database for shared links. | -| config.sharedLinks.sql.driver | string | `"sqlite"` | The SQL driver to use for storing shared links in a SQL database. Supported values: [mysql, sqlite]. | -| config.sharedLinks.sql.dsn | string | `"/tmp/promlens-links.db"` | SQL Data Source Name when using a SQL database to shared links (see https://github.com/go-sql-driver/mysql#dsn-data-source-name) for MySQL, https://github.com/glebarez/go-sqlite#example for SQLite) | -| config.sharedLinks.sql.enabled | bool | `false` | Enable Link Sharing via SQL database | -| config.sharedLinks.sql.existingSecret | string | `""` | An existing secret containing the dsn for the link storage backend, key needs to be dsn | -| config.sharedLinks.sql.retention | string | `"0"` | The maximum retention time for shared links when using a SQL database (e.g. '10m', '12h'). Set to 0 for infinite retention. | -| config.web.defaultPrometheusUrl | string | `""` | The default Prometheus URL to load PromLens with. | -| config.web.externalUrl | string | `""` | The URL under which PromLens is externally reachable (for example, if PromLens is served via a reverse proxy). Used for generating relative and absolute links back to PromLens itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by PromLens. If omitted, relevant URL components will be derived automatically. | -| config.web.routePrefix | string | `""` | | -| fullnameOverride | string | `""` | String to fully override `"promlens.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"prom/promlens"` | image repository | -| image.tag | string | `"v0.3.0"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | Annotations to add to the ingress | -| ingress.className | string | `""` | Ingress class name | -| ingress.enabled | bool | `false` | Enable ingress | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `promlens` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | Pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `8080` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| config.grafana.apiToken | string | `""` | The auth token to pass to the Grafana API, see https://grafana.com/docs/grafana/latest/http_api/auth/ | +| config.grafana.defaultDatasourceId | string | `""` | The default Grafana datasource ID to use (overrides Grafana's own default). | +| config.grafana.enabled | bool | `false` | Enable integration with Grafana | +| config.grafana.existingSecret | string | `""` | An existing secret containing the auth token, key needs to be api-token | +| config.grafana.url | string | `""` | The URL of your Grafana installation | +| config.log.format | string | `"json"` | Output format of log messages. One of: [logfmt, json] | +| config.log.level | string | `"info"` | Only log messages with the given severity or above. One of: [debug, info, warn, error] | +| config.sharedLinks.gcs.bucket | string | `""` | Name of the GCS bucket for storing shared links | +| config.sharedLinks.gcs.enabled | bool | `false` | Enable Link Sharing via Google Storage Bucket | +| config.sharedLinks.gcs.existingSecret | string | `""` | An existing secret containing the credentials for the storage-account as json, key needs to be gcs-cred.json | +| config.sharedLinks.gcs.storageAccount | string | `""` | Google Cloud Storage Account key | +| config.sharedLinks.sql.createTables | bool | `true` | Whether to automatically create the required tables when using a SQL database for shared links. | +| config.sharedLinks.sql.driver | string | `"sqlite"` | The SQL driver to use for storing shared links in a SQL database. Supported values: [mysql, sqlite]. | +| config.sharedLinks.sql.dsn | string | `"/tmp/promlens-links.db"` | SQL Data Source Name when using a SQL database to shared links (see https://github.com/go-sql-driver/mysql#dsn-data-source-name) for MySQL, https://github.com/glebarez/go-sqlite#example for SQLite) | +| config.sharedLinks.sql.enabled | bool | `false` | Enable Link Sharing via SQL database | +| config.sharedLinks.sql.existingSecret | string | `""` | An existing secret containing the dsn for the link storage backend, key needs to be dsn | +| config.sharedLinks.sql.retention | string | `"0"` | The maximum retention time for shared links when using a SQL database (e.g. '10m', '12h'). Set to 0 for infinite retention. | +| config.web.defaultPrometheusUrl | string | `""` | The default Prometheus URL to load PromLens with. | +| config.web.externalUrl | string | `""` | The URL under which PromLens is externally reachable (for example, if PromLens is served via a reverse proxy). Used for generating relative and absolute links back to PromLens itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by PromLens. If omitted, relevant URL components will be derived automatically. | +| config.web.routePrefix | string | `""` | | +| fullnameOverride | string | `""` | String to fully override `"promlens.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"prom/promlens"` | image repository | +| image.tag | string | `"v0.3.0"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | Annotations to add to the ingress | +| ingress.className | string | `""` | Ingress class name | +| ingress.enabled | bool | `false` | Enable ingress | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `promlens` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | Pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `8080` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/proxysql/README.md b/charts/proxysql/README.md index d7b184f8..09e5d73b 100644 --- a/charts/proxysql/README.md +++ b/charts/proxysql/README.md @@ -44,75 +44,75 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------------------------------ | ------ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| fullnameOverride | string | `""` | String to fully override `"proxysql.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"proxysql/proxysql"` | image repository | -| image.tag | string | `"2.7.1"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations."nginx.ingress.kubernetes.io/backend-protocol" | string | `"HTTPS"` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| metrics.enabled | bool | `false` | | -| metrics.serviceMonitor.additionalLabels | object | `{}` | | -| metrics.serviceMonitor.enabled | bool | `false` | | -| nameOverride | string | `""` | Provide a name in place of `proxysql` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to pods | -| podSecurityContext | object | `{"fsGroup":999,"runAsGroup":999,"runAsNonRoot":true,"runAsUser":999}` | pod-level security context | -| proxysql.admin.password | string | `"admin"` | | -| proxysql.admin.user | string | `"admin"` | | -| proxysql.cluster.claim.accessModes[0] | string | `"ReadWriteOnce"` | | -| proxysql.cluster.claim.enabled | bool | `true` | | -| proxysql.cluster.claim.size | string | `"1Gi"` | | -| proxysql.cluster.claim.storageClassName | string | `"default"` | | -| proxysql.cluster.enabled | bool | `false` | | -| proxysql.cluster.password | string | `"cluster"` | | -| proxysql.cluster.user | string | `"cluster"` | | -| proxysql.monitor.enabled | bool | `false` | | -| proxysql.monitor.replicationLagInterval | int | `10000` | | -| proxysql.monitor.replicationLagTimeout | int | `1500` | | -| proxysql.monitor.slaveLagWhenNull | int | `60` | | -| proxysql.monitor.writerAsReader | bool | `true` | | -| proxysql.mysql.connectionMaxAgeMS | int | `0` | | -| proxysql.mysql.galera.enabled | bool | `false` | | -| proxysql.mysql.galera.maxWriters | int | `1` | | -| proxysql.mysql.galera.writerAsReader | bool | `true` | | -| proxysql.mysql.maxConnections | int | `2048` | | -| proxysql.mysql.port | int | `3306` | | -| proxysql.mysql.queryRetriesOnFailure | int | `2` | | -| proxysql.mysql.queyCacheSizeMB | int | `256` | | -| proxysql.mysql.readWriteSplit | bool | `true` | | -| proxysql.mysql.servers | list | `[]` | | -| proxysql.mysql.slave.checkType | string | `"read_only"` | | -| proxysql.mysql.slave.enabled | bool | `false` | | -| proxysql.mysql.users | list | `[]` | | -| proxysql.mysql.version | string | `"5.7.34"` | | -| proxysql.mysql.waitTimeout | int | `28800000` | | -| proxysql.port | int | `6032` | | -| proxysql.web.enabled | bool | `true` | | -| proxysql.web.password | string | `"sadmin"` | | -| proxysql.web.port | int | `443` | | -| proxysql.web.user | string | `"sadmin"` | | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| fullnameOverride | string | `""` | String to fully override `"proxysql.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"proxysql/proxysql"` | image repository | +| image.tag | string | `"2.7.1"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations."nginx.ingress.kubernetes.io/backend-protocol" | string | `"HTTPS"` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| metrics.enabled | bool | `false` | | +| metrics.serviceMonitor.additionalLabels | object | `{}` | | +| metrics.serviceMonitor.enabled | bool | `false` | | +| nameOverride | string | `""` | Provide a name in place of `proxysql` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to pods | +| podSecurityContext | object | `{"fsGroup":999,"runAsGroup":999,"runAsNonRoot":true,"runAsUser":999}` | pod-level security context | +| proxysql.admin.password | string | `"admin"` | | +| proxysql.admin.user | string | `"admin"` | | +| proxysql.cluster.claim.accessModes[0] | string | `"ReadWriteOnce"` | | +| proxysql.cluster.claim.enabled | bool | `true` | | +| proxysql.cluster.claim.size | string | `"1Gi"` | | +| proxysql.cluster.claim.storageClassName | string | `"default"` | | +| proxysql.cluster.enabled | bool | `false` | | +| proxysql.cluster.password | string | `"cluster"` | | +| proxysql.cluster.user | string | `"cluster"` | | +| proxysql.monitor.enabled | bool | `false` | | +| proxysql.monitor.replicationLagInterval | int | `10000` | | +| proxysql.monitor.replicationLagTimeout | int | `1500` | | +| proxysql.monitor.slaveLagWhenNull | int | `60` | | +| proxysql.monitor.writerAsReader | bool | `true` | | +| proxysql.mysql.connectionMaxAgeMS | int | `0` | | +| proxysql.mysql.galera.enabled | bool | `false` | | +| proxysql.mysql.galera.maxWriters | int | `1` | | +| proxysql.mysql.galera.writerAsReader | bool | `true` | | +| proxysql.mysql.maxConnections | int | `2048` | | +| proxysql.mysql.port | int | `3306` | | +| proxysql.mysql.queryRetriesOnFailure | int | `2` | | +| proxysql.mysql.queyCacheSizeMB | int | `256` | | +| proxysql.mysql.readWriteSplit | bool | `true` | | +| proxysql.mysql.servers | list | `[]` | | +| proxysql.mysql.slave.checkType | string | `"read_only"` | | +| proxysql.mysql.slave.enabled | bool | `false` | | +| proxysql.mysql.users | list | `[]` | | +| proxysql.mysql.version | string | `"5.7.34"` | | +| proxysql.mysql.waitTimeout | int | `28800000` | | +| proxysql.port | int | `6032` | | +| proxysql.web.enabled | bool | `true` | | +| proxysql.web.password | string | `"sadmin"` | | +| proxysql.web.port | int | `443` | | +| proxysql.web.user | string | `"sadmin"` | | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/proxyweb/README.md b/charts/proxyweb/README.md index 30811580..c65be468 100644 --- a/charts/proxyweb/README.md +++ b/charts/proxyweb/README.md @@ -44,73 +44,73 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ---------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | ----------- | --- | ------- | --- | ------------- | --- | -------------- | --- | --------- | --- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| configuration.config.flask.SECRET_KEY | string | `"kaNGSGSLrEzaplUL"` | | -| configuration.config.flask.SEND_FILE_MAX_AGE_DEFAULT | int | `0` | | -| configuration.config.flask.TEMPLATES_AUTO_RELOAD | string | `"True"` | | -| configuration.config.global.default_server | string | `"proxysql"` | | -| configuration.config.global.hide_tables[0] | string | `""` | | -| configuration.config.global.read_only | bool | `false` | | -| configuration.config.misc.adhoc_report[0].info | string | `"Examining queries with big sum_time(number of execution * time to run) is a good place to start when optimizing queries."` | | -| configuration.config.misc.adhoc_report[0].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time/1000/1000 as sum_time_sec FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY sum_time DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[0].title | string | `"Top 10 SELECTs by sum_time"` | | -| configuration.config.misc.adhoc_report[1].info | string | `"Caching/rewriting/even removing frequently running queries can improve the overall performance significantly. ProxySQL support all the mentioned methods. Example: it's a good idea to cache queries often issued by connectors like `^SELECT @@max_allowed_packet`"` | | -| configuration.config.misc.adhoc_report[1].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY count_star DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[1].title | string | `"Top 10 SELECTs by count_star"` | | -| configuration.config.misc.adhoc_report[2].info | string | `"Caching/rewriting/even removing frequently running queries can improve the overall performance significantly. ProxySQL support all the mentioned methods. Example: it's a good idea to cache queries often issued by connectors like `^SELECT @@max_allowed_packet`"` | | -| configuration.config.misc.adhoc_report[2].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time, (sum_time/count_star)/1000 as avg_time_ms FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY avg_time_ms DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[2].title | string | `"Top 10 SELECTs by avg_time"` | | -| configuration.config.misc.adhoc_report[3].info | string | `"This helps identify the most frequently running writes"` | | -| configuration.config.misc.adhoc_report[3].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time FROM stats_mysql_query_digest where digest_text LIKE 'INSERT%' or digest_text like 'DELETE%' or digest_text like 'UPDATE%' order by count_star DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[3].title | string | `"Top 10 writes"` | | -| configuration.config.misc.adhoc_report[4].info | string | `"This helps identify the schemas getting the most writes"` | | -| configuration.config.misc.adhoc_report[4].sql | string | `"SELECT schemaname, sum(sum_time) as time_spent, sum(count_star) as sum_count_star FROM stats_mysql_query_digest where digest_text LIKE 'INSERT%' or digest_text like 'DELETE%' or digest_text like 'UPDATE%' group by schemaname order by time_spent desc;"` | | -| configuration.config.misc.adhoc_report[4].title | string | `"Schemas with the most DMLs"` | | -| configuration.config.misc.adhoc_report[5].info | string | `"List of the schemas with the highest overall sum_time"` | | -| configuration.config.misc.adhoc_report[5].sql | string | `"SELECT schemaname, sum(sum_time) as time_spent FROM stats_mysql_query_digest group by schemaname order by time_spent desc limit 5;"` | | -| configuration.config.misc.adhoc_report[5].title | string | `"Top 5 schemas by sum_time"` | | -| configuration.config.misc.adhoc_report[6].info | string | `"Don't send selects to the readers without checking the impact first as the app might read back the data immediately after writing it."` | | -| configuration.config.misc.adhoc_report[6].sql | string | `"select \"replace into mysql_query_rules (username,schemaname,destination_hostgroup,active,apply,digest) values('\" | | st.username | | \"','\" | | st.schemaname | | \"',12,1,1,'\" | | st.digest | | \"');\" from stats_mysql_query_digest st left join runtime_mysql_query_rules qr on st.digest = qr.digest where qr.rule_id is null and digest_text LIKE 'SELECT%' ORDER BY count_star desc limit 5;"` | | -| configuration.config.misc.adhoc_report[6].title | string | `"Send the top 5 SELECTS to the readers"` | | -| configuration.config.servers.proxysql.dsn[0].db | string | `"main"` | | -| configuration.config.servers.proxysql.dsn[0].host | string | `"127.0.0.1"` | | -| configuration.config.servers.proxysql.dsn[0].passwd | string | `"sadmin"` | | -| configuration.config.servers.proxysql.dsn[0].port | string | `"6032"` | | -| configuration.config.servers.proxysql.dsn[0].user | string | `"sadmin"` | | -| configuration.existingSecret | string | `""` | | -| fullnameOverride | string | `""` | String to fully override `"proxyweb.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"proxyweb/proxyweb"` | image repository | -| image.tag | string | `"latest"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `proxyweb` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to pods | -| podSecurityContext | object | `{}` | pod-level security context | -| psp.enabled | bool | `false` | | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| configuration.config.flask.SECRET_KEY | string | `"kaNGSGSLrEzaplUL"` | | +| configuration.config.flask.SEND_FILE_MAX_AGE_DEFAULT | int | `0` | | +| configuration.config.flask.TEMPLATES_AUTO_RELOAD | string | `"True"` | | +| configuration.config.global.default_server | string | `"proxysql"` | | +| configuration.config.global.hide_tables[0] | string | `""` | | +| configuration.config.global.read_only | bool | `false` | | +| configuration.config.misc.adhoc_report[0].info | string | `"Examining queries with big sum_time(number of execution * time to run) is a good place to start when optimizing queries."` | | +| configuration.config.misc.adhoc_report[0].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time/1000/1000 as sum_time_sec FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY sum_time DESC LIMIT 10;"` | | +| configuration.config.misc.adhoc_report[0].title | string | `"Top 10 SELECTs by sum_time"` | | +| configuration.config.misc.adhoc_report[1].info | string | `"Caching/rewriting/even removing frequently running queries can improve the overall performance significantly. ProxySQL support all the mentioned methods. Example: it's a good idea to cache queries often issued by connectors like `^SELECT @@max_allowed_packet`"` | | +| configuration.config.misc.adhoc_report[1].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY count_star DESC LIMIT 10;"` | | +| configuration.config.misc.adhoc_report[1].title | string | `"Top 10 SELECTs by count_star"` | | +| configuration.config.misc.adhoc_report[2].info | string | `"Caching/rewriting/even removing frequently running queries can improve the overall performance significantly. ProxySQL support all the mentioned methods. Example: it's a good idea to cache queries often issued by connectors like `^SELECT @@max_allowed_packet`"` | | +| configuration.config.misc.adhoc_report[2].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time, (sum_time/count_star)/1000 as avg_time_ms FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY avg_time_ms DESC LIMIT 10;"` | | +| configuration.config.misc.adhoc_report[2].title | string | `"Top 10 SELECTs by avg_time"` | | +| configuration.config.misc.adhoc_report[3].info | string | `"This helps identify the most frequently running writes"` | | +| configuration.config.misc.adhoc_report[3].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time FROM stats_mysql_query_digest where digest_text LIKE 'INSERT%' or digest_text like 'DELETE%' or digest_text like 'UPDATE%' order by count_star DESC LIMIT 10;"` | | +| configuration.config.misc.adhoc_report[3].title | string | `"Top 10 writes"` | | +| configuration.config.misc.adhoc_report[4].info | string | `"This helps identify the schemas getting the most writes"` | | +| configuration.config.misc.adhoc_report[4].sql | string | `"SELECT schemaname, sum(sum_time) as time_spent, sum(count_star) as sum_count_star FROM stats_mysql_query_digest where digest_text LIKE 'INSERT%' or digest_text like 'DELETE%' or digest_text like 'UPDATE%' group by schemaname order by time_spent desc;"` | | +| configuration.config.misc.adhoc_report[4].title | string | `"Schemas with the most DMLs"` | | +| configuration.config.misc.adhoc_report[5].info | string | `"List of the schemas with the highest overall sum_time"` | | +| configuration.config.misc.adhoc_report[5].sql | string | `"SELECT schemaname, sum(sum_time) as time_spent FROM stats_mysql_query_digest group by schemaname order by time_spent desc limit 5;"` | | +| configuration.config.misc.adhoc_report[5].title | string | `"Top 5 schemas by sum_time"` | | +| configuration.config.misc.adhoc_report[6].info | string | `"Don't send selects to the readers without checking the impact first as the app might read back the data immediately after writing it."` | | +| configuration.config.misc.adhoc_report[6].sql | string | `"select \"replace into mysql_query_rules (username,schemaname,destination_hostgroup,active,apply,digest) values('\" || st.username || \"','\" || st.schemaname || \"',12,1,1,'\" || st.digest || \"');\" from stats_mysql_query_digest st left join runtime_mysql_query_rules qr on st.digest = qr.digest where qr.rule_id is null and digest_text LIKE 'SELECT%' ORDER BY count_star desc limit 5;"` | | +| configuration.config.misc.adhoc_report[6].title | string | `"Send the top 5 SELECTS to the readers"` | | +| configuration.config.servers.proxysql.dsn[0].db | string | `"main"` | | +| configuration.config.servers.proxysql.dsn[0].host | string | `"127.0.0.1"` | | +| configuration.config.servers.proxysql.dsn[0].passwd | string | `"sadmin"` | | +| configuration.config.servers.proxysql.dsn[0].port | string | `"6032"` | | +| configuration.config.servers.proxysql.dsn[0].user | string | `"sadmin"` | | +| configuration.existingSecret | string | `""` | | +| fullnameOverride | string | `""` | String to fully override `"proxyweb.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"proxyweb/proxyweb"` | image repository | +| image.tag | string | `"latest"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `proxyweb` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to pods | +| podSecurityContext | object | `{}` | pod-level security context | +| psp.enabled | bool | `false` | | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/shlink-backend/README.md b/charts/shlink-backend/README.md index 9da37568..dcb156e8 100644 --- a/charts/shlink-backend/README.md +++ b/charts/shlink-backend/README.md @@ -44,59 +44,59 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | -------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| env[0].name | string | `"DEFAULT_DOMAIN"` | | -| env[0].value | string | `"doma.in"` | | -| env[1].name | string | `"IS_HTTPS_ENABLED"` | | -| env[1].value | string | `"false"` | | -| fullnameOverride | string | `""` | String to fully override `"shlink-backend.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"shlinkio/shlink"` | image repository | -| image.tag | string | `"3.7.4"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| mariadb.auth.database | string | `"shlink"` | | -| mariadb.auth.password | string | `"shlink"` | | -| mariadb.auth.username | string | `"shlink"` | | -| mariadb.enabled | bool | `false` | | -| mysql.auth.database | string | `"shlink"` | | -| mysql.auth.password | string | `"shlink"` | | -| mysql.auth.username | string | `"shlink"` | | -| mysql.enabled | bool | `false` | | -| nameOverride | string | `""` | Provide a name in place of `shlink-backend` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to pods | -| podLabels | object | `{}` | Labels to be added to pods | -| podSecurityContext | object | `{}` | pod-level security context | -| postgresql.auth.database | string | `"shlink"` | | -| postgresql.auth.password | string | `"shlink"` | | -| postgresql.auth.username | string | `"shlink"` | | -| postgresql.enabled | bool | `false` | | -| rabbitmq.enabled | bool | `false` | | -| redis.auth.enabled | bool | `false` | | -| redis.enabled | bool | `false` | | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| env[0].name | string | `"DEFAULT_DOMAIN"` | | +| env[0].value | string | `"doma.in"` | | +| env[1].name | string | `"IS_HTTPS_ENABLED"` | | +| env[1].value | string | `"false"` | | +| fullnameOverride | string | `""` | String to fully override `"shlink-backend.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"shlinkio/shlink"` | image repository | +| image.tag | string | `"3.7.4"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| mariadb.auth.database | string | `"shlink"` | | +| mariadb.auth.password | string | `"shlink"` | | +| mariadb.auth.username | string | `"shlink"` | | +| mariadb.enabled | bool | `false` | | +| mysql.auth.database | string | `"shlink"` | | +| mysql.auth.password | string | `"shlink"` | | +| mysql.auth.username | string | `"shlink"` | | +| mysql.enabled | bool | `false` | | +| nameOverride | string | `""` | Provide a name in place of `shlink-backend` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to pods | +| podLabels | object | `{}` | Labels to be added to pods | +| podSecurityContext | object | `{}` | pod-level security context | +| postgresql.auth.database | string | `"shlink"` | | +| postgresql.auth.password | string | `"shlink"` | | +| postgresql.auth.username | string | `"shlink"` | | +| postgresql.enabled | bool | `false` | | +| rabbitmq.enabled | bool | `false` | | +| redis.auth.enabled | bool | `false` | | +| redis.enabled | bool | `false` | | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/shlink-web/README.md b/charts/shlink-web/README.md index adb26c0a..af88211a 100644 --- a/charts/shlink-web/README.md +++ b/charts/shlink-web/README.md @@ -1,6 +1,6 @@ # shlink-web -A ReactJS-based progressive web application for Shlink. +A ReactJS-based progressive web application for Shlink. ## TL;DR; @@ -44,41 +44,41 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| configuration | list | `[]` | | -| fullnameOverride | string | `""` | String to fully override `"shlink-web.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"shlinkio/shlink-web-client"` | image repository | -| image.tag | string | `"4.2.2"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `shlink-web` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to pods | -| podLabels | object | `{}` | Labels to be added to pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| configuration | list | `[]` | | +| fullnameOverride | string | `""` | String to fully override `"shlink-web.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"shlinkio/shlink-web-client"` | image repository | +| image.tag | string | `"4.2.2"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `shlink-web` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to pods | +| podLabels | object | `{}` | Labels to be added to pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/skooner/README.md b/charts/skooner/README.md index 41b7c27b..b02dfe9f 100644 --- a/charts/skooner/README.md +++ b/charts/skooner/README.md @@ -44,51 +44,50 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| clusterRoleBinding.clusterRole | string | `"edit"` | Define which ClusterRole to bind to: cluster-admin, edit, view | -| fullnameOverride | string | `""` | String to fully override `"skooner.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"ghcr.io/skooner-k8s/skooner"` | image repository | -| image.tag | string | `"stable"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `skooner` | -| nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Node labels for pod assignment | -| oidc.enabled | bool | `false` | | -| oidc.provider.oidcMetadata | string | `""` | | -| oidc.provider.oidcScopes | string | `"openid email"` | | -| oidc.provider.oidcUrl | string | `""` | | -| oidc.secret.clientId | string | `""` | | -| oidc.secret.clientSecret | string | `""` | | -| oidc.secret.name | string | `""` | | -| oidc.secret.useExistingSecret | bool | `false` | | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{"fsGroup":1000}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{"runAsNonRoot":true,"runAsUser":1000}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | -| volumeMounts | list | `[]` | Container's volume mounts | -| volumes | list | `[]` | Pod's volumes | - +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| clusterRoleBinding.clusterRole | string | `"edit"` | Define which ClusterRole to bind to: cluster-admin, edit, view | +| fullnameOverride | string | `""` | String to fully override `"skooner.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"ghcr.io/skooner-k8s/skooner"` | image repository | +| image.tag | string | `"stable"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `skooner` | +| nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Node labels for pod assignment | +| oidc.enabled | bool | `false` | | +| oidc.provider.oidcMetadata | string | `""` | | +| oidc.provider.oidcScopes | string | `"openid email"` | | +| oidc.provider.oidcUrl | string | `""` | | +| oidc.secret.clientId | string | `""` | | +| oidc.secret.clientSecret | string | `""` | | +| oidc.secret.name | string | `""` | | +| oidc.secret.useExistingSecret | bool | `false` | | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{"fsGroup":1000}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{"runAsNonRoot":true,"runAsUser":1000}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | +| volumeMounts | list | `[]` | Container's volume mounts | +| volumes | list | `[]` | Pod's volumes | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/sloop/README.md b/charts/sloop/README.md index b0a233b2..073b3433 100644 --- a/charts/sloop/README.md +++ b/charts/sloop/README.md @@ -44,48 +44,48 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| clusterRole.additionalApiGroups | list | `[]` | | -| clusterRole.additionalPermissions | list | `[]` | | -| fullnameOverride | string | `""` | String to fully override `"sloop.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"ghcr.io/salesforce/sloop"` | image repository | -| image.tag | string | `"sha-2ce8bbe"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `sloop` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| persistence.accessModes[0] | string | `"ReadWriteOnce"` | | -| persistence.annotations | object | `{}` | | -| persistence.enabled | bool | `false` | | -| persistence.existingClaim | string | `""` | | -| persistence.size | string | `"10Gi"` | | -| persistence.storageClass | string | `""` | | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `80` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| sloop.config | string | `"{\n \"displayContext\": \"cluster\",\n \"defaultNamespace\": \"default\",\n \"defaultKind\": \"Pod\",\n \"defaultLookback\": \"1h\",\n \"leftBarLinks\": [\n ],\n \"resourceLinks\": [\n ]\n}\n"` | | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| clusterRole.additionalApiGroups | list | `[]` | | +| clusterRole.additionalPermissions | list | `[]` | | +| fullnameOverride | string | `""` | String to fully override `"sloop.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"ghcr.io/salesforce/sloop"` | image repository | +| image.tag | string | `"sha-2ce8bbe"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `sloop` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| persistence.accessModes[0] | string | `"ReadWriteOnce"` | | +| persistence.annotations | object | `{}` | | +| persistence.enabled | bool | `false` | | +| persistence.existingClaim | string | `""` | | +| persistence.size | string | `"10Gi"` | | +| persistence.storageClass | string | `""` | | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `80` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| sloop.config | string | `"{\n \"displayContext\": \"cluster\",\n \"defaultNamespace\": \"default\",\n \"defaultKind\": \"Pod\",\n \"defaultLookback\": \"1h\",\n \"leftBarLinks\": [\n ],\n \"resourceLinks\": [\n ]\n}\n"` | | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/syncserver/README.md b/charts/syncserver/README.md index 2e5bbd5d..c8b93c72 100644 --- a/charts/syncserver/README.md +++ b/charts/syncserver/README.md @@ -49,54 +49,54 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| fullnameOverride | string | `""` | String to fully override `"syncserver.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"mozilla/syncserver"` | image repository | -| image.tag | string | `"latest"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | Provide a name in place of `syncserver` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `5000` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| syncserver.config.allowNewUser | bool | `false` | controls whether the server will accept requests from previously-unseen users | -| syncserver.config.batchUploadEnabled | bool | `true` | | -| syncserver.config.debugEnabled | bool | `false` | | -| syncserver.config.existingSecret | string | `""` | Name of an existing secret containing the syncserver secret under the key syncserver-secret | -| syncserver.config.forceWsgiEnviron | bool | `true` | | -| syncserver.config.publicUrl | string | `"http://localhost:5000"` | | -| syncserver.config.secret | string | `"super-strong-secret"` | Secret to secure the syncserver | -| syncserver.config.sqlUri | string | `"sqlite:////data/syncserver.db"` | | -| syncserver.extraEnv | list | `[]` | additional environment variables to be added to the syncserver pods | -| syncserver.persistence.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | -| syncserver.persistence.annotations | object | `{}` | | -| syncserver.persistence.enabled | bool | `false` | | -| syncserver.persistence.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | -| syncserver.persistence.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | -| syncserver.persistence.storageClassName | string | `""` | Name of the StorageClass required by the claim. | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| fullnameOverride | string | `""` | String to fully override `"syncserver.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"mozilla/syncserver"` | image repository | +| image.tag | string | `"latest"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | Provide a name in place of `syncserver` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `5000` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| syncserver.config.allowNewUser | bool | `false` | controls whether the server will accept requests from previously-unseen users | +| syncserver.config.batchUploadEnabled | bool | `true` | | +| syncserver.config.debugEnabled | bool | `false` | | +| syncserver.config.existingSecret | string | `""` | Name of an existing secret containing the syncserver secret under the key syncserver-secret | +| syncserver.config.forceWsgiEnviron | bool | `true` | | +| syncserver.config.publicUrl | string | `"http://localhost:5000"` | | +| syncserver.config.secret | string | `"super-strong-secret"` | Secret to secure the syncserver | +| syncserver.config.sqlUri | string | `"sqlite:////data/syncserver.db"` | | +| syncserver.extraEnv | list | `[]` | additional environment variables to be added to the syncserver pods | +| syncserver.persistence.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | +| syncserver.persistence.annotations | object | `{}` | | +| syncserver.persistence.enabled | bool | `false` | | +| syncserver.persistence.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | +| syncserver.persistence.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | +| syncserver.persistence.storageClassName | string | `""` | Name of the StorageClass required by the claim. | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/tenant-namespace/README.md b/charts/tenant-namespace/README.md index a3b4328c..5c2af63b 100644 --- a/charts/tenant-namespace/README.md +++ b/charts/tenant-namespace/README.md @@ -44,50 +44,50 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| --------------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| fullnameOverride | string | `""` | String to fully override `"tenant-namespace.fullname"` | -| limitRange.additionalAnnotations | object | `{}` | Annotations to be added to the LimitRange | -| limitRange.additionalLabels | object | `{}` | Labels to be added to the LimitRange | -| limitRange.enabled | bool | `false` | - create a LimitRange resource | -| limitRange.limits | list | `[]` | define the list of limits | -| limitRange.name | string | `""` | The name of the LimitRange to be created. If left empty will simply use the Release name. | -| nameOverride | string | `""` | Provide a name in place of `tenant-namespace` | -| namespace.annotations.additionalAnnotations | object | `{}` | Annotations to be added to the Namespace | -| namespace.annotations.openShift.description | string | `""` | The optional description can be a more detailed description of the project and is visible in the web console. | -| namespace.annotations.openShift.displayName | string | `""` | The optional displayName is how the project is displayed in the web console (defaults to name). | -| namespace.annotations.openShift.requester | string | `""` | The optional requesting user. | -| namespace.annotations.scheduler.defaultTolerations | list | `[]` | This annotation requires the PodTolerationRestriction admission controller to be enabled. This annotation key allows assigning tolerations to a namespace and any new pods created in this namespace would get these tolerations added. | -| namespace.annotations.scheduler.nodeSelector | string | `""` | The PodNodeSelector uses this annotation key to assign node selectors to pods in namespaces. | -| namespace.annotations.scheduler.tolerationsWhitelist | list | `[]` | This annotation requires the PodTolerationRestriction admission controller to be enabled. The annotation value is a JSON document that defines a list of allowed tolerations for the namespace it annotates. When you create a Pod or modify its tolerations, the API server checks the tolerations to see if they are mentioned in the allow list. The pod is admitted only if the check succeeds. | -| namespace.enabled | bool | `false` | - create a Namespace resource | -| namespace.labels.additionalLabels | object | `{}` | Labels to be added to the Namespace | -| namespace.labels.podSecurityAdmission.audit.standard | string | `""` | Value must be one of privileged, baseline, or restricted which correspond to Pod Security Standard levels. | -| namespace.labels.podSecurityAdmission.audit.version | string | `""` | Version label that can be used to pin the policy to the version that shipped with a given Kubernetes minor version (for example v1.27). | -| namespace.labels.podSecurityAdmission.enforce.standard | string | `""` | Value must be one of privileged, baseline, or restricted which correspond to Pod Security Standard levels. | -| namespace.labels.podSecurityAdmission.enforce.version | string | `""` | Version label that can be used to pin the policy to the version that shipped with a given Kubernetes minor version (for example v1.27). | -| namespace.labels.podSecurityAdmission.warning.standard | string | `""` | Value must be one of privileged, baseline, or restricted which correspond to Pod Security Standard levels. | -| namespace.labels.podSecurityAdmission.warning.version | string | `""` | Version label that can be used to pin the policy to the version that shipped with a given Kubernetes minor version (for example v1.27). | -| namespace.name | string | `""` | The Name of the newly created namespace. Uses the Release name be default. | -| networkPolicies.additionalAnnotations | object | `{}` | Annotations to be added to the NetworkPolicies | -| networkPolicies.additionalLabels | object | `{}` | Labels to be added to the NetworkPolicies | -| networkPolicies.egress.allow.dns.enabled | bool | `true` | create a NetworkPolicy that allows outgoing traffic to the Kubernetes DNS | -| networkPolicies.egress.allow.dns.namespace | string | `"kube-system"` | The namespace where the Kubneretes DNS is running | -| networkPolicies.egress.allow.dns.podLabels | object | `{"k8s-app":"kube-dns"}` | The labels of the Kubernetes DNS | -| networkPolicies.egress.allow.dns.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | -| networkPolicies.egress.deny.all.enabled | bool | `true` | create a NetworkPolicy that denies all outgoing traffic | -| networkPolicies.egress.deny.all.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | -| networkPolicies.enabled | bool | `false` | - create NetworkPolicy resources to limit the allowed traffic | -| networkPolicies.ingress.allow.openShift.ingressController.enabled | bool | `true` | create a NetworkPolicy that allows incoming traffic from the OpenShift Ingress Controller | -| networkPolicies.ingress.allow.openShift.ingressController.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | -| networkPolicies.ingress.allow.openShift.monitoring.enabled | bool | `true` | create a NetworkPolicy that allows incoming traffic from the OpenShift Monitoring | -| networkPolicies.ingress.allow.openShift.monitoring.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | -| networkPolicies.ingress.deny.all.enabled | bool | `true` | create a NetworkPolicy that denies all incoming traffic | -| networkPolicies.ingress.deny.all.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | -| networkPolicies.openShift.enabled | bool | `false` | enabled the creation of NetworkPolicies for OpenShift like Ingress and Monitoring | -| resourceQuotas | object | `{"additionalAnnotations":{},"additionalLabels":{},"enabled":false,"quotas":[]}` | define a list of ResourceQuotas that should be created | -| resourceQuotas.additionalAnnotations | object | `{}` | Annotations to be added to the LimitRange | -| resourceQuotas.additionalLabels | object | `{}` | Labels to be added to the LimitRange | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| fullnameOverride | string | `""` | String to fully override `"tenant-namespace.fullname"` | +| limitRange.additionalAnnotations | object | `{}` | Annotations to be added to the LimitRange | +| limitRange.additionalLabels | object | `{}` | Labels to be added to the LimitRange | +| limitRange.enabled | bool | `false` | - create a LimitRange resource | +| limitRange.limits | list | `[]` | define the list of limits | +| limitRange.name | string | `""` | The name of the LimitRange to be created. If left empty will simply use the Release name. | +| nameOverride | string | `""` | Provide a name in place of `tenant-namespace` | +| namespace.annotations.additionalAnnotations | object | `{}` | Annotations to be added to the Namespace | +| namespace.annotations.openShift.description | string | `""` | The optional description can be a more detailed description of the project and is visible in the web console. | +| namespace.annotations.openShift.displayName | string | `""` | The optional displayName is how the project is displayed in the web console (defaults to name). | +| namespace.annotations.openShift.requester | string | `""` | The optional requesting user. | +| namespace.annotations.scheduler.defaultTolerations | list | `[]` | This annotation requires the PodTolerationRestriction admission controller to be enabled. This annotation key allows assigning tolerations to a namespace and any new pods created in this namespace would get these tolerations added. | +| namespace.annotations.scheduler.nodeSelector | string | `""` | The PodNodeSelector uses this annotation key to assign node selectors to pods in namespaces. | +| namespace.annotations.scheduler.tolerationsWhitelist | list | `[]` | This annotation requires the PodTolerationRestriction admission controller to be enabled. The annotation value is a JSON document that defines a list of allowed tolerations for the namespace it annotates. When you create a Pod or modify its tolerations, the API server checks the tolerations to see if they are mentioned in the allow list. The pod is admitted only if the check succeeds. | +| namespace.enabled | bool | `false` | - create a Namespace resource | +| namespace.labels.additionalLabels | object | `{}` | Labels to be added to the Namespace | +| namespace.labels.podSecurityAdmission.audit.standard | string | `""` | Value must be one of privileged, baseline, or restricted which correspond to Pod Security Standard levels. | +| namespace.labels.podSecurityAdmission.audit.version | string | `""` | Version label that can be used to pin the policy to the version that shipped with a given Kubernetes minor version (for example v1.27). | +| namespace.labels.podSecurityAdmission.enforce.standard | string | `""` | Value must be one of privileged, baseline, or restricted which correspond to Pod Security Standard levels. | +| namespace.labels.podSecurityAdmission.enforce.version | string | `""` | Version label that can be used to pin the policy to the version that shipped with a given Kubernetes minor version (for example v1.27). | +| namespace.labels.podSecurityAdmission.warning.standard | string | `""` | Value must be one of privileged, baseline, or restricted which correspond to Pod Security Standard levels. | +| namespace.labels.podSecurityAdmission.warning.version | string | `""` | Version label that can be used to pin the policy to the version that shipped with a given Kubernetes minor version (for example v1.27). | +| namespace.name | string | `""` | The Name of the newly created namespace. Uses the Release name be default. | +| networkPolicies.additionalAnnotations | object | `{}` | Annotations to be added to the NetworkPolicies | +| networkPolicies.additionalLabels | object | `{}` | Labels to be added to the NetworkPolicies | +| networkPolicies.egress.allow.dns.enabled | bool | `true` | create a NetworkPolicy that allows outgoing traffic to the Kubernetes DNS | +| networkPolicies.egress.allow.dns.namespace | string | `"kube-system"` | The namespace where the Kubneretes DNS is running | +| networkPolicies.egress.allow.dns.podLabels | object | `{"k8s-app":"kube-dns"}` | The labels of the Kubernetes DNS | +| networkPolicies.egress.allow.dns.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | +| networkPolicies.egress.deny.all.enabled | bool | `true` | create a NetworkPolicy that denies all outgoing traffic | +| networkPolicies.egress.deny.all.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | +| networkPolicies.enabled | bool | `false` | - create NetworkPolicy resources to limit the allowed traffic | +| networkPolicies.ingress.allow.openShift.ingressController.enabled | bool | `true` | create a NetworkPolicy that allows incoming traffic from the OpenShift Ingress Controller | +| networkPolicies.ingress.allow.openShift.ingressController.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | +| networkPolicies.ingress.allow.openShift.monitoring.enabled | bool | `true` | create a NetworkPolicy that allows incoming traffic from the OpenShift Monitoring | +| networkPolicies.ingress.allow.openShift.monitoring.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | +| networkPolicies.ingress.deny.all.enabled | bool | `true` | create a NetworkPolicy that denies all incoming traffic | +| networkPolicies.ingress.deny.all.podSelector | object | `{}` | define a PodSelector that should be used. Uses all Pods by default | +| networkPolicies.openShift.enabled | bool | `false` | enabled the creation of NetworkPolicies for OpenShift like Ingress and Monitoring | +| resourceQuotas | object | `{"additionalAnnotations":{},"additionalLabels":{},"enabled":false,"quotas":[]}` | define a list of ResourceQuotas that should be created | +| resourceQuotas.additionalAnnotations | object | `{}` | Annotations to be added to the LimitRange | +| resourceQuotas.additionalLabels | object | `{}` | Labels to be added to the LimitRange | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/typo3/README.md b/charts/typo3/README.md index 6909b122..daad5f32 100644 --- a/charts/typo3/README.md +++ b/charts/typo3/README.md @@ -44,77 +44,77 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| ------------------------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| externalDatabase.auth.database | string | `"typo3"` | Name of the database to use | -| externalDatabase.auth.existingSecret | string | `""` | Name of existing secret to use for database credentials | -| externalDatabase.auth.password | string | `"typo3"` | Password to use | -| externalDatabase.auth.userPasswordKey | string | `""` | Key in the secret containing the password | -| externalDatabase.auth.username | string | `"typo3"` | Name of the user to use | -| externalDatabase.hostname | string | `""` | Hostname of the database | -| externalDatabase.port | int | `3306` | Port used to connect to database | -| externalDatabase.type | string | `"mysql"` | Type of database | -| fullnameOverride | string | `""` | String to fully override `"typo3.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.repository | string | `"martinhelmich/typo3"` | image repository | -| image.tag | string | `"12.4"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| mariadb.auth.database | string | `"typo3"` | Name for a custom database to create | -| mariadb.auth.existingSecret | string | `""` | Name of existing secret to use for MariaDB credentials | -| mariadb.auth.password | string | `"typo3"` | Password for the custom user to create. Ignored if mariadb.auth.existingSecret is provided | -| mariadb.auth.username | string | `"typo3"` | Name for a custom user to create | -| mariadb.enabled | bool | `false` | enable MariaDB™ subchart from Bitnami | -| mysql.auth.database | string | `"typo3"` | Name for a custom database to create | -| mysql.auth.existingSecret | string | `""` | Name of existing secret to use for MySQL credentials | -| mysql.auth.password | string | `"typo3"` | Password for the custom user to create. Ignored if mysql.auth.existingSecret is provided | -| mysql.auth.username | string | `"typo3"` | Name for a custom user to create | -| mysql.enabled | bool | `true` | enable MySQL™ subchart from Bitnami | -| mysql.primary.configuration | string | `"[mysqld]\ndefault_authentication_plugin=mysql_native_password\nskip-name-resolve\nexplicit_defaults_for_timestamp\nbasedir=/opt/bitnami/mysql\nplugin_dir=/opt/bitnami/mysql/lib/plugin\nport=3306\nsocket=/opt/bitnami/mysql/tmp/mysql.sock\ndatadir=/bitnami/mysql/data\ntmpdir=/opt/bitnami/mysql/tmp\nmax_allowed_packet=16M\nbind-address=0.0.0.0\npid-file=/opt/bitnami/mysql/tmp/mysqld.pid\nlog-error=/opt/bitnami/mysql/logs/mysqld.log\ncharacter-set-server=utf8mb4\ncollation-server=utf8mb4_unicode_ci\nslow_query_log=0\nslow_query_log_file=/opt/bitnami/mysql/logs/mysqld.log\nlong_query_time=10.0\n\n[client]\nport=3306\nsocket=/opt/bitnami/mysql/tmp/mysql.sock\ndefault-character-set=utf8mb4\nplugin_dir=/opt/bitnami/mysql/lib/plugin\n\n[manager]\nport=3306\nsocket=/opt/bitnami/mysql/tmp/mysql.sock\npid-file=/opt/bitnami/mysql/tmp/mysqld.pid"` | | -| mysql.primary.extraEnvVars[0].name | string | `"TZ"` | | -| mysql.primary.extraEnvVars[0].value | string | `"Europe/Berlin"` | | -| nameOverride | string | `""` | Provide a name in place of `typo3` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| persistence.fileadmin.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | -| persistence.fileadmin.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | -| persistence.fileadmin.enabled | bool | `false` | use a PVC to persist fileadmin data | -| persistence.fileadmin.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | -| persistence.fileadmin.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | -| persistence.fileadmin.storageClassName | string | `""` | Name of the StorageClass required by the claim. | -| persistence.typo3conf.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | -| persistence.typo3conf.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | -| persistence.typo3conf.enabled | bool | `false` | use a PVC to persist typo3conf data | -| persistence.typo3conf.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | -| persistence.typo3conf.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | -| persistence.typo3conf.storageClassName | string | `""` | Name of the StorageClass required by the claim. | -| podAnnotations | object | `{}` | Annotations to be added to exporter pods | -| podSecurityContext | object | `{}` | pod-level security context | -| postgresql.auth.database | string | `"typo3"` | Name for a custom database to create | -| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | -| postgresql.auth.password | string | `"typo3"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | -| postgresql.auth.username | string | `"typo3"` | Name for a custom user to create | -| postgresql.enabled | bool | `false` | enable PostgreSQL™ subchart from Bitnami | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the headwind pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{}` | container-level security context | -| service.port | int | `8080` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| externalDatabase.auth.database | string | `"typo3"` | Name of the database to use | +| externalDatabase.auth.existingSecret | string | `""` | Name of existing secret to use for database credentials | +| externalDatabase.auth.password | string | `"typo3"` | Password to use | +| externalDatabase.auth.userPasswordKey | string | `""` | Key in the secret containing the password | +| externalDatabase.auth.username | string | `"typo3"` | Name of the user to use | +| externalDatabase.hostname | string | `""` | Hostname of the database | +| externalDatabase.port | int | `3306` | Port used to connect to database | +| externalDatabase.type | string | `"mysql"` | Type of database | +| fullnameOverride | string | `""` | String to fully override `"typo3.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.repository | string | `"martinhelmich/typo3"` | image repository | +| image.tag | string | `"12.4"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| mariadb.auth.database | string | `"typo3"` | Name for a custom database to create | +| mariadb.auth.existingSecret | string | `""` | Name of existing secret to use for MariaDB credentials | +| mariadb.auth.password | string | `"typo3"` | Password for the custom user to create. Ignored if mariadb.auth.existingSecret is provided | +| mariadb.auth.username | string | `"typo3"` | Name for a custom user to create | +| mariadb.enabled | bool | `false` | enable MariaDB™ subchart from Bitnami | +| mysql.auth.database | string | `"typo3"` | Name for a custom database to create | +| mysql.auth.existingSecret | string | `""` | Name of existing secret to use for MySQL credentials | +| mysql.auth.password | string | `"typo3"` | Password for the custom user to create. Ignored if mysql.auth.existingSecret is provided | +| mysql.auth.username | string | `"typo3"` | Name for a custom user to create | +| mysql.enabled | bool | `true` | enable MySQL™ subchart from Bitnami | +| mysql.primary.configuration | string | `"[mysqld]\ndefault_authentication_plugin=mysql_native_password\nskip-name-resolve\nexplicit_defaults_for_timestamp\nbasedir=/opt/bitnami/mysql\nplugin_dir=/opt/bitnami/mysql/lib/plugin\nport=3306\nsocket=/opt/bitnami/mysql/tmp/mysql.sock\ndatadir=/bitnami/mysql/data\ntmpdir=/opt/bitnami/mysql/tmp\nmax_allowed_packet=16M\nbind-address=0.0.0.0\npid-file=/opt/bitnami/mysql/tmp/mysqld.pid\nlog-error=/opt/bitnami/mysql/logs/mysqld.log\ncharacter-set-server=utf8mb4\ncollation-server=utf8mb4_unicode_ci\nslow_query_log=0\nslow_query_log_file=/opt/bitnami/mysql/logs/mysqld.log\nlong_query_time=10.0\n\n[client]\nport=3306\nsocket=/opt/bitnami/mysql/tmp/mysql.sock\ndefault-character-set=utf8mb4\nplugin_dir=/opt/bitnami/mysql/lib/plugin\n\n[manager]\nport=3306\nsocket=/opt/bitnami/mysql/tmp/mysql.sock\npid-file=/opt/bitnami/mysql/tmp/mysqld.pid"` | | +| mysql.primary.extraEnvVars[0].name | string | `"TZ"` | | +| mysql.primary.extraEnvVars[0].value | string | `"Europe/Berlin"` | | +| nameOverride | string | `""` | Provide a name in place of `typo3` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| persistence.fileadmin.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | +| persistence.fileadmin.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | +| persistence.fileadmin.enabled | bool | `false` | use a PVC to persist fileadmin data | +| persistence.fileadmin.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | +| persistence.fileadmin.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | +| persistence.fileadmin.storageClassName | string | `""` | Name of the StorageClass required by the claim. | +| persistence.typo3conf.accessModes | list | `["ReadWriteOnce"]` | the desired access modes the volume should have. | +| persistence.typo3conf.annotations | object | `{}` | Annotations to be added to the PersistentVolumeClaim | +| persistence.typo3conf.enabled | bool | `false` | use a PVC to persist typo3conf data | +| persistence.typo3conf.existingClaim | string | `""` | provide an existing PersistentVolumeClaim | +| persistence.typo3conf.resources | object | `{}` | represents the minimum and maximum resources the volume should have. | +| persistence.typo3conf.storageClassName | string | `""` | Name of the StorageClass required by the claim. | +| podAnnotations | object | `{}` | Annotations to be added to exporter pods | +| podSecurityContext | object | `{}` | pod-level security context | +| postgresql.auth.database | string | `"typo3"` | Name for a custom database to create | +| postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | +| postgresql.auth.password | string | `"typo3"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | +| postgresql.auth.username | string | `"typo3"` | Name for a custom user to create | +| postgresql.enabled | bool | `false` | enable PostgreSQL™ subchart from Bitnami | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the headwind pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{}` | container-level security context | +| service.port | int | `8080` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. diff --git a/charts/umami/README.md b/charts/umami/README.md index 44b751be..2d727e64 100644 --- a/charts/umami/README.md +++ b/charts/umami/README.md @@ -46,78 +46,78 @@ The command removes all the Kubernetes components associated with the chart and ## Values -| Key | Type | Default | Description | -| --------------------------------------------- | ------ | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| affinity | object | `{}` | Affinity settings for pod assignment | -| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | -| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | -| autoscaling.minReplicas | int | `1` | Minimum number of replicas | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | -| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | -| database.databaseUrlKey | string | `""` | Key in the existing secret containing the database url | -| database.existingSecret | string | `""` | use an existing secret containing the database url. If none given, we will generate the database url by using the other values. The password for the database has to be set using `.Values.postgresql.auth.password`, `.Values.mysql.auth.password` or `.Values.externalDatabase.auth.password`. | -| externalDatabase.auth.database | string | `"mychart"` | Name of the database to use | -| externalDatabase.auth.password | string | `"mychart"` | Password to use | -| externalDatabase.auth.username | string | `"mychart"` | Name of the user to use | -| externalDatabase.hostname | string | `""` | Hostname of the database | -| externalDatabase.port | int | `5432` | Port used to connect to database | -| externalDatabase.type | string | `"postgresql"` | Type of database | -| extraEnv | list | `[]` | additional environment variables to be added to the pods. See https://umami.is/docs/environment-variables for a complete list of available variables. Most variables can be set under umami as well. | -| fullnameOverride | string | `""` | String to fully override `"umami.fullname"` | -| image.pullPolicy | string | `"Always"` | image pull policy | -| image.registry | string | `"ghcr.io"` | image registry | -| image.repository | string | `"umami-software/umami"` | image repository | -| image.tag | string | `"postgresql-v2.9.0"` | Overrides the image tag | -| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | -| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | -| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | -| ingress.enabled | bool | `false` | Enable ingress record generation | -| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with hosts and paths | -| ingress.tls | list | `[]` | An array with the tls configuration | -| mysql.auth.database | string | `"mychart"` | Name for a custom database to create | -| mysql.auth.password | string | `"mychart"` | Password for the custom user to create | -| mysql.auth.username | string | `"mychart"` | Name for a custom user to create | -| mysql.enabled | bool | `false` | enable MySQL™ subchart from Bitnami | -| nameOverride | string | `""` | Provide a name in place of `umami` | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| podAnnotations | object | `{}` | Annotations to be added to pods | -| podLabels | object | `{}` | Labels to be added to pods | -| podSecurityContext | object | `{}` | pod-level security context | -| postgresql.auth.database | string | `"mychart"` | Name for a custom database to create | -| postgresql.auth.password | string | `"mychart"` | Password for the custom user to create | -| postgresql.auth.username | string | `"mychart"` | Name for a custom user to create | -| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | -| replicaCount | int | `1` | Number of replicas | -| resources | object | `{}` | Resource limits and requests for the controller pods. | -| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | -| securityContext | object | `{"runAsGroup":65533,"runAsNonRoot":true,"runAsUser":1001}` | container-level security context | -| service.port | int | `3000` | Kubernetes port where service is exposed | -| service.type | string | `"ClusterIP"` | Kubernetes service type | -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | Toleration labels for pod assignment | -| umami.appSecret.existingSecret | string | `""` | Name of an existing secret containing the app secret under the key app-secret. | -| umami.appSecret.secret | string | `""` | A random string used to generate unique values. | -| umami.clientIpHeader | string | `""` | HTTP header to check for the client's IP address. This is useful when you're behind a proxy that uses non-standard headers. | -| umami.cloudMode | string | `"1"` | Disables users, teams, and websites settings page. | -| umami.collectApiEndpoint | string | `""` | Allows you to send metrics to a location different than the default `/api/send`. This is to help you avoid some ad-blockers. | -| umami.corsMaxAge | string | `"86400"` | How many seconds a CORS preflight should last. Default is 24 hours. | -| umami.debug | string | `""` | Console logging for specific areas of the application. Values include `umami:auth`, `umami:clickhouse`, `umami:kafka`, `umami:middleware`, and `umami:prisma`. | -| umami.disableBotCheck | string | `"1"` | By default bots are excluded from statistics. This disables checking for bots. | -| umami.disableLogin | string | `"1"` | Disables the login page for the application | -| umami.disableTelemetry | string | `"1"` | Umami collects completely anonymous telemetry data in order help improve the application. You can choose to disable this if you don't want to participate. | -| umami.disableUpdates | string | `"1"` | Disables the check for new versions of Umami | -| umami.enableTestConsole | string | `"1"` | Enables the internal test page, {host}/console. Admin access is required. Users can manually fire pageviews and events to their websites. | -| umami.forceSSL | string | `"1"` | This will redirect all requests from http to https in the Umami application. Note, this does not apply to the tracking script. | -| umami.hostname | string | `"0.0.0.0"` | hostname under which Umami will be reached | -| umami.ignoreHostname | string | `""` | This will do a DNS lookup on a hostname and the resulting IP address will be ignored. This can be a comma delimited list of hostnames. | -| umami.ignoredIpAddresses | string | `""` | You can provide a comma-delimited list of IP address to exclude from data collection. | -| umami.logQuery | string | `"1"` | If you are running in development mode, this will log database queries to the console for debugging. | -| umami.migration.v1v2.enabled | bool | `false` | enable a job that migrates database structure from v1 to v2 | -| umami.removeDisableLoginEnv | bool | `true` | setting this to true removes the environment variable DISABLE_LOGIN defined in `umami.disableLogin` from the deployment as this caused errors in some setups | -| umami.removeTrailingSlash | string | `"1"` | Removes the trailing slash from all incoming urls. | -| umami.trackerScriptName | string | `"umami"` | Allows you to assign a custom name to the tracker script different from the default umami. This is to help you avoid some ad-blockers. | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment | +| autoscaling.enabled | bool | `false` | Enable Horizontal POD autoscaling | +| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | +| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target Memory utilization percentage | +| database.databaseUrlKey | string | `""` | Key in the existing secret containing the database url | +| database.existingSecret | string | `""` | use an existing secret containing the database url. If none given, we will generate the database url by using the other values. The password for the database has to be set using `.Values.postgresql.auth.password`, `.Values.mysql.auth.password` or `.Values.externalDatabase.auth.password`. | +| externalDatabase.auth.database | string | `"mychart"` | Name of the database to use | +| externalDatabase.auth.password | string | `"mychart"` | Password to use | +| externalDatabase.auth.username | string | `"mychart"` | Name of the user to use | +| externalDatabase.hostname | string | `""` | Hostname of the database | +| externalDatabase.port | int | `5432` | Port used to connect to database | +| externalDatabase.type | string | `"postgresql"` | Type of database | +| extraEnv | list | `[]` | additional environment variables to be added to the pods. See https://umami.is/docs/environment-variables for a complete list of available variables. Most variables can be set under umami as well. | +| fullnameOverride | string | `""` | String to fully override `"umami.fullname"` | +| image.pullPolicy | string | `"Always"` | image pull policy | +| image.registry | string | `"ghcr.io"` | image registry | +| image.repository | string | `"umami-software/umami"` | image repository | +| image.tag | string | `"postgresql-v2.9.0"` | Overrides the image tag | +| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. | +| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource | +| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress | +| ingress.enabled | bool | `false` | Enable ingress record generation | +| ingress.hosts | list | see [values.yaml](./values.yaml) | An array with hosts and paths | +| ingress.tls | list | `[]` | An array with the tls configuration | +| mysql.auth.database | string | `"mychart"` | Name for a custom database to create | +| mysql.auth.password | string | `"mychart"` | Password for the custom user to create | +| mysql.auth.username | string | `"mychart"` | Name for a custom user to create | +| mysql.enabled | bool | `false` | enable MySQL™ subchart from Bitnami | +| nameOverride | string | `""` | Provide a name in place of `umami` | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| podAnnotations | object | `{}` | Annotations to be added to pods | +| podLabels | object | `{}` | Labels to be added to pods | +| podSecurityContext | object | `{}` | pod-level security context | +| postgresql.auth.database | string | `"mychart"` | Name for a custom database to create | +| postgresql.auth.password | string | `"mychart"` | Password for the custom user to create | +| postgresql.auth.username | string | `"mychart"` | Name for a custom user to create | +| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | +| replicaCount | int | `1` | Number of replicas | +| resources | object | `{}` | Resource limits and requests for the controller pods. | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | +| securityContext | object | `{"runAsGroup":65533,"runAsNonRoot":true,"runAsUser":1001}` | container-level security context | +| service.port | int | `3000` | Kubernetes port where service is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | Toleration labels for pod assignment | +| umami.appSecret.existingSecret | string | `""` | Name of an existing secret containing the app secret under the key app-secret. | +| umami.appSecret.secret | string | `""` | A random string used to generate unique values. | +| umami.clientIpHeader | string | `""` | HTTP header to check for the client's IP address. This is useful when you're behind a proxy that uses non-standard headers. | +| umami.cloudMode | string | `"1"` | Disables users, teams, and websites settings page. | +| umami.collectApiEndpoint | string | `""` | Allows you to send metrics to a location different than the default `/api/send`. This is to help you avoid some ad-blockers. | +| umami.corsMaxAge | string | `"86400"` | How many seconds a CORS preflight should last. Default is 24 hours. | +| umami.debug | string | `""` | Console logging for specific areas of the application. Values include `umami:auth`, `umami:clickhouse`, `umami:kafka`, `umami:middleware`, and `umami:prisma`. | +| umami.disableBotCheck | string | `"1"` | By default bots are excluded from statistics. This disables checking for bots. | +| umami.disableLogin | string | `"1"` | Disables the login page for the application | +| umami.disableTelemetry | string | `"1"` | Umami collects completely anonymous telemetry data in order help improve the application. You can choose to disable this if you don't want to participate. | +| umami.disableUpdates | string | `"1"` | Disables the check for new versions of Umami | +| umami.enableTestConsole | string | `"1"` | Enables the internal test page, {host}/console. Admin access is required. Users can manually fire pageviews and events to their websites. | +| umami.forceSSL | string | `"1"` | This will redirect all requests from http to https in the Umami application. Note, this does not apply to the tracking script. | +| umami.hostname | string | `"0.0.0.0"` | hostname under which Umami will be reached | +| umami.ignoreHostname | string | `""` | This will do a DNS lookup on a hostname and the resulting IP address will be ignored. This can be a comma delimited list of hostnames. | +| umami.ignoredIpAddresses | string | `""` | You can provide a comma-delimited list of IP address to exclude from data collection. | +| umami.logQuery | string | `"1"` | If you are running in development mode, this will log database queries to the console for debugging. | +| umami.migration.v1v2.enabled | bool | `false` | enable a job that migrates database structure from v1 to v2 | +| umami.removeDisableLoginEnv | bool | `true` | setting this to true removes the environment variable DISABLE_LOGIN defined in `umami.disableLogin` from the deployment as this caused errors in some setups | +| umami.removeTrailingSlash | string | `"1"` | Removes the trailing slash from all incoming urls. | +| umami.trackerScriptName | string | `"umami"` | Allows you to assign a custom name to the tracker script different from the default umami. This is to help you avoid some ad-blockers. | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.