Skip to content

Commit

Permalink
[bitnami/*] Standardize documentation (bitnami#19835)
Browse files Browse the repository at this point in the history
Signed-off-by: Jota Martos <[email protected]>
  • Loading branch information
jotamartos authored Oct 20, 2023
1 parent 94a19e6 commit ca5ce90
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/odoo
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/odoo
```

> 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

This chart bootstraps a [Odoo](https://github.com/bitnami/containers/tree/main/bitnami/odoo) deployment on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
Expand All @@ -36,9 +38,11 @@ Looking to use Odoo in production? Try [VMware Application Catalog](https://bitn
To install the chart with the release name `my-release`:

```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/odoo
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/odoo
```

> 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 command deploys Odoo 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`
Expand Down Expand Up @@ -78,8 +82,8 @@ The command removes all the Kubernetes components associated with the chart and
| `diagnosticMode.enabled` | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | `false` |
| `diagnosticMode.command` | Command to override all containers in the the statefulset | `["sleep"]` |
| `diagnosticMode.args` | Args to override all containers in the the statefulset | `["infinity"]` |
| `image.registry` | Odoo image registry | `docker.io` |
| `image.repository` | Odoo image repository | `bitnami/odoo` |
| `image.registry` | Odoo image registry | `REGISTRY_NAME` |
| `image.repository` | Odoo image repository | `REPOSITORY_NAME/odoo` |
| `image.tag` | Odoo image tag (immutable tags are recommended) | `16.0.20231015-debian-11-r0` |
| `image.digest` | Odoo image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | Odoo image pull policy | `IfNotPresent` |
Expand Down Expand Up @@ -287,19 +291,22 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
```console
helm install my-release \
--set odooPassword=password,postgresql.postgresPassword=secretpassword \
oci://registry-1.docker.io/bitnamicharts/odoo
oci://REGISTRY_NAME/REPOSITORY_NAME/odoo
```

> 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 Odoo administrator account password to `password` and the PostgreSQL `postgres` user password to `secretpassword`.

> NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

```console
helm install my-release -f values.yaml oci://registry-1.docker.io/bitnamicharts/odoo
helm install my-release -f values.yaml oci://REGISTRY_NAME/REPOSITORY_NAME/odoo
```

> 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`.
> **Tip**: You can use the default [values.yaml](values.yaml)
## Configuration and installation details
Expand Down
4 changes: 2 additions & 2 deletions values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ diagnosticMode:

## Bitnami Odoo image
## ref: https://hub.docker.com/r/bitnami/odoo/tags/
## @param image.registry Odoo image registry
## @param image.repository Odoo image repository
## @param image.registry [default: REGISTRY_NAME] Odoo image registry
## @param image.repository [default: REPOSITORY_NAME/odoo] Odoo image repository
## @param image.tag Odoo image tag (immutable tags are recommended)
## @param image.digest Odoo image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param image.pullPolicy Odoo image pull policy
Expand Down

0 comments on commit ca5ce90

Please sign in to comment.