Merge branch 'master' of https://github.com/CrunchyData/postgres-operator

Author: Jeff McCormick

README.asciidoc

@@ -1,7 +1,7 @@
-== PostgreSQL Operator
+= PostgreSQL Operator
 v1.0.0, {docdate}
 
-# Overview
+== Overview
 
 The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Databases and Clusters deployed within a Kubernetes.
 
@@ -23,13 +23,13 @@ What actually gets created on the Kube cluster for a *pgdatabase* or
 *pgcluster* resource is defined as a *deployment strategy*.  Strategies
 are documented in detail here link:docs/strategies.asciidoc[Deployment Strategies] 
 
-# Requirements
+== Requirements
 
 * Kubernetes 1.5.3+
 * link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.5+ Container]
 * link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
 
-# Example Commands Usage
+== Example Commands Usage
 
 Some examples of using the command line interface:
 
@@ -78,7 +78,7 @@ Details on the *pgo* commands are found in the
 link:docs/user-guide.asciidoc[User Guide] 
 
 
-# postgres-operator Container
+== postgres-operator Container
 
 In the following diagram, the postgres operator client, *pgo*, is
 shown interacting with the postgres operator that runs within
@@ -94,7 +94,7 @@ is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Doc
 You can also build the Docker image for *postgres-operator* using
 the build instructions link:docs/build.asciidoc[Build and Setup].
 
-# Command Line Interface
+== Command Line Interface
 
 With the operator deployed, you can then use the *pgo* command line 
 interface to execute commands that the *postgres-operator* understands 
@@ -105,12 +105,12 @@ the Releases page on the github repository or build
 it yourself using the build instructions.
 
 
-# Build and Setup Instructions
+== Build and Setup Instructions
 
 Build instructions are documented here.
 link:docs/build.asciidoc[Build and Setup] 
 
-# Configuration
+== Configuration
 
 You can configure both the client and the operator.  The
 configuration options are documented here.

docs/build.asciidoc

@@ -1,21 +1,22 @@
-== PostgreSQL Operator Build and Setup
+= PostgreSQL Operator Build and Setup
 v1.0.0, {docdate}
 
 == Overview
 
 This document describes how to build from source code the
 Postgres Operator.  If you don't want to build the images
 from source, you can download them from the following:
+
  * Dockerhub (crunchydata/lspvc and crunchydata/postgres-operator images)
- * Github Releases  (pgo client and client configuration files, extracted to your $HOME)
+ * link:https://github.com/CrunchyData/postgres-operator/releases[Github Releases]  (pgo client and client configuration files, extracted to your $HOME)
 
-=== Requirements
+== Requirements
 
 * Kubernetes 1.5.3+
 * link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.5+ Container]
-* link:https://hub.docker.com/r/crunchydata/crunchy-backup/ [PostgreSQL Backup Container]
+* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
 
-=== Kubernetes Environment
+== Kubernetes Environment
 
 To test the *postgres-operator* you will need a Kubernetes cluster
 environment.  There are many ways to install a Kube cluster, but for the
@@ -36,7 +37,7 @@ required dependencies:
 yum -y install git
 ....
 
-=== Create Project and Clone 
+== Create Project and Clone 
 In your .bashrc file, include the following:
 ....
 export GOPATH=$HOME/odev
@@ -57,7 +58,26 @@ git clone https://github.com/CrunchyData/postgres-operator.git
 cd postgres-operator
 ....
 
-==== Get the dependencies:
+== Get Pre-built Images
+At this point if you want to avoid building the images and binary
+from source, you can pull down the Docker images as follows:
+....
+docker pull crunchydata/lspvc:centos7-1.0.0
+docker pull crunchydata/postgres-operator:centos7-1.0.0
+....
+
+Then to get the *pgo* client, go to the Releases page and download the tar ball, uncompress
+it into your $HOME directory:
+....
+cd $HOME
+wget https://github.com/CrunchyData/postgres-operator/releases/download/v1.0/postgres-operator.1.0.0.tar.gz
+tar xvzf ./postgres-operator.1.0.0.tar.gz
+....
+
+Lastly, add the *pgo* client into your PATH.
+
+
+== Source Dependencies
 
 Install a golang compiler, this can be done with either
 your package manager or by following directions
