final updates for 1.1.0 release

Jeff McCormick · Jeff McCormick · commit a7867d53dd57 · 2017-04-28T10:26:36.000-05:00
diff --git a/README.asciidoc b/README.asciidoc
@@ -1,5 +1,5 @@
 = PostgreSQL Operator
-v1.0.0, {docdate}
+v1.1.0, {docdate}
 
 == Overview
 
@@ -17,6 +17,7 @@ Once the objects are detected, the PostgreSQL Operator enables users to perform
 * Destroy Database or Cluster
 * Backup Database or Cluster
 * Restore Database or Cluster
+* Upgrade Database or Cluster
 * View PVC
 
 What actually gets created on the Kube cluster for a *pgdatabase* or
@@ -28,6 +29,7 @@ are documented in detail here link:docs/strategies.asciidoc[Deployment Strategie
 * 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-upgrade/[PostgreSQL Upgrade Container]
 
 == Example Commands Usage
 
@@ -68,6 +70,18 @@ pgo create backup mydatabase
 pgo create database myrestore --backup-pvc=mypvc --backup-path=foo-backups/2017-03-21-15-57-21
 ----
 
+.Upgrade Database (minor Postgres version upgrade)
+[source,bash]
+----
+pgo create upgrade mydatabase 
+----
+
+.Upgrade Database (major Postgres version upgrade from 9.5 to 9.6)
+[source,bash]
+----
+pgo create upgrade mydatabase --upgrade-type=major
+----
+
 .View PVC
 [source,bash]
 ----
diff --git a/centos7/Dockerfile.lspvc.centos7 b/centos7/Dockerfile.lspvc.centos7
@@ -1,6 +1,6 @@
 FROM centos:7
 
-LABEL Release="1.0.0" Vendor="Crunchy Data Solutions" 
+LABEL Release="1.1.0" Vendor="Crunchy Data Solutions" 
 
 VOLUME ["/pgdata"]
 
diff --git a/centos7/Dockerfile.postgres-operator.centos7 b/centos7/Dockerfile.postgres-operator.centos7
@@ -1,6 +1,6 @@
 FROM centos:7
 
-LABEL Release="1.0.0" Vendor="Crunchy Data Solutions" 
+LABEL Release="1.1.0" Vendor="Crunchy Data Solutions" 
 
 RUN yum -y install bind-utils \
 	hostname \
diff --git a/docs/build.asciidoc b/docs/build.asciidoc
@@ -1,5 +1,5 @@
 = PostgreSQL Operator Build and Setup
-v1.0.0, {docdate}
+v1.1.0, {docdate}
 
 == Overview
 
@@ -63,7 +63,7 @@ export GOBIN=$GOPATH/bin
 export PATH=$PATH:$GOBIN
 export COROOT=$GOPATH/src/github.com/crunchydata/postgres-operator
 export CO_BASEOS=centos7
-export CO_VERSION=1.0.0
+export CO_VERSION=1.1.0
 export CO_IMAGE_TAG=$CO_BASEOS-$CO_VERSION
 ....
 
@@ -80,16 +80,16 @@ cd postgres-operator
 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
+docker pull crunchydata/lspvc:centos7-1.1.0
+docker pull crunchydata/postgres-operator:centos7-1.1.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
+wget https://github.com/CrunchyData/postgres-operator/releases/download/v1.1.0/postgres-operator.1.1.0.tar.gz
+tar xvzf ./postgres-operator.1.1.0.tar.gz
 ....
 
 Lastly, add the *pgo* client into your PATH.
@@ -185,7 +185,30 @@ kubectl get thirdpartyresources
 kubectl get pgdatabases
 kubectl get pgclusters
 kubectl get pgbackups
+kubectl get pgupgrades
 ....
 
 At this point, you should be ready to start using the *pgo* client!
 
+== Performing a Smoke Test
+
+A simple *smoke test* of the postgres operator includes testing
+the following:
+ 
+ * create a database
+ * show a database
+ * backup a database
+ * show backup of database
+ * delete a database
+ * restore a database
+ * create a cluster
+ * show a cluster
+ * backup a cluster
+ * show backup of cluster
+ * delete a cluster
+ * restore a cluster
+ * minor upgrade a database
+ * major upgrade a database
+ * minor upgrade a cluster
+ * major upgrade a cluster
+
diff --git a/docs/config.asciidoc b/docs/config.asciidoc
@@ -1,5 +1,5 @@
 = PostgreSQL Operator Configuration
-v1.0.0, {docdate}
+v1.1.0, {docdate}
 
 
 This document describes the configuration options
@@ -28,7 +28,7 @@ DB:
   PVC_NAME:  crunchy-pvc
   PVC_SIZE:  100M
   PVC_ACCESS_MODE:  ReadWriteMany
-  CCP_IMAGE_TAG:  centos7-9.5-1.2.8
+  CCP_IMAGE_TAG:  centos7-9.5-1.4.0
   PORT:  5432
   PG_MASTER_USER:  master
   PG_MASTER_PASSWORD:  password
@@ -38,12 +38,14 @@ DB:
   PG_ROOT_PASSWORD:  password
   FSGROUP:  26
   SUPPLEMENTALGROUPS:  65534
+  STRATEGY:  1
 PGO:
   LSPVC_TEMPLATE:  /home/jeffmc/.pgo.lspvc-template.json
-  CO_IMAGE_TAG:  centos7-1.0.0
+  CO_IMAGE_TAG:  centos7-1.1.0
   DEBUG:  false
 CLUSTER:
   REPLICAS:  2
+  STRATEGY:  1
 ....
 
 Values in the pgo configuration file have the following meaning:
@@ -56,7 +58,7 @@ Values in the pgo configuration file have the following meaning:
 |DB.PVC_NAME        |if set, the PVC to use for created databases, only makes sense when your file system is sharable
 |DB.PVC_SIZE        |the size to use when creating new PVCs (e.g. 100M, 1Gi)
 |DB.PVC_ACCESS_MODE        |the access mode for new PVCs (e.g. ReadWriteMany, ReadWriteOnce)
-|DB.CCP_IMAGE_TAG        |newly created containers will be based on this image version (e.g. centos7-9.6-1.2.8)
+|DB.CCP_IMAGE_TAG        |newly created containers will be based on this image version (e.g. centos7-9.6-1.4.0)
 |DB.PORT        | the PostgreSQL port to use for new containers (e.g. 5432)
 |DB.PG_MASTER_USER        | the PostgreSQL master user name
 |DB.PG_MASTER_PASSWORD        | the PostgreSQL master user password
@@ -65,10 +67,12 @@ Values in the pgo configuration file have the following meaning:
 |DB.PG_ROOT_PASSWORD        | the PostgreSQL *postgres* user password
 |DB.FSGROUP        | if set, will cause a *SecurityContext* and *fsGroup* attributes to be added to generated Pod and Deployment definitions 
 |DB.SUPPLEMENTALGROUPS        | if set, will cause a SecurityContext to be added to generated Pod and Deployment definitions 
+|DB.STRATEGY        | sets the deployment strategy to be used for deploying a database, currently there is only strategy *1*
 |PGO.LSPVC_TEMPLATE        | the PVC lspvc template file used to view PVCs
 |PGO.CO_IMAGE_TAG        | image tag to use for the PostgreSQL operator containers
 |PGO.DEBUG        | set to true if you want to see debug messages from the pgo client
 |CLUSTER.REPLICAS        | the number of cluster replicas to create for newly created clusters
+|CLUSTER.STRATEGY        | sets the deployment strategy to be used for deploying a cluster, currently there is only strategy *1*
 |======================
 
 
diff --git a/docs/design.asciidoc b/docs/design.asciidoc
@@ -1,5 +1,5 @@
 = postgres Operator Design
-v1.0.0, {docdate}
+v1.1.0, {docdate}
 
 image::crunchy_logo.png?raw=true[]
 
@@ -14,6 +14,7 @@ of the postgres Operator to define:
  * Database  - *pgdatabases*
  * Cluster - *pgclusters*
  * Backup - *pgbackups*
+ * Upgrade - *pgupgrades*
 
 A Database is made up of Pods and Services, whereas a Cluster is
 made up of multiple Pods, Services, and Proxies.
@@ -93,7 +94,7 @@ To verify the operator installed the following ThirdPartyResources:
 kubectl get thirdpartyresources
 ----
 
-You should see 3 crunchy third party resources deployed.
+You should see 4 crunchy third party resources deployed.
 
 # Command Line Interface
 
diff --git a/docs/strategies.asciidoc b/docs/strategies.asciidoc
@@ -1,5 +1,5 @@
 = PostgreSQL Operator Deployment Strategies
-v1.0.0, {docdate}
+v1.1.0, {docdate}
 
 
 This document describes the various deployment strategies
diff --git a/docs/user-guide.asciidoc b/docs/user-guide.asciidoc
@@ -1,5 +1,5 @@
 = postgres Operator User Guide
-v1.0.0, {docdate}
+v1.1.0, {docdate}
 
 This document is meant for users and demonstrates
 the basic interface of the *pgo* command line interface.
@@ -134,6 +134,57 @@ pgo delete cluster mycluster
 *Note*, when you delete a database or cluster, the operator
 will NOT delete any associated PVCs used by the cluster or database.
 
+== Minor Database and Cluster Upgrade
+
+You can perform a minor Postgres version upgrade
+of either a database or cluster as follows:
+....
+pgo create upgrade mydatabase
+pgo create upgrade mycluster
+....
+
+When you run this command, it will cause the operator
+to delete the existing containers of the database or cluster
+and recreate them using the currently defined Postgres
+container image specified in your pgo configuration file.
+
+The database data files remain untouched, only the container
+is updated, this will upgrade your Postgres server version only.
+
+== Major Database and Cluster Upgrade
+
+You can perform a major Postgres version upgrade
+of either a database or cluster as follows:
+....
+pgo create upgrade mydatabase --upgrade-type=major
+pgo create upgrade mycluster --upgrade-type=major
+....
+
+When you run this command, it will cause the operator
+to delete the existing containers of the database or cluster
+and recreate them using the currently defined Postgres
+container image specified in your pgo configuration file.
+
+The database data files are converted to the new major Postgres
+version as specified by the current Postgres image version
+in your pgo configuration file.  Currently only a Postgres
+9.5 to 9.6 upgrade is supported.
+
+In this scenario, the upgrade is performed by the Postgres
+pg_upgrade utility which is containerized in the *crunchydata/crunchy-upgrade*
+container.  The operator will create a Job which runs the upgrade container,
+using the existing Postgres database files as input, and output
+the updated database files to a new PVC.
+
+Once the upgrade job is completed, the operator will create the
+original database or cluster container mounted with the new PVC
+which contains the upgraded database files.
+
+As the upgrade is processed, the status of the *pgupgrade* TPR is
+updated to give the user some insight into how the upgrade is
+proceeding.  Upgrades like this can take a long time if your
+database is large.  The operator creates a watch on the upgrade
+job to know when and how to proceed.
 
 == Viewing PVC Information
 
diff --git a/examples/operator/deployment.json b/examples/operator/deployment.json
@@ -15,7 +15,7 @@
             "spec": {
                 "containers": [{
                     "name": "postgres-operator",
-                    "image": "crunchydata/postgres-operator:centos7-1.0.0",
+                    "image": "crunchydata/postgres-operator:centos7-1.1.0",
                     "imagePullPolicy": "IfNotPresent",
                     "env": [{
                         "name" : "DEBUG",
diff --git a/examples/operator/run.sh b/examples/operator/run.sh
@@ -36,4 +36,4 @@ fi
 # copy all the operator templates to the PVC location
 sudo cp -r $COROOT/conf/postgres-operator /data
 
-kubectl --namespace=$NAMESPACE create -f $DIR/deployment.json
+envsubst < $DIR/deployment.json | kubectl --namespace=$NAMESPACE create -f -
diff --git a/operator/cluster/cluster_strategy_1.go b/operator/cluster/cluster_strategy_1.go
diff --git a/operator/cluster/upgrade_strategy_1.go b/operator/cluster/upgrade_strategy_1.go
diff --git a/rhel7/Dockerfile.lspvc.rhel7 b/rhel7/Dockerfile.lspvc.rhel7
diff --git a/rhel7/Dockerfile.postgres-operator.rhel7 b/rhel7/Dockerfile.postgres-operator.rhel7
