Skip to content

Commit

Permalink
[bitnami/*] Standardize documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Jota Martos <[email protected]>
  • Loading branch information
jotamartos committed Oct 19, 2023
1 parent ce6806c commit 78f1825
Show file tree
Hide file tree
Showing 213 changed files with 14,659 additions and 13,569 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ Looking to use our applications in production? Try [VMware Application Catalog](
## TL;DR

```bash
helm install my-release oci://registry-1.docker.io/bitnamicharts/<chart>
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/<chart>
```

> 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.
## Vulnerabilities scanner

Each Helm chart contains one or more containers. Those containers use images provided by Bitnami through its test & release pipeline and whose source code can be found at [bitnami/containers](https://github.com/bitnami/containers).
Expand Down Expand Up @@ -54,8 +56,10 @@ Please refer to the [Quick Start guide](https://helm.sh/docs/intro/quickstart/)

Useful Helm Client Commands:

- Install a chart: `helm install my-release oci://registry-1.docker.io/bitnamicharts/<chart>`
- Upgrade your application: `helm upgrade my-release oci://registry-1.docker.io/bitnamicharts/<chart>`
- Install a chart: `helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/<chart>`
- Upgrade your application: `helm upgrade my-release oci://REGISTRY_NAME/REPOSITORY_NAME/<chart>`

> 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.
## License

Expand Down
566 changes: 287 additions & 279 deletions bitnami/airflow/README.md

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions bitnami/airflow/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ dags:
existingConfigmap: ""
## OS Shell + Utility image
## ref: https://hub.docker.com/r/bitnami/os-shell/tags/
## @param dags.image.registry Init container load-dags image registry
## @param dags.image.repository Init container load-dags image repository
## @param dags.image.registry [default: REGISTRY_NAME] Init container load-dags image registry
## @param dags.image.repository [default: REPOSITORY_NAME/os-shell] Init container load-dags image repository
## @param dags.image.tag Init container load-dags image tag (immutable tags are recommended)
## @param dags.image.digest Init container load-dags image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param dags.image.pullPolicy Init container load-dags image pull policy
Expand Down Expand Up @@ -178,8 +178,8 @@ extraVolumes: []
web:
## Bitnami Airflow image version
## ref: https://hub.docker.com/r/bitnami/airflow/tags/
## @param web.image.registry Airflow image registry
## @param web.image.repository Airflow image repository
## @param web.image.registry [default: REGISTRY_NAME] Airflow image registry
## @param web.image.repository [default: REPOSITORY_NAME/airflow] Airflow image repository
## @param web.image.tag Airflow image tag (immutable tags are recommended)
## @param web.image.digest Airflow image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param web.image.pullPolicy Airflow image pull policy
Expand Down Expand Up @@ -435,8 +435,8 @@ web:
scheduler:
## Bitnami Airflow Scheduler image version
## ref: https://hub.docker.com/r/bitnami/airflow-scheduler/tags/
## @param scheduler.image.registry Airflow Scheduler image registry
## @param scheduler.image.repository Airflow Scheduler image repository
## @param scheduler.image.registry [default: REGISTRY_NAME] Airflow Scheduler image registry
## @param scheduler.image.repository [default: REPOSITORY_NAME/airflow-scheduler] Airflow Scheduler image repository
## @param scheduler.image.tag Airflow Scheduler image tag (immutable tags are recommended)
## @param scheduler.image.digest Airflow Schefuler image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param scheduler.image.pullPolicy Airflow Scheduler image pull policy
Expand Down Expand Up @@ -639,8 +639,8 @@ scheduler:
worker:
## Bitnami Airflow Worker image version
## ref: https://hub.docker.com/r/bitnami/airflow-worker/tags/
## @param worker.image.registry Airflow Worker image registry
## @param worker.image.repository Airflow Worker image repository
## @param worker.image.registry [default: REGISTRY_NAME] Airflow Worker image registry
## @param worker.image.repository [default: REPOSITORY_NAME/airflow-worker] Airflow Worker image repository
## @param worker.image.tag Airflow Worker image tag (immutable tags are recommended)
## @param worker.image.digest Airflow Worker image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param worker.image.pullPolicy Airflow Worker image pull policy
Expand Down Expand Up @@ -913,8 +913,8 @@ worker:
git:
## Bitnami Git image version
## ref: https://hub.docker.com/r/bitnami/git/tags/
## @param git.image.registry Git image registry
## @param git.image.repository Git image repository
## @param git.image.registry [default: REGISTRY_NAME] Git image registry
## @param git.image.repository [default: REPOSITORY_NAME/git] Git image repository
## @param git.image.tag Git image tag (immutable tags are recommended)
## @param git.image.digest Git image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param git.image.pullPolicy Git image pull policy
Expand Down Expand Up @@ -1276,8 +1276,8 @@ metrics:
enabled: false
## Bitnami Airflow exporter image
## ref: https://hub.docker.com/r/bitnami/airflow-exporter/tags/
## @param metrics.image.registry Airflow exporter image registry
## @param metrics.image.repository Airflow exporter image repository
## @param metrics.image.registry [default: REGISTRY_NAME] Airflow exporter image registry
## @param metrics.image.repository [default: REPOSITORY_NAME/airflow-exporter] Airflow exporter image repository
## @param metrics.image.tag Airflow exporter image tag (immutable tags are recommended)
## @param metrics.image.digest Airflow exporter image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param metrics.image.pullPolicy Airflow exporter image pull policy
Expand Down
Loading

0 comments on commit 78f1825

Please sign in to comment.