Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions charts/cloudnative-pg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,5 @@ CloudNativePG Operator Helm Chart
| updateStrategy | object | `{}` | Update strategy for the operator. ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy For example: type: RollingUpdate rollingUpdate: maxSurge: 25% maxUnavailable: 25% |
| webhook | object | `{"livenessProbe":{"initialDelaySeconds":3},"mutating":{"create":true,"failurePolicy":"Fail"},"port":9443,"readinessProbe":{"initialDelaySeconds":3},"startupProbe":{"failureThreshold":6,"periodSeconds":5},"validating":{"create":true,"failurePolicy":"Fail"}}` | The webhook configuration. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
21 changes: 21 additions & 0 deletions charts/cluster/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# cluster






![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

> **Warning**
> ### This chart is under active development.
> ### Advised caution when using in production!


A note on the chart's purpose
-----------------------------

Expand All @@ -26,6 +32,7 @@ That being said, we welcome PRs that improve the chart, but please keep in mind
single configuration that the operator provides and we may reject PRs that add too much complexity and maintenance
difficulty to the chart.


Getting Started
---------------

Expand Down Expand Up @@ -53,6 +60,7 @@ cnpg/cluster

A more detailed guide can be found in the [Getting Started docs](<./docs/Getting Started.md>).


Cluster Configuration
---------------------

Expand Down Expand Up @@ -97,17 +105,23 @@ Each backup adapter takes it's own set of parameters, listed in the [Configurati
below. Refer to the table for the full list of parameters and place the configuration under the appropriate key: `backup.s3`,
`backup.azure`, or `backup.google`.


Recovery
--------

There is a separate document outlining the recovery procedure here: **[Recovery](docs/recovery.md)**


Examples
--------

There are several configuration examples in the [examples](examples) directory. Refer to them for a basic setup and
refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentation/current/) for more advanced configurations.





## Values

| Key | Type | Default | Description |
Expand Down Expand Up @@ -159,6 +173,7 @@ refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentat
| cluster.imageName | string | `""` | Name of the container image, supporting both tags (<image>:<tag>) and digests for deterministic and repeatable deployments: <image>:<tag>@sha256:<digestValue> |
| cluster.imagePullPolicy | string | `"IfNotPresent"` | Image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
| cluster.imagePullSecrets | list | `[]` | The list of pull secrets to be used to pull the images. See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-LocalObjectReference |
| cluster.inheritedMetadata | object | `{}` | Metadata to be inherited by all resources related to a Cluster, annotations and labels defined here will be added to all cluster resources See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-EmbeddedObjectMetadata |
| cluster.initdb | object | `{}` | BootstrapInitDB is the configuration of the bootstrap process when initdb is used. See: https://cloudnative-pg.io/documentation/current/bootstrap/ See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-bootstrapinitdb |
| cluster.instances | int | `3` | Number of instances |
| cluster.logLevel | string | `"info"` | The instances' log level, one of the following values: error, warning, info (default), debug, trace |
Expand Down Expand Up @@ -291,6 +306,7 @@ refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentat
| ---- | ------ | --- |
| itay-grudev | <itay+cloudnativepg-charts+github.com@grudev.com> | |


Features that require feedback
------------------------------

Expand All @@ -300,8 +316,13 @@ Alternatively a ticket and a PR if you have found that something needs a change
- [ ] Google Cloud Storage Backups
- [ ] Google Cloud Storage Recovery


TODO
----
* IAM Role for S3 Service Account
* Automatic provisioning of a Alert Manager configuration



----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
3 changes: 3 additions & 0 deletions charts/cluster/templates/cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ spec:
{{- if .Values.cluster.priorityClassName }}
priorityClassName: {{ .Values.cluster.priorityClassName }}
{{- end }}
inheritedMetadata:
{{- toYaml . | nindent 4 }}
{{ end }}

primaryUpdateMethod: {{ .Values.cluster.primaryUpdateMethod }}
primaryUpdateStrategy: {{ .Values.cluster.primaryUpdateStrategy }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ spec:
postgresUID: 1001
postgresGID: 1002
instances: 2
inheritedMetadata:
labels:
azure.workload.identity/use: "true"
postgresql:
ldap:
server: 'openldap.default.svc.cluster.local'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ cluster:
foo: bar
annotations:
foo: bar
inheritedMetadata:
annotations:
super.annotation: "super-annotation"
labels:
azure.workload.identity/use: "true"
serviceAccountTemplate:
metadata:
annotations:
Expand Down
3 changes: 3 additions & 0 deletions charts/cluster/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,9 @@
"imagePullSecrets": {
"type": "array"
},
"inheritedMetadata": {
"type": "object"
},
"initdb": {
"type": "object"
},
Expand Down
10 changes: 9 additions & 1 deletion charts/cluster/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,15 @@ cluster:

additionalLabels: {}
annotations: {}

# -- Metadata to be inherited by all resources related to a Cluster, annotations and labels defined here will be added to all cluster resources
# See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-EmbeddedObjectMetadata
inheritedMetadata: {}
# annotations:
# my.custom: annotation
# another.custom: annotation
# labels:
# my.custom: label
# another.custom: label

backups:
# -- You need to configure backups manually, so backups are disabled by default.
Expand Down