diff --git a/charts/postgrescluster/Chart.yaml b/charts/postgrescluster/Chart.yaml index 55309c6..746b604 100644 --- a/charts/postgrescluster/Chart.yaml +++ b/charts/postgrescluster/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 -name: postgres +name: postgrescluster description: A Helm chart for deploying a PostgresCluster instance using Crunchy Postgres Operator. https://access.crunchydata.com/documentation/postgres-operator/latest type: application # The version below should match the version on the PostgresCluster CRD -version: 5.6.0 -appVersion: 5.6.0 +version: 5.6.1 +appVersion: 5.6.1 diff --git a/charts/postgrescluster/README.md b/charts/postgrescluster/README.md new file mode 100644 index 0000000..795cae8 --- /dev/null +++ b/charts/postgrescluster/README.md @@ -0,0 +1,21 @@ +# PostgresCluster + +This chart is used to deploy a `PostgresCluster` instance using [Crunchy Postgres Operator](https://access.crunchydata.com/documentation/postgres-operator/latest). + +This chart is just a copy of their example chart. It is only copied here so that it is available in our Helm repository (the official chart is not published anywhere and requires a git clone). + +Docs: + + + +Examples Repo: + + + +Original source of this chart: + + + +Full `PostgresCluster` CRD reference (all of these configs are available in the chart values): + + diff --git a/charts/postgrescluster/templates/postgres.yaml b/charts/postgrescluster/templates/postgres.yaml index 0429fc3..81d0c6a 100644 --- a/charts/postgrescluster/templates/postgres.yaml +++ b/charts/postgrescluster/templates/postgres.yaml @@ -1,10 +1,13 @@ +# CRD reference: +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster apiVersion: postgres-operator.crunchydata.com/v1beta1 kind: PostgresCluster metadata: name: {{ default .Release.Name .Values.name }} + {{ with .Values.annotations }} annotations: - # https://access.crunchydata.com/documentation/postgres-operator/latest/tutorials/basic-setup/user-management#automatically-creating-per-user-schemas - postgres-operator.crunchydata.com/autoCreateUserSchema: "true" +{{ toYaml . | indent 4 }} + {{ end }} spec: postgresVersion: {{ required "You must set the version of Postgres to deploy." .Values.postgresVersion }} {{- if .Values.postGISVersion }} diff --git a/charts/postgrescluster/values.yaml b/charts/postgrescluster/values.yaml index 38dffbd..a62a503 100644 --- a/charts/postgrescluster/values.yaml +++ b/charts/postgrescluster/values.yaml @@ -1,7 +1,7 @@ --- # For a full explanation of how to set up the custom resource, please refer to # the documentation: -# https://access.crunchydata.com/documentation/postgres-operator/v5/ +# https://access.crunchydata.com/documentation/postgres-operator/latest/ ########### # General # @@ -11,6 +11,10 @@ # release. # name: hippo +# PostgresCluster annotations +# annotations: +# postgres-operator.crunchydata.com/autoCreateUserSchema: "true" + # postgresVersion sets the version to deploy. This version number needs to be # available as one of the "RELATED_IMAGE_POSTGRES_..." images as part of the PGO # installation if you want to deploy the image without setting the "postgres" @@ -98,7 +102,9 @@ postgresVersion: 16 # Advanced Postgres Settings # ############################## -# instances allows you to define one or more Postgres instance sets. By default, +# Instances +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster#postgresclusterspecinstancesindex +# The instances config allows you to define one or more Postgres instance sets. By default, # PGO will only deploy a single instance. Each instance set has similar # characteristics to the other instances in the set, e.g. storage size, resource # etc. You can have multiple replicas within an instance set. @@ -130,13 +136,16 @@ postgresVersion: 16 # postgresql: # parameters: # synchronous_commit: "on" +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster#postgresclusterspecpatroni # patroni: {} # users sets any custom Postgres users and databases that they have access to # as well as any permissions associated with the user account. +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster#postgresclusterspecusersindex # users: {} # dataSource specifies a data source for bootstrapping a Postgres cluster. +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster#postgresclusterspecdatasource # dataSource: {} # customTLSSecret references a Secret that contains the relevant information for @@ -259,6 +268,7 @@ postgresVersion: 16 # pgBackRestConfig allows for the configuration of every pgBackRest option # except for "image", which is set by "pgBackRest". +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster#postgresclusterspecbackupspgbackrest # pgBackRestConfig: {} ################################ @@ -267,6 +277,7 @@ postgresVersion: 16 # pgBouncerConfig sets all of the pgBouncer portions of the spec except for # image. To set image, you need to set the "pgBouncer" setting. +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster#postgresclusterspecproxypgbouncer # pgBouncerConfig: {} ####################### @@ -276,6 +287,7 @@ postgresVersion: 16 # monitoringConfig sets all of the monitoring portions of the spec except for the # image. To set the image, which also enables monitoring, you need to set the # "monitoring" setting. +# https://access.crunchydata.com/documentation/postgres-operator/latest/references/crd/5.6.x/postgrescluster#postgresclusterspecmonitoring # monitoringConfig: {} #######################