helm-charts/postgresql
2023-12-21 00:04:44 +01:00
..
files fix(postgresql): init 2023-09-26 00:12:53 +02:00
templates fix(postgresql): put job annotations to values 2023-12-02 01:05:37 +01:00
.helmignore fix(postgresql): init 2023-09-26 00:12:53 +02:00
_docs.gotmpl fix: README with oci 2023-11-03 16:51:58 +01:00
Chart.yaml fix(postgresql): put job annotations to values 2023-12-02 01:05:37 +01:00
README.adoc fix(forgejo-runner): update appVersion (and move from README.md to README.adoc) 2023-12-21 00:04:44 +01:00
values.yaml fix(postgresql): put job annotations to values 2023-12-02 01:05:37 +01:00


= postgresql

image::https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square[Version: 0.1.3]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
image::https://img.shields.io/badge/AppVersion-16.1-alpine3.18-informational?style=flat-square[AppVersion: 16.1-alpine3.18]

== Usage

Helm must be installed and setup to your kubernetes cluster to use the charts.
Refer to Helm's https://helm.sh/docs[documentation] to get started.
Once Helm has been set up correctly, fetch the charts as follows:

[source,bash]
----
helm pull oci://codeberg.org/wrenix/helm-charts/postgresql
----

You can install a chart release using the following command:

[source,bash]
----
helm install postgresql-release oci://codeberg.org/wrenix/helm-charts/postgresql --values values.yaml
----

To uninstall a chart release use `helm`'s delete command:

[source,bash]
----
helm uninstall postgresql-release
----

== Values

.Values
|===
| Key | Type | Default | Description

| affinity
| object
| `{}`
|

| fullnameOverride
| string
| `""`
|

| image.pullPolicy
| string
| `"IfNotPresent"`
|

| image.registry
| string
| `"docker.io"`
|

| image.repository
| string
| `"postgres"`
|

| image.tag
| string
| `""`
|

| imagePullSecrets
| list
| `[]`
|

| job.annotations
| object
| `{"helm.sh/hook":"post-install,post-upgrade","helm.sh/hook-delete-policy":"before-hook-creation,hook-succeeded"}`
| Annotations (usefull to delete job by helm afterwards)

| job.databases
| object
| `{}`
| Bootstrap databases into postgresql server. When databases already exists, they will stay untouched.  databases:  "name_of_database":    owner: "existing_user_which_will_get_grant"    additionalParams: "" # Optional

| job.enabled
| bool
| `true`
| Enable database bootstrapping.

| job.retries
| int
| `60`
| Amount of retries while waiting for postgresql server is available.

| job.users
| object
| `{}`
| Bootstrap users into postgresql server. When users already exists, they will stay untouched.  users:   username: RandomPassword0#"

| job.wait
| int
| `5`
| Time to wait in each wait in each iteration until postgresql server is available.

| nameOverride
| string
| `""`
|

| nodeSelector
| object
| `{}`
|

| persistence.accessMode
| string
| `"ReadWriteOnce"`
|

| persistence.annotations
| object
| `{}`
|

| persistence.enabled
| bool
| `true`
|

| persistence.size
| string
| `"1Gi"`
|

| podAnnotations
| object
| `{}`
|

| podLabels
| object
| `{}`
|

| podSecurityContext
| object
| `{}`
|

| postgres.password
| string
| `"SUPERSTRONGPW"`
| Database password.

| postgres.user
| string
| `"postgres"`
| Database user.

| resources
| object
| `{}`
|

| securityContext
| object
| `{}`
|

| service.port
| int
| `5432`
|

| service.type
| string
| `"ClusterIP"`
|

| serviceAccount.annotations
| object
| `{}`
|

| serviceAccount.create
| bool
| `false`
|

| serviceAccount.name
| string
| `""`
|

| tolerations
| list
| `[]`
|
|===

Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]