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

Converge values.yaml and README

Browse source 
Update links and slight formulations

diff --git a/README.md b/README.md
index 59a982c..1b85548 100644
--- a/README.md
+++ b/README.md
@@ -177,12 +177,12 @@ This chart will set a few defaults in the Forgejo configuration based on the ser
 All defaults can be overwritten in `gitea.config`.

-INSTALL_LOCK is always set to true, since we want to configure Forgejo with this helm chart and everything is taken care of.
+INSTALL_LOCK is always set to true because the configuration in this helm chart makes any configuration via installer superfluous.

-_All default settings are made directly in the generated `app.ini`, not in the Values._
+_All default settings are directly in the generated `app.ini`, not in the Values._

 #### Database defaults

-If a builtIn database is enabled the database configuration is set automatically.
-For example, PostgreSQL builtIn will appear in the `app.ini` as:
+If the inbuilt database is enabled, the database configuration is set automatically.
+For example, PostgreSQL built will appear in the `app.ini` as:

 ```ini
@@ -532,6 +532,5 @@ postgresql:
 This chart enables you to create a default admin user.
 It is also possible to update the password for this user by upgrading or redeploying the chart.
-It is not possible to delete an admin user after it has been created.
-This has to be done in the ui.
+Deleting the admin user can only be done from the UI.
 You cannot use `admin` as username.

@@ -634,5 +633,5 @@ Affected options:
 Like the admin user, OAuth2 settings can be updated and disabled but not deleted.
 Deleting OAuth2 settings has to be done in the UI.
-All OAuth2 values, which are documented [here](https://forgejo.org/docs/latest/admin/command-line/#admin), are available.
+[All OAuth2 values](https://forgejo.org/docs/latest/admin/command-line/#admin-auth-add-oauth) are available.

 Multiple OAuth2 sources can be configured with additional OAuth list items.
@@ -693,9 +692,11 @@ route:
 ## Configure commit signing

-When using the rootless image the gpg key folder is not persistent by default.
-If you consider using signed commits for internal Forgejo activities (e.g. initial commit), you'd need to provide a signing key.
-Prior to [PR186](https://gitea.com/gitea/helm-chart/pulls/186), imported keys had to be re-imported once the container got replaced by another.
+When using the rootless image, the GPG key folder is not persistent by default.
+If you want commits by Forgejo (e.g. initial commit) to be signed,
+you need to provide a signing key.
+Prior to [PR186](https://gitea.com/gitea/helm-chart/pulls/186),
+imported keys had to be re-imported once the container got replaced by another.

-The mentioned PR introduced a new configuration object `signing` allowing you to configure prerequisites for commit signing.
+The mentioned PR introduced a new configuration object `signing` so you can configure prerequisites for commit signing.
 By default this section is disabled to maintain backwards compatibility.

@@ -706,6 +707,6 @@ signing:
 ```

-Regardless of the used container image the `signing` object allows to specify a private gpg key.
-Either using the `signing.privateKey` to define the key inline, or refer to an existing secret containing the key data by using `signing.existingSecret`.
+Regardless of the used container image the `signing` object allows to specify a private GPG key.
+Either using the `signing.privateKey` to define the key inline, or referring to an existing secret containing the key data with `signing.existingSecret`.

 ```yaml
@@ -727,5 +728,5 @@ signing:
 ```

