Enable s2i

Author: dhodovsk

examples/extending-image/init/init-backup-user.sh

@@ -0,0 +1,4 @@
+# create backup user
+
+psql -U postgres -d $POSTGRESQL_DATABASE -c "CREATE USER $POSTGRESQL_BACKUP_USER SUPERUSER  password '$POSTGRESQL_BACKUP_PASSWORD';"
+psql -U postgres -d $POSTGRESQL_DATABASE -c "ALTER USER $POSTGRESQL_BACKUP_USER set default_transaction_read_only = on;"

examples/extending-image/postgresql-config/logging.conf

@@ -0,0 +1,4 @@
+log_destination = 'stderr'
+logging_collector = on
+log_directory = 'pg_log'
+log_filename = 'postgresql.log'

examples/extending-image/pre-init/check-backup-user.sh

@@ -0,0 +1,3 @@
+# Check that user credentials for backup is set
+
+[[ -v POSTGRESQL_BACKUP_USER && -v POSTGRESQL_BACKUP_PASSWORD ]] || usage "You have to set all variables for user for doing backup: POSTGRESQL_BACKUP_USER, POSTGRESQL_BACKUP_PASSWORD"

latest/Dockerfile

@@ -1,4 +1,4 @@
-FROM centos:centos7
+FROM centos/s2i-core-centos7
 
 # PostgreSQL image for OpenShift.
 # Volumes:
@@ -13,7 +13,8 @@ FROM centos:centos7
 ENV POSTGRESQL_VERSION=9.6 \
     POSTGRESQL_PREV_VERSION=9.5 \
     HOME=/var/lib/pgsql \
-    PGUSER=postgres
+    PGUSER=postgres \
+    APP_DATA=/opt/app-root
 
 ENV SUMMARY="PostgreSQL is an advanced Object-Relational database management system" \
     DESCRIPTION="PostgreSQL is an advanced Object-Relational database management system (DBMS). \
@@ -57,6 +58,7 @@ ENV CONTAINER_SCRIPTS_PATH=/usr/share/container-scripts/postgresql \
     ENABLED_COLLECTIONS=rh-postgresql96
 
 COPY root /
+COPY ./s2i/bin/ $STI_SCRIPTS_PATH
 
 # When bash is started non-interactively, to run a shell script, for example it
 # looks for this variable and source the content of this file. This will enable
@@ -67,6 +69,7 @@ ENV BASH_ENV=${CONTAINER_SCRIPTS_PATH}/scl_enable \
 
 VOLUME ["/var/lib/pgsql/data"]
 
+RUN chown -R 26:26 ${APP_DATA}
 USER 26
 
 ENTRYPOINT ["container-entrypoint"]

latest/Dockerfile.rhel7

@@ -1,4 +1,4 @@
-FROM rhel7
+FROM rhscl/s2i-core-rhel7:1
 
 # PostgreSQL image for OpenShift.
 # Volumes:
@@ -13,7 +13,8 @@ FROM rhel7
 ENV POSTGRESQL_VERSION=9.6 \
     POSTGRESQL_PREV_VERSION=9.5 \
     HOME=/var/lib/pgsql \
-    PGUSER=postgres
+    PGUSER=postgres \
+    APP_DATA=/opt/app-root
 
 ENV SUMMARY="PostgreSQL is an advanced Object-Relational database management system" \
     DESCRIPTION="PostgreSQL is an advanced Object-Relational database management system (DBMS). \
@@ -60,6 +61,7 @@ ENV CONTAINER_SCRIPTS_PATH=/usr/share/container-scripts/postgresql \
     ENABLED_COLLECTIONS=rh-postgresql96
 
 COPY root /
+COPY ./s2i/bin/ $STI_SCRIPTS_PATH
 
 # When bash is started non-interactively, to run a shell script, for example it
 # looks for this variable and source the content of this file. This will enable
@@ -70,6 +72,7 @@ ENV BASH_ENV=${CONTAINER_SCRIPTS_PATH}/scl_enable \
 
 VOLUME ["/var/lib/pgsql/data"]
 
+RUN chown -R 26:26 ${APP_DATA}
 USER 26
 
 ENTRYPOINT ["container-entrypoint"]

latest/root/usr/bin/run-postgresql

@@ -22,12 +22,17 @@ else
   try_pgupgrade
 fi
 
+process_extending_files ${APP_DATA}/src/pre-init ${CONTAINER_SCRIPTS_PATH}/pre-init
+
 pg_ctl -w start -o "-h ''"
 if $PG_INITIALIZED ; then
     migrate_db
     create_users
 fi
 set_passwords
