Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history 
Signed-off-by: Ivan P <[email protected]>
  • Loading branch information
@i5okie
i5okie committed Oct 9, 2024
1 parent e2b0f1a commit b193606
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 14 deletions.
23 changes: 10 additions & 13 deletions charts/vc-authn-oidc/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,15 @@ kubectl delete secret,pvc --selector "app.kubernetes.io/instance"=my-release

### Common Configuration

| Name | Description | Value |
| ------------------- | --------------------------------------------------------------- | ------------------------------- |
| `nameOverride` | | `""` |
| `fullnameOverride` | | `""` |
| `image.repository` | | `ghcr.io/bcgov/vc-authn-oidc` |
| `image.pullPolicy` | | `IfNotPresent` |
| `image.pullSecrets` | | `[]` |
| `image.tag` | Overrides the image tag which defaults to the chart appVersion. | `2.2.1` |
| `ingressSuffix` | Domain suffix to be used for default hostpaths in ingress | `.apps.silver.devops.gov.bc.ca` |
| Name | Description | Value |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| `nameOverride` | String to override the helm chart name, second part of the prefix | `""` |
| `fullnameOverride` | String to fully override the helm chart name, full prefix. *Must be provided if using a custom release name that does not include the name of the helm chart (`vc-authn-oidc`).* | `""` |
| `image.repository` | | `ghcr.io/bcgov/vc-authn-oidc` |
| `image.pullPolicy` | | `IfNotPresent` |
| `image.pullSecrets` | | `[]` |
| `image.tag` | Overrides the image tag which defaults to the chart appVersion. | `2.2.1` |
| `ingressSuffix` | Domain suffix to be used for default hostpaths in ingress | `.apps.silver.devops.gov.bc.ca` |

### Controller Configuration

Expand Down Expand Up @@ -299,10 +299,7 @@ Note: Secure values of the configuration are passed via equivalent environment v
| `postgresql.fullnameOverride` | When overriding fullnameOverride, you must override this to match. | `""` |
| `postgresql.architecture` | PostgreSQL architecture (`standalone` or `replication`) | `standalone` |
| `postgresql.commonLabels` | Add labels to all the deployed resources (sub-charts are not considered). | `[]` |
| `postgresql.auth.enablePostgresUser` | Assign a password to the "postgres" admin user. Otherwise, remote access will be blocked for this user | `true` |
| `postgresql.auth.existingSecret` | Name of existing secret to use for PostgreSQL credentials. `postgresql.auth.postgresPassword`, `postgresql.auth.password`, and `postgresql.auth.replicationPassword` will be ignored and picked up from this secret. The secret might also contains the key `ldap-password` if LDAP is enabled. `ldap.bind_password` will be ignored and picked from this secret in this case. | `{{ include "global.fullname" . }}` |
| `postgresql.auth.secretKeys.adminPasswordKey` | Name of key in existing secret to use for PostgreSQL credentials. Only used when `auth.existingSecret` is set. | `admin-password` |
| `postgresql.auth.secretKeys.userPasswordKey` | Name of key in existing secret to use for PostgreSQL credentials. Only used when `auth.existingSecret` is set. | `database-password` |
| `postgresql.auth.enablePostgresUser` | Assign a password to the "postgres" admin user. Otherwise, remote access will be blocked for this user. Not recommended for production deployments. | `true` |
| `postgresql.auth.database` | Name for a custom database to create | `traction` |
| `postgresql.auth.username` | Name for a custom user to create | `acapy` |
| `postgresql.primary.persistence.enabled` | Enable PostgreSQL Primary data persistence using PVC | `true` |
Expand Down
2 changes: 1 addition & 1 deletion charts/vc-authn-oidc/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ postgresql:
## ref: https://github.com/bitnami/containers/tree/main/bitnami/postgresql#creating-a-database-user-on-first-run
##
auth:
## @param postgresql.auth.enablePostgresUser Assign a password to the "postgres" admin user. Otherwise, remote access will be blocked for this user
## @param postgresql.auth.enablePostgresUser Assign a password to the "postgres" admin user. Otherwise, remote access will be blocked for this user. Not recommended for production deployments.
##
enablePostgresUser: true
## @param postgresql.auth.database Name for a custom database to create
Expand Down

0 comments on commit b193606

Please sign in to comment.