Merge pull request #39 from jujaga/feature/cronupdate

Add Database User/Password Key Parameterization to cronjob

.gitignore

@@ -5,6 +5,7 @@
 *_DeploymentConfig.json
 *_BuildConfig.json
 *.local.*
+*.overrides.*
 
 # Visual Studio Code
 .vscode

README.md

@@ -89,6 +89,8 @@ The following environment variables are defaults used by the `backup` app.
 | MONTHLY_BACKUPS | 1 | When using the rolling backup strategy this value is used to determine the number of monthly (last day of the month) backups to retain before pruning. |
 | BACKUP_PERIOD | 1d | Only used for Legacy Mode.  Ignored when running in Cron Mode.  The schedule on which to run the backups.  The value is used by a sleep command and can be defined in d, h, m, or s. |
 | DATABASE_SERVICE_NAME | postgresql | The name of the service/host for the *default* database target. |
+| DATABASE_USER_KEY_NAME | database-user | The database user key name stored in database deployment resources specified by DATABASE_DEPLOYMENT_NAME. |
+| DATABASE_PASSWORD_KEY_NAME | database-password | The database password key name stored in database deployment resources specified by DATABASE_DEPLOYMENT_NAME. |
 | POSTGRESQL_DATABASE | my_postgres_db | The name of the *default* database target; the name of the database you want to backup. |
 | POSTGRESQL_USER | *wired to a secret* | The username for the database(s) hosted by the `postgresql` Postgres server. The deployment configuration makes the assumption you have your database credentials stored in secrets (which you should), and the key for the username is `database-user`.  The name of the secret must be provided as the `DATABASE_DEPLOYMENT_NAME` parameter to the deployment configuration template. |
 | POSTGRESQL_PASSWORD | *wired to a secret* | The password for the database(s) hosted by the `postgresql` Postgres server. The deployment configuration makes the assumption you have your database credentials stored in secrets (which you should), and the key for the username is `database-password`.  The name of the secret must be provided as the `DATABASE_DEPLOYMENT_NAME` parameter to the deployment configuration template. |
@@ -124,6 +126,8 @@ The following variables are supported in the first iteration of the backup cronj
 | WEEKLY_BACKUPS | 4 | When using the rolling backup strategy this value is used to determine the number of weekly (Sun) backups to retain before pruning. |
 | MONTHLY_BACKUPS | 1 | When using the rolling backup strategy this value is used to determine the number of monthly (last day of the month) backups to retain before pruning. |
 | DATABASE_SERVICE_NAME | postgresql | The name of the service/host for the *default* database target. |
+| DATABASE_USER_KEY_NAME | database-user | The database user key name stored in database deployment resources specified by DATABASE_DEPLOYMENT_NAME. |
+| DATABASE_PASSWORD_KEY_NAME | database-password | The database password key name stored in database deployment resources specified by DATABASE_DEPLOYMENT_NAME. |
 | POSTGRESQL_DATABASE | my_postgres_db | The name of the *default* database target; the name of the database you want to backup. |
 | POSTGRESQL_USER | *wired to a secret* | The username for the database(s) hosted by the `postgresql` Postgres server. The deployment configuration makes the assumption you have your database credentials stored in secrets (which you should), and the key for the username is `database-user`.  The name of the secret must be provided as the `DATABASE_DEPLOYMENT_NAME` parameter to the deployment configuration template. |
 | POSTGRESQL_PASSWORD | *wired to a secret* | The password for the database(s) hosted by the `postgresql` Postgres server. The deployment configuration makes the assumption you have your database credentials stored in secrets (which you should), and the key for the username is `database-password`.  The name of the secret must be provided as the `DATABASE_DEPLOYMENT_NAME` parameter to the deployment configuration template. |

openshift/templates/backup/backup-cronjob.yaml

@@ -58,6 +58,20 @@ parameters:
     description: "The name associated to the database deployment resources.  In particular, this is used to wire up the credentials associated to the database."
     required: true
     value: "postgresql"
+  - name: DATABASE_USER_KEY_NAME
+    displayName: Database User Key Name
+    description:
+      The database user key name stored in database deployment resources specified
+      by DATABASE_DEPLOYMENT_NAME.
+    required: true
+    value: database-user
+  - name: DATABASE_PASSWORD_KEY_NAME
+    displayName: Database Password Key Name
+    description:
+      The database password key name stored in database deployment resources
+      specified by DATABASE_DEPLOYMENT_NAME.
+    required: true
+    value: database-password
   - name: "BACKUP_STRATEGY"
     displayName: "Backup Strategy"
     description: "The strategy to use for backups; for example daily, or rolling."
@@ -120,7 +134,7 @@ objects:
     DATABASE_SERVICE_NAME: "${DATABASE_SERVICE_NAME}"
     DEFAULT_PORT: "${DATABASE_DEFAULT_PORT}"
     POSTGRESQL_DATABASE: "${DATABASE_NAME}"
-#    BACKUP_STRATEGY: "daily"
+    # BACKUP_STRATEGY: "daily"
     RETENTION.NUM_BACKUPS: "${NUM_BACKUPS}"
     BACKUP_STRATEGY: "rolling"
     RETENTION.DAILY_BACKUPS: "${DAILY_BACKUPS}"
@@ -150,7 +164,7 @@ objects:
             containers:
               - name: "${JOB_NAME}-cronjob"
                 image: "docker-registry.default.svc:5000/${IMAGE_NAMESPACE}/${SOURCE_IMAGE_NAME}:${TAG_NAME}"
-#                image: backup
+                # image: backup
                 command:
                   - "/bin/bash"
                   - "-c"
@@ -210,12 +224,12 @@ objects:
                     valueFrom:
                       secretKeyRef:
                         name: "${DATABASE_DEPLOYMENT_NAME}"
-                        key: database-user
+                        key: "${DATABASE_USER_KEY_NAME}"
                   - name: POSTGRESQL_PASSWORD
                     valueFrom:
                       secretKeyRef:
                         name: "${DATABASE_DEPLOYMENT_NAME}"
-                        key: database-password
+                        key: "${DATABASE_PASSWORD_KEY_NAME}"
             volumes:
               - name: backup
                 persistentVolumeClaim: