Allow for a S3 bucket name to be edited after cluster creation

This allows for the name of a S3 bucket to be edited after a cluster is created, i.e. through the custom resource. Should this action be taken, the following occurs: - The pgBackRest report Pod is redeployed - The PostgreSQL cluster is redeployed using a rolling update - Once the above two actions complete, a new stanza is created and an initial backup in that stanza is created. A create stanza must be attempted as the new bucket may be entirely empty. Issue: [ch11061]

Author: jkatz

docs/content/architecture/high-availability/_index.md

@@ -443,5 +443,6 @@ modification to the custom resource:
 - Custom annotation changes
 - Enabling/disabling the monitoring sidecar on a PostgreSQL cluster (`--metrics`)
 - Enabling/disabling the pgBadger sidecar on a PostgreSQL cluster (`--pgbadger`)
+- S3 bucket name updates
 - Tablespace additions
 - Toleration modifications

docs/content/custom-resources/_index.md

@@ -726,7 +726,7 @@ make changes, as described below.
 | backrestLimits | `create`, `update` | Specify the container resource limits that the pgBackRest repository should use. Follows the [Kubernetes definitions of resource limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container). |
 | backrestRepoPath | `create` | Optional reference to the location of the pgBackRest repository. |
 | BackrestResources | `create`, `update` | Specify the container resource requests that the pgBackRest repository should use. Follows the [Kubernetes definitions of resource requests](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container). |
-| backrestS3Bucket | `create` | An optional parameter that specifies a S3 bucket that pgBackRest should use. |
+| backrestS3Bucket | `create`, `update` | An optional parameter that specifies a S3 bucket that pgBackRest should use. If the name is updated, the Postgres Operator will create a new stanza and take an initial backup in the new bucket. |
 | backrestS3Endpoint | `create` | An optional parameter that specifies the S3 endpoint pgBackRest should use. |
 | backrestS3Region | `create` | An optional parameter that specifies a cloud region that pgBackRest should use. |
 | backrestS3URIStyle | `create` | An optional parameter that specifies if pgBackRest should use the `path` or `host` S3 URI style. |

internal/apiserver/backrestservice/backrestimpl.go

