Skip to content

Commit 339e0a7

Browse files
author
Jeff McCormick
committed
update docs
1 parent 9161354 commit 339e0a7

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.asciidoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,24 @@ v1.0.0, {docdate}
55

66
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Databases and Clusters deployed within a Kubernetes.
77

8-
The PostgreSQL Operator leverages a Kubernetes Third Party Resources in order to define custom Kubernetes objects such as 'Database Name' and 'Cluster Name'.
8+
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource types *pgdatabase* and *pgcluster*.
99

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

12-
The PostgreSQL Operator runs within Kubernetes enabling Kubernetes to detect these new custom object types being created or removed.
12+
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created or removed.
1313

14-
Once the objects are detected, the PostgreSQL Operator enables useres to perform operations across the Kubernetes environment, including
14+
Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:
1515

1616
* Create Database or Cluster
1717
* Destroy Database or Cluster
1818
* Backup Database or Cluster
1919
* Restore Database or Cluster
2020
* View PVC
2121
22+
What actually gets created on the Kube cluster for a *pgdatabase* or
23+
*pgcluster* resource is defined as a *deployment strategy*. Strategies
24+
are documented in detail here link:docs/strategies.asciidoc[Deployment Strategies]
25+
2226
# Requirements
2327

2428
* Kubernetes 1.5.3+

0 commit comments

Comments
 (0)