Skip to content

Commit c46e841

Browse files
author
Jeff McCormick
committed
final doc updates and clean up deprecated directory
1 parent 3f32c80 commit c46e841

File tree

16 files changed

+16
-318
lines changed

16 files changed

+16
-318
lines changed

README.asciidoc

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,36 +25,29 @@ The PostgreSQL Operator leverages Kubernetes Custom Resource Definitions to defi
2525
* *pgbackups*
2626
* *pgpolicies*
2727

28-
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
28+
Kubernetes provides the ability to create and manage Custom Resource Definitions similar to any other native Kubernetes object.
2929

30-
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created, updated, or removed.
30+
The PostgreSQL Operator runs within Kubernetes detecting these custom object types as they are created, updated, or removed.
3131

32-
Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:
32+
The PostgreSQL Operator enables users to perform operations, including:
3333

34-
* Create a PostgreSQL Cluster
35-
* Destroy a PostgreSQL Cluster
36-
* Backup a PostgreSQL Cluster
37-
* Scale a a PostgreSQL Cluster
38-
* Restore a PostgreSQL Cluster
34+
* Create, Delete, Scale, Restore, and Backup a PostgreSQL Cluster
3935
* Upgrade a PostgreSQL Cluster
40-
* View PVC
36+
* View PVCs used by PostgreSQL clusters
4137
* Test Connections to a PostgreSQL Cluster
42-
* Create a SQL-based Policy
43-
* Apply a SQL-based Policy to a PostgreSQL Cluster
44-
* Perform User Management
38+
* Create and apply a SQL-based Policy to a PostgreSQL Cluster
39+
* Perform User and Password Management
4540
* Apply User Defined Labels to PostgreSQL Clusters
46-
* Perform Password Management
4741

4842

4943
[#Requirements]
5044
== Requirements
5145

52-
CRD (custom resource definitions) are supported starting with Kube 1.7.X.
53-
NOTE: Along with this new major version, changes were made to the configuration
54-
settings from the prior version of the Operator.
46+
CRD (custom resource definitions) are supported starting with Kube 1.7.X and
47+
with the PostgreSQL Operator version 2.0.
5548

5649
If you require an older version of Kube (< 1.7), you can work
57-
with the operator version 1.5.2 which resides in the github 1.5.X branch.
50+
with the PostgreSQL Operator version 1.5.2 which resides in the github 1.5.X branch.
5851
Note however, that the older operator will be deprecated and no longer
5952
maintained in the future.
6053

@@ -171,11 +164,10 @@ pgo apply policy1 --selector=name=mycluster
171164
Details on the *pgo* commands and complex examples are found in the
172165
link:docs/user-guide.asciidoc[User Guide]
173166

174-
#PostgreSQL Operator Container]
175167
== PostgreSQL Operator Container
176168

177-
The following diagram depicts the components of the PostgreSQL Operator:
178-
, the PostgreSQL operator client, *pgo*, is
169+
The following diagram depicts the components of the PostgreSQL Operator,
170+
here the PostgreSQL operator client, *pgo*, is
179171
shown interacting with the PostgreSQL operator that runs within
180172
a Kubernetes cluster. The operator is responsible for creating
181173
or modifying PostgreSQL databases deployed within the Kubernetes cluster.

docs/build.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ the following:
363363
* repeat testing using create storage type
364364
* repeat testing using existing storage type
365365
* create a series of clusters (*pgo create cluster myseries --series=2*)
366-
* TODO apply policies at cluster creation (*pgo create cluster xraydb --series=2 --labels=project=xray --policies=xrayapp,rlspolicy*)
366+
* apply labels at cluster creation (*pgo create cluster xraydb --series=2 --labels=project=xray*)
367367
* apply a label to an existing set of clusters (*pgo label --label=env=research --selector=project=xray*)
368368
* create a user for a given cluster (*pgo user --add-user=user0 --valid-days=30 --managed --db=userdb --selector=name=xraydb0*)
369369
* load a csv file into a cluster (*pgo load --load-config=./sample-load-config.json --selector=project=xray*)

docs/config.asciidoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Starting with Operator version 2.1, the *pgo.yaml* configuration
1111
file is used solely by the *apiserver* and has no effect on the *pgo* client. With this change, the Operator configuration is centralized to
1212
the *apiserver* container which is deployed alongside the *postgres-operator* container.
1313

14-
Sample pgo configuration files for various storage configurations are located in the $COROOT/examples directory.
14+
Sample Operator configuration files for various storage configurations are located in the $COROOT/examples directory.
1515

1616
To configure the Operator, modify the settings found in
17-
$COROOT/conf/apiserver/pgo.yaml to meet your project needs. Typically
17+
*$COROOT/conf/apiserver/pgo.yaml* to meet your project needs. Typically
1818
you will modify the storage and namespace settings.
1919

2020
=== pgo Configuration Format
@@ -24,10 +24,9 @@ The default pgo configuration file, included in
2424

2525
[source,yaml]
2626
....
27-
Kubeconfig: /etc/kubernetes/admin.conf
2827
Namespace: demo
2928
Cluster:
30-
CCPImageTag: centos7-10.0-1.6.0
29+
CCPImageTag: centos7-9.6.5-1.6.0
3130
Port: 5432
3231
PrimaryPassword: password
3332
User: testuser
@@ -64,7 +63,6 @@ Values in the pgo configuration file have the following meaning:
6463
[width="90%",cols="m,2",frame="topbot",options="header"]
6564
|======================
6665
|Setting | Definition
67-
|Kubeconfig | the path to the kubeconfig file
6866
|Namespace | the namespace the Operator will run within
6967
|Cluster.CCPImageTag |newly created containers will be based on this image version (e.g. centos7-9.6.5-1.6.0), unless you override it using the --ccp-image-tag command line flag
7068
|Cluster.Port | the PostgreSQL port to use for new containers (e.g. 5432)

examples/operator/cleanup.sh

Lines changed: 0 additions & 24 deletions
This file was deleted.

examples/operator/create-pv-nfs.sh

Lines changed: 0 additions & 27 deletions
This file was deleted.

examples/operator/create-pv.sh

Lines changed: 0 additions & 27 deletions
This file was deleted.

examples/operator/crunchy-pv-nfs.json

Lines changed: 0 additions & 19 deletions
This file was deleted.

examples/operator/crunchy-pv.json

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)