@@ -424,21 +424,19 @@ func ShowBackrest(name, selector, ns string) msgs.ShowBackrestResponse {
 
 // get the pgBackRest info using this legacy function
 info, err := getInfo(storageType, podname, ns, verifyTLS)
+
 // see if the function returned successfully, and if so, unmarshal the JSON
+// if there was an error getting the info, log that the error occurred in
+// the API server logs and have the response added to the list.
 if err != nil {
 log.Error(err)
-response.Status.Code = msgs.Error
-response.Status.Msg = err.Error()
-
-return response
-}
-
-if err := json.Unmarshal([]byte(info), &detail.Info); err != nil {
-log.Error(err)
-response.Status.Code = msgs.Error
-response.Status.Msg = err.Error()
-
-return response
+} else {
+if err := json.Unmarshal([]byte(info), &detail.Info); err != nil {
+log.Error(err)
+response.Status.Code = msgs.Error
+response.Status.Msg = err.Error()
+return response
+}
 }
 
 // append the details to the list of items

internal/controller/pgcluster/pgclustercontroller.go

@@ -18,6 +18,7 @@ limitations under the License.
 import (
 "context"
 "encoding/json"
+"fmt"
 "reflect"
 "strings"
 
@@ -332,6 +333,20 @@ func (c *Controller) onUpdate(oldObj, newObj interface{}) {
 rollingUpdateFuncs = append(rollingUpdateFuncs, clusteroperator.UpdateTolerations)
 }
 
+// check to see if the S3 bucket name has changed. If it has, this requires
+// both updating the Postgres + pgBackRest Deployments AND reruning the stanza
+// create Job
+if oldcluster.Spec.BackrestS3Bucket != newcluster.Spec.BackrestS3Bucket {
+// first, update the pgBackRest repository
+if err := updateBackrestS3(c, newcluster); err != nil {
+log.Errorf("not updating pgBackrest S3 settings: %s", err.Error())
+} else {
+// if that is successful, add updating the pgBackRest S3 settings to the
+// rolling update changes
+rollingUpdateFuncs = append(rollingUpdateFuncs, clusteroperator.UpdateBackrestS3)
+}
+}
+
 // if there is no need to perform a rolling update, exit here
 if len(rollingUpdateFuncs) == 0 {
 return
@@ -351,6 +366,12 @@ func (c *Controller) onUpdate(oldObj, newObj interface{}) {
 log.Error(err)
 return
 }
+
+// one follow-up post rolling update: if the S3 bucket changed, issue a
+// "create stanza" job
+if oldcluster.Spec.BackrestS3Bucket != newcluster.Spec.BackrestS3Bucket {
+backrestoperator.StanzaCreate(newcluster.Namespace, newcluster.Name, c.Client)
+}
 }
 
 // onDelete is called when a pgcluster is deleted
@@ -508,6 +529,54 @@ func updateAnnotations(c *Controller, oldCluster *crv1.Pgcluster, newCluster *cr
 return len(annotationsPostgres) != 0, nil
 }
 
+// updateBackrestS3 makes updates to the pgBackRest repo Deployment if any of
+// the S3 specific settings have changed. Presently, this is just the S3 bucket
+// name
+func updateBackrestS3(c *Controller, cluster *crv1.Pgcluster) error {
+ctx := context.TODO()
+
+// get the pgBackRest deployment
+backrestDeploymentName := fmt.Sprintf(util.BackrestRepoDeploymentName, cluster.Name)
+backrestDeployment, err := c.Client.AppsV1().Deployments(cluster.Namespace).Get(ctx,
+backrestDeploymentName, metav1.GetOptions{})
+
+if err != nil {
+return err
+}
+
+// update the environmental variable(s) in the container that is aptly(?)
+// named database
+for i, container := range backrestDeployment.Spec.Template.Spec.Containers {
+if container.Name != "database" {
+continue
+}
+
+for j, envVar := range backrestDeployment.Spec.Template.Spec.Containers[i].Env {
+if envVar.Name == "PGBACKREST_REPO1_S3_BUCKET" {
+backrestDeployment.Spec.Template.Spec.Containers[i].Env[j].Value = cluster.Spec.BackrestS3Bucket
+}
+}
+}
+
+if _, err := c.Client.AppsV1().Deployments(cluster.Namespace).Update(ctx,
+backrestDeployment, metav1.UpdateOptions{}); err != nil {
+return err
+}
+
+// update the annotation on the pgBackRest Secret too
+secretName := fmt.Sprintf(util.BackrestRepoSecretName, cluster.Name)
+patch, _ := kubeapi.NewMergePatch().Add("metadata", "annotations")(map[string]string{
+config.ANNOTATION_S3_BUCKET: cluster.Spec.BackrestS3Bucket,
+}).Bytes()
+
+if _, err := c.Client.CoreV1().Secrets(cluster.Namespace).Patch(ctx,
+secretName, types.MergePatchType, patch, metav1.PatchOptions{}); err != nil {
+return err
+}
+
+return nil
+}
+
 // updatePgBouncer updates the pgBouncer Deployment to reflect any changes that
 // may be made, which include:
 // - enabling a pgBouncer Deployment :)

internal/operator/cluster/cluster.go

@@ -485,6 +485,26 @@ func UpdateAnnotations(clientset kubeapi.Interface, cluster *crv1.Pgcluster, dep
 return nil
 }
 
+// UpdateBackrestS3 updates any pgBackRest settings that may have been updated.
+// Presently this is just the bucket name.
+func UpdateBackrestS3(clientset kubeapi.Interface, cluster *crv1.Pgcluster, deployment *apps_v1.Deployment) error {
+// go through the environmetnal variables on the "database" container and edit
+// the appropriate S3 related ones
+for i, container := range deployment.Spec.Template.Spec.Containers {
+if container.Name != "database" {
+continue
+}
+
+for j, envVar := range deployment.Spec.Template.Spec.Containers[i].Env {
+if envVar.Name == "PGBACKREST_REPO1_S3_BUCKET" {
+deployment.Spec.Template.Spec.Containers[i].Env[j].Value = cluster.Spec.BackrestS3Bucket
+}
+}
+}
+
+return nil
+}
+
 // UpdateResources updates the PostgreSQL instance Deployments to reflect the
 // update resources (i.e. CPU, memory)
 func UpdateResources(clientset kubeapi.Interface, cluster *crv1.Pgcluster, deployment *apps_v1.Deployment) error {