renamed env param POSTGRES_REPLICATION_MODE to POSTGRES_MODE

Author: Sameer Naik

README.md

@@ -189,7 +189,7 @@ When `POSTGRES_USER` is is specified, the `postgres` user is not assigned a pass
 
 A [Streaming replication](http://www.postgresql.org/docs/9.4/static/warm-standby.html#STREAMING-REPLICATION) cluster can easily be setup with the Bitnami PostgreSQL Docker Image using the following environment variables:
 
- - `POSTGRES_REPLICATION_MODE`: Replication mode. Possible values `master`/`slave` (default: master).
+ - `POSTGRES_MODE`: Replication mode. Possible values `master`/`slave` (default: master).
  - `POSTGRES_REPLICATION_USER`: Replication user. User is created on the master at first boot (default: none).
  - `POSTGRES_REPLICATION_PASSWORD`: Replication users password. Password is set for `POSTGRES_REPLICATION_USER` on master on the first boot (default: none).
  - `POSTGRES_MASTER_HOST`: Hostname/IP of replication master (parameter available only on slave).
@@ -208,15 +208,15 @@ docker run --name postgresql-master \
   -e POSTGRES_USER=my_user \
   -e POSTGRES_PASSWORD=password123 \
   -e POSTGRES_DB=my_database \
-  -e POSTGRES_REPLICATION_MODE=master \
+  -e POSTGRES_MODE=master \
   -e POSTGRES_REPLICATION_USER=my_repl_user \
   -e POSTGRES_REPLICATION_PASSWORD=my_repl_password \
   bitnami/postgresql
 ```
 
-In this command we are configuring the container as the master using the `POSTGRES_REPLICATION_MODE=master` parameter. Using the `POSTGRES_REPLICATION_USER` and `POSTGRES_REPLICATION_PASSWORD` parameters we are creating a replication user that will be used by the slaves to connect to the master and perform streaming replication.
+In this command we are configuring the container as the master using the `POSTGRES_MODE=master` parameter. Using the `POSTGRES_REPLICATION_USER` and `POSTGRES_REPLICATION_PASSWORD` parameters we are creating a replication user that will be used by the slaves to connect to the master and perform streaming replication.
 
-By default a container is configured as a `master`. As a result you can drop the `POSTGRES_REPLICATION_MODE=master` from the above command.
+By default a container is configured as a `master`. As a result you can drop the `POSTGRES_MODE=master` from the above command.
 
 ### Step 2: Create the replication slave
 
@@ -227,13 +227,13 @@ docker run --name postgresql-slave \
   --link postgresql-master:master \
   -e POSTGRES_MASTER_HOST=master \
   -e POSTGRES_MASTER_PORT=5432 \
-  -e POSTGRES_REPLICATION_MODE=slave \
+  -e POSTGRES_MODE=slave \
   -e POSTGRES_REPLICATION_USER=my_repl_user \
   -e POSTGRES_REPLICATION_PASSWORD=my_repl_password \
   bitnami/postgresql
 ```
 
-In this command we are configuring the container as a slave using the `POSTGRES_REPLICATION_MODE=slave` parameter. Before the replication slave is started, the `POSTGRES_MASTER_HOST` and `POSTGRES_MASTER_PORT` parameters are used by the slave container to connect to the master and replicate the initial database from the master. The `POSTGRES_REPLICATION_USER` and `POSTGRES_REPLICATION_PASSWORD` credentials are used to authenticate with the master.
+In this command we are configuring the container as a slave using the `POSTGRES_MODE=slave` parameter. Before the replication slave is started, the `POSTGRES_MASTER_HOST` and `POSTGRES_MASTER_PORT` parameters are used by the slave container to connect to the master and replicate the initial database from the master. The `POSTGRES_REPLICATION_USER` and `POSTGRES_REPLICATION_PASSWORD` credentials are used to authenticate with the master.
 
 Using the `master` docker link alias, the Bitnami PostgreSQL Docker image automatically fetches the replication paramaters from the master container, namely:
 
@@ -247,7 +247,7 @@ As a result you can drop all of these parameters from the slave.
 ```bash
 docker run --name postgresql-slave \
   --link postgresql-master:master \
-  -e POSTGRES_REPLICATION_MODE=slave \
+  -e POSTGRES_MODE=slave \
   bitnami/postgresql
 ```
 
@@ -272,7 +272,7 @@ master:
     - POSTGRES_USER=my_user
     - POSTGRES_PASSWORD=password123
     - POSTGRES_DB=my_database
-    - POSTGRES_REPLICATION_MODE=master
+    - POSTGRES_MODE=master
     - POSTGRES_REPLICATION_USER=my_repl_user
     - POSTGRES_REPLICATION_PASSWORD=my_repl_password
 
@@ -281,7 +281,7 @@ slave:
   links:
     - master:master
   environment:
-    - POSTGRES_REPLICATION_MODE=slave
+    - POSTGRES_MODE=slave
 ```
 
 Scale the number of slaves using:

help.txt

@@ -4,7 +4,7 @@
       POSTGRES_USER: User to be created on first boot (default: postgres).
       POSTGRES_PASSWORD: Password to be set for POSTGRES_USER on first boot (default: none).
       POSTGRES_DB: Database to be created on first boot, accessible by POSTGRES_USER (default: none).
-      POSTGRES_REPLICATION_MODE: Replication mode. Possible values master/slave (default: master).
+      POSTGRES_MODE: Replication mode. Possible values master/slave (default: master).
       POSTGRES_REPLICATION_USER: Replication user. User is created on the master at first boot (default: none).
       POSTGRES_REPLICATION_PASSWORD: Replication users password. Password is set for POSTGRES_REPLICATION_USER on master on the first boot (default: none).
       POSTGRES_MASTER_HOST: Hostname/IP of replication master (parameter available only on slave).

help.yaml

@@ -2,7 +2,7 @@ environment_variables:
   POSTGRES_USER: "User to be created on first boot (default: postgres)."
   POSTGRES_PASSWORD: "Password to be set for POSTGRES_USER on first boot (default: none)."
   POSTGRES_DB: "Database to be created on first boot, accessible by POSTGRES_USER (default: none)."
-  POSTGRES_REPLICATION_MODE: "Replication mode. Possible values master/slave (default: master)."
+  POSTGRES_MODE: "Replication mode. Possible values master/slave (default: master)."
   POSTGRES_REPLICATION_USER: "Replication user. User is created on the master at first boot (default: none)."
   POSTGRES_REPLICATION_PASSWORD: "Replication users password. Password is set for POSTGRES_REPLICATION_USER on master on the first boot (default: none)."
   POSTGRES_MASTER_HOST: "Hostname/IP of replication master (parameter available only on slave)."

rootfs/bitnami-utils-custom.sh

@@ -1,7 +1,7 @@
 # PostgreSQL Utility functions
 PROGRAM_OPTIONS="-D $BITNAMI_APP_DIR/data --config_file=$BITNAMI_APP_DIR/conf/postgresql.conf --hba_file=$BITNAMI_APP_DIR/conf/pg_hba.conf --ident_file=$BITNAMI_APP_DIR/conf/pg_ident.conf"
 
-POSTGRES_REPLICATION_MODE=${POSTGRES_REPLICATION_MODE:-master}
+POSTGRES_MODE=${POSTGRES_MODE:-master}
 
 set_pg_param() {
   local key=${1}
@@ -37,7 +37,7 @@ set_recovery_param() {
 }
 
 discover_replication_parameters() {
-  case $POSTGRES_REPLICATION_MODE in
+  case $POSTGRES_MODE in
     master) ;;
     slave)
       echo "==> Trying to fetch replication parameters exposed by docker links..."
@@ -73,15 +73,15 @@ discover_replication_parameters() {
       fi
       ;;
     *)
-      echo "Replication mode \"$POSTGRES_REPLICATION_MODE\" not supported!"
+      echo "Replication mode \"$POSTGRES_MODE\" not supported!"
       echo ""
       exit -1
       ;;
   esac
 }
 
 initialize_database() {
-  case "$POSTGRES_REPLICATION_MODE" in
+  case "$POSTGRES_MODE" in
     master)
       echo "==> Initializing database..."
       echo ""
@@ -131,7 +131,7 @@ initialize_database() {
 }
 
 create_custom_database() {
-  if [ "$POSTGRES_REPLICATION_MODE" == "master" ]; then
+  if [ "$POSTGRES_MODE" == "master" ]; then
     if [ "$POSTGRES_DB" ]; then
       echo "==> Creating database $POSTGRES_DB..."
       echo ""
@@ -142,7 +142,7 @@ create_custom_database() {
 }
 
 create_postgresql_user() {
-  if [ "$POSTGRES_REPLICATION_MODE" == "master" ]; then
+  if [ "$POSTGRES_MODE" == "master" ]; then
     POSTGRES_USER=${POSTGRES_USER:-postgres}
     if [ "$POSTGRES_USER" != "postgres" ]; then
       if [ ! $POSTGRES_PASSWORD ]; then
@@ -184,7 +184,7 @@ create_replication_user() {
       exit -1
     fi
 
-    if [ "$POSTGRES_REPLICATION_MODE" == "master" ]; then
+    if [ "$POSTGRES_MODE" == "master" ]; then
       echo "==> Creating replication user $POSTGRES_REPLICATION_USER..."
       echo ""
       echo "CREATE ROLE \"$POSTGRES_REPLICATION_USER\" REPLICATION LOGIN ENCRYPTED PASSWORD '$POSTGRES_REPLICATION_PASSWORD';" | \
@@ -196,7 +196,7 @@ create_replication_user() {
 }
 
 configure_recovery() {
-  if [ "$POSTGRES_REPLICATION_MODE" == "slave" ]; then
+  if [ "$POSTGRES_MODE" == "slave" ]; then
     echo "==> Setting up streaming replication slave..."
     echo ""
 
@@ -208,7 +208,7 @@ configure_recovery() {
 }
 
 print_postgresql_password() {
-  case "$POSTGRES_REPLICATION_MODE" in
+  case "$POSTGRES_MODE" in
     master)
       if [ -z $POSTGRES_PASSWORD ]; then
         echo "**none**"
@@ -223,7 +223,7 @@ print_postgresql_password() {
 }
 
 print_postgresql_database() {
-  case "$POSTGRES_REPLICATION_MODE" in
+  case "$POSTGRES_MODE" in
     master)
       if [ $POSTGRES_DB ]; then
         echo "Database: $POSTGRES_DB"

test.sh

@@ -204,22 +204,22 @@ cleanup_environment
 @test "Can't setup replication slave without master host" {
   # create replication slave without specifying POSTGRES_MASTER_HOST
   run container_create slave0 \
-    -e POSTGRES_REPLICATION_MODE=slave
+    -e POSTGRES_MODE=slave
   [[ "$output" =~ "you need to provide the POSTGRES_MASTER_HOST" ]]
 }
 
 @test "Can't setup replication slave without replication user" {
   # create replication slave without specifying POSTGRES_REPLICATION_USER
   run container_create slave0 \
-    -e POSTGRES_REPLICATION_MODE=slave \
+    -e POSTGRES_MODE=slave \
     -e POSTGRES_MASTER_HOST=master
   [[ "$output" =~ "you need to provide the POSTGRES_REPLICATION_USER" ]]
 }
 
 @test "Can't setup replication slave without replication password" {
   # create replication slave without specifying POSTGRES_REPLICATION_PASSWORD
   run container_create slave0 \
-    -e POSTGRES_REPLICATION_MODE=slave \
+    -e POSTGRES_MODE=slave \
     -e POSTGRES_MASTER_HOST=master \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER
   [[ "$output" =~ "you need to provide the POSTGRES_REPLICATION_PASSWORD" ]]
@@ -230,15 +230,15 @@ cleanup_environment
     -e POSTGRES_USER=$POSTGRES_USER \
     -e POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
     -e POSTGRES_DB=$POSTGRES_DB \
-    -e POSTGRES_REPLICATION_MODE=master \
+    -e POSTGRES_MODE=master \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
   container_create slave0 -d \
     $(container_link default $CONTAINER_NAME) \
     -e POSTGRES_MASTER_HOST=$CONTAINER_NAME \
     -e POSTGRES_MASTER_PORT=5432 \
-    -e POSTGRES_REPLICATION_MODE=slave \
+    -e POSTGRES_MODE=slave \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
@@ -257,14 +257,14 @@ cleanup_environment
     -e POSTGRES_USER=$POSTGRES_USER \
     -e POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
     -e POSTGRES_DB=$POSTGRES_DB \
-    -e POSTGRES_REPLICATION_MODE=master \
+    -e POSTGRES_MODE=master \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
   # create replication slave0 linked to master with alias named master
   container_create slave0 -d \
     $(container_link default master) \
-    -e POSTGRES_REPLICATION_MODE=slave
+    -e POSTGRES_MODE=slave
 
   # create users table on master and insert a new row
   psql_client default -U $POSTGRES_USER $POSTGRES_DB -c \
@@ -281,7 +281,7 @@ cleanup_environment
     -e POSTGRES_USER=$POSTGRES_USER \
     -e POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
     -e POSTGRES_DB=$POSTGRES_DB \
-    -e POSTGRES_REPLICATION_MODE=master \
+    -e POSTGRES_MODE=master \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
@@ -295,7 +295,7 @@ cleanup_environment
     $(container_link default $CONTAINER_NAME) \
     -e POSTGRES_MASTER_HOST=$CONTAINER_NAME \
     -e POSTGRES_MASTER_PORT=5432 \
-    -e POSTGRES_REPLICATION_MODE=slave \
+    -e POSTGRES_MODE=slave \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
@@ -310,7 +310,7 @@ cleanup_environment
     -e POSTGRES_USER=$POSTGRES_USER \
     -e POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
     -e POSTGRES_DB=$POSTGRES_DB \
-    -e POSTGRES_REPLICATION_MODE=master \
+    -e POSTGRES_MODE=master \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
@@ -324,7 +324,7 @@ cleanup_environment
     $(container_link default $CONTAINER_NAME) \
     -e POSTGRES_MASTER_HOST=$CONTAINER_NAME \
     -e POSTGRES_MASTER_PORT=5432 \
-    -e POSTGRES_REPLICATION_MODE=slave \
+    -e POSTGRES_MODE=slave \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
@@ -350,15 +350,15 @@ cleanup_environment
     -e POSTGRES_USER=$POSTGRES_USER \
     -e POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
     -e POSTGRES_DB=$POSTGRES_DB \
-    -e POSTGRES_REPLICATION_MODE=master \
+    -e POSTGRES_MODE=master \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
   container_create slave0 -d \
     $(container_link default $CONTAINER_NAME) \
     -e POSTGRES_MASTER_HOST=$CONTAINER_NAME \
     -e POSTGRES_MASTER_PORT=5432 \
-    -e POSTGRES_REPLICATION_MODE=slave \
+    -e POSTGRES_MODE=slave \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD
 
@@ -379,7 +379,7 @@ cleanup_environment
     $(container_link slave0 $CONTAINER_NAME) \
     -e POSTGRES_MASTER_HOST=$CONTAINER_NAME \
     -e POSTGRES_MASTER_PORT=5432 \
-    -e POSTGRES_REPLICATION_MODE=slave \
+    -e POSTGRES_MODE=slave \
     -e POSTGRES_REPLICATION_USER=$POSTGRES_REPLICATION_USER \
     -e POSTGRES_REPLICATION_PASSWORD=$POSTGRES_REPLICATION_PASSWORD