Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@trispera
trispera committed Mar 11, 2024
1 parent e79439c commit 8907406
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 32 deletions.
8 changes: 7 additions & 1 deletion charts/hedgedoc/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,16 @@ helm upgrade --install hedgedoc . -f {custom_values.yaml}
| `hedgedoc.containerSecurityContext` | Set SecurityContext for the container | `allowPrivilegeEscalation: false`<br>`runAsUser:`<br>`runAsGroup:`<br>`capabilities:`<br>&nbsp;&nbsp;`drop:`<br>&nbsp;&nbsp;`- ALL`<br>`runAsNonRoot: true`<br>`seccompProfile:`<br>&nbsp;&nbsp;`type: RuntimeDefault` |
| `hedgedoc.pvc.storageSpace` | Storage space for the PersistentVolume | `5Gi` |
| `hedgedoc.service.type` | Set the Service type | `ClusterIP` |
| `hedgedoc.random_pw_secret_key` | Key to store the password | `database-password` |
| `hedgedoc.secret.database-name` | Name of the database | `postgres` |
| `hedgedoc.secret.database-user` | Name of the postgres user | `postgres` |
| `hedgedoc.secret.database-password` | Function that retrieve the generated password | `'{{- include "random_pw_reusable" . -}}'` |

### PostgreSQL parameters

