fix bug related to replica pvc specification for shared and non-shared volume types

Jeff McCormick · Jeff McCormick · commit ddd105784327 · 2017-06-29T09:49:49.000-05:00
diff --git a/client/cmd/cluster.go b/client/cmd/cluster.go
@@ -94,8 +94,10 @@ func listDeployments(name string) {
 		log.Error("error getting list of deployments" + err.Error())
 		return
 	}
+
 	for _, d := range deployments.Items {
 		fmt.Println(TREE_BRANCH + "deployment : " + d.ObjectMeta.Name)
+		//fmt.Printf("labels : %v\n", d.ObjectMeta)
 	}
 
 }
diff --git a/conf/postgres-operator/cluster/1/cluster-replica-deployment-1-shared.json b/conf/postgres-operator/cluster/1/cluster-replica-deployment-1-shared.json
@@ -0,0 +1,107 @@
+{
+    "kind": "Deployment",
+    "apiVersion": "extensions/v1beta1",
+    "metadata": {
+        "name": "{{.Name}}",
+        "labels": {
+	{{.OPERATOR_LABELS}}
+        }
+    },
+    "spec": {
+        "replicas": {{.REPLICAS}},
+        "selector": {
+            "matchLabels": {
+                "name": "{{.Name}}"
+            }
+        },
+        "template": {
+            "metadata": {
+                "labels": {
+                    "name": "{{.Name}}",
+                    "pg-cluster": "{{.ClusterName}}"
+                }
+            },
+            "spec": {
+
+	    	{{.SECURITY_CONTEXT}}
+
+                "containers": [{
+                    "name": "database",
+                    "image": "crunchydata/crunchy-postgres:{{.CCP_IMAGE_TAG}}",
+                    "env": [{
+                        "name": "PG_MASTER_PORT",
+                        "value": "{{.Port}}"
+                    }, {
+                        "name": "PG_MASTER_HOST",
+                        "value": "{{.PG_MASTER_HOST}}"
+                    }, {
+                        "name": "PG_MODE",
+                        "value": "slave"
+                    }, {
+                        "name": "PG_DATABASE",
+                        "value": "{{.PG_DATABASE}}"
+                    }, {
+                        "name": "PGHOST",
+                        "value": "/tmp"
+                    }],
+                    "volumeMounts": [
+		    {
+                        "mountPath": "/pgdata",
+                        "name": "pgdata",
+                        "readOnly": false
+                    }, {
+			"mountPath": "/pguser",
+			"name": "pguser-volume"
+			}, {
+			"mountPath": "/pgmaster",
+			"name": "pgmaster-volume"
+			}, {
+			"mountPath": "/pgroot",
+			"name": "pgroot-volume"
+			}
+		    ],
+
+                    "ports": [{
+                        "containerPort": 5432,
+                        "protocol": "TCP"
+                    }],
+                    "resources": {},
+                    "imagePullPolicy": "IfNotPresent"
+                }],
+                "volumes": [
+		{
+                    "name": "pgdata",
+            		"persistentVolumeClaim": {
+                		"claimName": "{{.PVC_NAME}}"
+            		}
+                }, {
+		  	"name": "pguser-volume",
+			"secret": {
+			"secretName": "{{.PGUSER_SECRET_NAME}}"
+			}
+		}, {
+			"name": "pgmaster-volume",
+			"secret": {
+			"secretName": "{{.PGMASTER_SECRET_NAME}}"
+			}
+		}, {
+			"name": "pgroot-volume",
+			"secret": {
+			"secretName": "{{.PGROOT_SECRET_NAME}}"
+			}
+		}
+		],
+
+                "restartPolicy": "Always",
+                "dnsPolicy": "ClusterFirst"
+            }
+        },
+        "strategy": {
+            "type": "RollingUpdate",
+            "rollingUpdate": {
+                "maxUnavailable": 1,
+                "maxSurge": 1
+            }
+        }
+    }
+}
diff --git a/conf/postgres-operator/cluster/1/cluster-replica-deployment-1.json b/conf/postgres-operator/cluster/1/cluster-replica-deployment-1.json
@@ -71,9 +71,7 @@
                 "volumes": [
 		{
                     "name": "pgdata",
-            		"persistentVolumeClaim": {
-                		"claimName": "{{.PVC_NAME}}"
-            		}
+		    "emptyDir": {}
                 }, {
 		  	"name": "pguser-volume",
 			"secret": {
diff --git a/docs/strategies.asciidoc b/docs/strategies.asciidoc
@@ -69,9 +69,24 @@ image::operator-diagram-cluster.png?raw=true[]
 The default cluster strategy creates the following:
 
  * deployment running a Postgres *master* container with replica count of 1
- * deployment running a Postgres *replica* container with replica count of 2
+ * deployment running a Postgres *replica* container with replica count of 0
  * service mapped to the *master* Postgres database
  * service mapped to the *replica* Postgres database
- * PVC for the *master* will be created if not specified in configuration
-
+ * PVC for the *master* will be created if not specified in configuration, this
+   assumes you are using a non-shared volume technology (e.g. Amazon EBS), 
+   if the CLUSTER.PVC_NAME value is set in your configuration then a 
+   shared volume technology is assumed (e.g. HostPath or NFS), if a PVC
+   is created for the master, the naming convention is *clustername-pvc*
+   where clustername is the name of your cluster.
+
+Replica(s) will be created based upon either a shared or non-shared
+volume type.  The selection of the Replica configuration template
+is based on the cluster's PVC_NAME value, if this is not set, a non-shared
+volume is assumed and the non-shared configuration template is used.
+
+Currently, the example non-shared replica configuration template 
+uses emptyDir volume types to simulate a dynamic volume type.  If you
+are wanting replica(s) to persist to a persistent volume type and
+not emptyDir, you will need to modify the *cluster-replica-deployment-1.json*
+configuration file to specify your volume type specification.
 
diff --git a/examples/operator/remove-tpr.sh b/examples/operator/remove-tpr.sh
@@ -0,0 +1,24 @@
+#!/bin/bash -x
+# Copyright 2016 Crunchy Data Solutions, Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+source $DIR/setup.sh
+
+$CO_CMD delete thirdpartyresources pg-backup.crunchydata.com \
+	pg-clone.crunchydata.com \
+	pg-cluster.crunchydata.com  \
+	pg-policy.crunchydata.com   \
+	pg-upgrade.crunchydata.com
+
diff --git a/operator/cluster/cluster.go b/operator/cluster/cluster.go
@@ -34,7 +34,7 @@ import (
 )
 
 type ClusterStrategy interface {
-	AddCluster(*kubernetes.Clientset, *rest.RESTClient, *tpr.PgCluster, string) error
+	AddCluster(*kubernetes.Clientset, *rest.RESTClient, *tpr.PgCluster, string, string) error
 	DeleteCluster(*kubernetes.Clientset, *rest.RESTClient, *tpr.PgCluster, string) error
 
 	MinorUpgrade(*kubernetes.Clientset, *rest.RESTClient, *tpr.PgCluster, *tpr.PgUpgrade, string) error
@@ -134,16 +134,18 @@ func addCluster(clientset *kubernetes.Clientset, client *rest.RESTClient, cl *tp
 	}
 
 	//create the PVC for the master if required
+	var pvcName = cl.Spec.PVC_NAME
+
 	if cl.Spec.PVC_NAME == "" {
-		cl.Spec.PVC_NAME = cl.Spec.Name + "-pvc"
+		pvcName = cl.Spec.Name + "-pvc"
 		log.Debug("PVC_NAME=%s PVC_SIZE=%s PVC_ACCESS_MODE=%s\n",
-			cl.Spec.PVC_NAME, cl.Spec.PVC_ACCESS_MODE, cl.Spec.PVC_SIZE)
-		err = pvc.Create(clientset, cl.Spec.PVC_NAME, cl.Spec.PVC_ACCESS_MODE, cl.Spec.PVC_SIZE, namespace)
+			pvcName, cl.Spec.PVC_ACCESS_MODE, cl.Spec.PVC_SIZE)
+		err = pvc.Create(clientset, pvcName, cl.Spec.PVC_ACCESS_MODE, cl.Spec.PVC_SIZE, namespace)
 		if err != nil {
 			log.Error("error in pvc create " + err.Error())
 			return
 		}
-		log.Info("created PVC =" + cl.Spec.PVC_NAME + " in namespace " + namespace)
+		log.Info("created PVC =" + pvcName + " in namespace " + namespace)
 	}
 	log.Debug("creating PgCluster object strategy is [" + cl.Spec.STRATEGY + "]")
 
@@ -179,7 +181,7 @@ func addCluster(clientset *kubernetes.Clientset, client *rest.RESTClient, cl *tp
 
 	setFullVersion(client, cl, namespace)
 
-	strategy.AddCluster(clientset, client, cl, namespace)
+	strategy.AddCluster(clientset, client, cl, namespace, pvcName)
 
 	err = util.Patch(client, "/spec/status", tpr.UPGRADE_COMPLETED_STATUS, "pgclusters", cl.Spec.Name, namespace)
 	if err != nil {
diff --git a/operator/cluster/cluster_strategy_1.go b/operator/cluster/cluster_strategy_1.go
@@ -41,16 +41,18 @@ type ClusterStrategy1 struct{}
 
 var DeploymentTemplate1 *template.Template
 var ReplicaDeploymentTemplate1 *template.Template
+var ReplicaDeploymentTemplate1Shared *template.Template
 var ServiceTemplate1 *template.Template
 
 func init() {
 
 	ServiceTemplate1 = util.LoadTemplate("/operator-conf/cluster-service-1.json")
 	ReplicaDeploymentTemplate1 = util.LoadTemplate("/operator-conf/cluster-replica-deployment-1.json")
+	ReplicaDeploymentTemplate1Shared = util.LoadTemplate("/operator-conf/cluster-replica-deployment-1-shared.json")
 	DeploymentTemplate1 = util.LoadTemplate("/operator-conf/cluster-deployment-1.json")
 }
 
-func (r ClusterStrategy1) AddCluster(clientset *kubernetes.Clientset, client *rest.RESTClient, cl *tpr.PgCluster, namespace string) error {
+func (r ClusterStrategy1) AddCluster(clientset *kubernetes.Clientset, client *rest.RESTClient, cl *tpr.PgCluster, namespace string, masterPvcName string) error {
 	var serviceDoc, replicaServiceDoc, masterDoc, replicaDoc bytes.Buffer
 	var err error
 	var replicaServiceResult, serviceResult *v1.Service
@@ -124,7 +126,7 @@ func (r ClusterStrategy1) AddCluster(clientset *kubernetes.Clientset, client *re
 		ClusterName:          cl.Spec.Name,
 		Port:                 cl.Spec.Port,
 		CCP_IMAGE_TAG:        cl.Spec.CCP_IMAGE_TAG,
-		PVC_NAME:             cl.Spec.PVC_NAME,
+		PVC_NAME:             masterPvcName,
 		OPERATOR_LABELS:      util.GetLabels(cl.Spec.Name, cl.Spec.ClusterName, false, false),
 		BACKUP_PVC_NAME:      util.CreateBackupPVCSnippet(cl.Spec.BACKUP_PVC_NAME),
 		BACKUP_PATH:          cl.Spec.BACKUP_PATH,
@@ -179,7 +181,14 @@ func (r ClusterStrategy1) AddCluster(clientset *kubernetes.Clientset, client *re
 		PGUSER_SECRET_NAME:   cl.Spec.PGUSER_SECRET_NAME,
 	}
 
-	err = ReplicaDeploymentTemplate1.Execute(&replicaDoc, replicaDeploymentFields)
+	if cl.Spec.PVC_NAME == "" {
+		//if no PVC_NAME then assume a non-shared volume type
+		log.Debug("using the dynamic replica template ")
+		err = ReplicaDeploymentTemplate1.Execute(&replicaDoc, replicaDeploymentFields)
+	} else {
+		log.Debug("using the shared replica template ")
+		err = ReplicaDeploymentTemplate1Shared.Execute(&replicaDoc, replicaDeploymentFields)
+	}
 	if err != nil {
 		log.Error(err.Error())
 		return err
@@ -367,7 +376,14 @@ func (r ClusterStrategy1) PrepareClone(clientset *kubernetes.Clientset, tprclien
 		PGUSER_SECRET_NAME:   cl.Spec.PGUSER_SECRET_NAME,
 	}
 
-	err = ReplicaDeploymentTemplate1.Execute(&replicaDoc, replicaDeploymentFields)
+	if cl.Spec.PVC_NAME == "" {
+		//if PVC_NAME is blank, assume a non-shared volume type
+		log.Debug("using the dynamic replica template ")
+		err = ReplicaDeploymentTemplate1.Execute(&replicaDoc, replicaDeploymentFields)
+	} else {
+		log.Debug("using the shared replica template ")
+		err = ReplicaDeploymentTemplate1Shared.Execute(&replicaDoc, replicaDeploymentFields)
+	}
 	if err != nil {
 		log.Error("error in clone rep dep tem exec " + err.Error())
 		return err

Original file line number	Diff line number	Diff line change
`@@ -94,8 +94,10 @@ func listDeployments(name string) {`
`94`	`94`	`log.Error("error getting list of deployments" + err.Error())`
`95`	`95`	`return`
`96`	`96`	`}`
	`97`	`+`
`97`	`98`	`for _, d := range deployments.Items {`
`98`	`99`	`fmt.Println(TREE_BRANCH + "deployment : " + d.ObjectMeta.Name)`
	`100`	`+ //fmt.Printf("labels : %v\n", d.ObjectMeta)`
`99`	`101`	`}`
`100`	`102`
`101`	`103`	`}`