Merge pull request #252 from xenophenes/docfix

Documentation updates

Author: jmccormick2001

hugo/content/_index.adoc

@@ -5,7 +5,6 @@ draft: false
 ---
 
 image::crunchy_logo.png[Crunchy Data Logo,width="25%",height="25%", align="center"]
-= PostgreSQL Operator
 
 v3.1, {docdate}
 

hugo/content/getting-started/_index.adoc

@@ -473,12 +473,7 @@ pgo createa user sally --selector=name=mycluster
 
 To delete a Postgres user in the *mycluster* cluster, execute:
 ....
-pgo user --delete-user=sally --selector=name=mycluster
-....
-
-To delete that user in all clusters:
-....
-pgo user --delete-user=sally
+pgo user delete user sally --selector=name=mycluster
 ....
 
 To change the password for a user in the *mycluster* cluster:
@@ -511,11 +506,6 @@ value and the *valid until* expiration date set to 10 days from now, this
 command will take effect across all clusters that match the selector.  If you
 specify *valid-days=-1* it will mean the password will not expire (e.g. infinity).
 
-To drop a user:
-....
-pgo user --delete-user=user3   --selector=project=xray
-....
-
 To see which passwords are set to expire in a given number of days:
 ....
 pgo user --expired=10  --selector=project=xray
@@ -593,6 +583,7 @@ can be used to promote a replica to a primary role in a PostgreSQL
 cluster.
 
 This process includes the following actions:
+
  * pick a target replica to become the new primary
  * delete the current primary deployment to avoid user requests from
    going to multiple primary databases (split brain)

hugo/content/how-it-works/_index.adoc

@@ -396,19 +396,20 @@ See link:https://github.com/CrunchyData/crunchy-containers/blob/master/docs/exam
 === Manual Failover
 
 With manual failover some key features include:
+
  * when you perform a failover, a new replica is created to replace the
- replica that was promoted to even out the cluster to the original 
+ replica that was promoted to even out the cluster to the original
  number of replicas
  * when you perform a failover, the promoted replica is removed from the pgreplica CRD to represent the current *truth*
 
-The *pgo failover --query* command will return a list of replica
+The `pgo failover --query` command will return a list of replica
 targets which you can select from.  That list include the *Ready* status
 of the database as well as the Kube node name it is running on.
 
 === Auto Failover
 
 Starting with release 3.1, there is an *auto* failover mechanism
-that can be leveraged by *pgo* users if enabled.  
+that can be leveraged by *pgo* users if enabled.
 
 This feature will cause the operator to start a timer on a database
 primary that has received a *NotReady* status after the database
@@ -420,7 +421,7 @@ back to a *Ready* status within that timer period, a failover
 is triggered for this cluster.  The failover target is selected
 by the auto failover logic.
 
-The amount of time (in seconds) the auto failover timer will wait before 
+The amount of time (in seconds) the auto failover timer will wait before
 triggering a failover is determined by the following *pgo.yaml* setting:
 ....
 AutofailSleepSeconds:  9
@@ -430,18 +431,19 @@ If the above setting is not configured a default value of 30 seconds is
 chose.
 
 The logic of auto failover works like this:
- * the readiness probe on the primary database container is executed every few seonds to check the *readiness* of the database, this is what tells Kubernetes whether or not the container is *Ready* or *NotReady*.  
+
+ * the readiness probe on the primary database container is executed every few seonds to check the *readiness* of the database, this is what tells Kubernetes whether or not the container is *Ready* or *NotReady*.
  * if a *NotReady* state is detected then that event is caught by the operator which is watching for database containers created by the operator
  * upon a *NotReady* event, a timer is started for that database which acts as the final check as to if a failover is required for that database
  * if the timer expires and the state is still *Not Ready* then the manual
  failover logic is executed for this cluster which causes a promotion of
- a replica to primary, and also creates a replacement replica 
+ a replica to primary, and also creates a replacement replica
  * only replica targets with a status of *Ready* will be used to select
  the target to promote
 
 The readiness probe settings are defined in the following template:
 ....
-conf/postgres-operator/cluster/1/cluster-deployment-1.jsono
+conf/postgres-operator/cluster/1/cluster-deployment-1.json
 ....
 
 The readiness probe settings determine how often the database check

hugo/content/installation/manual-installation.adoc

@@ -10,9 +10,20 @@ v3.0, {docdate}
 
 == Project Structure
 
-To perform an installation of the operator, first create the project structure as follows on your host, here we assume a local directory called *odev* -
+First, define the following environment variables in *.bashrc*:
 ....
 export GOPATH=$HOME/odev
+export GOBIN=$GOPATH/bin
+export CO_NAMESPACE=demo
+export CO_CMD=kubectl
+export COROOT=$GOPATH/src/github.com/crunchydata/postgres-operator
+export CO_IMAGE_PREFIX=crunchydata
+export CO_IMAGE_TAG=centos7-3.0
+export CO_BASEOS=centos7
+....
+
+To perform an installation of the operator, first create the project structure as follows on your host, here we assume a local directory called *odev* -
+....
 mkdir -p $HOME/odev/src $HOME/odev/bin $HOME/odev/pkg
 mkdir -p $GOPATH/src/github.com/crunchydata/
 ....
@@ -67,9 +78,6 @@ sudo chown 777 /data
 
 Create some sample Persistent Volumes using the following script:
 ....
-export CO_NAMESPACE=demo
-export CO_CMD=kubectl
-export COROOT=$GOPATH/src/github.com/crunchydata/postgres-operator
 go get github.com/blang/expenv
 $COROOT/pv/create-pv.sh
 ....
@@ -80,10 +88,8 @@ $COROOT/pv/create-pv.sh
 
 === Packaged Images
 
-To pull prebuilt versions from Dockerhub of the *postgres-operator* containers, specify the image versions, and execute the following Makefile target -
+To pull prebuilt versions from Dockerhub of the *postgres-operator* containers, execute the following Makefile target -
 ....
-export CO_IMAGE_PREFIX=crunchydata
-export CO_IMAGE_TAG=centos7-3.0
 make pull
 ....
 
@@ -136,22 +142,16 @@ This Operator is developed and tested on the following operating systems but is
 * *CentOS 7*
 * *RHEL 7*
 
-First, install the project library dependencies. The godep dependency manager is used for this purpose. -
+Before compiling the Operator, it's necessary to install the *Mercurial* requirement.
 ....
-cd $COROOT
-make setup
+sudo yum -y install mercurial
 ....
 
-Then, compile the PostgreSQL Operator using the Makefile.
+Then, install the project library dependencies. The godep dependency manager is used for this purpose. Then, compile the PostgreSQL Operator using the Makefile and deploy the operator to your Kubernetes cluster.
 ....
 cd $COROOT
+make setup
 make all
-which pgo
-....
-
-Finally, deploy the operator to your Kubernetes cluster.
-....
-cd $COROOT
 make deployoperator
 ....
 
@@ -160,7 +160,7 @@ make deployoperator
 == Makefile Targets
 
 The following table describes the Makefile targets -
-  
+
 .Makefile Targets
 [width="80%",frame="topbot",options="header"]
 |======================