Skip to content

Commit 2dd0107

Browse files
author
Jeff McCormick
committed
update docs to reflect openshift container platform 3.5
1 parent 2273bef commit 2dd0107

File tree

4 files changed

+31
-2
lines changed

4 files changed

+31
-2
lines changed

Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ run:
77
pgo:
88
cd client && go build -o $(GOBIN)/pgo pgo.go
99
clean:
10-
rm $(GOBIN)/pgo $(GOBIN)/postgres-operator
10+
rm -rf $(GOPATH)/pkg/* $(GOBIN)/*
11+
go get -u github.com/FiloSottile/gvt
12+
gvt restore
1113
operatorimage:
1214
cd operator && go install postgres-operator.go
1315
cp $(GOBIN)/postgres-operator bin/postgres-operator

README.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Once the objects are detected, the PostgreSQL Operator enables users to perform
2121
* Upgrade Cluster
2222
* View PVC
2323
* Test Connections
24+
* Clone a Cluster
2425

2526
What actually gets created on the Kube cluster for a
2627
*pgcluster* resource is defined as a *deployment strategy*. Strategies
@@ -29,6 +30,7 @@ are documented in detail here link:docs/strategies.asciidoc[Deployment Strategie
2930
== Requirements
3031

3132
* Kubernetes 1.5.3+
33+
* Openshift Origin 1.5.1+ or Openshift Container Platform 3.5
3234
* link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.5+ Container]
3335
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
3436
* link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container]
@@ -100,6 +102,12 @@ pgo show pvc mypvc
100102
pgo test mycluster
101103
----
102104

105+
.Clone Cluster
106+
[source,bash]
107+
----
108+
pgo clone mycluster --name=myclone
109+
----
110+
103111
Details on the *pgo* commands are found in the
104112
link:docs/user-guide.asciidoc[User Guide]
105113

docs/build.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ from source, you can download them from the following:
1313
== Requirements
1414

1515
* Kubernetes 1.5.3+
16-
* Openshif Origin 1.5.1+
16+
* Openshift Origin 1.5.1+ and Openshift Container Platform 3.5
1717
* link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.5+ Container]
1818
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
1919

docs/user-guide.asciidoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,25 @@ cluster. The cluster credentials are accessed and used to test
236236
the database connections. The equivalent *psql* command is printed
237237
out as connections are tried, along with the connection status.
238238

239+
== Clone Cluster
240+
241+
To create a cluster clone from an existing cluster, use the following:
242+
....
243+
pgo clone mycluster --name=myclone
244+
....
245+
246+
When you execute the *clone*, it will orchestrate the following
247+
actions:
248+
249+
* create a PgClone TPR to start the cloning workflow
250+
* create a replica on *mycluster* that will become the clone master
251+
* watch for cloned replicas to complete their replication
252+
* copy the original cluster's secrets for the clone to use
253+
* create a PgCluster TPR for the new clone cluster
254+
* create the Postgres trigger file on the clone to cause it to recover
255+
and become a valid read-write master
256+
* remove the PgClone TPR
257+
239258
== bash Completion
240259

241260
There is a bash completion file that is included for users to try, this

0 commit comments

Comments
 (0)