[RHIDP#14276]: Document new standalone Helm chart values reference #2500
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
|
|
||
| [id="application-config-values_{context}"] | ||
| = Application configuration values | ||
|
|
||
| [role="_abstract"] | ||
| You can configure the {backstage} application settings and backend service-to-service authentication for your {product-very-short} instance. | ||
|
|
||
| [cols="1m, 1, 1, 1m"] | ||
| |=== | ||
| d|*Key* |*Description* |*Type* d|*Default* | ||
|
|
||
| |appConfig | ||
| |Inline {backstage} app-config YAML. Rendered into a ConfigMap and mounted as `app-config-from-configmap.yaml`. | ||
| |object | ||
| e|See child keys | ||
|
|
||
| |appConfig.auth | ||
| |Authentication providers configuration. | ||
| |object | ||
| e|See child keys | ||
|
|
||
| |appConfig.auth.providers | ||
| |Authentication provider settings. | ||
| |object | ||
| |{} | ||
|
|
||
| |appConfig.app.baseUrl | ||
| |Base URL for the {backstage} front-end application. | ||
| |string | ||
| e|Go template | ||
|
|
||
| |appConfig.backend.baseUrl | ||
| |Base URL for the {backstage} backend. | ||
| |string | ||
| e|Go template | ||
|
|
||
| |appConfig.backend.cors.origin | ||
| |Allowed CORS origin for the backend. | ||
| |string | ||
| e|Go template | ||
|
|
||
| |appConfig.backend.database.connection.host | ||
| |Database connection host. Resolved from environment variables. | ||
| |string | ||
| |${POSTGRES_HOST} | ||
|
|
||
| |appConfig.backend.database.connection.port | ||
| |Database connection port. | ||
| |string | ||
| |${POSTGRES_PORT} | ||
|
|
||
| |appConfig.backend.database.connection.user | ||
| |Database connection user. | ||
| |string | ||
| |${POSTGRES_USER} | ||
|
|
||
| |appConfig.backend.database.connection.password | ||
| |Database connection password. | ||
| |string | ||
| |${POSTGRES_PASSWORD} | ||
|
|
||
| |appConfig.backend.auth.externalAccess | ||
| |External access configuration for backend authentication. | ||
| |list | ||
| e|See child keys | ||
|
|
||
| |extraAppConfig | ||
| a|Additional app-config files from existing ConfigMaps. Each item requires `filename` and `configMapRef` fields. | ||
| |list | ||
| |[] | ||
|
|
||
| |auth | ||
| |Backend service-to-service authentication configuration. | ||
| |object | ||
| e|See child keys | ||
|
|
||
| |auth.backend.enabled | ||
| a|Enable backend service-to-service authentication. Generates a random secret unless `existingSecretRef` is set or `value` is provided. | ||
| |boolean | ||
| |true | ||
|
|
||
| |auth.backend.existingSecretRef.name | ||
| |Name of an existing Secret containing the backend auth token. When empty, the chart generates one. | ||
| |string | ||
| |"" | ||
|
|
||
| |auth.backend.existingSecretRef.key | ||
| |Key within the Secret that holds the backend auth token. | ||
| |string | ||
| |"backend-secret" | ||
|
|
||
| |auth.backend.value | ||
| |Use a specific value for the backend auth token instead of generating one. | ||
| |string | ||
| |"" | ||
| |=== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
|
|
||
| [id="database-values_{context}"] | ||
| = Database values | ||
|
|
||
| [role="_abstract"] | ||
| You can configure the built-in PostgreSQL database or connect to an external PostgreSQL instance for your {product-very-short} deployment. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| To use an external PostgreSQL database, set `postgresql.enabled` to `false` and configure the `externalDatabase` values. | ||
| ==== | ||
|
|
||
| [cols="1m, 1, 1, 1m"] | ||
| |=== | ||
| d|*Key* |*Description* |*Type* d|*Default* | ||
|
|
||
| |postgresql | ||
| |Built-in PostgreSQL database configuration (Bitnami subchart). Enabled by default. | ||
| |object | ||
| e|See child keys | ||
|
|
||
| |postgresql.enabled | ||
| |Enable the built-in PostgreSQL database. | ||
| |boolean | ||
| |true | ||
|
|
||
| |postgresql.postgresqlDataDir | ||
| |PostgreSQL data directory. | ||
| |string | ||
| |"/var/lib/pgsql/data/userdata" | ||
|
|
||
| |postgresql.serviceBindings.enabled | ||
| |Enable service bindings for the PostgreSQL instance. | ||
| |boolean | ||
| |true | ||
|
|
||
| |postgresql.image.registry | ||
| |PostgreSQL image registry. | ||
| |string | ||
| |"quay.io" | ||
|
|
||
| |postgresql.image.repository | ||
| |PostgreSQL image repository. | ||
| |string | ||
| |"fedora/postgresql-15" | ||
|
|
||
| |postgresql.image.tag | ||
| |PostgreSQL image tag. | ||
| |string | ||
| |"latest" | ||
|
|
||
| |postgresql.image.digest | ||
| |Overrides the image tag with an image digest. | ||
| |string | ||
| |"" | ||
|
|
||
| |postgresql.auth.secretKeys.adminPasswordKey | ||
| |Key in the Secret for the PostgreSQL admin password. | ||
| |string | ||
| |"postgres-password" | ||
|
|
||
| |postgresql.auth.secretKeys.userPasswordKey | ||
| |Key in the Secret for the PostgreSQL user password. | ||
| |string | ||
| |"password" | ||
|
|
||
| |postgresql.primary.podSecurityContext.enabled | ||
| |Enable pod security context for the PostgreSQL primary. | ||
| |boolean | ||
| |false | ||
|
|
||
| |postgresql.primary.containerSecurityContext.enabled | ||
| |Enable container security context for the PostgreSQL primary. | ||
| |boolean | ||
| |false | ||
|
|
||
| |postgresql.primary.resources | ||
| a|Resource requests and limits. Defaults: requests `cpu=250m`, `memory=256Mi`; limits `cpu=250m`, `memory=1024Mi`, `ephemeral-storage=20Mi`. | ||
| |object | ||
| e|See description | ||
|
|
||
| |postgresql.primary.persistence.enabled | ||
| |Enable persistence for the PostgreSQL primary. | ||
| |boolean | ||
| |true | ||
|
|
||
| |postgresql.primary.persistence.size | ||
| |Size of the persistent volume. | ||
| |string | ||
| |"1Gi" | ||
|
|
||
| |postgresql.primary.persistence.mountPath | ||
| |Mount path for the persistent volume. | ||
| |string | ||
| |"/var/lib/pgsql/data" | ||
|
|
||
| |externalDatabase | ||
| a|External database connection configuration. Used when `postgresql.enabled` is `false`. | ||
| |object | ||
| e|See child keys | ||
|
|
||
| |externalDatabase.host | ||
| |External database hostname. | ||
| |string | ||
| |"" | ||
|
|
||
| |externalDatabase.port | ||
| |External database port. | ||
| |integer | ||
| |5432 | ||
|
|
||
| |externalDatabase.user | ||
| |External database user. | ||
| |string | ||
| |"postgres" | ||
|
|
||
| |externalDatabase.existingSecretRef.name | ||
| |Name of an existing Secret containing the database password. | ||
| |string | ||
| |"" | ||
|
|
||
| |externalDatabase.existingSecretRef.key | ||
| |Key within the Secret that holds the database password. | ||
| |string | ||
| |"password" | ||
| |=== |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The chart name would remain the same.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This hasn't been updated. Or did I miss anything?