Add docker image template with installed PostgreSQL, AQO and optimal startup settings.

danolivo · danolivo · commit 3f7ebff02a3a · 2019-08-16T14:54:04.000+05:00
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,55 @@
+# Copyright (c) 2016-2019, Postgres Professional
+FROM alpine
+LABEL maintainer="Andrey V. Lepikhov <a.lepikhov@postgrespro.ru>"
+ENV PG_VERSION 11.5
+ENV PG_SHA256 7fdf23060bfc715144cbf2696cf05b0fa284ad3eb21f0c378591c6bca99ad180
+
+# the home directory for the postgres user is not created by default
+RUN set -ex; \
+	postgresHome="$(getent passwd postgres)"; \
+	postgresHome="$(echo "$postgresHome" | cut -d: -f6)"; \
+	[ "$postgresHome" = '/var/lib/postgresql' ]; \
+	mkdir -p "$postgresHome"; \
+	chown -R postgres:postgres "$postgresHome"
+
+# Install minimal set of packages
+RUN apk add --update gcc libc-dev bison flex readline-dev zlib-dev perl make \
+	diffutils gdb iproute2 musl-dbg iputils patch bash su-exec
+
+RUN mkdir /pg && chown postgres:postgres pg
+
+# Download corresponding version of PostgreSQL sources
+RUN set -ex \
+	\
+	&& wget -O postgresql.tar.bz2 "https://ftp.postgresql.org/pub/source/v$PG_VERSION/postgresql-$PG_VERSION.tar.bz2" \
+	&& echo "$PG_SHA256 *postgresql.tar.bz2" | sha256sum -c - \
+	&& mkdir -p /pg/src \
+	&& tar \
+		--extract \
+		--file postgresql.tar.bz2 \
+		--directory /pg/src \
+		--strip-components 1 \
+	&& rm postgresql.tar.bz2
+
+# Configure, compile and install
+RUN mkdir /pg/src/contrib/aqo
+COPY ./ /pg/src/contrib/aqo
+RUN cd /pg/src/contrib/aqo && ls
+RUN cd /pg/src && \
+	patch -p1 --no-backup-if-mismatch < contrib/aqo/aqo_pg11.patch
+RUN cd /pg/src && \
+	./configure --enable-cassert --enable-debug --prefix=/pg/install && \
+	make -j 4 install
+RUN cd /pg/src/contrib/aqo && make clean && make install
+
+# Set environment
+ENV LANG en_US.utf8
+ENV CFLAGS -O0
+ENV PATH /pg/install/bin:$PATH
+ENV PGDATA /pg/data
+
+USER postgres
+ENTRYPOINT ["/pg/src/contrib/aqo/docker-entrypoint.sh"]
+
+EXPOSE 5432
+CMD ["postgres"]
diff --git a/README.md b/README.md
@@ -6,9 +6,22 @@ for improving cardinality estimation. Experimental evaluation shows that this
 improvement sometimes provides an enormously large speed-up for rather
 complicated queries.
 
+## Docker container
+For quick look into the query-driven adaptive query optimization you can use
+docker container defined by `Dockerfile` and `docker-entrypoint.sh` files.
+
+Frequently used commands:
+* docker build -t aqo .					# Build an image
+* docker run -d -p 5432:5432 aqo		# Run a container
+* docker exec -it `<CONTAINER_ID>` bash	# Open command prompt in the container
+Now, you can use `psql`.
+
 ## Installation
 
-The module works with PostgreSQL 9.6 and above.
+The module works with PostgreSQL 9.6 and above. You need to use appropriate
+branch from git repository. The repository contains branch `master` corresponding
+to current PostgreSQL master branch, and a number of branches called `stable9_6`
+`stable11` and `stable12`. The branch `stable11` can be used with PostgreSQL 10 too.
 
 The module contains a patch and an extension. Patch has to be applied to the
 sources of PostgresSQL. Patch affects header files, that is why PostgreSQL
@@ -18,16 +31,19 @@ Extension has to be unpacked into contrib directory and then to be compiled and
 installed with `make install`.
 
 ```
-cd postgresql-9.6                                                # enter postgresql source directory
-git clone https://github.com/tigvarts/aqo.git contrib/aqo        # clone aqo into contrib
-patch -p1 --no-backup-if-mismatch < contrib/aqo/aqo_pg9_6.patch  # patch postgresql
-make clean && make && make install                               # recompile postgresql
-cd contrib/aqo                                                   # enter aqo directory
-make && make install                                             # install aqo
-make check                                              # check whether it works correctly (optional)
+cd postgresql-9.6													# enter postgresql source directory
+git clone https://github.com/postgrespro/aqo.git					# clone aqo into contrib
+patch -p1 --no-backup-if-mismatch < contrib/aqo/aqo_pg<ver>.patch	# patch postgresql
+make clean && make && make install									# recompile postgresql
+cd contrib/aqo														# enter aqo directory
+make && make install												# install aqo
+make check															# check whether it works correctly (optional)
 ```
 
-For PostgreSQL 10 and above use aqo_pg10.patch instead of aqo_pg9_6.patch
+Tag `ver` at the patch name corresponds to suitable PostgreSQL release.
+For PostgreSQL 10 use aqo_pg10.patch; for PostgreSQL 11 use aqo_pg11.patch and so on.
+Also, you can see git tags at the master branch for more accurate definition of
+suitable PostgreSQL version.
 
 In your database:
 
diff --git a/docker-entrypoint.sh b/docker-entrypoint.sh
@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+if [ "$1" = 'postgres' ]; then
+	mkdir -p "$PGDATA"
+	chown -R postgres "$PGDATA"
+	chmod 700 "$PGDATA"
+
+	# look specifically for PG_VERSION, as it is expected in the DB dir
+	if [ ! -s "$PGDATA/PG_VERSION" ]; then
+		initdb --nosync
+
+		{ echo; echo "host all all 0.0.0.0/0 trust"; } >> "$PGDATA/pg_hba.conf"
+		{ echo; echo "host replication all 0.0.0.0/0 trust"; } >> "$PGDATA/pg_hba.conf"
+
+		cat <<-EOF >> $PGDATA/postgresql.conf
+			listen_addresses='*'
+			fsync = on
+			shared_preload_libraries = 'aqo'
+			aqo.mode = 'intelligent'
+			min_parallel_table_scan_size = 0
+			min_parallel_index_scan_size = 0
+		EOF
+
+		pg_ctl -D "$PGDATA" \
+				-o "-c listen_addresses=''" \
+				-w start
+
+		: ${POSTGRES_USER:=postgres}
+		: ${POSTGRES_DB:=$POSTGRES_USER}
+		export POSTGRES_USER POSTGRES_DB
+
+		if [ "$POSTGRES_DB" != 'postgres' ]; then
+			psql -U `whoami` postgres <<-EOSQL
+				CREATE DATABASE "$POSTGRES_DB" ;
+			EOSQL
+			echo
+		fi
+
+		if [ "$POSTGRES_USER" = `whoami` ]; then
+			op='ALTER'
+		else
+			op='CREATE'
+		fi
+
+		psql -U `whoami` postgres <<-EOSQL
+			$op USER "$POSTGRES_USER" WITH SUPERUSER PASSWORD '';
+		EOSQL
+		echo
+
+		psql -U `whoami` $POSTGRES_DB -c 'CREATE EXTENSION aqo;'
+		pg_ctl -D "$PGDATA" -m fast -w stop
+	fi
+fi
+
+exec "$@"
