Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-04-02 07:17:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/*] Standardize documentation (#19835)

Browse Source 
Signed-off-by: Jota Martos <jotamartos@vmware.com>
This commit is contained in:
Juan José Martos
2023-10-20 08:18:30 +02:00
committed by GitHub
parent 3e0672c0ad
commit af5f7530c1
216 changed files with 14699 additions and 13690 deletions
Download Patch File Download Diff File Expand all files Collapse all files

378
bitnami/jupyterhub/README.md
View File

@@ -11,9 +11,11 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/jupyterhub
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/jupyterhub
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
## Introduction
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
@@ -37,9 +39,11 @@ Looking to use JupyterHub in production? Try [VMware Application Catalog](https:
To install the chart with the release name `my-release`:
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/jupyterhub
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/jupyterhub
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
These commands deploy JupyterHub on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list`
@@ -81,79 +85,79 @@ The command removes all the Kubernetes components associated with the chart and
### Hub deployment parameters
| Name | Description | Value |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------- |
| `hub.image.registry` | Hub image registry | `docker.io` |
| `hub.image.repository` | Hub image repository | `bitnami/jupyterhub` |
| `hub.image.tag` | Hub image tag (immutable tags are recommended) | `4.0.2-debian-11-r55` |
| `hub.image.digest` | Hub image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `hub.image.pullPolicy` | Hub image pull policy | `IfNotPresent` |
| `hub.image.pullSecrets` | Hub image pull secrets | `[]` |
| `hub.baseUrl` | Hub base URL | `/` |
| `hub.adminUser` | Hub Dummy authenticator admin user | `user` |
| `hub.password` | Hub Dummy authenticator password | `""` |
| `hub.configuration` | Hub configuration file (to be used by jupyterhub_config.py) | `""` |
| `hub.existingConfigmap` | Configmap with Hub init scripts (replaces the scripts in templates/hub/configmap.yml) | `""` |
| `hub.existingSecret` | Secret with hub configuration (replaces the hub.configuration value) and proxy token | `""` |
| `hub.command` | Override Hub default command | `[]` |
| `hub.args` | Override Hub default args | `[]` |
| `hub.extraEnvVars` | Add extra environment variables to the Hub container | `[]` |
| `hub.extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars | `""` |
| `hub.extraEnvVarsSecret` | Name of existing Secret containing extra env vars | `""` |
| `hub.containerPorts.http` | Hub container port | `8081` |
| `hub.startupProbe.enabled` | Enable startupProbe on Hub containers | `true` |
| `hub.startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `10` |
| `hub.startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `hub.startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `3` |
| `hub.startupProbe.failureThreshold` | Failure threshold for startupProbe | `30` |
| `hub.startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `hub.livenessProbe.enabled` | Enable livenessProbe on Hub containers | `true` |
| `hub.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `10` |
| `hub.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `hub.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `3` |
| `hub.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `30` |
| `hub.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `hub.readinessProbe.enabled` | Enable readinessProbe on Hub containers | `true` |
| `hub.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `10` |
| `hub.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `hub.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `3` |
| `hub.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `30` |
| `hub.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `hub.customStartupProbe` | Override default startup probe | `{}` |
| `hub.customLivenessProbe` | Override default liveness probe | `{}` |
| `hub.customReadinessProbe` | Override default readiness probe | `{}` |
| `hub.resources.limits` | The resources limits for the Hub containers | `{}` |
| `hub.resources.requests` | The requested resources for the Hub containers | `{}` |
| `hub.containerSecurityContext.enabled` | Enabled Hub containers' Security Context | `true` |
| `hub.containerSecurityContext.runAsUser` | Set Hub container's Security Context runAsUser | `1000` |
| `hub.containerSecurityContext.runAsNonRoot` | Set Hub container's Security Context runAsNonRoot | `true` |
| `hub.podSecurityContext.enabled` | Enabled Hub pods' Security Context | `true` |
| `hub.podSecurityContext.fsGroup` | Set Hub pod's Security Context fsGroup | `1001` |
| `hub.lifecycleHooks` | LifecycleHooks for the Hub container to automate configuration before or after startup | `{}` |
| `hub.hostAliases` | Add deployment host aliases | `[]` |
| `hub.podLabels` | Add extra labels to the Hub pods | `{}` |
| `hub.podAnnotations` | Add extra annotations to the Hub pods | `{}` |
| `hub.podAffinityPreset` | Pod affinity preset. Ignored if `hub.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `hub.podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `hub.affinity` is set. Allowed values: `soft` or `hard` | `soft` |
| `hub.nodeAffinityPreset.type` | Node affinity preset type. Ignored if `hub.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `hub.nodeAffinityPreset.key` | Node label key to match. Ignored if `hub.affinity` is set | `""` |
| `hub.nodeAffinityPreset.values` | Node label values to match. Ignored if `hub.affinity` is set | `[]` |
| `hub.affinity` | Affinity for pod assignment. | `{}` |
| `hub.nodeSelector` | Node labels for pod assignment. | `{}` |
| `hub.tolerations` | Tolerations for pod assignment. | `[]` |
| `hub.topologySpreadConstraints` | Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template | `[]` |
| `hub.priorityClassName` | Priority Class Name | `""` |
| `hub.schedulerName` | Use an alternate scheduler, e.g. "stork". | `""` |
| `hub.terminationGracePeriodSeconds` | Seconds Hub pod needs to terminate gracefully | `""` |
| `hub.updateStrategy.type` | Update strategy - only really applicable for deployments with RWO PVs attached | `RollingUpdate` |
| `hub.updateStrategy.rollingUpdate` | Hub deployment rolling update configuration parameters | `{}` |
| `hub.extraVolumes` | Optionally specify extra list of additional volumes for Hub pods | `[]` |
| `hub.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for Hub container(s) | `[]` |
| `hub.initContainers` | Add additional init containers to the Hub pods | `[]` |
| `hub.sidecars` | Add additional sidecar containers to the Hub pod | `[]` |
| `hub.pdb.create` | Deploy Hub PodDisruptionBudget | `false` |
| `hub.pdb.minAvailable` | Set minimum available hub instances | `""` |
| `hub.pdb.maxUnavailable` | Set maximum available hub instances | `""` |
| Name | Description | Value |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------- |
| `hub.image.registry` | Hub image registry | `REGISTRY_NAME` |
| `hub.image.repository` | Hub image repository | `REPOSITORY_NAME/jupyterhub` |
| `hub.image.tag` | Hub image tag (immutable tags are recommended) | `4.0.2-debian-11-r55` |
| `hub.image.digest` | Hub image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `hub.image.pullPolicy` | Hub image pull policy | `IfNotPresent` |
| `hub.image.pullSecrets` | Hub image pull secrets | `[]` |
| `hub.baseUrl` | Hub base URL | `/` |
| `hub.adminUser` | Hub Dummy authenticator admin user | `user` |
| `hub.password` | Hub Dummy authenticator password | `""` |
| `hub.configuration` | Hub configuration file (to be used by jupyterhub_config.py) | `""` |
| `hub.existingConfigmap` | Configmap with Hub init scripts (replaces the scripts in templates/hub/configmap.yml) | `""` |
| `hub.existingSecret` | Secret with hub configuration (replaces the hub.configuration value) and proxy token | `""` |
| `hub.command` | Override Hub default command | `[]` |
| `hub.args` | Override Hub default args | `[]` |
| `hub.extraEnvVars` | Add extra environment variables to the Hub container | `[]` |
| `hub.extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars | `""` |
| `hub.extraEnvVarsSecret` | Name of existing Secret containing extra env vars | `""` |
| `hub.containerPorts.http` | Hub container port | `8081` |
| `hub.startupProbe.enabled` | Enable startupProbe on Hub containers | `true` |
| `hub.startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `10` |
| `hub.startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `hub.startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `3` |
| `hub.startupProbe.failureThreshold` | Failure threshold for startupProbe | `30` |
| `hub.startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `hub.livenessProbe.enabled` | Enable livenessProbe on Hub containers | `true` |
| `hub.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `10` |
| `hub.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `hub.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `3` |
| `hub.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `30` |
| `hub.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `hub.readinessProbe.enabled` | Enable readinessProbe on Hub containers | `true` |
| `hub.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `10` |
| `hub.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `hub.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `3` |
| `hub.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `30` |
| `hub.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `hub.customStartupProbe` | Override default startup probe | `{}` |
| `hub.customLivenessProbe` | Override default liveness probe | `{}` |
| `hub.customReadinessProbe` | Override default readiness probe | `{}` |
| `hub.resources.limits` | The resources limits for the Hub containers | `{}` |
| `hub.resources.requests` | The requested resources for the Hub containers | `{}` |
| `hub.containerSecurityContext.enabled` | Enabled Hub containers' Security Context | `true` |
| `hub.containerSecurityContext.runAsUser` | Set Hub container's Security Context runAsUser | `1000` |
| `hub.containerSecurityContext.runAsNonRoot` | Set Hub container's Security Context runAsNonRoot | `true` |
| `hub.podSecurityContext.enabled` | Enabled Hub pods' Security Context | `true` |
| `hub.podSecurityContext.fsGroup` | Set Hub pod's Security Context fsGroup | `1001` |
| `hub.lifecycleHooks` | LifecycleHooks for the Hub container to automate configuration before or after startup | `{}` |
| `hub.hostAliases` | Add deployment host aliases | `[]` |
| `hub.podLabels` | Add extra labels to the Hub pods | `{}` |
| `hub.podAnnotations` | Add extra annotations to the Hub pods | `{}` |
| `hub.podAffinityPreset` | Pod affinity preset. Ignored if `hub.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `hub.podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `hub.affinity` is set. Allowed values: `soft` or `hard` | `soft` |
| `hub.nodeAffinityPreset.type` | Node affinity preset type. Ignored if `hub.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `hub.nodeAffinityPreset.key` | Node label key to match. Ignored if `hub.affinity` is set | `""` |
| `hub.nodeAffinityPreset.values` | Node label values to match. Ignored if `hub.affinity` is set | `[]` |
| `hub.affinity` | Affinity for pod assignment. | `{}` |
| `hub.nodeSelector` | Node labels for pod assignment. | `{}` |
| `hub.tolerations` | Tolerations for pod assignment. | `[]` |
| `hub.topologySpreadConstraints` | Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template | `[]` |
| `hub.priorityClassName` | Priority Class Name | `""` |
| `hub.schedulerName` | Use an alternate scheduler, e.g. "stork". | `""` |
| `hub.terminationGracePeriodSeconds` | Seconds Hub pod needs to terminate gracefully | `""` |
| `hub.updateStrategy.type` | Update strategy - only really applicable for deployments with RWO PVs attached | `RollingUpdate` |
| `hub.updateStrategy.rollingUpdate` | Hub deployment rolling update configuration parameters | `{}` |
| `hub.extraVolumes` | Optionally specify extra list of additional volumes for Hub pods | `[]` |
| `hub.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for Hub container(s) | `[]` |
| `hub.initContainers` | Add additional init containers to the Hub pods | `[]` |
| `hub.sidecars` | Add additional sidecar containers to the Hub pod | `[]` |
| `hub.pdb.create` | Deploy Hub PodDisruptionBudget | `false` |
| `hub.pdb.minAvailable` | Set minimum available hub instances | `""` |
| `hub.pdb.maxUnavailable` | Set maximum available hub instances | `""` |
### Hub RBAC parameters
@@ -205,77 +209,77 @@ The command removes all the Kubernetes components associated with the chart and
### Proxy deployment parameters
| Name | Description | Value |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
| `proxy.image.registry` | Proxy image registry | `docker.io` |
| `proxy.image.repository` | Proxy image repository | `bitnami/configurable-http-proxy` |
| `proxy.image.tag` | Proxy image tag (immutable tags are recommended) | `4.6.0-debian-11-r16` |
| `proxy.image.digest` | Proxy image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `proxy.image.pullPolicy` | Proxy image pull policy | `IfNotPresent` |
| `proxy.image.pullSecrets` | Proxy image pull secrets | `[]` |
| `proxy.image.debug` | Activate verbose output | `false` |
| `proxy.secretToken` | Proxy secret token (used for communication with the Hub) | `""` |
| `proxy.command` | Override Proxy default command | `[]` |
| `proxy.args` | Override Proxy default args | `[]` |
| `proxy.extraEnvVars` | Add extra environment variables to the Proxy container | `[]` |
| `proxy.extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars | `""` |
| `proxy.extraEnvVarsSecret` | Name of existing Secret containing extra env vars | `""` |
| `proxy.containerPort.api` | Proxy api container port | `8001` |
| `proxy.containerPort.metrics` | Proxy metrics container port | `8002` |
| `proxy.containerPort.http` | Proxy http container port | `8000` |
| `proxy.startupProbe.enabled` | Enable startupProbe on Proxy containers | `true` |
| `proxy.startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `10` |
| `proxy.startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `proxy.startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `3` |
| `proxy.startupProbe.failureThreshold` | Failure threshold for startupProbe | `30` |
| `proxy.startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `proxy.livenessProbe.enabled` | Enable livenessProbe on Proxy containers | `true` |
| `proxy.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `10` |
| `proxy.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `proxy.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `3` |
| `proxy.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `30` |
| `proxy.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `proxy.readinessProbe.enabled` | Enable readinessProbe on Proxy containers | `true` |
| `proxy.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `10` |
| `proxy.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `proxy.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `3` |
| `proxy.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `30` |
| `proxy.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `proxy.customStartupProbe` | Override default startup probe | `{}` |
| `proxy.customLivenessProbe` | Override default liveness probe | `{}` |
| `proxy.customReadinessProbe` | Override default readiness probe | `{}` |
| `proxy.resources.limits` | The resources limits for the Proxy containers | `{}` |
| `proxy.resources.requests` | The requested resources for the Proxy containers | `{}` |
| `proxy.containerSecurityContext.enabled` | Enabled Proxy containers' Security Context | `true` |
| `proxy.containerSecurityContext.runAsUser` | Set Proxy container's Security Context runAsUser | `1001` |
| `proxy.containerSecurityContext.runAsNonRoot` | Set Proxy container's Security Context runAsNonRoot | `true` |
| `proxy.podSecurityContext.enabled` | Enabled Proxy pods' Security Context | `true` |
| `proxy.podSecurityContext.fsGroup` | Set Proxy pod's Security Context fsGroup | `1001` |
| `proxy.lifecycleHooks` | Add lifecycle hooks to the Proxy deployment | `{}` |
| `proxy.hostAliases` | Add deployment host aliases | `[]` |
| `proxy.podLabels` | Add extra labels to the Proxy pods | `{}` |
| `proxy.podAnnotations` | Add extra annotations to the Proxy pods | `{}` |
| `proxy.podAffinityPreset` | Pod affinity preset. Ignored if `proxy.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `proxy.podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `proxy.affinity` is set. Allowed values: `soft` or `hard` | `soft` |
| `proxy.nodeAffinityPreset.type` | Node affinity preset type. Ignored if `proxy.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `proxy.nodeAffinityPreset.key` | Node label key to match. Ignored if `proxy.affinity` is set | `""` |
| `proxy.nodeAffinityPreset.values` | Node label values to match. Ignored if `proxy.affinity` is set | `[]` |
| `proxy.affinity` | Affinity for pod assignment. Evaluated as a template. | `{}` |
| `proxy.nodeSelector` | Node labels for pod assignment. Evaluated as a template. | `{}` |
| `proxy.tolerations` | Tolerations for pod assignment. Evaluated as a template. | `[]` |
| `proxy.topologySpreadConstraints` | Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template | `[]` |
| `proxy.priorityClassName` | Priority Class Name | `""` |
| `proxy.schedulerName` | Use an alternate scheduler, e.g. "stork". | `""` |
| `proxy.terminationGracePeriodSeconds` | Seconds Proxy pod needs to terminate gracefully | `""` |
| `proxy.updateStrategy.type` | Update strategy - only really applicable for deployments with RWO PVs attached | `RollingUpdate` |
| `proxy.updateStrategy.rollingUpdate` | Proxy deployment rolling update configuration parameters | `{}` |
| `proxy.extraVolumes` | Optionally specify extra list of additional volumes for Proxy pods | `[]` |
| `proxy.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for Proxy container(s) | `[]` |
| `proxy.initContainers` | Add additional init containers to the Proxy pods | `[]` |
| `proxy.sidecars` | Add additional sidecar containers to the Proxy pod | `[]` |
| `proxy.pdb.create` | Deploy Proxy PodDisruptionBudget | `false` |
| `proxy.pdb.minAvailable` | Set minimum available proxy instances | `""` |
| `proxy.pdb.maxUnavailable` | Set maximum available proxy instances | `""` |
| Name | Description | Value |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- |
| `proxy.image.registry` | Proxy image registry | `REGISTRY_NAME` |
| `proxy.image.repository` | Proxy image repository | `REPOSITORY_NAME/configurable-http-proxy` |
| `proxy.image.tag` | Proxy image tag (immutable tags are recommended) | `4.6.0-debian-11-r16` |
| `proxy.image.digest` | Proxy image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `proxy.image.pullPolicy` | Proxy image pull policy | `IfNotPresent` |
| `proxy.image.pullSecrets` | Proxy image pull secrets | `[]` |
| `proxy.image.debug` | Activate verbose output | `false` |
| `proxy.secretToken` | Proxy secret token (used for communication with the Hub) | `""` |
| `proxy.command` | Override Proxy default command | `[]` |
| `proxy.args` | Override Proxy default args | `[]` |
| `proxy.extraEnvVars` | Add extra environment variables to the Proxy container | `[]` |
| `proxy.extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars | `""` |
| `proxy.extraEnvVarsSecret` | Name of existing Secret containing extra env vars | `""` |
| `proxy.containerPort.api` | Proxy api container port | `8001` |
| `proxy.containerPort.metrics` | Proxy metrics container port | `8002` |
| `proxy.containerPort.http` | Proxy http container port | `8000` |
| `proxy.startupProbe.enabled` | Enable startupProbe on Proxy containers | `true` |
| `proxy.startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `10` |
| `proxy.startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `proxy.startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `3` |
| `proxy.startupProbe.failureThreshold` | Failure threshold for startupProbe | `30` |
| `proxy.startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `proxy.livenessProbe.enabled` | Enable livenessProbe on Proxy containers | `true` |
| `proxy.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `10` |
| `proxy.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `proxy.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `3` |
| `proxy.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `30` |
| `proxy.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `proxy.readinessProbe.enabled` | Enable readinessProbe on Proxy containers | `true` |
| `proxy.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `10` |
| `proxy.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `proxy.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `3` |
| `proxy.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `30` |
| `proxy.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `proxy.customStartupProbe` | Override default startup probe | `{}` |
| `proxy.customLivenessProbe` | Override default liveness probe | `{}` |
| `proxy.customReadinessProbe` | Override default readiness probe | `{}` |
| `proxy.resources.limits` | The resources limits for the Proxy containers | `{}` |
| `proxy.resources.requests` | The requested resources for the Proxy containers | `{}` |
| `proxy.containerSecurityContext.enabled` | Enabled Proxy containers' Security Context | `true` |
| `proxy.containerSecurityContext.runAsUser` | Set Proxy container's Security Context runAsUser | `1001` |
| `proxy.containerSecurityContext.runAsNonRoot` | Set Proxy container's Security Context runAsNonRoot | `true` |
| `proxy.podSecurityContext.enabled` | Enabled Proxy pods' Security Context | `true` |
| `proxy.podSecurityContext.fsGroup` | Set Proxy pod's Security Context fsGroup | `1001` |
| `proxy.lifecycleHooks` | Add lifecycle hooks to the Proxy deployment | `{}` |
| `proxy.hostAliases` | Add deployment host aliases | `[]` |
| `proxy.podLabels` | Add extra labels to the Proxy pods | `{}` |
| `proxy.podAnnotations` | Add extra annotations to the Proxy pods | `{}` |
| `proxy.podAffinityPreset` | Pod affinity preset. Ignored if `proxy.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `proxy.podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `proxy.affinity` is set. Allowed values: `soft` or `hard` | `soft` |
| `proxy.nodeAffinityPreset.type` | Node affinity preset type. Ignored if `proxy.affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `proxy.nodeAffinityPreset.key` | Node label key to match. Ignored if `proxy.affinity` is set | `""` |
| `proxy.nodeAffinityPreset.values` | Node label values to match. Ignored if `proxy.affinity` is set | `[]` |
| `proxy.affinity` | Affinity for pod assignment. Evaluated as a template. | `{}` |
| `proxy.nodeSelector` | Node labels for pod assignment. Evaluated as a template. | `{}` |
| `proxy.tolerations` | Tolerations for pod assignment. Evaluated as a template. | `[]` |
| `proxy.topologySpreadConstraints` | Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template | `[]` |
| `proxy.priorityClassName` | Priority Class Name | `""` |
| `proxy.schedulerName` | Use an alternate scheduler, e.g. "stork". | `""` |
| `proxy.terminationGracePeriodSeconds` | Seconds Proxy pod needs to terminate gracefully | `""` |
| `proxy.updateStrategy.type` | Update strategy - only really applicable for deployments with RWO PVs attached | `RollingUpdate` |
| `proxy.updateStrategy.rollingUpdate` | Proxy deployment rolling update configuration parameters | `{}` |
| `proxy.extraVolumes` | Optionally specify extra list of additional volumes for Proxy pods | `[]` |
| `proxy.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for Proxy container(s) | `[]` |
| `proxy.initContainers` | Add additional init containers to the Proxy pods | `[]` |
| `proxy.sidecars` | Add additional sidecar containers to the Proxy pod | `[]` |
| `proxy.pdb.create` | Deploy Proxy PodDisruptionBudget | `false` |
| `proxy.pdb.minAvailable` | Set minimum available proxy instances | `""` |
| `proxy.pdb.maxUnavailable` | Set maximum available proxy instances | `""` |
### Proxy RBAC Parameters
@@ -403,35 +407,35 @@ The command removes all the Kubernetes components associated with the chart and
### Singleuser deployment parameters
| Name | Description | Value |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `singleuser.image.registry` | Single User image registry | `docker.io` |
| `singleuser.image.repository` | Single User image repository | `bitnami/jupyter-base-notebook` |
| `singleuser.image.tag` | Single User image tag (immutabe tags are recommended) | `4.0.2-debian-11-r55` |
| `singleuser.image.digest` | Single User image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `singleuser.image.pullPolicy` | Single User image pull policy | `IfNotPresent` |
| `singleuser.image.pullSecrets` | Single User image pull secrets | `[]` |
| `singleuser.notebookDir` | Notebook directory (it will be the same as the PVC volume mount) | `/opt/bitnami/jupyterhub-singleuser` |
| `singleuser.allowPrivilegeEscalation` | Controls whether a process can gain more privileges than its parent process | `false` |
| `singleuser.command` | Override Single User default command | `[]` |
| `singleuser.extraEnvVars` | Extra environment variables that should be set for the user pods | `[]` |
| `singleuser.containerPort` | Single User container port | `8888` |
| `singleuser.resources.limits` | The resources limits for the Singleuser containers | `{}` |
| `singleuser.resources.requests` | The requested resources for the Singleuser containers | `{}` |
| `singleuser.containerSecurityContext.enabled` | Enabled Single User containers' Security Context | `true` |
| `singleuser.containerSecurityContext.runAsUser` | Set Single User container's Security Context runAsUser | `1001` |
| `singleuser.podSecurityContext.enabled` | Enabled Single User pods' Security Context | `true` |
| `singleuser.podSecurityContext.fsGroup` | Set Single User pod's Security Context fsGroup | `1001` |
| `singleuser.podLabels` | Extra labels for Single User pods | `{}` |
| `singleuser.podAnnotations` | Annotations for Single User pods | `{}` |
| `singleuser.nodeSelector` | Node labels for pod assignment. Evaluated as a template. | `{}` |
| `singleuser.tolerations` | Tolerations for pod assignment. Evaluated as a template. | `[]` |
| `singleuser.priorityClassName` | Single User pod priority class name | `""` |
| `singleuser.lifecycleHooks` | Add lifecycle hooks to the Single User deployment to automate configuration before or after startup | `{}` |
| `singleuser.extraVolumes` | Optionally specify extra list of additional volumes for Single User pods | `[]` |
| `singleuser.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for Single User container(s) | `[]` |
| `singleuser.initContainers` | Add additional init containers to the Single User pods | `[]` |
| `singleuser.sidecars` | Add additional sidecar containers to the Single User pod | `[]` |
| Name | Description | Value |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| `singleuser.image.registry` | Single User image registry | `REGISTRY_NAME` |
| `singleuser.image.repository` | Single User image repository | `REPOSITORY_NAME/jupyter-base-notebook` |
| `singleuser.image.tag` | Single User image tag (immutabe tags are recommended) | `4.0.2-debian-11-r55` |
| `singleuser.image.digest` | Single User image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `singleuser.image.pullPolicy` | Single User image pull policy | `IfNotPresent` |
| `singleuser.image.pullSecrets` | Single User image pull secrets | `[]` |
| `singleuser.notebookDir` | Notebook directory (it will be the same as the PVC volume mount) | `/opt/bitnami/jupyterhub-singleuser` |
| `singleuser.allowPrivilegeEscalation` | Controls whether a process can gain more privileges than its parent process | `false` |
| `singleuser.command` | Override Single User default command | `[]` |
| `singleuser.extraEnvVars` | Extra environment variables that should be set for the user pods | `[]` |
| `singleuser.containerPort` | Single User container port | `8888` |
| `singleuser.resources.limits` | The resources limits for the Singleuser containers | `{}` |
| `singleuser.resources.requests` | The requested resources for the Singleuser containers | `{}` |
| `singleuser.containerSecurityContext.enabled` | Enabled Single User containers' Security Context | `true` |
| `singleuser.containerSecurityContext.runAsUser` | Set Single User container's Security Context runAsUser | `1001` |
| `singleuser.podSecurityContext.enabled` | Enabled Single User pods' Security Context | `true` |
| `singleuser.podSecurityContext.fsGroup` | Set Single User pod's Security Context fsGroup | `1001` |
| `singleuser.podLabels` | Extra labels for Single User pods | `{}` |
| `singleuser.podAnnotations` | Annotations for Single User pods | `{}` |
| `singleuser.nodeSelector` | Node labels for pod assignment. Evaluated as a template. | `{}` |
| `singleuser.tolerations` | Tolerations for pod assignment. Evaluated as a template. | `[]` |
| `singleuser.priorityClassName` | Single User pod priority class name | `""` |
| `singleuser.lifecycleHooks` | Add lifecycle hooks to the Single User deployment to automate configuration before or after startup | `{}` |
| `singleuser.extraVolumes` | Optionally specify extra list of additional volumes for Single User pods | `[]` |
| `singleuser.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for Single User container(s) | `[]` |
| `singleuser.initContainers` | Add additional init containers to the Single User pods | `[]` |
| `singleuser.sidecars` | Add additional sidecar containers to the Single User pod | `[]` |
### Single User RBAC parameters
@@ -463,14 +467,14 @@ The command removes all the Kubernetes components associated with the chart and
### Auxiliary image parameters
| Name | Description | Value |
| ---------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------ |
| `auxiliaryImage.registry` | Auxiliary image registry | `docker.io` |
| `auxiliaryImage.repository` | Auxiliary image repository | `bitnami/os-shell` |
| `auxiliaryImage.tag` | Auxiliary image tag (immutabe tags are recommended) | `11-debian-11-r90` |
| `auxiliaryImage.digest` | Auxiliary image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `auxiliaryImage.pullPolicy` | Auxiliary image pull policy | `IfNotPresent` |
| `auxiliaryImage.pullSecrets` | Auxiliary image pull secrets | `[]` |
| Name | Description | Value |
| ---------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------------- |
| `auxiliaryImage.registry` | Auxiliary image registry | `REGISTRY_NAME` |
| `auxiliaryImage.repository` | Auxiliary image repository | `REPOSITORY_NAME/os-shell` |
| `auxiliaryImage.tag` | Auxiliary image tag (immutabe tags are recommended) | `11-debian-11-r90` |
| `auxiliaryImage.digest` | Auxiliary image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `auxiliaryImage.pullPolicy` | Auxiliary image pull policy | `IfNotPresent` |
| `auxiliaryImage.pullSecrets` | Auxiliary image pull secrets | `[]` |
### JupyterHub database parameters
@@ -496,17 +500,21 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
```console
helm install my-release \
--set proxy.livenessProbe.successThreshold=5 \
oci://registry-1.docker.io/bitnamicharts/jupyterhub
oci://REGISTRY_NAME/REPOSITORY_NAME/jupyterhub
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
The above command sets the `proxy.livenessProbe.successThreshold` to `5`.
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
```console
helm install my-release -f values.yaml oci://registry-1.docker.io/bitnamicharts/jupyterhub
helm install my-release -f values.yaml oci://REGISTRY_NAME/REPOSITORY_NAME/jupyterhub
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
## Configuration and installation details
### [Rolling vs Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)

16
bitnami/jupyterhub/values.yaml
View File

@@ -61,8 +61,8 @@ diagnosticMode:
## @section Hub deployment parameters
hub:
## @param hub.image.registry Hub image registry
## @param hub.image.repository Hub image repository
## @param hub.image.registry [default: REGISTRY_NAME] Hub image registry
## @param hub.image.repository [default: REPOSITORY_NAME/jupyterhub] Hub image repository
## @param hub.image.tag Hub image tag (immutable tags are recommended)
## @param hub.image.digest Hub image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param hub.image.pullPolicy Hub image pull policy
@@ -625,8 +625,8 @@ hub:
## @section Proxy deployment parameters
proxy:
## @param proxy.image.registry Proxy image registry
## @param proxy.image.repository Proxy image repository
## @param proxy.image.registry [default: REGISTRY_NAME] Proxy image registry
## @param proxy.image.repository [default: REPOSITORY_NAME/configurable-http-proxy] Proxy image repository
## @param proxy.image.tag Proxy image tag (immutable tags are recommended)
## @param proxy.image.digest Proxy image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param proxy.image.pullPolicy Proxy image pull policy
@@ -1402,8 +1402,8 @@ imagePuller:
## Singleuser deployment parameters
## NOTE: The values in this section are used for generating the hub.configuration value. In case you provide
## a custom hub.configuration or a configmap, these will be ignored.
## @param singleuser.image.registry Single User image registry
## @param singleuser.image.repository Single User image repository
## @param singleuser.image.registry [default: REGISTRY_NAME] Single User image registry
## @param singleuser.image.repository [default: REPOSITORY_NAME/jupyter-base-notebook] Single User image repository
## @param singleuser.image.tag Single User image tag (immutabe tags are recommended)
## @param singleuser.image.digest Single User image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param singleuser.image.pullPolicy Single User image pull policy
@@ -1587,8 +1587,8 @@ singleuser:
## @section Auxiliary image parameters
##
## @param auxiliaryImage.registry Auxiliary image registry
## @param auxiliaryImage.repository Auxiliary image repository
## @param auxiliaryImage.registry [default: REGISTRY_NAME] Auxiliary image registry
## @param auxiliaryImage.repository [default: REPOSITORY_NAME/os-shell] Auxiliary image repository
## @param auxiliaryImage.tag Auxiliary image tag (immutabe tags are recommended)
## @param auxiliaryImage.digest Auxiliary image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param auxiliaryImage.pullPolicy Auxiliary image pull policy