docs(values) fix parameter annotations for readme generator
This commit is contained in:
alexandra catalina
parent
c00ee7cdfe
commit
e07a0e46fc
2 changed files with 53 additions and 46 deletions
36
README.md
36
README.md
|
|
@ -989,22 +989,26 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
|
|||
|
||||
### Gitea
|
||||
|
||||
| Name | Description | Value |
|
||||
| -------------------------------------- | --------------------------------------------------------------------------- | -------------------- |
|
||||
| `gitea.admin.username` | Username for the Forgejo admin user | `gitea_admin` |
|
||||
| `gitea.admin.existingSecret` | Use an existing secret to store admin user credentials | `nil` |
|
||||
| `gitea.admin.password` | Password for the Forgejo admin user | `r8sA8CPHD9!bt6d` |
|
||||
| `gitea.admin.email` | Email for the Forgejo admin user | `gitea@local.domain` |
|
||||
| `gitea.metrics.enabled` | Enable Forgejo metrics | `false` |
|
||||
| `gitea.metrics.serviceMonitor.enabled` | Enable Forgejo metrics service monitor | `false` |
|
||||
| `gitea.ldap` | LDAP configuration | `[]` |
|
||||
| `gitea.oauth` | OAuth configuration | `[]` |
|
||||
| `gitea.config.server.SSH_PORT` | SSH port for rootlful Forgejo image | `22` |
|
||||
| `gitea.config.server.SSH_LISTEN_PORT` | SSH port for rootless Forgejo image | `2222` |
|
||||
| `gitea.additionalConfigSources` | Additional configuration from secret or configmap | `[]` |
|
||||
| `gitea.additionalConfigFromEnvs` | Additional configuration sources from environment variables | `[]` |
|
||||
| `gitea.podAnnotations` | Annotations for the Forgejo pod | `{}` |
|
||||
| `gitea.ssh.logLevel` | Configure OpenSSH's log level. Only available for root-based Forgejo image. | `INFO` |
|
||||
| Name | Description | Value |
|
||||
| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
|
||||
| `gitea.admin.username` | Username for the Forgejo admin user | `gitea_admin` |
|
||||
| `gitea.admin.existingSecret` | Use an existing secret to store admin user credentials | `nil` |
|
||||
| `gitea.admin.password` | Password for the Forgejo admin user | `r8sA8CPHD9!bt6d` |
|
||||
| `gitea.admin.email` | Email for the Forgejo admin user | `gitea@local.domain` |
|
||||
| `gitea.metrics.enabled` | Enable Forgejo metrics | `false` |
|
||||
| `gitea.metrics.serviceMonitor.enabled` | Enable Forgejo metrics service monitor | `false` |
|
||||
| `gitea.ldap` | LDAP configuration | `[]` |
|
||||
| `gitea.oauth` | OAuth configuration | `[]` |
|
||||
| `gitea.config.APP_NAME` | Application name, used in the page title. | `Forgejo: Beyond coding. We forge.` |
|
||||
| `gitea.config.RUN_MODE` | Application run mode, affects performance and debugging: `dev` or `prod` | `prod` |
|
||||
| `gitea.config.repository.SCRIPT_TYPE` | Script type this server supports | `bash` |
|
||||
| `gitea.config.server.SSH_PORT` | SSH port for rootlful Forgejo image | `22` |
|
||||
| `gitea.config.server.SSH_LISTEN_PORT` | SSH port for rootless Forgejo image | `2222` |
|
||||
| `gitea.config.security.PASSWORD_COMPLEXITY` | Comma separated list of character classes required to pass minimum complexity. If left empty or no valid values are specified, checking is disabled (off) | `off` |
|
||||
| `gitea.additionalConfigSources` | Additional configuration from secret or configmap | `[]` |
|
||||
| `gitea.additionalConfigFromEnvs` | Additional configuration sources from environment variables | `[]` |
|
||||
| `gitea.podAnnotations` | Annotations for the Forgejo pod | `{}` |
|
||||
| `gitea.ssh.logLevel` | Configure OpenSSH's log level. Only available for root-based Forgejo image. | `INFO` |
|
||||
|
||||
### LivenessProbe
|
||||
|
||||
|
|
|
|||
63
values.yaml
63
values.yaml
|
|
@ -396,38 +396,41 @@ gitea:
|
|||
# as a Helm value. Configuration sections map to (lowercased) YAML blocks,
|
||||
# while the keys themselves remain in all caps.
|
||||
config:
|
||||
# # values in the DEFAULT section
|
||||
# # (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
|
||||
# # are un-namespaced
|
||||
# #
|
||||
# APP_NAME: "Forgejo: Git with a cup of tea"
|
||||
# RUN_MODE: dev
|
||||
# values in the DEFAULT section
|
||||
# (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
|
||||
# are un-namespaced
|
||||
|
||||
## @param gitea.config.APP_NAME Application name, used in the page title.
|
||||
APP_NAME: 'Forgejo: Beyond coding. We forge.'
|
||||
|
||||
## @param gitea.config.RUN_MODE Application run mode, affects performance and debugging: `dev` or `prod`
|
||||
RUN_MODE: prod
|
||||
|
||||
repository:
|
||||
## @param gitea.config.repository.SCRIPT_TYPE Script type this server supports
|
||||
SCRIPT_TYPE: bash
|
||||
|
||||
# if you're using an externally managed database (recommended;
|
||||
# https://codeberg.org/forgejo-contrib/forgejo-helm#external-database)
|
||||
#
|
||||
# # if you're using an externally managed database (recommended;
|
||||
# # https://codeberg.org/forgejo-contrib/forgejo-helm#external-database):
|
||||
# # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#database-database
|
||||
# database:
|
||||
# DB_TYPE: postgres # supported values are mysql, postgres, mssql, sqlite3
|
||||
# HOST: postgresql-svc
|
||||
# NAME: forgejo-db
|
||||
# USER: forgejo
|
||||
#
|
||||
# # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#server-server
|
||||
# server:
|
||||
# # @param gitea.config.server.SSH_PORT SSH port for rootlful Forgejo image
|
||||
# # @param gitea.config.server.SSH_LISTEN_PORT SSH port for rootless Forgejo image
|
||||
# SSH_PORT: 22 # rootful image
|
||||
# SSH_LISTEN_PORT: 2222 # rootless image
|
||||
#
|
||||
# # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#security-security
|
||||
# security:
|
||||
# PASSWORD_COMPLEXITY: spec
|
||||
#
|
||||
# # nested blocks are supported:
|
||||
# ui:
|
||||
# # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#ui---metadata-uimeta
|
||||
# metadata:
|
||||
# AUTHOR: "Forger"
|
||||
# DB_TYPE: postgres
|
||||
# HOST: postgresql-svc
|
||||
# NAME: forgejo-db
|
||||
# USER: forgejo
|
||||
|
||||
##
|
||||
server:
|
||||
## @param gitea.config.server.SSH_PORT SSH port for rootlful Forgejo image
|
||||
SSH_PORT: 22 # rootful image
|
||||
|
||||
## @param gitea.config.server.SSH_LISTEN_PORT SSH port for rootless Forgejo image
|
||||
SSH_LISTEN_PORT: 2222 # rootless image
|
||||
|
||||
##
|
||||
security:
|
||||
## @param gitea.config.security.PASSWORD_COMPLEXITY Comma separated list of character classes required to pass minimum complexity. If left empty or no valid values are specified, checking is disabled (off)
|
||||
PASSWORD_COMPLEXITY: 'off'
|
||||
|
||||
## @param gitea.additionalConfigSources Additional configuration from secret or configmap
|
||||
additionalConfigSources: []
|
||||
|
|
|
|||
Loading…
Reference in a new issue