Since we are using the `bitnami/postgresql` Helm Chart as a dependency, you can take a look to the [PostgreSQL ArtifactHub](https://artifacthub.io/packages/helm/bitnami/postgresql/13.4.4) to check the different values
Since we are using the `bitnami/postgresql` Helm Chart as a dependency, you can take a look to the [PostgreSQL ArtifactHub](https://artifacthub.io/packages/helm/bitnami/postgresql/13.4.4) to check the different values.

The postgres database password is generated randomly and won't change if you upgrade the Chart.

## Cleanup
To delete all the resources, simply uninstall the Helm Chart:
Expand Down
28 changes: 18 additions & 10 deletions charts/matomo/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,12 @@ helm upgrade --install matomo . -f {custom_values.yaml}
| `mariadb.service.type` | Set the Service type | `ClusterIP` |
| `mariadb.pvc.storageSize` | Storage size for the PersistentVolume | `5Gi` |
| `mariadb.pvc.storageClassName` | Storage Class Name for the PersistentVolume | `standard-csi` |
| `mariadb.secret.databaseName` | Name of your database | `matomodb` |
| `mariadb.secret.databaseUser` | Name of the database user | `matomouser` |
| `mariadb.random_pw_secret_key` | Key to store the password | `database-password` |
| `mariadb.random_root_pw_secret_key` | Key to store the root password | `database-root-password` |
| `mariadb.secret.database-name` | Name of the database | `matomodb` |
| `mariadb.secret.database-user` | Name of the database user | `matomouser` |
| `mariadb.secret.database-password` | Function that retrieve the generated password | `'{{- include "random_mariadb_pw_reusable" . -}}'` |
| `mariadb.secret.database-password` | Function that retrieve the generated root password | `'{{- include "random_mariadb_root_pw_reusable" . -}}'` |
| `mariadb.livenessProbe.enabled` | Enable or not `livenessProbe` | `true` |
| `mariadb.livenessProbe.initialDelaySeconds` | Set the `livenessProbe.initialDelaySeconds` | `30` |
| `mariadb.livenessProbe.timeoutSeconds` | Set the `livenessProbe.timeoutSeconds` | `1` |
Expand All @@ -36,18 +40,22 @@ helm upgrade --install matomo . -f {custom_values.yaml}

### Matomo parameters

| Name | Description | Value |
| ------------------------------------------------ | -------------------------------------------------------------------- | ----------------------- |
| `matomo.image` | Name of the `matomo` image. | `bitnami/matomo:latest` |
| `matomo.name` | Name of your app. | `matomo` |
| `matomo.service.type` | Set the Service type | `ClusterIP` |
| `matomo.route.tls.insecureEdgeTerminationPolicy` | Set the termination policy regarding insecure traffic for the route | `Redirect` |
| `matomo.route.tls.termination` | Set the termination for the route | `edge` |
| `matomo.secret.matomoUser` | Name of the database user | `matomouser` |
| Name | Description | Value |
| ------------------------------------------------ | -------------------------------------------------------------------- | ------------------------------------------------- |
| `matomo.image` | Name of the `matomo` image. | `bitnami/matomo:latest` |
| `matomo.name` | Name of your app. | `matomo` |
| `matomo.service.type` | Set the Service type | `ClusterIP` |
| `matomo.route.tls.insecureEdgeTerminationPolicy` | Set the termination policy regarding insecure traffic for the route | `Redirect` |
| `matomo.route.tls.termination` | Set the termination for the route | `edge` |
| `matomo.random_pw_secret_key` | Key to store the password | `matomo-password` |
| `matomo.secret.matomo-username` | Name of the matomo user | `matomouser` |
| `matomo.secret.matomo-password` | Function that retrieve the generated password | `'{{- include "random_matomo_pw_reusable" . -}}'` |

The password for the mariadb database and the root password are generated randomly. A function is created in the `_helpers.tpl` file.
It's the same behavior for the matomo user password.

The passwords won't change if you upgrade the Chart.

Follow the instructions after deploying the Helm Chart to retrieve the passwords.

## Cleanup
Expand Down
48 changes: 27 additions & 21 deletions charts/minio/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,34 @@ helm upgrade --install minio . -f {custom_values.yaml}
## Parameters
### minio parameters

| Name | Description | Value |
| ----------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------|
| `minio.domainSuffix` | Set the `domainSuffix` for your minio app | `2.rahtiapp.fi` |
| `minio.whiteList` | Set the access of your minio app | `0.0.0.0/0` |
| `minio.clusterName` | Name for your minio cluster | `my-minio-cluster` |
| `minio.image` | Name of the Minio image | `minio/minio:RELEASE.2023-12-14T18-51-57Z` |
| `minio.resources.limits.cpu` | Set the limits cpu | `500m` |
| `minio.resources.limits.memory` | Set the limits memory | `512Mi` |
| `minio.resources.requests.cpu` | Set the requests memory | `200m` |
| `minio.resources.requests.memory` | Set the requests memory | `256Mi` |
| `minio.readinessProbe.enabled` | Enable or not the `readinessProbe` | `true` |
| `minio.readinessProbe.httpGet.path` | Set the `httpGet` path for the `readinessProbe` | `/minio/health/ready` |
| `minio.readinessProbe.httpGet.port` | Set the `httpGet` port for the `readinessProbe` | `9000` |
| `minio.readinessProbe.httpGet.scheme` | Set the `httpGet` scheme for the `readinessProbe` | `HTTP` |
| `minio.pvc.name` | Name for the PersistentVolumeClaim | `minio-pvc` |
| `minio.pvc.storageSize` | Storage size for the PersistentVolumeClaim | `5Gi` |
| `minio.pvc.storageClassName` | Storage Class Name for the PersistentVolumeClaim | `standard-csi` |
| `minio.service.type` | Set the Service type | `ClusterIP` |
| `minio.route.tls.termination` | Set the termination for the route | `edge` |
| `minio.route.tls.insecureEdgeTerminationPolicy` | Set the termination policy regarding insecure traffic for the route | `Redirect` |
| Name | Description | Value |
| ----------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------|
| `minio.domainSuffix` | Set the `domainSuffix` for your minio app | `2.rahtiapp.fi` |
| `minio.whiteList` | Set the access of your minio app | `0.0.0.0/0` |
| `minio.clusterName` | Name for your minio cluster | `my-minio-cluster` |
| `minio.image` | Name of the Minio image | `minio/minio:RELEASE.2023-12-14T18-51-57Z` |
| `minio.resources.limits.cpu` | Set the limits cpu | `500m` |
| `minio.resources.limits.memory` | Set the limits memory | `512Mi` |
| `minio.resources.requests.cpu` | Set the requests memory | `200m` |
| `minio.resources.requests.memory` | Set the requests memory | `256Mi` |
| `minio.readinessProbe.enabled` | Enable or not the `readinessProbe` | `true` |
| `minio.readinessProbe.httpGet.path` | Set the `httpGet` path for the `readinessProbe` | `/minio/health/ready` |
| `minio.readinessProbe.httpGet.port` | Set the `httpGet` port for the `readinessProbe` | `9000` |
| `minio.readinessProbe.httpGet.scheme` | Set the `httpGet` scheme for the `readinessProbe` | `HTTP` |
| `minio.random_accesskey_secret_key` | Key to store the accessKey | `accessKey` |
| `minio.random_secretkey_secret_key` | Key to store the secretKey | `secretKey` |
| `minio.secret.accessKey` | Function that retrieve the generated accessKey | `'{{- include "random_minio_accesskey_reusable" . -}}'` |
| `minio.secret.secretKey` | Function that retrieve the generated secretKey | `'{{- include "random_minio_secretkey_reusable" . -}}'` |
| `minio.pvc.name` | Name for the PersistentVolumeClaim | `minio-pvc` |
| `minio.pvc.storageSize` | Storage size for the PersistentVolumeClaim | `5Gi` |
| `minio.pvc.storageClassName` | Storage Class Name for the PersistentVolumeClaim | `standard-csi` |
| `minio.service.type` | Set the Service type | `ClusterIP` |
| `minio.route.tls.termination` | Set the termination for the route | `edge` |
| `minio.route.tls.insecureEdgeTerminationPolicy` | Set the termination policy regarding insecure traffic for the route | `Redirect` |

The secretKey and the accessKey for the minio console are generated randomly. A function is created in the `_helpers.tpl` file.
The secretKey and the accessKey for the minio console are generated randomly. A function is created in the `_helpers.tpl` file.

The secretKey and the accessKey won't change if you upgrade the Chart.

Follow the instructions after deploying the Helm Chart to retrieve the passwords.

Expand Down

0 comments on commit 8907406

Please sign in to comment.