Skip to content

Commit c3c909c

Browse files
author
Jeff McCormick
committed
update docs
1 parent c4ca3d6 commit c3c909c

File tree

6 files changed

+18
-97
lines changed

6 files changed

+18
-97
lines changed

Makefile

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ ifndef GOBIN
1010
$(error GOBIN is not set)
1111
endif
1212

13-
#======= Main functions =======
14-
etlclient: check-go-vars
15-
go build -buildmode=plugin -o client/etlclient.so client/etlclient.go
1613
#======= Main functions =======
1714
# cd pgo && env GOOS=darwin GOARCH=amd64 go build pgo.go
15+
setup:
16+
godep restore && ./bin/get-deps.sh
1817
deployoperator:
1918
cd deploy && ./deploy.sh
2019
main: check-go-vars

README.asciidoc

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,7 @@ The CRD version of the operator is tested on the following platforms:
6060

6161
* *Kubernetes 1.7.X+*
6262
* *Kubernetes 1.8.0+*
63-
64-
Support for Openshift is in progress.
65-
66-
The Operator makes use of the following containers:
67-
68-
* link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.6.5 Container]
69-
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
70-
* link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container]
71-
* link:https://hub.docker.com/r/crunchydata/lspvc/[PostgreSQL PVC Listing Container]
72-
* link:https://hub.docker.com/r/crunchydata/postgres-operator/[postgres-operator Container]
63+
* *Openshift Origin 1.7.0+*
7364

7465
This Operator has also been tested on the following operating systems:
7566

deploy/deploy.sh

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515

1616
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
1717

18-
source $DIR/setup.sh
19-
2018
$DIR/cleanup.sh
2119

2220
$CO_CMD --namespace=$CO_NAMESPACE create configmap operator-conf \

deploy/setup.sh

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

docs/build.asciidoc

Lines changed: 15 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,11 @@ environment. A few different links are listed below that describe different
5252
methods of installation.
5353

5454
link:https://kubernetes.io/docs/setup/independent/install-kubeadm/[Installing kubeadm - Official Kubernetes Documentation]
55+
5556
link:http://linoxide.com/containers/setup-kubernetes-kubeadm-centos/[Installing Kubernetes 1.5 with kubeadm on CentOS]
57+
5658
link:https://blog.openebs.io/setting-up-kubernetes-1-5-5-cluster-with-vagrant-dda11e33b5bc[Setting up Kubernetes 1.5.5 Cluster with Vagrant]
59+
5760
link:https://github.com/kubernetes/minikube[Minikube]
5861

5962
==== minikube
@@ -99,26 +102,6 @@ kubectl create clusterrolebinding permissive-binding \
99102
See link:https://kubernetes.io/docs/admin/authorization/rbac/[here] for more
100103
details on how to enable RBAC roles.
101104

102-
==== Namespace
103-
104-
You can set the namespace to use for deploying the operator
105-
as follows. If not set, the namespace is set to *default* automatically.
106-
This behavior is defined within the postgres-operator shell script located
107-
link:https://github.com/CrunchyData/postgres-operator/blob/master/examples/operator/setup.sh[here]:
108-
....
109-
export CO_NAMESPACE=myproject
110-
....
111-
112-
==== Namespace
113-
114-
You can set the namespace to use for deploying the operator
115-
as follows. If not set, the namespace is set to *default* automatically.
116-
This behavior is defined within the postgres-operator shell script located
117-
link:https://github.com/CrunchyData/postgres-operator/blob/master/examples/operator/setup.sh[here]:
118-
....
119-
export CO_NAMESPACE=myproject
120-
....
121-
122105
== Installation
123106

124107
=== Create Project and Clone
@@ -137,6 +120,8 @@ export COROOT=$GOPATH/src/github.com/crunchydata/postgres-operator
137120
export CO_BASEOS=centos7
138121
export CO_VERSION=2.0
139122
export CO_IMAGE_TAG=$CO_BASEOS-$CO_VERSION
123+
export CO_NAMESPACE=myproject
124+
export CO_CMD=kubectl
140125
....
141126

142127
It will be necessary to log out and back in for the changes to your .bashrc
@@ -167,8 +152,7 @@ docker pull crunchydata/csvload:centos7-2.0
167152
docker pull crunchydata/postgres-operator:centos7-2.0
168153
....
169154