+
+process_extending_files ${APP_DATA}/src/init ${CONTAINER_SCRIPTS_PATH}/init
+
 pg_ctl stop
 
 unset_env_vars

latest/root/usr/bin/run-postgresql-slave

@@ -28,9 +28,13 @@ check_env_vars
 generate_passwd_file
 generate_postgresql_config
 
+process_extending_files ${APP_DATA}/src/pre-init ${CONTAINER_SCRIPTS_PATH}/pre-init
+
 wait_for_postgresql_master
 export MASTER_FQDN=$(postgresql_master_addr)
 initialize_replica
 
+process_extending_files ${APP_DATA}/src/init ${CONTAINER_SCRIPTS_PATH}/init
+
 unset_env_vars
 exec postgres "$@"

latest/root/usr/share/container-scripts/postgresql/README.md

@@ -235,6 +235,52 @@ enough space for the copy;  upgrade failure because of not enough space might
 lead to data loss.
 
 
+Extending image
+----------------
+
+This image can be extended using
+[source-to-image](https://github.com/openshift/source-to-image).
+
+For example to build customized image `new-postgresql`
+with configuration in `~/image-configuration/` run:
+
+
+```
+$ s2i build ~/image-configuration/ postgresql new-postgresql
+```
+
+The directory passed to `s2i build` should contain one or more of the
+following directories:
+
+##### `postgresql-config/`
+
+contained files will be included at the end of image postgresql.conf file
+
+##### `pre-init/`
+
+contained shell scripts (`*.sh`) are sourced before `service` is started
+
+##### `init/`
+
+contained shell scripts (`*.sh`) are sourced after `service` is
+started
+
+----------------------------------------------
+
+During `s2i build` all provided files are copied into `/opt/app-root/src`
+directory in the new image. If some configuration files are present in
+destination directory, files with the same name are overwritten. Also only one
+file with the same name can be used for customization and user provided files
+are preferred over default files in `/usr/share/container-scripts/`-
+so it is possible to overwrite them.
+
+Same configuration directory structure can be used to customize the image
+every time the image is started using `docker run`. The directory have to be
+mounted into `/opt/app-root/src/` in the image (`-v
+./image-configuration/:/opt/app-root/src/`). This overwrites customization
+built into the image.
+
+
 Troubleshooting
 ---------------
 At first the postgres daemon writes its logs to the standard output, so these are available in the container log. The log can be examined by running:

latest/root/usr/share/container-scripts/postgresql/common.sh

@@ -415,3 +415,32 @@ try_pgupgrade ()
 
   run_pgupgrade
 }
+
+# get_matched_files finds file for image extending
+function get_matched_files() {
+  local custom_dir default_dir
+  custom_dir="$1"
+  default_dir="$2"
+  files_matched="$3"
+  find "$default_dir" -maxdepth 1 -type f -name "$files_matched" -printf "%f\n"
+  [ -d "$custom_dir" ] && find "$custom_dir" -maxdepth 1 -type f -name "$files_matched" -printf "%f\n"
+}
+
+# process_extending_files process extending files in $1 and $2 directories
+# - source all *.sh files
+#   (if there are files with same name source only file from $1)
+function process_extending_files() {
+  local custom_dir default_dir
+  custom_dir=$1
+  default_dir=$2
+
+  while read filename ; do
+    echo "=> sourcing $filename ..."
+    # Custom file is prefered
+    if [ -f $custom_dir/$filename ]; then
+      source $custom_dir/$filename
+    elif [ -f $default_dir/$filename ]; then
+      source $default_dir/$filename
+    fi
+  done <<<"$(get_matched_files "$custom_dir" "$default_dir" '*.sh' | sort -u)"
+}

latest/root/usr/share/container-scripts/postgresql/pre-init/set-config.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+cat >> "$PGDATA/postgresql.conf" <<EOF
+
+# Custom extending configuration
+EOF
+
+extending_cfg_dir="${APP_DATA}/src/postgresql-config"
+
+for conf in $(ls ${extending_cfg_dir}); do
+    cat >> "$PGDATA/postgresql.conf" <<EOF
+include '$extending_cfg_dir/${conf}'
+EOF
+done

latest/s2i/bin/assemble

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+shopt -s dotglob
+echo "---> Installing application source ..."
+mv /tmp/src/* ./
+
+# Fix source directory permissions
+/usr/libexec/fix-permissions ./

latest/s2i/bin/run

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+/usr/bin/run-postgresql

latest/s2i/bin/usage

@@ -0,0 +1 @@
+groff -t -man -ETascii /help.1