-To use the gpg key, Forgejo needs to be configured accordingly.
+To use the GPG key, Forgejo needs to be configured accordingly.
 A detailed description can be found in the [documentation](https://forgejo.org/docs/latest/admin/signing/#general-configuration).

@@ -1023,5 +1024,5 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
 | `signing.enabled`        | Enable commit/action signing                                      | `false`            |
 | `signing.gpgHome`        | GPG home directory                                                | `/data/git/.gnupg` |
-| `signing.privateKey`     | Inline private gpg key for signed internal Git activity           | `""`               |
+| `signing.privateKey`     | Inline private GPG key for signed internal Git activity           | `""`               |
 | `signing.existingSecret` | Use an existing secret to store the value of `signing.privateKey` | `""`               |

@@ -1185,5 +1186,5 @@ Complete Configuration can be taken from their website.

 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.
+Full configuration options are available on their website.

 | Name                                                    | Description                                                      | Value   |
@@ -1200,9 +1201,9 @@ Complete Configuration can be taken from their website.
 | Name               | Description                                                        | Value     |
 | ------------------ | ------------------------------------------------------------------ | --------- |
-| `checkDeprecation` | Set it to false to skip this basic validation check.               | `true`    |
-| `test.enabled`     | Set it to false to disable test-connection Pod.                    | `true`    |
+| `checkDeprecation` | Whether to run this basic validation check.                        | `true`    |
+| `test.enabled`     | Whether to use test-connection Pod.                                | `true`    |
 | `test.image.name`  | Image name for the wget container used in the test-connection Pod. | `busybox` |
 | `test.image.tag`   | Image tag for the wget container used in the test-connection Pod.  | `latest`  |
-| `extraDeploy`      | Array of extra objects to deploy with the release                  | `[]`      |
+| `extraDeploy`      | Array of extra objects to deploy with the release.                 | `[]`      |

 ## Contributing
diff --git a/values.yaml b/values.yaml
index a482438..161173e 100644
--- a/values.yaml
+++ b/values.yaml
@@ -370,5 +370,5 @@ initContainers:
 ## @param signing.enabled Enable commit/action signing
 ## @param signing.gpgHome GPG home directory
-## @param signing.privateKey Inline private gpg key for signed internal Git activity
+## @param signing.privateKey Inline private GPG key for signed internal Git activity
 ## @param signing.existingSecret Use an existing secret to store the value of `signing.privateKey`
 signing:
@@ -777,6 +777,6 @@ postgresql:
 # Set it to false to skip this basic validation check.
 ## @section Advanced
-## @param checkDeprecation Set it to false to skip this basic validation check.
-## @param test.enabled Set it to false to disable test-connection Pod.
+## @param checkDeprecation Whether to run this basic validation check.
+## @param test.enabled Whether to use test-connection Pod.
 ## @param test.image.name Image name for the wget container used in the test-connection Pod.
 ## @param test.image.tag Image tag for the wget container used in the test-connection Pod.
@@ -788,5 +788,5 @@ test:
     tag: latest

-## @param extraDeploy Array of extra objects to deploy with the release
+## @param extraDeploy Array of extra objects to deploy with the release.
 ##
 extraDeploy: []
This commit is contained in:
xeruf 2024-01-23 18:10:13 +00:00 committed by xeruf
parent 40d06b8376
commit c386e289f5
2 changed files with 23 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -176,14 +176,14 @@ gitea:
This chart will set a few defaults in the Forgejo configuration based on the service and ingress settings. This chart will set a few defaults in the Forgejo configuration based on the service and ingress settings.
All defaults can be overwritten in `gitea.config`. All defaults can be overwritten in `gitea.config`.
INSTALL_LOCK is always set to true, since we want to configure Forgejo with this helm chart and everything is taken care of. INSTALL_LOCK is always set to true because the configuration in this helm chart makes any configuration via installer superfluous.
_All default settings are made directly in the generated `app.ini`, not in the Values._ _All default settings are made directly in the generated `app.ini`, not in the Values._
#### Database defaults #### Database defaults
If a builtIn database is enabled the database configuration is set automatically. If a database subchart is enabled, the database configuration is set automatically.
For example, PostgreSQL builtIn will appear in the `app.ini` as: For example, PostgreSQL will appear in the `app.ini` as:
```ini ```ini
[database] [database]
@ -531,8 +531,7 @@ postgresql:
This chart enables you to create a default admin user. This chart enables you to create a default admin user.
It is also possible to update the password for this user by upgrading or redeploying the chart. It is also possible to update the password for this user by upgrading or redeploying the chart.
It is not possible to delete an admin user after it has been created. Deleting the admin user can only be done from the UI.
This has to be done in the ui.
You cannot use `admin` as username. You cannot use `admin` as username.
```yaml ```yaml
@ -633,7 +632,7 @@ Affected options:
Like the admin user, OAuth2 settings can be updated and disabled but not deleted. Like the admin user, OAuth2 settings can be updated and disabled but not deleted.
Deleting OAuth2 settings has to be done in the UI. Deleting OAuth2 settings has to be done in the UI.
All OAuth2 values, which are documented [here](https://forgejo.org/docs/latest/admin/command-line/#admin), are available. [All OAuth2 values](https://forgejo.org/docs/latest/admin/command-line/#admin-auth-add-oauth) are available.
Multiple OAuth2 sources can be configured with additional OAuth list items. Multiple OAuth2 sources can be configured with additional OAuth list items.
@ -692,11 +691,13 @@ route:
## Configure commit signing ## Configure commit signing
When using the rootless image the gpg key folder is not persistent by default. When using the rootless image, the GPG key folder is not persistent by default.
If you consider using signed commits for internal Forgejo activities (e.g. initial commit), you'd need to provide a signing key. If you want commits by Forgejo (e.g. initial commit) to be signed,
Prior to [PR186](https://gitea.com/gitea/helm-chart/pulls/186), imported keys had to be re-imported once the container got replaced by another. you need to provide a signing key.
Prior to [PR186](https://gitea.com/gitea/helm-chart/pulls/186),
imported keys had to be re-imported once the container got replaced by another.
The mentioned PR introduced a new configuration object `signing` allowing you to configure prerequisites for commit signing. The mentioned PR introduced a new configuration object `signing` so you can configure prerequisites for commit signing.
By default this section is disabled to maintain backwards compatibility. By default this section is disabled to maintain backwards compatibility.
```yaml ```yaml
@ -705,8 +706,8 @@ signing:
gpgHome: /data/git/.gnupg gpgHome: /data/git/.gnupg
``` ```
Regardless of the used container image the `signing` object allows to specify a private gpg key. Regardless of the used container image the `signing` object allows to specify a private GPG key.
Either using the `signing.privateKey` to define the key inline, or refer to an existing secret containing the key data by using `signing.existingSecret`. Either using the `signing.privateKey` to define the key inline, or referring to an existing secret containing the key data with `signing.existingSecret`.
```yaml ```yaml
apiVersion: v1 apiVersion: v1
@ -726,7 +727,7 @@ signing:
existingSecret: custom-gitea-gpg-key existingSecret: custom-gitea-gpg-key
``` ```
To use the gpg key, Forgejo needs to be configured accordingly. To use the GPG key, Forgejo needs to be configured accordingly.
A detailed description can be found in the [documentation](https://forgejo.org/docs/latest/admin/signing/#general-configuration). A detailed description can be found in the [documentation](https://forgejo.org/docs/latest/admin/signing/#general-configuration).
## Metrics and profiling ## Metrics and profiling
@ -1022,7 +1023,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
| ------------------------ | ----------------------------------------------------------------- | ------------------ | | ------------------------ | ----------------------------------------------------------------- | ------------------ |
| `signing.enabled` | Enable commit/action signing | `false` | | `signing.enabled` | Enable commit/action signing | `false` |
| `signing.gpgHome` | GPG home directory | `/data/git/.gnupg` | | `signing.gpgHome` | GPG home directory | `/data/git/.gnupg` |
| `signing.privateKey` | Inline private gpg key for signed internal Git activity | `""` | | `signing.privateKey` | Inline private GPG key for signed internal Git activity | `""` |
| `signing.existingSecret` | Use an existing secret to store the value of `signing.privateKey` | `""` | | `signing.existingSecret` | Use an existing secret to store the value of `signing.privateKey` | `""` |
### Gitea ### Gitea
@ -1184,7 +1185,7 @@ Complete Configuration can be taken from their website.
### PostgreSQL ### PostgreSQL
PostgreSQL is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) if enabled in the values. 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. Full configuration options are available on their website.
| Name | Description | Value | | Name | Description | Value |
| ------------------------------------------------------- | ---------------------------------------------------------------- | ------- | | ------------------------------------------------------- | ---------------------------------------------------------------- | ------- |
@ -1199,11 +1200,11 @@ Complete Configuration can be taken from their website.
| Name | Description | Value | | Name | Description | Value |
| ------------------ | ------------------------------------------------------------------ | --------- | | ------------------ | ------------------------------------------------------------------ | --------- |
| `checkDeprecation` | Set it to false to skip this basic validation check. | `true` | | `checkDeprecation` | Whether to run this basic validation check. | `true` |
| `test.enabled` | Set it to false to disable test-connection Pod. | `true` | | `test.enabled` | Whether to use test-connection Pod. | `true` |
| `test.image.name` | Image name for the wget container used in the test-connection Pod. | `busybox` | | `test.image.name` | Image name for the wget container used in the test-connection Pod. | `busybox` |
| `test.image.tag` | Image tag for the wget container used in the test-connection Pod. | `latest` | | `test.image.tag` | Image tag for the wget container used in the test-connection Pod. | `latest` |
| `extraDeploy` | Array of extra objects to deploy with the release | `[]` | | `extraDeploy` | Array of extra objects to deploy with the release. | `[]` |
## Contributing ## Contributing

8
values.yaml
View file

@ -369,7 +369,7 @@ initContainers:
# #
## @param signing.enabled Enable commit/action signing ## @param signing.enabled Enable commit/action signing
## @param signing.gpgHome GPG home directory ## @param signing.gpgHome GPG home directory
## @param signing.privateKey Inline private gpg key for signed internal Git activity ## @param signing.privateKey Inline private GPG key for signed internal Git activity
## @param signing.existingSecret Use an existing secret to store the value of `signing.privateKey` ## @param signing.existingSecret Use an existing secret to store the value of `signing.privateKey`
signing: signing:
enabled: false enabled: false
@ -776,8 +776,8 @@ postgresql:
# By default, removed or moved settings that still remain in a user defined values.yaml will cause Helm to fail running the install/update. # By default, removed or moved settings that still remain in a user defined values.yaml will cause Helm to fail running the install/update.
# Set it to false to skip this basic validation check. # Set it to false to skip this basic validation check.
## @section Advanced ## @section Advanced
## @param checkDeprecation Set it to false to skip this basic validation check. ## @param checkDeprecation Whether to run this basic validation check.
## @param test.enabled Set it to false to disable test-connection Pod. ## @param test.enabled Whether to use test-connection Pod.
## @param test.image.name Image name for the wget container used in the test-connection Pod. ## @param test.image.name Image name for the wget container used in the test-connection Pod.
## @param test.image.tag Image tag for the wget container used in the test-connection Pod. ## @param test.image.tag Image tag for the wget container used in the test-connection Pod.
checkDeprecation: true checkDeprecation: true
@ -787,6 +787,6 @@ test:
name: busybox name: busybox
tag: latest tag: latest
## @param extraDeploy Array of extra objects to deploy with the release ## @param extraDeploy Array of extra objects to deploy with the release.
## ##
extraDeploy: [] extraDeploy: []