170-
Then to get the *pgo* client, go to the Releases page and download the tar ball, uncompress
171-
it into your $HOME directory:
155+
Next get the *pgo* client, go to the Releases page and download the tar ball, uncompress it into your $HOME directory:
172156
....
173157
cd $HOME
174158
wget https://github.com/CrunchyData/postgres-operator/releases/download/2.0/postgres-operator.2.0.tar.gz
@@ -177,15 +161,13 @@ tar xvzf ./postgres-operator.2.0.tar.gz
177161

178162
Lastly, add the *pgo* client into your PATH.
179163

180-
At this point, you'll want to head to the
181-
link:https://github.com/xenophenes/postgres-operator/blob/master/docs/build.asciidoc#deploy-the-postgresql-operator[Deploy the PostgreSQL Operator]
182-
section in order to complete installation.
164+
You are now ready to Deploy the operator to your Kube system.
183165

184166
=== Build from Source
185167

186168
Install a golang compiler, this can be done with either
187169
your package manager or by following directions
188-
from https://golang.org/dl/. The operator is currenlty built
170+
from https://golang.org/dl/. The operator is currently built
189171
using golang version 1.8.X
190172

191173

@@ -194,50 +176,29 @@ as follows:
194176
....
195177
cd $COROOT
196178
go get github.com/tools/godep
197-
./bin/get-deps.sh
198-
....
199-
200-
In a development environment you will likely want to create a
201-
*docker* group and add your user ID to that group, this allows
202-
you as your normal user ID to access the *docker* daemon and
203-
issue commands to it:
204-
....
205-
sudo groupadd docker
206-
sudo usermod -a -G docker youruserID
207-
sudo systemctl restart docker
208-
newgrp docker
179+
make setup
209180
....
210181

211182
==== Compiling the PostgreSQL Operator
212183
....
213184
cd $COROOT
214185
make pgo
215-
which pgo
216-
....
217-
218-
==== Build the Docker Images
219-
....
220-
cd $COROOT
221186
make operatorimage
222187
make lsimage
223-
docker images | grep crunchydata
188+
make csvimage
189+
which pgo
224190
....
225191

226192
=== Deploy the PostgreSQL Operator
227193
*NOTE*: This will create and use */data* on your
228194
local system as the persistent store for the operator to use
229195
for its persistent volume.
230196
....
231-
cd $COROOT/examples/operator
232-
./deploy.sh
197+
cd $COROOT
198+
make deployoperator
233199
kubectl get pod -l 'name=postgres-operator'
234200
....
235201

236-
You can also deploy the operator by running the following command:
237-
....
238-
make deploy
239-
....
240-
241202
When you first run the operator, it will create the required
242203
CustomResourceDefinitions. You can view these as follows:
243204

@@ -266,16 +227,15 @@ Strategies for deploying the operator can be found in the link:design.asciidoc[P
266227

267228
=== Configuration
268229

269-
The *pgo* client requires two configuration files be copied
230+
The *pgo* client requires three configuration files be copied
270231
to your $HOME as follows:
271232
....
272233
cp $COROOT/examples/pgo.yaml.emptydir $HOME/.pgo.yaml
273234
cp $COROOT/examples/pgo.lspvc-template.json $HOME/.pgo.lspvc-template.json
274235
cp $COROOT/examples/pgo.csvload-template.json $HOME/.pgo.csvload-template.json
275236
....
276237

277-
If you are disinterested in having the configuration files in your $HOME folder,
278-
you do have the option of hosting them in three different locations:
238+
Alternatively, the configuration files can be located in these locations:
279239

280240
* . (current directory)
281241
* $HOME

docs/config.asciidoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,6 @@ by means of a mounted volume.
144144
The templates are located in the *$COROOT/conf/postgres-operator* directory
145145
and get added into a config map which is mounted by the operator deployment.
146146

147-
For your persistent file system, you might need to adjust the templates
148-
to add *fsGroup* or *supplementalGroup* attributes to your *pgo* configuration
149-
file.
150-
151147
=== Persistence
152148

153149
Different ways of handling storage are specified by a user in

0 commit comments

Comments
 (0)