EDB Postgres Containers - EnterpriseDB...EDB Postgres Containers now provides support for a PEM...
Transcript of EDB Postgres Containers - EnterpriseDB...EDB Postgres Containers now provides support for a PEM...
Copyright © 2018 EnterpriseDB Corporation. All rights reserved.
2
EDB Postgres Containers and Integration with OpenShift, Version 2.3 by EnterpriseDB® Corporation
Copyright © 2018 EnterpriseDB Corporation. All rights reserved.
EnterpriseDB Corporation, 34 Crosby Drive, Suite 201, Bedford, MA 01730, USA
T +1 781 357 3390 F +1 978 467 1307 E [email protected] www.enterprisedb.com
Copyright © 2018 EnterpriseDB Corporation. All rights reserved.
Table of Contents
1 Introduction ................................................................................................................. 3
1.1 What’s New ........................................................................................................ 4
1.2 Typographical Conventions Used in this Guide ................................................. 4
1.3 Supported Base Operating Systems .................................................................... 5
2 Preparing to Deploy an Advanced Server Container .................................................. 6
2.1 Deployment Prerequisites ................................................................................... 7
2.1.1 Step One - Create an OpenShift Project ......................................................... 8
2.1.2 Step Two - Grant Access Privileges ............................................................... 9
2.1.3 Step Three – Create and Configure the Volume Resources ......................... 10
2.1.4 Step Four - Create a Registry Secret ............................................................. 15
2.2 Creating a Template .......................................................................................... 16
2.3 Creating a Local Repository ............................................................................. 16
3 Using the OpenShift Console.................................................................................... 17
3.1 Scaling an Advanced Server Deployment ........................................................ 24
3.2 Using a ConfigMap Object to Customize a Configuration ............................... 25
3.3 Performing a Rolling Update ............................................................................ 28
3.4 Performing a Manual Backup ........................................................................... 29
3.4.1 Restoring a Cluster from Backup .................................................................. 30
3.5 Preparing an Advanced Server Cluster for Monitoring .................................... 31
3.5.1 Deploying a PEM Server ................................................................................. 31
3.5.2 Launching PEM Agent on Advanced Server Cluster ................................... 32
3.6 Removing a Project ........................................................................................... 33
3.6.1 Retaining a Project with No Pods ................................................................. 33
3.7 Upgrading an Advanced Server Container ....................................................... 34
4 Deploying a Container at the Docker Command Line .............................................. 36
4.1 Creating a Container at the Docker Command Line ......................................... 37
4.1.1 Deploying Advanced Server in a Container (Master Node) ......................... 38
4.1.2 Deploying Advanced Server in a Container (Standby Node) ....................... 41
4.1.3 Deploying pgPool in a Container .................................................................. 44
4.1.4 Deploying BART in a Container .................................................................. 46
5 Reference .................................................................................................................. 48
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 2
5.1 Sample Template File - EDB Postgres Advanced Server, pgPool, BART, and
PEM Agent.................................................................................................................... 48
5.2 Sample Template File - EDB Postgres Advanced Server and pgPool with
Custom Features............................................................................................................ 56
5.3 Sample Template File - BART ......................................................................... 61
5.4 Sample Template File - BART, Managing Backups for Multiple Databases ... 64
5.5 Sample Template File – PEM Server................................................................ 68
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 3
1 Introduction
EDB Postgres Platform for Containers allows you to use a Docker-formatted container to
deploy and manage EDB Postgres Advanced Server (Advanced Server) and supporting
components in a Red Hat OpenShift environment. OpenShift automation provides an
environment in which you can easily:
Deploy or disable Advanced Server instances as needed.
Automatically scale an Advanced Server instance to meet application
requirements.
Easily ensure Failover Manager protection for your data.
Utilize load balancing to distribute read/write requests across available servers.
Deploy Advanced Server instances with custom configurations in a container
environment.
The EDB Postgres Platform for Containers automates the deployment of containers that
include Advanced Server and the following supporting components:
EDB Failover Manager (EFM)
EDB Postgres Backup and Recovery Tool (BART)
pgPool (connection pooling for Postgres databases)
EDB Postgres Enterprise Manager (PEM)
For detailed information and documentation for each component, please visit the
EnterpriseDB website at:
http://www.enterprisedb.com/products-services-training/products/documentation
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 4
1.1 What’s New
The following changes have been made to EDB Postgres Containers and Integration with
OpenShift to create version 2.3:
EDB Postgres Containers now provides support for a PEM container. To review
the sample yaml file, see Section 5.5.
1.2 Typographical Conventions Used in this Guide
Certain typographical conventions are used in this manual to clarify the meaning and
usage of various commands, statements, programs, examples, etc. This section provides a
summary of these conventions.
In the following descriptions a term refers to any word or group of words that are
language keywords, user-supplied values, literals, etc. A term’s exact meaning depends
upon the context in which it is used.
Italic font introduces a new term, typically, in the sentence that defines it for the
first time.
Fixed-width (mono-spaced) font is used for terms that must be given
literally such as SQL commands, specific table and column names used in the
examples, programming language keywords, etc. For example, SELECT * FROM emp;
Italic fixed-width font is used for terms for which the user must
substitute values in actual usage. For example, DELETE FROM table_name;
A vertical pipe | denotes a choice between the terms on either side of the pipe. A
vertical pipe is used to separate two or more alternative terms within square
brackets (optional choices) or braces (one mandatory choice).
Square brackets [ ] denote that one or none of the enclosed term(s) may be
substituted. For example, [ a | b ], means choose one of “a” or “b” or neither
of the two.
Braces {} denote that exactly one of the enclosed alternatives must be specified.
For example, { a | b }, means exactly one of “a” or “b” must be specified.
Ellipses ... denote that the proceeding term may be repeated. For example, [ a |
b ] ... means that you may have the sequence, “b a a b a”.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 5
1.3 Supported Base Operating Systems
The following containers are available in the EDB container registry at
containers.enterprisedb.com:
CentOS 7-based containers:
containers.enterprisedb.com/edb/edb-as:v10
containers.enterprisedb.com/edb/edb-as:v9.6
containers.enterprisedb.com/edb/edb-pgpool:v3.6
containers.enterprisedb.com/edb/edb-bart:v2.1
containers.enterprisedb.com/edb/edb-pemserver:v7.3
containers.enterprisedb.com/edb/edb-admintool
RHEL 7-based containers:
containers.enterprisedb.com/edb/edb-as-rhel7:v10
containers.enterprisedb.com/edb/edb-as-rhel7:v9.6
containers.enterprisedb.com/edb/edb-pgpool-rhel7:v3.6
containers.enterprisedb.com/edb/edb-bart-rhel7:v2.1
containers.enterprisedb.com/edb/edb-pemserver-rhel7:v7.3
NOTE: These images are also downloadable as tar files from the EDB website at:
https://www.enterprisedb.com/advanced-downloads
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 6
2 Preparing to Deploy an Advanced Server Container
Red Hat OpenShift is an open source container application platform based on the
Kubernetes container orchestrator for enterprise application development and
deployment. EDB Postgres Platform for Containers is supported on Red Hat OpenShift
Container Platform (previously called OpenShift Enterprise), Red Hat OpenShift Origin,
and Red Hat OpenShift Online environments.
OpenShift supports multi-node Advanced Server clusters that include deployments of
Advanced Server (with EDB Failover Manager), EDB BART, and pgPool.
EDB Postgres Platform for Containers are supported on OpenShift version 3.6 or later.
For information about OpenShift Container Platform and OpenShift Online, please visit:
https://www.openshift.com
For information about OpenShift Origin, please visit
https://www.openshift.org/
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 7
2.1 Deployment Prerequisites
To deploy a container, you must have access to the repository in which the containers are
stored (containers.enterprisedb.com). To receive credentials that allow you to
access the container repository, please submit a request at:
https://www.enterprisedb.com/general-inquiry-form
Some prerequisite steps and advanced management tasks must be performed at the
OpenShift command line. For detailed information about using the OpenShift command
line, see the project documentation at:
https://docs.openshift.com/container-platform/3.6/cli_reference/get_started_cli.html
Before deploying the EDB Postgres Platform for Containers, you must:
1. Create an OpenShift project that will describe the resource allocations and
template information for the container.
2. Grant required privileges to the project.
3. Create and configure the volume resources that the Advanced Server and BART
containers will use.
4. Create a registry secret that contains connection information for the container
repository.
The following sections provide detailed information about each step listed above.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 8
2.1.1 Step One - Create an OpenShift Project
Use the OpenShift command line utility to login and create a project. Include the -u flag
and specify a user name when connecting and enter the password when prompted:
oc login -u user_name
Then, create a project:
oc new-project project_name
Where project_name specifies the name of the new project.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 9
2.1.2 Step Two - Grant Access Privileges
Use the following commands to grant cluster role privileges to the default service account
associated with the project:
oadm policy add-cluster-role-to-user edit
system:serviceaccount:project_name:default
oc policy add-role-to-user view
system:serviceaccount:project_name:default
Where project_name specifies the name of the project.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 10
2.1.3 Step Three – Create and Configure the Volume Resources
Advanced Server and BART containers require persistent storage. In OpenShift,
persistent storage is provided through persistent volume (PV) and persistent volume
claims (PVC). Before deploying an Advanced Server or BART container, an
administrative user must provision persistent storage by creating the required persistent
volumes, and developers must create persistent volume claims for the project to request
PV resources. The administrator can choose from a variety of storage backends such as
local volumes or shared volumes (NFS, glusterFS, etc.) to configure the persistent
volumes. The volume on which Advanced Server resides may be either local or shared,
but BART must reside on a non-local volume.
For OpenShift Enterprise and OpenShift Origin environments, the following sections
provide examples of creating and configuring PVs and PVCs using two different storage
backends, local volumes and glusterfs-based shared volumes.
For more information about OpenShift volumes, please see the OpenShift documentation
at:
https://docs.openshift.com/container-platform/3.6/dev_guide/persistent_volumes.html
If you are using an OpenShift Online environment, use the web console to create the
persistent volumes. For more information, please visit:
https://docs.openshift.com/online/dev_guide/persistent_volumes.html
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 11
2.1.3.1 Using Local Volumes
To use a local volume, the administrator must create the directories in which the volume
will reside and ensure that the permissions on the directory allow write access.
Note: Local volumes are not recommended for production environments.
Use the following commands to set up the directory:
mkdir path_to_volume_directory
chmod -R 777 path_to_volume_directory
chcon -Rt svirt_sandbox_file_t path_to_volume_directory
Where:
path_to_volume_directory is the complete path to the directory in which
the volume will reside.
Note: the directory must be created on each OpenShift node, and necessary privileges
granted in OpenShift to use the local (hostPath) volumes.
Once the directory (directories in case of multiple nodes), the following sample YAML
files create a persistent volume and volume claim for local volumes.
The local persistent-volume.yaml File
Include the following content when defining a local persistent volume; customize the
content for your host(s):
apiVersion: v1
kind: PersistentVolume
metadata:
name: persistent_volume_name
spec:
capacity:
storage: 10Gi
accessModes:
- ReadWriteOnce
hostPath:
path: path_to_volume_directory
persistentVolumeReclaimPolicy: Retain
Where:
persistent_volume_name is the name of the persistent volume.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 12
path_to_volume_directory is the directory in which the volume will reside
The local persistent-volume-claim.yaml File
Include the following content when defining a local persistent volume claim:
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: persistent_volume_claim_name
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 2Gi
volumeName: persistent_volume_name
Where:
persistent_volume_claim_name is the name of the persistent volume claim.
persistent_volume_name is the name of the associated persistent volume.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 13
2.1.3.2 Using Shared Volumes
To use shared volumes based on a glusterfs-based storage backend, use the following the
YAML files to create the endpoint, the persistent volume, and the volume claim files.
The glusterfs-endpoint.yaml File
apiVersion: v1
kind: Endpoints
metadata:
name: glusterfs_endpoint_name
subsets:
- addresses:
- ip: glusterfs-node1-ipaddress # node1 IP
ports:
- port: 1
- addresses:
- ip: glusterfs-node2-ipaddress # node2 IP
ports:
- port: 1
Where:
glusterfs_endpoint_name is the name of the glusterfs endpoint.
glusterfs-node1-ipaddress is the IP address of node 1 of the glusterfs
cluster.
glusterfs-node2-ipaddress is the IP address of node 2 of the glusterfs
cluster.
The shared persistent-volume.yaml File
Include the following content when defining a shared persistent volume; customize the
content for your host(s):
apiVersion: v1
kind: PersistentVolume
metadata:
name: persistent_volume_name
spec:
capacity:
storage: 4Gi
accessModes:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 14
- ReadWriteMany
glusterfs:
endpoints: glusterfs_endpoint_name
path: glusterfs_volume
readOnly: false
persistentVolumeReclaimPolicy: Retain
Where:
persistent_volume_name is the name of the persistent volume.
glusterfs_endpoint_name is the name of the glusterfs endpoint.
glusterfs_volume is the name of the glusterfs volume.
The shared persistent-volume-claim.yaml File
Include the following content when defining a shared persistent volume claim:
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: persistent_volume_claim_name
spec:
accessModes:
- ReadWriteMany
resources:
requests:
storage: 2Gi
volumeName: persistent_volume_name
Where:
persistent_volume_claim_name is the name of the persistent volume claim.
persistent_volume_name is the name of the associated persistent volume.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 15
2.1.4 Step Four - Create a Registry Secret
Use the oc secrets command to create an OpenShift Secret object that contains
connection information for the EnterpriseDB repository:
oc secrets new-dockercfg secret_name \
--docker-server=containers.enterprisedb.com \
--docker-username=repo_user_name \
--docker-password=repo_user_password \
Where:
secret_name specifies the name of the secret.
repo_user_name specifies the name of the EnterpriseDB repository user.
repo_user_password specifies the password associated with the specified
user name.
[email protected] specifies the email address of the user.
You must add the secret to your service account; include the default keyword to use
the default service account:
oc secrets add serviceaccount/default secrets/secret_name -
-for=pull
The following command creates a secret that can be mounted in a pod:
oc secrets add serviceaccount/builder secrets/secret_name
You can also use OpenShift Secret objects to manage sensitive information such as
passwords. For more information about using OpenShift Secret objects, see the
OpenShift documentation at:
https://docs.openshift.com/container-platform/3.6/dev_guide/secrets.html
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 16
2.2 Creating a Template
A template is a .yaml file that describes a set of objects that can be parameterized and
processed to produce a list of objects for creation by OpenShift Container Platform. To
create and upload a template to your current project’s template library, use the command:
oc create -f template-yaml-file
After creating the template, you can customize parameter values during deployment.
Section 4 includes a number of sample template files that you can use as a starting point.
2.3 Creating a Local Repository
To create a local repository that contains EDB Postgres images, you must create a local
Docker registry. For example, the following command creates and starts a registry on localhost:5000
docker run -d -p 5000:5000 --restart=always --name registry
registry:2
The following commands will push the Advanced Server image from the EnterpriseDB
repository to a local repository (localhost:5000):
docker pull containers.enterprisedb.com/edb/edb-as:v10
docker tag containers.enterprisedb.com/edb/edb-as:v10
localhost:5000/edb/edb-as:v10
docker push localhost:5000/edb/edb-as:v10
Use similar steps to create pgPool (edb-pgpool:v3.5) and BART (edb-bart:v2.0)
repositories.
For information about creating a local Docker registry, please see the Docker
documentation at:
https://docs.docker.com/registry/deploying/#storage-customization
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 17
3 Using the OpenShift Console
After creating a project and any required templates (the prerequisite steps outlined in
Section 2), you can use the OpenShift console to create and manage Advanced Server
projects. Use your browser to access the OpenShift web console, and log on using your
OpenShift credentials. When you've successfully authenticated, the console displays the
My Projects page (see Figure 3.1).
Figure 3.1 – The OpenShift console Projects page.
Select your project (for example, my-edbas-project) from the Projects list; the
OpenShift console will navigate to the project management page (see Figure 3.2).
Figure 3.2 – The OpenShift console project management page.
Click the Add to Project button to open the Select Image or Template page (see
Figure 3.3).
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 18
Figure 3.3 – The OpenShift console Select Image or Template page.
Select the button that is labeled with the name of the Advanced Server template. The
OpenShift console opens a page that allows you to specify details for your Advanced
Server deployment (see Figure 3.4).
Figure 3.4 – The OpenShift Parameters page.
Use the fields displayed under the Parameters heading to provide installation details
for the deployment. The details provided are used during pod initialization; it is
important to note that password changes are not allowed after a pod has been initialized.
Use the Database Name field to provide the name of the database that will be
created when the cluster is initialized.
Use the Default database user field to specify the name of a database
superuser that is created when the database is initialized; by default, the database
superuser is named enterprisedb.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 19
If you accept the default (enterprisedb), the user will be associated with the
password provided by an OpenShift Secret created for the enterprisedb
password.
If you specify an alternate name for the database superuser, the user will be
associated with the password provided via an OpenShift Secret created for the
alternate user password. Optionally, you can provide the name of an alternate
user with a ConfigMap.
Use the Repl user field to specify the name of the replication user; the default
name is repl. Optionally, you can use a ConfigMap to provide the name of a
replication user.
The replication user will be associated with a password provided in a OpenShift
Secret created for the replication user password.
Use the Database Port field to specify the port that the database will monitor
for connections.
Use the Locale field to specify the locale used by the cluster; by default, the
locale is the system locale.
Use the Host Cleanup Schedule to specify the execution schedule for a
cleanup script. The cleanup script will review the data directories, and mark any
directory for deletion that has not been used in the last 24 hours. If you do not
provide a value in this field, the cleanup script will not execute.
Use the Email field to provide the email address that will receive any
notifications sent by Failover Manager.
Use the Name Server for Email parameter to provide the identity of a name
server that will be used for notifications from Failover Manager.
Use the Enable Monitoring parameter to indicate whether monitoring should
be enabled; valid options are Yes or No (default).
Use the Enable High Availability parameter to indicate whether high
availability mode should be enabled; valid options are Yes (default) or No.
Use the Persistent Volume field to specify the name of the persistent volume
definition file.
Use the Persistent Volume Claim to specify the name of the persistent
volume claim definition file.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 20
Use the Backup Volume field to provide the name of the volume claim for
BART.
Use the Backup Volume Claim field to provide the name of the persistent
volume claim for BART.
Use the BART Host Address field to provide the address of the BART server
host.
Use the Database Host field to provide the name of the database server that
BART is backing up.
Use the Automate backup operation field to indicate if backups should be
taken automatically; if you specify No, the BART Backup Schedule field and the
BART Number of Backups to Keep fields will not apply, and you must
manually take backups and manage backup retention.
Use the BART Backup Schedule field to provide the cron formatted schedule
on which backups will be performed.
Use the BART Number of Backups to Keep field to specify the number of
database backups that will be stored.
Use the Compress backup files field to specify if backup files should be
stored in compressed format.
Use the Restore File field to specify the name and location of a backup file
that will be restored during the deployment.
Use the PEM Server field to specify the address of the PEM server.
Use the PEM Server Port field to specify the port number of the PEM
database server.
Use the PEM user field to specify the name of the PEM user for accessing the
PEM server.
Provide a value in the Accept end-user license agreement field; valid
options are Yes or No.
Use the Labels section of the Parameters dialog to specify one or more tags that will
be applied to the container. For more information about using labels, see the OpenShift
documentation.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 21
When you have completed the Parameters dialog, click the Create button to deploy
an Advanced Server project.
Figure 3.5 – Continue to the project overview.
Click the Continue to overview banner (see Figure 3.5) to open the deployment
status screen. In the example, four Advanced Server pods, two pgPool pods, and one
BART pod are being deployed.
Figure 3.6 – The pods are being deployed.
As OpenShift spins up the pods, the progress indicator will change from light blue to
darker blue (see Figure 3.6).
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 22
Figure 3.7 – The cluster is ready for use.
When the progress indicators are solid blue for all the pods, the pods are ready to accept
client requests and the cluster is ready for use (see Figure 3.7).
You can review a listing of all the pods in the cluster on the Applications dialog (see
Figure 3.8).
Figure 3.8 – A list of available pods, including pod names.
You can also use the OpenShift CLI to review a list of pods, along with their respective
roles:
oc get pods -o wide -L role -L cluster-l
cluster=cluster_name
Where:
cluster_name specifies the name of the cluster.
The following screen shows the pod listing for a cluster named edb:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 23
Figure 3.9 – List of pods with names and roles
To check the log files for a pod, use the command:
oc rsh pod_name cat startup.log
Where pod_name specifies the name of a specific pod.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 24
3.1 Scaling an Advanced Server Deployment
The default configuration of EDB Postgres Advanced Server for OpenShift uses EDB
Postgres Failover Manager to ensure high-availability for your deployment. If a pod
fails, Failover Manager detects the failure, and replaces the pod with a running node. If
the failed node is the master in your replication scenario, Failover Manager promotes a
standby node to the role of master before adding a replacement standby to the scenario.
To prevent disruptions in Failover Manager monitoring, an Advanced Server deployment
must have at least four pods; by default, each new Advanced Server project will have
four pods.
Figure 3.10 – Use the arrows to the right of the blue circle to scale a deployment.
Please note: by default, the container environment will support up to 9 pods; to support
10 or more pods, you must modify the server configuration.
Manually Scaling a Pod
You can use the up arrow (to the right of the blue circle) to add new pods to your
deployment when processing requirements are higher, or use the down arrow to remove
unneeded pods from the deployment when processing requirements are light (see Figure
3.11). Please note that when removing a pod from your deployment, OpenShift may
remove the master node in your replication scenario. If Failover Manager is enabled, and
the master node is removed during scaling, a standby node will be promoted to the role of
master.
If you plan to remove multiple pods from a deployment, you should allow time for each
pod to be completely removed before removing each additional pod to avoid interfering
with Failover Manager protection.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 25
3.2 Using a ConfigMap Object to Customize a Configuration
You can use an OpenShift ConfigMap object to create a template that specifies a custom
configuration, executes SQL commands, or specifies the name of the database superuser.
When specifying a custom parameter value for the postgresql.conf file,
provide the modified parameter=value pair(s) in a file named
postgresql.conf.in. Contents of the postgresql.conf.in file are
appended to the current postgresql.conf file.
When specifying a custom entry for the pg_hba.conf file, provide the entry in a
file named pg_hba.conf.in. Contents of the pg_hba.conf.in file are
appended to the current pg_hba.conf file.
When using a ConfigMap to execute SQL commands at deployment, provide the
SQL commands in a file named dbload.
Sample contents of the postgresql.conf.in file, the pg_hba.conf.in file, and the
dbload file are included in Section 5.2.
After creating custom files, copy the files into a directory that can be accessed when
deploying the container. Then, create a ConfigMap with the command:
oc create configmap map_name --from-file=directory_name
Where:
map_name is the name of the ConfigMap.
directory_name specifies the directory that contains the custom configuration
files.
After creating the ConfigMap, you must modify the template file, specifying the location
of the files in the volumes section:
- name: mount_name
configMap:
name: map_name
You must also modify the volumeMounts section:
volumeMounts:
- name: mount_name
mountPath: /target_directory
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 26
Where:
mount_name is the name used within the template file to link the ConfigMap
name with the target directory on the deployment.
map_name is the name of the ConfigMap.
target_directory is the name of the directory on the deployment to which the
files will be copied.
Any containers deployed using the template will use the customized configuration files.
To create a ConfigMap that specifies the (non-default) name of the database superuser or
replication user, include the --from-literal type, followed by the associated
keyword, and the name of the user.
When specifying the name of a database superuser, include the database.user
keywords.
When specifying the name of a replication user, include the repl.user
keywords.
Use the following command to create the ConfigMap:
oc create configmap --from-literal=user_type=user_name
Where:
user_type is either database.user or repl.user.
user_name is the name of the user.
You do not need to update the template file when using a ConfigMap to specify a non-
default user name.
For detailed information about customizing the postgresql.conf file, please refer to
the Postgres core documentation, available at:
https://www.postgresql.org/docs/10/static/config-setting.html#CONFIG-SETTING-
CONFIGURATION-FILE
For detailed information about customizing the pg_hba.conf file, please refer to the
Postgres core documentation, available at:
https://www.postgresql.org/docs/10/static/auth-pg-hba-conf.html
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 27
For more information about using an OpenShift ConfigMap object, please see the
OpenShift documentation at:
https://docs.openshift.com/enterprise/3.2/dev_guide/configmaps.html
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 28
3.3 Performing a Rolling Update
When an updated version of Advanced Server becomes available, you can use a rolling
update technique to upgrade your cluster. EnterpriseDB's Docker repository will always
make available the most recent version of the server; to update the server version used in
your deployment, you can simply:
1. When an updated version of Advanced Server becomes available, use the
OpenShift console to add new pods to the cluster; as each new pod is added, the
new pod will use the updated server version.
2. Remove pods that were instantiated using the old server version (including the
original master node of the replication scenario).
Note: To preserve the integrity of your Failover Manager scenario, you should not let the
total pod count of the deployment drop below four when performing a rolling update.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 29
3.4 Performing a Manual Backup
To perform a manual backup, use the OpenShift command line to identify the BART
container:
oc get pods -o wide -L role -L cluster -l role=backuptool
-l cluster=cluster_name
Then, use the OpenShift command line to log in to the BART container
oc rsh pod_name
Where pod_name is the value displayed for the backuptool in the list of pods.
Then, use BART to perform a backup:
bart backup -s cluster_name -Ft –z
Where:
cluster_name specifies the name of the cluster.
For example:
bart backup -s edb -Ft -z
INFO: creating backup for server 'edb'
INFO: backup identifier: '1525640148300'
65043/65043 kB (100%), 1/1 tablespace
INFO: backup completed successfully
INFO: backup checksum: 86bd2596f9bd69f4ca11f96555ff98f0 of
base.tar.gz
INFO:
BACKUP DETAILS:
BACKUP STATUS: active
BACKUP IDENTIFIER: 1525640148300
BACKUP NAME: none
BACKUP PARENT: none
BACKUP LOCATION: /edbbackup/edb-bart-1-
j1czk/pgbackup/edb/1525640148300
BACKUP SIZE: 6.73 MB
BACKUP FORMAT: tar.gz
BACKUP TIMEZONE: UTC
XLOG METHOD: fetch
BACKUP CHECKSUM(s): 1
ChkSum File
86bd2596f9bd69f4ca11f96555ff98f0 base.tar.gz
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 30
TABLESPACE(s): 0
START WAL LOCATION: 00000001000000000000000D
BACKUP METHOD: streamed
BACKUP FROM: master
START TIME: 2018-05-06 20:55:48 UTC
STOP TIME: 2018-05-06 20:55:50 UTC
TOTAL DURATION: 2 sec(s)
BART creates the fully qualified filename by concatenating the BACKUP LOCATION and
File fields. You can use the filename to restore the cluster if needed. In the example
above, the fully qualified filename is:
/edbbackup/edb-bart-1-j1czk/pgbackup/edb/1525640148300/
base.tar.gz
3.4.1 Restoring a Cluster from Backup
To restore the cluster, use the Add to Project button to deploy a new cluster; when
prompted, provide the name of the backup file in the Restore File field on the
Parameters dialog for the deployment (see Figure 3.11).
Figure 3.11 – Restoring a cluster from backup.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 31
3.5 Preparing an Advanced Server Cluster for Monitoring
To use PEM to monitor an Advanced Server cluster, you must complete the following
steps:
1. Start (deploy) the PEM server container.
2. Launch the PEM agent on the Advanced Server cluster.
3.5.1 Deploying a PEM Server
To deploy the PEM server, you can use the sample template provided in Section 5.5 after
you make required changes. Once the PEM server is deployed, you can access the admin
console via your browser at the following URL and login:
https://<your-server-ip>:<pem-port>/pem/login
Figure 3.12 – PEM Admin Console Login Page
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 32
3.5.2 Launching PEM Agent on Advanced Server Cluster
Once the PEM server is deployed, you can launch the the PEM agent on the Advanced
Server cluster in either of the two ways:
1. Enable monitoring on the Advanced Server cluster at startup by setting the
ENABLE_MONITOR_MODE parameter to Yes (refer to sample template in Section
5.1)
2. Use the admin tool to enable monitoring on a running Advanced Server cluster:
First, download the admin tool:
oc new-app containers.enterprisedb.com/edb/edb-admintool
Then, launch the agent:
oc rsh `oc get pod -o name -l role=admintool` \
launchpemagent \
--database=database_name \
--pem-port=pem-port \
--pem-user=pem-user
Figure 3.12 – PEM Admin Console Global Overview Page
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 33
3.6 Removing a Project
Use the following set of commands to remove a project:
oc project project-name
For example, to remove a project named epas-10:
oc project epas-10
3.6.1 Retaining a Project with No Pods
You can delete all pods in the project but retain the project for later use; use the
commands:
oc delete dc/database_name-as10
dc/database_name -pgpool
dc/database_name -bart
oc delete svc database_name-service
You can reuse the Secret and ConfigMap objects created earlier.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 34
3.7 Upgrading an Advanced Server Container
You can use the migration tool to upgrade an Advanced Server version 9.6 Container to
Advanced Server version 10. The following steps detail the upgrade process:
1. Download the migration tool:
oc new-app containers.enterprisedb.com/ edb/edb-admintool
2. Open a command line to the Advanced Server container:
oc rsh container_name
3. Inside the Advanced Server container, use pg_dumpall to take a logical backup.
When the command completes, verify the location of the dump file, and exit back
to the command line.
mkdir -p /edbvolume/$DATABASE_NAME/$HOSTNAME/pgdump
pg_dumpall -c -f
/edbvolume/$DATABASE_NAME/$HOSTNAME/pgdump/${DATABASE_NAME}
.dumpall.sql
ls -l
/edbvolume/$DATABASE_NAME/$HOSTNAME/pgdump/${DATABASE_NAME}
.dumpall.sql
exit
4. Run the migration tool in preview mode. This is an optional step that will not
perform an actual migration, but will generate a sample of the yaml file to be used
to deploy the upgraded Advanced Server container
oc rsh `oc get pod -o name -l role=admintool` migratedb
--database=database_name
--version=10
--restore-file=dumpall_file_name
--preview > my_deployment_preview.yaml
Where:
database_name is the name of the Advanced Server database.
dumpall_file_name is the name of the pg_dumpall file created in Step 3.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 35
my_deployment_preview.yaml specifies the name of the yaml file generated
when invoking the migration tool in preview mode.
5. Run the migration tool. This step will delete the old Advanced Server cluster,
deploy the upgraded Advanced Server cluster and restore data from the old cluster
into the new cluster.
oc rsh `oc get pod -o name -l role=admintool` migratedb
--database=database_name
--version=10
--restore-file= dumpall_file_name | oc create -f -
Where:
database_name is the name of the Advanced Server database.
dumpall_file_name is the name of the pg_dumpall file created in Step 3.
For detailed information about using pg_dumpall, see the PostgreSQL online
documentation at:
https://www.postgresql.org/docs/10/static/app-pgdumpall.html
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 36
4 Deploying a Container at the Docker Command Line
You can use the Docker command line client to deploy, manage, and use an Advanced
Server container. We recommend including the following docker command options
when using the command line:
-d
The –d option forces docker to run in the background as a daemon. This option is
optional.
--privileged
The --privileged option may be required if local security settings do not
permit mounting a local volume with read-write options. As an alternative, we
recommend allowing your security settings to permit the container to have read-
write access to the mounted volume. If applicable, adjust your SELinux settings
to allow access.
--restart=always
This option specifies your restart preferences for the container. Please refer to the
docker documentation for details about the supported options.
For more information about docker commands and command options, please see the
documentation at:
https://docs.docker.com/engine/reference/commandline/docker/
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 37
4.1 Creating a Container at the Docker Command Line
Use the docker run command to deploy a container at the command line. You can
specify environment variables at the command line (when invoking the docker run
command), or (for convenience) in a file located in the network mountpoint. Consult the
docker documentation for a complete list of command options:
https://docs.docker.com/engine/reference/commandline/run/
The number of nodes that you must deploy will depend on the features that you wish to
use with your system. For example, if you are using EFM functionality, you will need to
create at least one master and two standby nodes.
When you use the Docker command line to create standby nodes or containers that
provide complimentary functionality for Advanced Server, you specify information about
the configuration of the cluster, and the names of master or standby nodes of the cluster.
Please note that information provided in the container configuration must be consistent
across all nodes of the cluster.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 38
4.1.1 Deploying Advanced Server in a Container (Master Node)
The master node of a cluster contains an instance of Advanced Server and a supporting
Failover Manager deployment. When deploying a master node, include the following
syntax:
docker run \
--name "master_name" \
-e DATABASE_NAME="db_name"\
-e PGPORT=db_listener_port \
-e DATABASE_USER="db_user_name" \
-e DATABASE_USER_PASSWORD="db_user_password" \
-e ENTERPRISEDB_PASSWORD="enterprisedb_password" \
-e LOCALEPARAMETER="locale" \
-e CLEANUP_SCHEDULE="0:0:*:*:*" \
-e EFM_EMAIL="[email protected]" \
-e NAMESERVER=”nameserver_ipaddress” \
-e ACCEPT_EULA=Yes|No \
-e REPL_USER="repl_user_name" \
-e REPL_PASSWORD="repl_user_password" \
-v hostvolume:/edbvolume \
-p host_port:container_port \
-d containers.enterprisedb.com/edb/edb-as:v10
Include the --name option to specify the name of the master node of the cluster. For
example, master, replica1, replica2, and replica3 might identify the nodes of
a replication cluster.
Include the -e option with the docker run command to specify values for environment
variables used to configure your container. Include the following values when deploying
a master node that includes Advanced Server and Failover Manager:
Use the DATABASE_NAME environment variable to specify the name of the
Advanced Server database.
Use the PGPORT environment variable to specify the listener port of the
Advanced Server database (by default, 5444).
Use the DATABASE_USER environment variable to specify the name of a
database superuser that will be created when the database is initialized; by default,
the database superuser is named enterprisedb.
If you specify the default (enterprisedb), the user will be associated
with the password provided in the EnterpriseDB Password field.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 39
If you specify an alternate name for the database superuser, the user will
be associated with the password provided in the Password for default
database user field.
Use the DATABASE_USER_PASSWORD environment variable to specify the
password associated with the database superuser if you specify a
db_user_password other than enterprisedb. Please note that this password
should not be changed after the pod is initialized.
Use the ENTERPRISEDB_PASSWORD environment variable to specify the
password associated with the default database superuser (enterprisedb).
During the installation process, the container creates a database superuser named
enterprisedb. Please note that this password should not be changed after the
pod is initialized.
Use the LOCALEPARAMETER environment variable to specify the locale that will
be used by the container.
Use the CLEANUP_SCHEDULE environment variable to provide an execution
schedule for a cleanup script. The cleanup script will review the data directories,
and mark any directory for deletion that has not been used in the last 24 hours.
Specify the value in a cron format; if you do not provide a value, the cleanup
script will not execute.
Use the EFM_EMAIL environment variable to specify the email address that will
receive any notifications sent by Failover Manager. For detailed information
about Failover Manager event notifications, please see the EDB Postgres Failover
Manager Guide.
Use the NAMESERVER environment variable to specify the identity of a name
server that will be used for notifications from Failover Manager.
Use the ACCEPT_EULA environment variable to indicate if you accept or decline
the EnterpriseDB license. The license is available for review at:
https://www.enterprisedb.com/node/4509
Please note: you must accept the license agreement to deploy a container.
Use the REPL_USER environment variable to specify the name of the Postgres
streaming replication user.
Use the REPL_PASSWORD environment variable to specify the password
associated with the replication user.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 40
Include the -v option and the name of the volume in which the container will reside; for
example, the following /data/edbas:/edbvolume
Include the -d option to indicate that the container should be deployed in detached mode;
this enables background processing for the deployment.
Include the -p option to enable port forwarding from the container to the host machine;
for example, -p 5445:5444 makes port 5444 in the container available on port 5445
on the host system.
After providing values for the environment variable and including any docker options,
specify the repository name and image you wish to use.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 41
4.1.2 Deploying Advanced Server in a Container (Standby Node)
A standby container hosts an instance of Advanced Server that is replicating the
Advanced Server master node. If Failover Manager detects a failure on the part of the
master node, a standby will assume the role of master node for the cluster. When
deploying a standby node, include the following syntax:
docker run --name "standby_name" \
-e DATABASE_NAME="db_name" \
-e PGPORT=db_listener_port \
-e DATABASE_USER="db_user_name" \
-e DATABASE_USER_PASSWORD="db_user_password" \
-e ENTERPRISEDB_PASSWORD="enterprisedb_password" \
-e REPL_USER="repl_user_name" \
-e REPL_PASSWORD="repl_user_password" \
-e LOCALEPARAMETER="locale" \
-e CLEANUP_SCHEDULE="0:0:*:*:*" \
-e EFM_EMAIL="[email protected]" \
-e NAMESERVER=”nameserver_ipaddress” \
-e ACCEPT_EULA=Yes|No \
-e MASTER_HOST "`sudo docker inspect --format '{{ .NetworkSettings.IPAddress }}' master_name`" \
-e MASTER_PORT=5444 \
-v hostvolume:/edbvolume \
--expose standby_listener_port \
-d containers.enterprisedb.com/edb/edb-as:v10
Include the --name option to specify the unique name of the node.
Include the -e option with the docker run command to specify values for environment
variables used to configure your container. Include the following values when deploying
a container that includes an installation of Advanced Server:
Use the DATABASE_NAME environment variable to specify the name of the
Advanced Server database.
Use the PGPORT environment variable to specify the listener port of the
Advanced Server database (by default, 5444).
Use the DATABASE_USER environment variable to specify the name of a
database superuser that will be created when the database is initialized; by default,
the database superuser is named enterprisedb.
If you specify the default (enterprisedb), the user will be associated
with the password provided in the EnterpriseDB Password field.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 42
If you specify an alternate name for the database superuser, the user will
be associated with the password provided in the Password for default
database user field.
Use the DATABASE_USER_PASSWORD environment variable to specify the
password associated with the database superuser if you specify a
db_user_password other than enterprisedb. Please note that this password
should not be changed after the pod is initialized.
Use the ENTERPRISEDB_PASSWORD environment variable to specify the
password associated with the default database superuser (enterprisedb).
During the installation process, the container creates a database superuser named
enterprisedb. Please note that this password should not be changed after the
pod is initialized.
Use the REPL_USER environment variable to specify the name of the Postgres
streaming replication user.
Use the REPL_PASSWORD environment variable to specify the password
associated with the replication user.
Use the LOCALEPARAMETER environment variable to specify the locale that will
be used by the container.
Use the CLEANUP_SCHEDULE environment variable to provide an execution
schedule for a cleanup script. The cleanup script will review the data directories,
and mark any directory for deletion that has not been used in the last 24 hours.
Specify the value in a cron format; if you do not provide a value, the cleanup
script will not execute.
Use the EFM_EMAIL environment variable to specify the email address that will
receive any notifications sent by Failover Manager. For detailed information
about Failover Manager event notifications, please see the EDB Postgres Failover
Manager Guide.
Use the NAMESERVER environment variable to specify the identity of a name
server that will be used for notifications from Failover Manager.
Use the ACCEPT_EULA environment variable to indicate if you accept or decline
the EnterpriseDB license. The license is available for review at:
https://www.enterprisedb.com/node/4509
Note: You must accept the license agreement to deploy a container.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 43
Use the MASTER_HOST environment variable to identify the master node of the
replication cluster. The clause uses a call to docker inspect to retrieve the
address of the master node of the cluster:
MASTER_HOST="`sudo docker inspect --format '{{
.NetworkSettings.IPAddress }}'master_name`".
Replace master_name with the name of the master node of the cluster.
Include the -v option and the name of the volume in which the container will reside; for
example, /data/edbas:/edbvolume.
Include the --expose clause and the port number monitored by the Advanced Server host
to make the specified port available for connections.
Include the -d option to indicate that the container should be deployed in detached mode;
this enables background processing for the deployment.
After providing values for the environment variable and including any docker options,
specify the repository name and image you wish to use.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 44
4.1.3 Deploying pgPool in a Container
pgPool is a connection pooler for Advanced Server. When deploying a pgPool container,
include the following syntax:
docker run --name "container_name" \
-e DATABASE_NAME="db_name" \
-e PGPORT=db_listener_port \
-e ENTERPRISEDB_PASSWORD="enterprisedb_password" \
-e REPL_USER="repl_user_name" \
-e REPL_PASSWORD="repl_user_password " \
-e MASTER_HOST=master_ipaddress \
-e STANDBY_HOSTS=standby_ipaddress_list \
-e ACCEPT_EULA=Yes|No \
-d containers.enterprisedb.com/edb/edb-pgpool:v3.5
Include the --name option to specify the name of the container in which pgPool resides.
Include the -e option with the docker run command to specify values for environment
variables used to configure your container. Include the following values when deploying
a master node that includes Advanced Server and Failover Manager:
Use the DATABASE_NAME environment variable to specify the name of the
Advanced Server database.
Use the PGPORT environment variable to specify the listener port of the
Advanced Server database (by default, 5444).
Use the ENTERPRISEDB_PASSWORD environment variable to specify the
password associated with the default database superuser (enterprisedb).
During the installation process, the container creates a database superuser named
enterprisedb. Please note that this password should not be changed after the
pod is initialized.
Use the REPL_USER environment variable to specify the name of the Postgres
streaming replication user.
Use the REPL_PASSWORD environment variable to specify the password
associated with the replication user.
Use the MASTER_HOST environment variable to identify the master node of the
replication cluster. The clause uses a call to docker inspect to retrieve the
address of the master node of the cluster:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 45
MASTER_HOST="`sudo docker inspect --format '{{
.NetworkSettings.IPAddress }}'master_name`".
Replace master_name with the name of the master node of the cluster.
Use the STANDBY_HOSTS environment variable to identify the standby nodes in
the replication cluster. The clause uses a call to docker inspect to retrieve the
address of the master node of the cluster:
STANDBY_HOSTS="`sudo docker inspect --format '{{
.NetworkSettings.IPAddress }}' standby_name`"
Replace standby_name with the name of the standby node of the cluster.
Use the ACCEPT_EULA environment variable to indicate if you accept or decline
the EnterpriseDB license. The license is available for review at:
https://www.enterprisedb.com/node/4509
Please note: you must accept the license agreement to deploy a container.
Include the -d option to indicate that the container should be deployed in detached mode;
this enables background processing for the deployment.
After providing values for the environment variable and including any docker options,
specify the repository name and image you wish to use.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 46
4.1.4 Deploying BART in a Container
EDB Postgres Backup and Recovery Tool (BART) simplifies backup management for
Advanced Server databases. When deploying BART in a container, include the
following syntax:
docker run \
--name "container_name" \
-e DATABASE_NAME=db_name \
-e BART_HOST_ADDRESS=host_address
-e PGHOST="`sudo docker inspect --format '{{
.NetworkSettings.IPAddress }}' master_name`" \
-e PGPORT=db_listener_port \
-e REPL_USER="repl_user_name" \
-e REPL_PASSWORD="repl_user_password" \
-e BART_AUTOMATE_BACKUP=Yes|No \
-e BART_NUM_BACKUPS_TO_KEEP=2 \
-e BART_COMPRESS_BACKUP=Yes|No \
-e ACCEPT_EULA=Yes \
-v hostvolume:/edbbackup \
-d containers.enterprisedb.com/edb/edb-bart:v2.0
Include the --name option to specify the name of the container in which BART will
reside.
Include the -e option with the docker run command to specify values for environment
variables used to configure your container. Include the following values when deploying
a master node that includes Advanced Server and Failover Manager:
Use the DATABASE_NAME environment variable to specify the name of
the Advanced Server database that will be backed up.
Use the BART_HOST_ADDRESS environment variable to provide the IP
address or location of the BART host.
Use the PGHOST environment variable to identify the master node of the
replication cluster. The clause uses a call to docker inspect to retrieve
the address of the master node of the cluster:
PGHOST="`sudo docker inspect --format '{{
.NetworkSettings.IPAddress }}'master_name`".
Replace master_name with the name of the master node of the cluster.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 47
Use the PGPORT environment variable to specify the listener port of the
Advanced Server database (by default, 5444).
Use the REPL_USER environment variable to specify the name of the
Postgres streaming replication user.
Use the REPL_PASSWORD environment variable to specify the password
associated with the replication user.
Use the BART_AUTOMATE_BACKUP environment variable to specify if
BART should automate the backup process.
Use the BART_NUM_BACKUPS_TO_KEEP environment variable to specify
the number of backups retained by BART.
Use the BART_COMPRESS_BACKUP environment variable to specify if
BART should compress the backup. Specify yes to indicate that backups
should be compressed, or no to indicate that they should not be
compressed.
Use the ACCEPT_EULA environment variable to indicate if you accept or
decline the EnterpriseDB license. The license is available for review at:
https://www.enterprisedb.com/node/4509
Note: You must accept the license agreement to deploy a container.
Include the -v option and the name of the volume in which the container will reside; for
example, the following /data/edbas:/edbvolume
Include the -d option to indicate that the container should be deployed in detached mode;
this enables background processing for the deployment.
After providing values for the environment variable and including any docker options,
specify the repository name and image you wish to use.
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 48
5 Reference
The following sections provide sample template files.
5.1 Sample Template File - EDB Postgres Advanced Server, pgPool, BART, and PEM Agent
The following sample template file deploys Advanced Server (with Failover Manager),
pgPool, BART and PEM agent. The template uses OpenShift Secret objects to provide
passwords for the database user and the EDB yum repository user. After creating the
template, you can use the OpenShift console to provide installation details for your
deployment.
apiVersion: v1
kind: Template
metadata:
name: edbas10-persistent
annotations:
description: "Standard EDB Postgres Advanced Server 10.0
Deployment Config"
tags: "database,epas,postgres,postgresql"
iconClass: "icon-postgresql"
objects:
- apiVersion: v1
kind: Service
metadata:
name: ${DATABASE_NAME}-service
labels:
role: loadbalancer
cluster: ${DATABASE_NAME}
spec:
selector:
lb: ${DATABASE_NAME}-pgpool
ports:
- name: lb
port: ${PGPORT}
nodePort: 30016
targetPort: 9999
sessionAffinity: None
type: LoadBalancer
- apiVersion: v1
kind: DeploymentConfig
metadata:
name: ${DATABASE_NAME}-pgpool
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 49
spec:
replicas: 2
selector:
lb: ${DATABASE_NAME}-pgpool
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
labels:
lb: ${DATABASE_NAME}-pgpool
role: queryrouter
cluster: ${DATABASE_NAME}
spec:
containers:
- name: edb-pgpool
env:
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: PGPORT
value: ${PGPORT}
- name: REPL_USER
value: ${REPL_USER}
- name: ENTERPRISEDB_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-enterprisedb-passwd
key: password
- name: REPL_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-repl-user-passwd
key: password
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
image: containers.enterprisedb.com/edb/edb-pgpool:v3.6
imagePullPolicy: Always
readinessProbe:
exec:
command:
- /var/lib/edb/testIsReady.sh
initialDelaySeconds: 60
timeoutSeconds: 5
triggers:
- type: ConfigChange
- apiVersion: v1
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 50
kind: DeploymentConfig
metadata:
name: ${DATABASE_NAME}-as
spec:
replicas: 4
selector:
db: ${DATABASE_NAME}-as10
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
creationTimestamp: null
labels:
db: ${DATABASE_NAME}-as10
cluster: ${DATABASE_NAME}
spec:
containers:
- name: edb-as10
env:
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: DATABASE_USER
value: ${DATABASE_USER}
- name: DATABASE_USER_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-database-user-passwd
key: password
- name: ENTERPRISEDB_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-enterprisedb-passwd
key: password
- name: REPL_USER
value: ${REPL_USER}
- name: REPL_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-repl-user-passwd
key: password
- name: PGPORT
value: ${PGPORT}
- name: LOCALEPARAMETER
value: ${LOCALEPARAMETER}
- name: EFM_EMAIL
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 51
value: ${EFM_EMAIL}
- name: NAMESERVER
value: ${NAMESERVER}
- name: POD_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: POD_NODE
valueFrom:
fieldRef:
fieldPath: spec.nodeName
- name: POD_IP
valueFrom:
fieldRef:
fieldPath: status.podIP
- name: ENABLE_MONITOR_MODE
value: ${ENABLE_MONITOR_MODE}
- name: PEM_SERVER
value: ${PEM_SERVER}
- name: PEM_PORT
value: ${PEM_PORT}
- name: PEM_USER
value: ${PEM_USER}
- name: PEM_USER_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-pem-user-passwd
key: password
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
image: containers.enterprisedb.com/edb/edb-as:v10.4
imagePullPolicy: Always
readinessProbe:
exec:
command:
- /var/lib/edb/testIsReady.sh
initialDelaySeconds: 60
timeoutSeconds: 5
livenessProbe:
exec:
command:
- /var/lib/edb/testIsHealthy.sh
initialDelaySeconds: 300
timeoutSeconds: 60
lifecycle:
preStop:
exec:
command:
- /var/lib/edb/shutdown.sh
ports:
- containerPort: ${PGPORT}
volumeMounts:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 52
- name: ${PERSISTENT_VOLUME}
mountPath: /edbvolume
- name: ${BACKUP_VOLUME}
mountPath: /edbbackup
dnsPolicy: ClusterFirst
restartPolicy: Always
volumes:
- name: ${PERSISTENT_VOLUME}
persistentVolumeClaim:
claimName: ${PERSISTENT_VOLUME_CLAIM}
- name: ${BACKUP_VOLUME}
persistentVolumeClaim:
claimName: ${BACKUP_VOLUME_CLAIM}
- apiVersion: v1
kind: DeploymentConfig
metadata:
name: ${DATABASE_NAME}-bart
spec:
replicas: 1
selector:
name: ${DATABASE_NAME}-bart
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
labels:
name: ${DATABASE_NAME}-bart
role: backuptool
cluster: ${DATABASE_NAME}
spec:
containers:
- name: edb-bart
env:
- name: BART_HOST_ADDRESS
value: ${BART_HOST_ADDRESS}
- name: PGHOST
value: "${DATABASE_NAME}-service"
- name: PGPORT
value: ${PGPORT}
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: REPL_USER
value: ${REPL_USER}
- name: REPL_PASSWORD
valueFrom:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 53
secretKeyRef:
name: ${DATABASE_NAME}-repl-user-passwd
key: password
- name: BART_AUTOMATE_BACKUP
value: ${BART_AUTOMATE_BACKUP}
- name: BART_BACKUP_SCHEDULE
value: ${BART_BACKUP_SCHEDULE}
- name: BART_NUM_BACKUPS_TO_KEEP
value: ${BART_NUM_BACKUPS_TO_KEEP}
- name: BART_COMPRESS_BACKUP
value: ${BART_COMPRESS_BACKUP}
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
image: containers.enterprisedb.com/edb/edb-bart:v2.1
imagePullPolicy: Always
volumeMounts:
- name: ${BACKUP_VOLUME}
mountPath: /edbbackup
volumes:
- name: ${BACKUP_VOLUME}
persistentVolumeClaim:
claimName: ${BACKUP_VOLUME_CLAIM}
triggers:
- type: ConfigChange
parameters:
- name: DATABASE_NAME
displayName: Database Name
description: Name of Postgres database (leave edb for default)
value: 'edb'
- name: DATABASE_USER
displayName: Default database user (leave enterprisedb for
default)
description: Default database user
value: 'enterprisedb'
- name: REPL_USER
displayName: Repl user
description: repl database user
value: 'repl'
- name: PGPORT
displayName: Database Port
description: Database Port (leave 5444 for default)
value: '5444'
- name: LOCALEPARAMETER
displayName: Locale
description: Locale of database
value: 'en_US.UTF-8'
- name: EFM_EMAIL
displayName: Email
description: Email for EFM
value: '[email protected]'
- name: NAMESERVER
displayName: Name Server for Email
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 54
description: Name Server for Email
value: '8.8.8.8'
- name: PERSISTENT_VOLUME
displayName: Persistent Volume
description: Persistent volume name
value: 'edb-data-pv'
required: true
- name: PERSISTENT_VOLUME_CLAIM
displayName: Persistent Volume Claim
description: Persistent volume claim name
value: 'edb-data-pvc'
required: true
- name: BACKUP_VOLUME
displayName: Backup Volume
description: Backup volume name
value: 'edb-backup2-pv'
- name: BACKUP_VOLUME_CLAIM
displayName: Backup Volume Claim
description: Backup volume claim name
value: 'edb-backup2-pvc'
- name: BART_HOST_ADDRESS
displayName: BART Host Address
description: BART host address (leave localhost for default)
value: 'localhost'
required: true
- name: PGHOST
displayName: Database Host
description: Database Host (leave ${DATABASE_NAME}-service for
default)
value: ${DATABASE_NAME}-service
required: true
- name: BART_AUTOMATE_BACKUP
displayName: Automate backup operation (leave 'Yes' for
default)
description: Indicates whether backups should be done
automatically
value: 'Yes'
required: true
- name: BART_BACKUP_SCHEDULE
displayName: BART Backup Schedule
description: Standard cron schedule - min (0 - 59), hour (0 -
23), day of month (1 - 31), month (1 - 12), day of week (0 - 6)
(0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the
same as 0)
value: '0:0:*:*:*'
required: true
- name: BART_NUM_BACKUPS_TO_KEEP
displayName: BART Number of Backups to Keep
description: How many backups to keep, older backups will be
removed as newer backups are added
value: '2'
required: true
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 55
- name: BART_COMPRESS_BACKUP
displayName: Compress backup files (leave 'Yes' for default)
description: Indicates whether backup files should be
compressed
value: 'Yes'
- name: ENABLE_MONITOR_MODE
displayName: Enable monitoring (using PEM agent)
description: Indicates whether monitoring should be enabled
using PEM agent
value: 'Yes'
- name: PEM_SERVER
displayName: PEM Server
description: PEM Server address
value: ' 10.130.0.76'
- name: PEM_PORT
displayName: PEM Server Port
description: PEM Server database port
value: '5444'
- name: PEM_USER
displayName: PEM user
description: PEM user name
value: 'enterprisedb'
- name: ACCEPT_EULA
displayName: Accept end-user license agreement (leave 'Yes' for
default)
description: Indicates whether user accepts the end-user
license agreement
value: 'Yes'
required: true
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 56
5.2 Sample Template File - EDB Postgres Advanced Server and pgPool with Custom Features
The following sample template deploys Advanced Server (with Failover Manager) and
pgPool with additional features. In addition to using OpenShift Secret objects to provide
passwords for the database users, the template uses OpenShift ConfigMap objects to
provide usernames, custom database configuration files (postgresql.conf,
pg_hba.conf), and an initialization script.
Please Note: This example assumes that a ConfigMap volume and edb-initconf-vol
volume (where edb is the name of the database), have been created to store:
custom server configurations in postgresql.conf.in and pg_hba.conf.in
an initialization script named dbload, and the file containing the SQL
commands that will be executed.
The example in Section 5.2 uses customized database configuration settings and a
dbload file. The names of the configuration files, initialization script, and mountpath of
the ConfigMap volume (/initconf) must match those in this example.
The postgresql.conf.in file contains:
max_connections = 105
The pg_hba.conf.in file contains:
host replication all 0.0.0.0/0 md5
The dbload file contains:
psql -p $PGPORT -U $DATABASE_USER -d $DATABASE_NAME -f my-
data.sql
Where:
my-data.sql is the file containing the SQL commands to be executed located in
the same directory. The file name is completely arbitrary.
apiVersion: v1
kind: Template
metadata:
name: edbas10-persistent
annotations:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 57
description: "Standard EDB Postgres Advanced Server
10.0 Deployment Config"
tags: "database,epas,postgres,postgresql"
iconClass: "icon-postgresql"
objects:
- apiVersion: v1
kind: Service
metadata:
name: ${DATABASE_NAME}-service
labels:
role: loadbalancer
cluster: ${DATABASE_NAME}
spec:
selector:
lb: ${DATABASE_NAME}-pgpool
ports:
- name: lb
port: ${PGPORT}
nodePort: 30016
targetPort: 9999
sessionAffinity: None
type: LoadBalancer
- apiVersion: v1
kind: DeploymentConfig
metadata:
name: ${DATABASE_NAME}-pgpool
spec:
replicas: 2
selector:
lb: ${DATABASE_NAME}-pgpool
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
labels:
lb: ${DATABASE_NAME}-pgpool
role: queryrouter
cluster: ${DATABASE_NAME}
spec:
containers:
- name: edb-pgpool
env:
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: PGPORT
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 58
value: ${PGPORT}
- name: REPL_USER
value: ${REPL_USER}
- name: ENTERPRISEDB_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-enterprisedb-passwd
key: password
- name: REPL_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-repl-user-passwd
key: password
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
image: containers.enterprisedb.com/edb/edb-
pgpool:v3.6
imagePullPolicy: Always
readinessProbe:
exec:
command:
- /var/lib/edb/testIsReady.sh
initialDelaySeconds: 60
timeoutSeconds: 5
triggers:
- type: ConfigChange
- apiVersion: v1
kind: DeploymentConfig
metadata:
name: ${DATABASE_NAME}-as
spec:
replicas: 4
selector:
db: ${DATABASE_NAME}-as10
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
creationTimestamp: null
labels:
db: ${DATABASE_NAME}-as10
cluster: ${DATABASE_NAME}
spec:
containers:
- name: edb-as10
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 59
env:
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: DATABASE_USER
valueFrom:
configMapKeyRef:
name: ${DATABASE_NAME}-config
key: database.user
- name: DATABASE_USER_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-database-user-passwd
key: password
- name: ENTERPRISEDB_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-enterprisedb-passwd
key: password
- name: REPL_USER
valueFrom:
configMapKeyRef:
name: ${DATABASE_NAME}-config
key: repl.user
- name: REPL_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-repl-user-passwd
key: password
- name: PGPORT
value: ${PGPORT}
- name: LOCALEPARAMETER
value: ${LOCALEPARAMETER}
- name: EFM_EMAIL
value: ${EFM_EMAIL}
- name: NAMESERVER
value: ${NAMESERVER}
- name: POD_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: POD_NODE
valueFrom:
fieldRef:
fieldPath: spec.nodeName
- name: POD_IP
valueFrom:
fieldRef:
fieldPath: status.podIP
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
image: containers.enterprisedb.com/edb/edb-
as:v10.4
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 60
imagePullPolicy: Always
readinessProbe:
exec:
command:
- /var/lib/edb/testIsReady.sh
initialDelaySeconds: 60
timeoutSeconds: 5
livenessProbe:
exec:
command:
- /var/lib/edb/testIsHealthy.sh
initialDelaySeconds: 300
timeoutSeconds: 60
lifecycle:
preStop:
exec:
command:
- /var/lib/edb/shutdown.sh
ports:
- containerPort: ${PGPORT}
volumeMounts:
- name: ${PERSISTENT_VOLUME}
mountPath: /edbvolume
- name: ${BACKUP_VOLUME}
mountPath: /edbbackup
dnsPolicy: ClusterFirst
restartPolicy: Always
volumes:
- name: ${PERSISTENT_VOLUME}
persistentVolumeClaim:
claimName: ${PERSISTENT_VOLUME_CLAIM}
- name: ${BACKUP_VOLUME}
persistentVolumeClaim:
claimName: ${BACKUP_VOLUME_CLAIM}
triggers:
- type: ConfigChange
parameters:
- name: DATABASE_NAME
displayName: Database Name
description: Name of Postgres database (leave edb for
default)
value: 'edb'
- name: DATABASE_USER
displayName: Default database user (leave enterprisedb
for default)
description: Default database user
value: 'enterprisedb'
- name: REPL_USER
displayName: Repl user
description: repl database user
value: 'repl'
- name: PGPORT
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 61
displayName: Database Port
description: Database Port (leave 5444 for default)
value: '5444'
- name: LOCALEPARAMETER
displayName: Locale
description: Locale of database
value: 'en_US.UTF-8'
- name: EFM_EMAIL
displayName: Email
description: Email for EFM
value: '[email protected]'
- name: NAMESERVER
displayName: Name Server for Email
description: Name Server for Email
value: '8.8.8.8'
- name: PERSISTENT_VOLUME
displayName: Persistent Volume
description: Persistent volume name
value: 'edb-data-pv'
required: true
- name: PERSISTENT_VOLUME_CLAIM
displayName: Persistent Volume Claim
description: Persistent volume claim name
value: 'edb-data-pvc'
required: true
- name: ACCEPT_EULA
displayName: Accept end-user license agreement (leave
'Yes' for default)
description: Indicates whether user accepts the end-user
license agreement
value: 'Yes'
required: true
5.3 Sample Template File - BART
Use the following sample template to deploy a BART container:
apiVersion: v1
kind: Template
metadata:
name: edb-bart
annotations:
description: "Standard EDB Backup And Recovery Tool
Deployment Config"
tags: "database,edbas,postgres,postgresql"
iconClass: "icon-postgresql"
labels:
template: edb-bart
objects:
- apiVersion: v1
kind: DeploymentConfig
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 62
metadata:
name: ${DATABASE_NAME}-bart
spec:
replicas: 1
selector:
name: ${DATABASE_NAME}-bart
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
labels:
name: ${DATABASE_NAME}-bart
role: backuptool
cluster: ${DATABASE_NAME}
spec:
containers:
- name: edb-bart
env:
- name: BART_HOST_ADDRESS
value: ${BART_HOST_ADDRESS}
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: PGHOST
value: "${DATABASE_NAME}-service"
- name: PGPORT
value: ${PGPORT}
- name: REPL_USER
valueFrom:
configMapKeyRef:
name: ${DATABASE_NAME}-config
key: repl.user
- name: REPL_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-repl-user-passwd
key: password
- name: BART_AUTOMATE_BACKUP
value: ${BART_AUTOMATE_BACKUP}
- name: BART_BACKUP_SCHEDULE
value: "${BART_BACKUP_SCHEDULE}"
- name: BART_NUM_BACKUPS_TO_KEEP
value: "${BART_NUM_BACKUPS_TO_KEEP}"
- name: BART_COMPRESS_BACKUP
value: ${BART_COMPRESS_BACKUP}
- name: POD_NAMESPACE
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 63
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
volumeMounts:
- name: ${BACKUP_VOLUME}
mountPath: /edbbackup
image: containers.enterprisedb.com/edb/edb-bart:v2.1
imagePullPolicy: Always
lifecycle:
preStop:
exec:
command:
- /var/lib/edb/shutdown.sh
volumes:
- name: ${BACKUP_VOLUME}
persistentVolumeClaim:
claimName: ${BACKUP_VOLUME_CLAIM}
triggers:
- type: ConfigChange
parameters:
- name: BART_HOST_ADDRESS
displayName: BART Host Address
description: BART host address (leave localhost for default)
value: 'localhost'
required: true
- name: DATABASE_NAME
displayName: Database Name
description: Name of Postgres database (leave edb for default)
value: 'edb'
required: true
- name: PGHOST
displayName: Database Host
description: Database Host (leave ${DATABASE_NAME}-service for
default)
value: ${DATABASE_NAME}-service
required: true
- name: PGPORT
displayName: Database Port
description: Database Port (leave 5444 for default)
value: '5444'
required: true
- name: BACKUP_VOLUME
displayName: Backup Volume
description: Backup volume name
value: 'edb-backup-pv'
- name: BACKUP_VOLUME_CLAIM
displayName: Backup Volume Claim
description: Backup volume claim name
value: 'edb-backup-pvc'
- name: BART_AUTOMATE_BACKUP
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 64
displayName: Automate backup operation (leave 'Yes' for
default)
description: Indicates whether backups should be done
automatically
value: 'Yes'
required: true
- name: BART_BACKUP_SCHEDULE
displayName: BART Backup Schedule
description: Standard cron schedule - min (0 - 59), hour (0 -
23), day of month (1 - 31), month (1 - 12), day of week (0 - 6)
(0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the
same as 0)
value: '0:0:*:*:*'
required: true
- name: BART_NUM_BACKUPS_TO_KEEP
displayName: BART Number of Backups to Keep
description: How many backups to keep, older backups will be
removed as newer backups are added
value: '2'
required: true
- name: BART_COMPRESS_BACKUP
displayName: Compress backup files (leave 'Yes' for default)
description: Indicates whether backup files should be
compressed
value: 'Yes'
required: true
- name: ACCEPT_EULA
displayName: Accept end-user license agreement (leave 'Yes' for
default)
description: Indicates whether user accepts the end-user
license agreement
value: 'Yes'
required: true
5.4 Sample Template File - BART, Managing Backups for Multiple Databases
This example assumes that a ConfigMap volume named edb-bart-vol has been
created to store custom configurations in bart.cfg.in. The names of the configuration
file and mountpath of the ConfigMap volume (/bartconf) must match those in this
example.
The following is an example of a bart.cfg.in entry for an additional database named edb2:
[edb2]
host=edb2-service
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 65
port=5444
user=repl
cluster_owner=enterprisedb
password=passw0rd2
automate_backup=Yes
backup_schedule=0:0:0:0:7
compress_backup=No
Note: If a setting is not specified, it will default to values specified in the yaml file.
The following sample template deploys a BART container that can support multiple
databases.
apiVersion: v1
kind: Template
metadata:
name: edb-bart
annotations:
description: "Standard EDB Backup And Recovery Tool
Deployment Config"
tags: "database,edbas,postgres,postgresql"
iconClass: "icon-postgresql"
labels:
template: edb-bart
objects:
- apiVersion: v1
kind: DeploymentConfig
metadata:
name: ${DATABASE_NAME}-bart
spec:
replicas: 1
selector:
name: ${DATABASE_NAME}-bart
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
labels:
name: ${DATABASE_NAME}-bart
role: backuptool
cluster: ${DATABASE_NAME}
spec:
containers:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 66
- name: edb-bart
env:
- name: BART_HOST_ADDRESS
value: ${BART_HOST_ADDRESS}
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: PGHOST
value: "${DATABASE_NAME}-service"
- name: PGPORT
value: ${PGPORT}
- name: REPL_USER
valueFrom:
configMapKeyRef:
name: ${DATABASE_NAME}-config
key: repl.user
- name: REPL_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-repl-user-passwd
key: password
- name: BART_AUTOMATE_BACKUP
value: ${BART_AUTOMATE_BACKUP}
- name: BART_BACKUP_SCHEDULE
value: "${BART_BACKUP_SCHEDULE}"
- name: BART_NUM_BACKUPS_TO_KEEP
value: "${BART_NUM_BACKUPS_TO_KEEP}"
- name: BART_COMPRESS_BACKUP
value: ${BART_COMPRESS_BACKUP}
- name: POD_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
volumeMounts:
- name: ${BACKUP_VOLUME}
mountPath: /edbbackup
- name: edb-bartconf
mountPath: /bartconf
image: containers.enterprisedb.com/edb/edb-bart:v2.1
imagePullPolicy: Always
lifecycle:
preStop:
exec:
command:
- /var/lib/edb/shutdown.sh
volumes:
- name: ${BACKUP_VOLUME}
persistentVolumeClaim:
claimName: ${BACKUP_VOLUME_CLAIM}
- name: edb-bartconf
configMap:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 67
name: ${DATABASE_NAME}-bartconf-vol
triggers:
- type: ConfigChange
parameters:
- name: BART_HOST_ADDRESS
displayName: BART Host Address
description: BART host address (leave localhost for default)
value: 'localhost'
required: true
- name: DATABASE_NAME
displayName: Database Name
description: Name of Postgres database (leave edb for default)
value: 'edb'
required: true
- name: PGHOST
displayName: Database Host
description: Database Host (leave ${DATABASE_NAME}-service for
default)
value: ${DATABASE_NAME}-service
required: true
- name: PGPORT
displayName: Database Port
description: Database Port (leave 5444 for default)
value: '5444'
required: true
- name: BACKUP_VOLUME
displayName: Backup Volume
description: Backup volume name
value: 'edb-backup-pv'
- name: BACKUP_VOLUME_CLAIM
displayName: Backup Volume Claim
description: Backup volume claim name
value: 'edb-backup-pvc'
- name: BART_AUTOMATE_BACKUP
displayName: Automate backup operation (leave 'Yes' for
default)
description: Indicates whether backups should be done
automatically
value: 'Yes'
required: true
- name: BART_BACKUP_SCHEDULE
displayName: BART Backup Schedule
description: Standard cron schedule - min (0 - 59), hour (0 -
23), day of month (1 - 31), month (1 - 12), day of week (0 - 6)
(0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the
same as 0)
value: '0:0:*:*:*'
required: true
- name: BART_NUM_BACKUPS_TO_KEEP
displayName: BART Number of Backups to Keep
description: How many backups to keep, older backups will be
removed as newer backups are added
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 68
value: '2'
required: true
- name: BART_COMPRESS_BACKUP
displayName: Compress backup files (leave 'Yes' for default)
description: Indicates whether backup files should be
compressed
value: 'Yes'
required: true
- name: ACCEPT_EULA
displayName: Accept end-user license agreement (leave 'Yes' for
default)
description: Indicates whether user accepts the end-user
license agreement
value: 'Yes'
required: true
5.5 Sample Template File – PEM Server
Use the following sample template to deploy a PEM server container:
apiVersion: v1
kind: Template
metadata:
name: edb-pemserver
annotations:
description: "Standard EDB Postgres Enterprise Manager Server
7.3 Deployment Config"
tags: "pemserver"
iconClass: "icon-postgresql"
objects:
- apiVersion: v1
kind: Service
metadata:
name: ${DATABASE_NAME}-webservice
labels:
name: ${DATABASE_NAME}-webservice
spec:
selector:
role: pemserver
ports:
- name: https
port: 30443
nodePort: 30443
protocol: TCP
targetPort: 8443
- name: http
port: 30080
nodePort: 30080
protocol: TCP
targetPort: 8080
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 69
type: NodePort
- apiVersion: v1
kind: DeploymentConfig
metadata:
name: edb-pemserver
spec:
replicas: 1
selector:
app: pemserver
strategy:
resources: {}
rollingParams:
intervalSeconds: 1
maxSurge: 25%
maxUnavailable: 25%
timeoutSeconds: 600
updatePeriodSeconds: 1
type: Rolling
template:
metadata:
creationTimestamp: null
labels:
app: pemserver
cluster: ${DATABASE_NAME}
spec:
containers:
- name: pem-db
env:
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: DATABASE_USER
value: ${DATABASE_USER}
- name: DATABASE_USER_PASSWORD
valueFrom:
secretKeyRef:
name: pem-database-user-passwd
key: password
- name: ENTERPRISEDB_PASSWORD
valueFrom:
secretKeyRef:
name: pem-enterprisedb-passwd
key: password
- name: POD_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: POD_NODE
valueFrom:
fieldRef:
fieldPath: spec.nodeName
- name: POD_IP
valueFrom:
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 70
fieldRef:
fieldPath: status.podIP
- name: PGPORT
value: ${PGPORT}
- name: RESTORE_FILE
value: ${RESTORE_FILE}
- name: ENABLE_HA_MODE
value: "No"
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
image: containers2.enterprisedb.com/test/edb-as:v10.4
imagePullPolicy: Always
volumeMounts:
- name: ${PERSISTENT_VOLUME}
mountPath: /edbvolume
- name: pem-webclient
image: containers.enterprisedb.com/edb/edb-
pemserver:v7.3
imagePullPolicy: Always
env:
- name: DATABASE_NAME
value: ${DATABASE_NAME}
- name: DATABASE_USER
value: ${DATABASE_USER}
- name: DATABASE_USER_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-database-user-passwd
key: password
- name: ENTERPRISEDB_PASSWORD
valueFrom:
secretKeyRef:
name: ${DATABASE_NAME}-enterprisedb-passwd
key: password
- name: POD_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: POD_NODE
valueFrom:
fieldRef:
fieldPath: spec.nodeName
- name: POD_IP
valueFrom:
fieldRef:
fieldPath: status.podIP
- name: PGPORT
value: ${PGPORT}
- name: CIDR_ADDR
value: ${CIDR_ADDR}
- name: ACCEPT_EULA
value: ${ACCEPT_EULA}
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 71
ports:
- containerPort: ${PGPORT}
volumeMounts:
- name: ${PERSISTENT_VOLUME}
mountPath: /edbvolume
- name: httpd-shm
mountPath: /run/httpd
volumes:
- name: ${PERSISTENT_VOLUME}
persistentVolumeClaim:
claimName: ${PERSISTENT_VOLUME_CLAIM}
- name: httpd-shm
emptyDir:
medium: Memory
dnsPolicy: ClusterFirst
restartPolicy: Always
triggers:
- type: ConfigChange
parameters:
- name: DATABASE_NAME
displayName: Database Name
description: Name of Postgres database (leave edb for default)
value: 'pem'
required: true
- name: DATABASE_USER
displayName: Default database user (leave enterprisedb for
default)
description: Default database user
value: 'enterprisedb'
- name: PGPORT
displayName: Database Port
description: Database Port (leave 5444 for default)
value: '5444'
required: true
- name: PERSISTENT_VOLUME
displayName: Persistent Volume
description: Persistent volume name
value: 'edb-data-pv'
required: true
- name: PERSISTENT_VOLUME_CLAIM
displayName: Persistent Volume Claim
description: Persistent volume claim name
value: 'edb-data-pvc'
required: true
- name: RESTORE_FILE
displayName: Restore File
description: Restore file location
value: ''
- name: CIDR_ADDR
displayName: CIDR address block for PEM
description: CIDR address block for PEM (leave '0.0.0.0/0' for
default)
EDB™ Postgres Containers and Integration with OpenShift
Copyright © 2018 EnterpriseDB Corporation. All rights reserved. 72
value: '0.0.0.0/0'
- name: ACCEPT_EULA
displayName: Accept end-user license agreement (leave 'Yes' for
default)
description: Indicates whether user accepts the end-user
license agreement
value: 'Yes'
required: true