docs: add descriptions for dependencies

This commit is contained in:
Michael Kriese 2023-01-03 22:52:27 +01:00
parent 09f7dc79cd
commit fca4db32fa
No known key found for this signature in database
GPG key ID: B83F553A0724D44E
2 changed files with 23 additions and 5 deletions

View file

@ -729,13 +729,17 @@ gitea:
### Memcached ### Memcached
| Name | Description | Value | Memcached is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/memcached) if enabled in the values. Complete Configuration can be taken from their website.
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `memcached.enabled` | Memcached is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/memcached) if enabled in the values. Complete Configuration can be taken from their website. | `true` | | Name | Description | Value |
| `memcached.service.ports.memcached` | Port for Memcached | `11211` | | ----------------------------------- | ------------------ | ------- |
| `memcached.enabled` | Enable Memcached | `true` |
| `memcached.service.ports.memcached` | Port for Memcached | `11211` |
### PostgreSQL ### PostgreSQL
PostgreSQL is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) if enabled in the values. Complete Configuration can be taken from their website.
| Name | Description | Value | | Name | Description | Value |
| --------------------------------------------- | ----------------------------------------- | ------- | | --------------------------------------------- | ----------------------------------------- | ------- |
| `postgresql.enabled` | Enable PostgreSQL | `true` | | `postgresql.enabled` | Enable PostgreSQL | `true` |

View file

@ -396,8 +396,11 @@ gitea:
failureThreshold: 10 failureThreshold: 10
## @section Memcached ## @section Memcached
## @descriptionStart
## Memcached is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/memcached) if enabled in the values. Complete Configuration can be taken from their website.
## @descriptionEnd
# #
## @param memcached.enabled Memcached is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/memcached) if enabled in the values. Complete Configuration can be taken from their website. ## @param memcached.enabled Enable Memcached
## @param memcached.service.ports.memcached Port for Memcached ## @param memcached.service.ports.memcached Port for Memcached
memcached: memcached:
enabled: true enabled: true
@ -406,6 +409,9 @@ memcached:
memcached: 11211 memcached: 11211
## @section PostgreSQL ## @section PostgreSQL
## @descriptionStart
## PostgreSQL is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) if enabled in the values. Complete Configuration can be taken from their website.
## @descriptionEnd
# #
## @param postgresql.enabled Enable PostgreSQL ## @param postgresql.enabled Enable PostgreSQL
## @param postgresql.auth.database PostgreSQL database ## @param postgresql.auth.database PostgreSQL database
@ -429,6 +435,10 @@ postgresql:
size: 10Gi size: 10Gi
## @section MySQL ## @section MySQL
## @descriptionStart
## MySQL is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/mysql) if enabled in the values. Complete Configuration can be taken from their website.
## @descriptionEnd
#
# #
## @param mysql.enabled Enable MySQL ## @param mysql.enabled Enable MySQL
## @param mysql.auth.database Name for new database to create. ## @param mysql.auth.database Name for new database to create.
@ -452,6 +462,10 @@ mysql:
size: 10Gi size: 10Gi
## @section MariaDB ## @section MariaDB
## @descriptionStart
## MariaDB is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) if enabled in the values. Complete Configuration can be taken from their website.
## @descriptionEnd
#
# #
## @param mariadb.enabled Enable MariaDB ## @param mariadb.enabled Enable MariaDB
## @param mariadb.auth.database Name of the database to create. ## @param mariadb.auth.database Name of the database to create.