@@ -81,14 +101,14 @@ sudo systemctl restart docker
 newgrp docker 
 ....
 
-==== Compile the CLI:
+== Compile *pgo*
 ....
 cd $COROOT
 make pgo
 which pgo
 ....
 
-==== Compile and build the operator Docker images:
+== Build the Docker Images
 ....
 cd $COROOT
 make operatorimage
@@ -97,7 +117,7 @@ docker images | grep crunchydata
 ....
 
 
-==== Deploy the PostgreSQL Operator
+== Deploy the PostgreSQL Operator
 note that this will create and use */data* on your
 local system as the persistent store for the operator to use
 for its persistent volume:
@@ -115,7 +135,7 @@ desired PVC to use when databases and clusters are created.
 When you first run the operator, it will create the required
 ThirdPartyResources.
 
-==== Setup initial configuration file for the postgres operator CLI
+== Setup *pgo* Configuration File 
 
 The *pgo* client requires two configuration files be copied
 to your $HOME as follows:
@@ -137,7 +157,7 @@ located in */etc/kubernetes/admin.conf*.  Update this kubeconfig
 path to match your local Kube config file location.  Also, update
 the location of the LSPVC_TEMPLATE value to match your $HOME value.
 
-==== Viewing Operator Resources
+== Viewing Operator Resources
 
 When you first run the operator, it will look for the presence
 of its third party resources, and create them if not found.  You can view the various resources created and used by the

docs/config.asciidoc

@@ -1,4 +1,4 @@
-== PostgreSQL Operator Configuration
+= PostgreSQL Operator Configuration
 v1.0.0, {docdate}
 
 

docs/design.asciidoc

@@ -1,4 +1,4 @@
-== postgres Operator Design
+= postgres Operator Design
 v1.0.0, {docdate}
 
 image::crunchy_logo.png?raw=true[]
@@ -19,7 +19,7 @@ A Database is made up of Pods and Services, whereas a Cluster is
 made up of multiple Pods, Services, and Proxies.
 
 
-=== Command Line Interface
+== Command Line Interface
 
 The pgo command line interface (CLI) is used by a normal end-user
 to create databases or clusters, or make changes to existing databases.
@@ -36,7 +36,7 @@ From the CLI, users can view existing databases and clusters that
 were deployed using the CLI and Operator.  Objects that were
 not created by the Crunchy Operator are now viewable from the CLI.
 
-=== Operator Deployment
+== Operator Deployment
 
 The postgres Operator runs within a Pod Deployment in the Kubernetes
 cluster.  An administrator will deploy the postgres Operator pod
@@ -49,7 +49,7 @@ the CLI creates for example a new *pgdatabase* third party
 resource, the operator catches that event and creates pods and services
 for that new database request.
 
-=== CLI Design
+== CLI Design
 
 The CLI uses the cobra package to implement CLI functionality
 like help text, config file processing, and command line parsing.

docs/strategies.asciidoc

@@ -1,4 +1,4 @@
-== PostgreSQL Operator Deployment Strategies
+= PostgreSQL Operator Deployment Strategies
 v1.0.0, {docdate}
 
 
@@ -21,15 +21,15 @@ in their Kube cluster.
 
 Being open source, users can also write their own strategy!
 
-=== Specifying a Strategy
+== Specifying a Strategy
 
 In the pgo client configuration file, there is a *DB.STRATEGY*
 and *CLUSTER.STRATEGY* settings.  The current value of the
 default strategy is *1*.  If you don't set that value, the
 default strategy is assumed.  If you set that value to something
 not supported, the operator will log an error.
 
-=== Strategy Template Files
+== Strategy Template Files
 
 Each strategy supplies its set of templates used by the operator
 to create new pods, services, etc.

docs/user-guide.asciidoc

@@ -1,4 +1,4 @@
-== postgres Operator User Guide
+= postgres Operator User Guide
 v1.0.0, {docdate}
 
 This document is meant for users and demonstrates