Skip to content

Commit 530a169

Browse files
author
Jeff McCormick
committed
tweak docs
1 parent 7289adb commit 530a169

File tree

3 files changed

+35
-18
lines changed

3 files changed

+35
-18
lines changed

README.asciidoc

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,33 @@ v1.4, {docdate}
1515

1616
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes.
1717

18-
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource type *pgcluster*, *pgbackups*, and *pgupgrades*.
18+
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource types such as:
19+
20+
* *pgcluster*
21+
* *pgbackups*
22+
* *pgupgrades*
23+
* *pgclones*
24+
* *pgpolicies*
25+
* *pgpolicylogs*
26+
1927

2028
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
2129

22-
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created or removed.
30+
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created, updated, or removed.
2331

2432
Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:
2533

26-
* Create Cluster
27-
* Destroy Cluster
28-
* Backup Cluster
29-
* Scale a Cluster
30-
* Restore Cluster
31-
* Upgrade Cluster
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
39+
* Upgrade a PostgreSQL Cluster
3240
* View PVC
33-
* Test Connections
34-
* Clone a Cluster
35-
* Create a Policy
36-
* Apply a Policy
41+
* Test Connections to a PostgreSQL Cluster
42+
* Clone a PostgreSQL Cluster
43+
* Create a SQL-based Policy
44+
* Apply a SQL-based Policy to a PostgreSQL Cluster
3745

3846
What actually gets created on the Kube cluster for a
3947
*pgcluster* resource is defined as a *deployment strategy*. Strategies
@@ -167,8 +175,8 @@ or modifying PostgreSQL databases deployed within the Kube cluster.
167175

168176
image::docs/operator-diagram.png?raw=true[]
169177

170-
The operator functionality runs in a Pod deployed to your
171-
Kubernetes cluster. The *postgres-operator* Docker container
178+
The operator functionality runs in a Kubernetes Deployment on your
179+
Kubernetes cluster. The *postgres-operator* Docker container image
172180
is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Dockerhub].
173181

174182
You can also build the Docker image for *postgres-operator* using

docs/build.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,14 @@ kubectl create clusterrolebinding permissive-binding \
7878
See https://kubernetes.io/docs/admin/authorization/rbac/ for more
7979
details on how to enable RBAC roles.
8080

81-
To test the *postgres-operator* you will need a Kubernetes cluster
81+
To test the *postgres-operator* you will need a Kubernetes cluster.
82+
83+
In testing, I've found that specifying GOMAXPROCS to equal your number
84+
of CPUs when executing Kubernetes is preferable, for example:
85+
86+
....
87+
export GOMAXPROCS=4
88+
....
8289

8390
[#Openshift Origin Environment]
8491
== Openshift Origin Environment

docs/design.asciidoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ of the postgres Operator to define:
1414
* Cluster - *pgclusters*
1515
* Backup - *pgbackups*
1616
* Upgrade - *pgupgrades*
17+
* Clones - *pgclones*
18+
* Policy - *pgpolicies*
1719

18-
A Cluster is made up of multiple Pods, Services, and Proxies.
20+
A PostgreSQL Cluster is made up of multiple Deployments, Services, and Proxies.
1921

2022

2123
== Command Line Interface
@@ -35,8 +37,8 @@ not created by the Crunchy Operator are now viewable from the CLI.
3537

3638
== Operator Deployment
3739

38-
The postgres Operator runs within a Pod Deployment in the Kubernetes
39-
cluster. An administrator will deploy the postgres Operator pod
40+
The postgres Operator runs within a Deployment in the Kubernetes
41+
cluster. An administrator will deploy the postgres Operator Deployment
4042
using the provided script. Once installed and running, the Operator
4143
pod will start watching for certain defined events.
4244

0 commit comments

Comments
 (0)