DevFW-CICD/forgejo-helm
16
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(values) fix parameter annotations for readme generator

Browse source
This commit is contained in:
alexandra catalina 2024-04-04 14:22:38 -07:00
parent c00ee7cdfe
commit e07a0e46fc
2 changed files with 53 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -989,22 +989,26 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
### Gitea ### Gitea
| Name | Description | Value | | Name | Description | Value |
| -------------------------------------- | --------------------------------------------------------------------------- | -------------------- | | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| `gitea.admin.username` | Username for the Forgejo admin user | `gitea_admin` | | `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.existingSecret` | Use an existing secret to store admin user credentials | `nil` |
| `gitea.admin.password` | Password for the Forgejo admin user | `r8sA8CPHD9!bt6d` | | `gitea.admin.password` | Password for the Forgejo admin user | `r8sA8CPHD9!bt6d` |
| `gitea.admin.email` | Email for the Forgejo admin user | `gitea@local.domain` | | `gitea.admin.email` | Email for the Forgejo admin user | `gitea@local.domain` |
| `gitea.metrics.enabled` | Enable Forgejo metrics | `false` | | `gitea.metrics.enabled` | Enable Forgejo metrics | `false` |
| `gitea.metrics.serviceMonitor.enabled` | Enable Forgejo metrics service monitor | `false` | | `gitea.metrics.serviceMonitor.enabled` | Enable Forgejo metrics service monitor | `false` |
| `gitea.ldap` | LDAP configuration | `[]` | | `gitea.ldap` | LDAP configuration | `[]` |
| `gitea.oauth` | OAuth configuration | `[]` | | `gitea.oauth` | OAuth configuration | `[]` |
| `gitea.config.server.SSH_PORT` | SSH port for rootlful Forgejo image | `22` | | `gitea.config.APP_NAME` | Application name, used in the page title. | `Forgejo: Beyond coding. We forge.` |
| `gitea.config.server.SSH_LISTEN_PORT` | SSH port for rootless Forgejo image | `2222` | | `gitea.config.RUN_MODE` | Application run mode, affects performance and debugging: `dev` or `prod` | `prod` |
| `gitea.additionalConfigSources` | Additional configuration from secret or configmap | `[]` | | `gitea.config.repository.SCRIPT_TYPE` | Script type this server supports | `bash` |
| `gitea.additionalConfigFromEnvs` | Additional configuration sources from environment variables | `[]` | | `gitea.config.server.SSH_PORT` | SSH port for rootlful Forgejo image | `22` |
| `gitea.podAnnotations` | Annotations for the Forgejo pod | `{}` | | `gitea.config.server.SSH_LISTEN_PORT` | SSH port for rootless Forgejo image | `2222` |
| `gitea.ssh.logLevel` | Configure OpenSSH's log level. Only available for root-based Forgejo image. | `INFO` | | `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 ### LivenessProbe

63
values.yaml
View file

@ -396,38 +396,41 @@ gitea:
# as a Helm value. Configuration sections map to (lowercased) YAML blocks, # as a Helm value. Configuration sections map to (lowercased) YAML blocks,
# while the keys themselves remain in all caps. # while the keys themselves remain in all caps.
config: config:
# # values in the DEFAULT section # values in the DEFAULT section
# # (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default) # (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
# # are un-namespaced # are un-namespaced
# #
# APP_NAME: "Forgejo: Git with a cup of tea" ## @param gitea.config.APP_NAME Application name, used in the page title.
# RUN_MODE: dev 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: # database:
# DB_TYPE: postgres # supported values are mysql, postgres, mssql, sqlite3 # DB_TYPE: postgres
# HOST: postgresql-svc # HOST: postgresql-svc
# NAME: forgejo-db # NAME: forgejo-db
# USER: forgejo # USER: forgejo
#
# # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#server-server ##
# server: server:
# # @param gitea.config.server.SSH_PORT SSH port for rootlful Forgejo image ## @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_PORT: 22 # rootful image
# SSH_LISTEN_PORT: 2222 # rootless image ## @param gitea.config.server.SSH_LISTEN_PORT SSH port for rootless Forgejo image
# SSH_LISTEN_PORT: 2222 # rootless image
# # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#security-security
# security: ##
# PASSWORD_COMPLEXITY: spec 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)
# # nested blocks are supported: PASSWORD_COMPLEXITY: 'off'
# ui:
# # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#ui---metadata-uimeta
# metadata:
# AUTHOR: "Forger"
## @param gitea.additionalConfigSources Additional configuration from secret or configmap ## @param gitea.additionalConfigSources Additional configuration from secret or configmap
additionalConfigSources: [] additionalConfigSources: []