Skip to content

Commit 7317152

Browse files
author
Jonathan S. Katz
committed
Clarification in documentation around custom resource use.
This cleans up some language that no longer applies to the custom resources, and modifies the examples slightly.
1 parent ec8d911 commit 7317152

File tree

2 files changed

+15
-19
lines changed

2 files changed

+15
-19
lines changed

docs/content/architecture/high-availability/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,5 +418,6 @@ modification to the custom resource:
418418
- CPU resource adjustments
419419
- Custom annotation changes
420420
- Enabling/disabling the monitoring sidecar on a PostgreSQL cluster (`--metrics`)
421+
- Enabling/disabling the pgBadger sidecar on a PostgreSQL cluster (`--pgbadger`)
421422
- Tablespace additions
422423
- Toleration modifications

docs/content/custom-resources/_index.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,8 @@ when manipulating the PostgreSQL Operator Custom Resources directly.
4040
### Create a PostgreSQL Cluster
4141

4242
The fundamental workflow for interfacing with a PostgreSQL Operator Custom
43-
Resource Definition is for creating a PostgreSQL cluster. However, this is also
44-
one of the most complicated workflows to go through, as there are several
45-
Kubernetes objects that need to be created prior to using this method. These
46-
include:
43+
Resource Definition is for creating a PostgreSQL cluster. There are several
44+
that a PostgreSQL cluster requires to be deployed, including:
4745

4846
- Secrets
4947
- Information for setting up a pgBackRest repository
@@ -54,14 +52,11 @@ include:
5452
Additionally, if you want to add some of the other sidecars, you may need to
5553
create additional secrets.
5654

57-
The following guide goes through how to create a PostgreSQL cluster called
58-
`hippo` by creating a new custom resource.
59-
60-
The below manifest references the Secrets created in the previous step to add a
61-
custom resource to the `pgclusters.crunchydata.com` custom resource definition.
55+
The good news is that if you do not provide these objects, the PostgreSQL
56+
Operator will create them for you to get your Postgres cluster up and running!
6257

63-
**NOTE**: You will need to modify the storage sections to match your storage
64-
configuration.
58+
The following goes through how to create a PostgreSQL cluster called
59+
`hippo` by creating a new custom resource.
6560

6661
```
6762
# this variable is the name of the cluster being created
@@ -91,23 +86,23 @@ spec:
9186
name: ""
9287
size: 1G
9388
storageclass: ""
94-
storagetype: create
89+
storagetype: dynamic
9590
supplementalgroups: ""
9691
PrimaryStorage:
9792
accessmode: ReadWriteMany
9893
matchLabels: ""
9994
name: ${pgo_cluster_name}
10095
size: 1G
10196
storageclass: ""
102-
storagetype: create
97+
storagetype: dynamic
10398
supplementalgroups: ""
10499
ReplicaStorage:
105100
accessmode: ReadWriteMany
106101
matchLabels: ""
107102
name: ""
108103
size: 1G
109104
storageclass: ""
110-
storagetype: create
105+
storagetype: dynamic
111106
supplementalgroups: ""
112107
annotations: {}
113108
ccpimage: crunchy-postgres-ha
@@ -406,23 +401,23 @@ spec:
406401
name: ""
407402
size: 1G
408403
storageclass: ""
409-
storagetype: create
404+
storagetype: dynamic
410405
supplementalgroups: ""
411406
PrimaryStorage:
412407
accessmode: ReadWriteMany
413408
matchLabels: ""
414409
name: ${pgo_cluster_name}
415410
size: 1G
416411
storageclass: ""
417-
storagetype: create
412+
storagetype: dynamic
418413
supplementalgroups: ""
419414
ReplicaStorage:
420415
accessmode: ReadWriteMany
421416
matchLabels: ""
422417
name: ""
423418
size: 1G
424419
storageclass: ""
425-
storagetype: create
420+
storagetype: dynamic
426421
supplementalgroups: ""
427422
annotations: {}
428423
ccpimage: crunchy-postgres-ha
@@ -539,7 +534,7 @@ spec:
539534
name: ${pgo_cluster_name}-${pgo_cluster_replica_suffix}
540535
size: 1G
541536
storageclass: ""
542-
storagetype: create
537+
storagetype: dynamic
543538
supplementalgroups: ""
544539
tolerations: []
545540
userlabels:
@@ -588,7 +583,7 @@ tablespaceMounts:
588583
matchLabels: ""
589584
size: 5Gi
590585
storageclass: ""
591-
storagetype: create
586+
storagetype: dynamic
592587
supplementalgroups: ""
593588
```
594589

0 commit comments

Comments
 (0)