[feat:10] 增加针对PostgreSQL 10.x的Dockerfile文件
This commit is contained in:
@@ -0,0 +1,74 @@
|
||||
FROM --platform=linux/amd64 endial/ubuntu:v18.04
|
||||
# --platform=$BUILDPLATFORM linux/amd64, linux/arm64, or windows/amd64
|
||||
|
||||
LABEL \
|
||||
"Version"="v10.12" \
|
||||
"Description"="Docker image for PostgreSQL 10.12 based on Ubuntu 18.04." \
|
||||
"Dockerfile"="https://github.com/endial/docker-libs" \
|
||||
"Vendor"="Endial Fang (endial@126.com)"
|
||||
|
||||
ENV PG_MAJOR 10
|
||||
ENV PG_VERSION 10.12-2.pgdg18.04+1
|
||||
ENV PG_KEYS B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8
|
||||
|
||||
ENV PGDATA /srv/data/postgresql
|
||||
ENV PATH $PATH:/usr/lib/postgresql/${PG_MAJOR}/bin
|
||||
|
||||
RUN set -eux; \
|
||||
# add user after ningx docker
|
||||
groupadd -r -g 502 postgres; \
|
||||
useradd -r -g postgres -d /var/lib/postgresql -s /bin/bash -u 502 postgres; \
|
||||
mkdir -p /var/lib/postgresql; \
|
||||
chown -R postgres:postgres /var/lib/postgresql; \
|
||||
\
|
||||
fetchDeps=" \
|
||||
dirmngr \
|
||||
gnupg \
|
||||
"; \
|
||||
apt update; \
|
||||
apt install -y --no-install-recommends ${fetchDeps}; \
|
||||
\
|
||||
export GNUPGHOME="$(mktemp -d)"; \
|
||||
gpg --batch --keyserver ha.pool.sks-keyservers.net --recv-keys "${PG_KEYS}"; \
|
||||
gpg --batch --export "${PG_KEYS}" > /etc/apt/trusted.gpg.d/postgres.gpg; \
|
||||
command -v gpgconf > /dev/null && gpgconf --kill all; \
|
||||
rm -rf "$GNUPGHOME"; \
|
||||
apt-key list; \
|
||||
\
|
||||
echo "deb http://apt.postgresql.org/pub/repos/apt/ bionic-pgdg main ${PG_MAJOR}" >> /etc/apt/sources.list; \
|
||||
echo "deb-src http://apt.postgresql.org/pub/repos/apt/ bionic-pgdg main ${PG_MAJOR}" >> /etc/apt/sources.list; \
|
||||
apt update; \
|
||||
\
|
||||
# set noninteractive for install tzdata
|
||||
export DEBIAN_FRONTEND=noninteractive; \
|
||||
\
|
||||
apt install -y --no-install-recommends \
|
||||
postgresql-${PG_MAJOR}=${PG_VERSION} \
|
||||
postgresql-common \
|
||||
libnss-wrapper \
|
||||
xz-utils \
|
||||
; \
|
||||
\
|
||||
# reconfigure tzdata for China
|
||||
ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime; \
|
||||
dpkg-reconfigure -f noninteractive tzdata; \
|
||||
\
|
||||
apt purge -y --auto-remove ${fetchDeps}; \
|
||||
apt autoclean -y; \
|
||||
rm -rf /var/lib/apt/lists/*; \
|
||||
\
|
||||
# make the sample config easier to munge (and "correct by default")
|
||||
dpkg-divert --add --rename --divert "/usr/share/postgresql/postgresql.conf.sample.dpkg" "/usr/share/postgresql/$PG_MAJOR/postgresql.conf.sample"; \
|
||||
cp -v /usr/share/postgresql/postgresql.conf.sample.dpkg /usr/share/postgresql/postgresql.conf.sample; \
|
||||
ln -sv ../postgresql.conf.sample "/usr/share/postgresql/$PG_MAJOR/";
|
||||
|
||||
|
||||
COPY ./entrypoint.sh /usr/local/bin/
|
||||
|
||||
VOLUME ["/srv/conf", "/srv/data", "/var/log", "/var/run"]
|
||||
|
||||
EXPOSE 5432
|
||||
|
||||
ENTRYPOINT ["entrypoint.sh"]
|
||||
|
||||
CMD ["postgres"]
|
||||
Executable
+346
@@ -0,0 +1,346 @@
|
||||
#!/bin/bash
|
||||
# docker entrypoint script
|
||||
|
||||
set -Eeo pipefail
|
||||
|
||||
echo "[i] Initial Container"
|
||||
|
||||
# allow the container to be started with `--user` or `-u`
|
||||
# if [ "$1" = 'app-name' -a "$(id -u)" = '0' ]; then
|
||||
# echo "[i] Restart container with user: user-name"
|
||||
# echo ""
|
||||
# exec gosu user-name "$0" "$@"
|
||||
# fi
|
||||
|
||||
# TODO swap to -Eeuo pipefail above (after handling all potentially-unset variables)
|
||||
|
||||
# 检测"_FILE"文件,并从文件中读取信息作为参数值;环境变量不允许 VAR 与 VAR_FILE 方式并存
|
||||
#
|
||||
# usage: file_env VAR [DEFAULT]
|
||||
# ie: file_env 'XYZ_DB_PASSWORD' 'example'
|
||||
file_env() {
|
||||
local var="$1"
|
||||
local fileVar="${var}_FILE"
|
||||
local def="${2:-}"
|
||||
if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then
|
||||
echo >&2 "error: both $var and $fileVar are set (but are exclusive)"
|
||||
exit 1
|
||||
fi
|
||||
local val="$def"
|
||||
if [ "${!var:-}" ]; then
|
||||
val="${!var}"
|
||||
elif [ "${!fileVar:-}" ]; then
|
||||
val="$(< "${!fileVar}")"
|
||||
fi
|
||||
export "$var"="$val"
|
||||
unset "$fileVar"
|
||||
}
|
||||
|
||||
# check to see if this file is being run or sourced from another script
|
||||
_is_sourced() {
|
||||
# https://unix.stackexchange.com/a/215279
|
||||
[ "${#FUNCNAME[@]}" -ge 2 ] \
|
||||
&& [ "${FUNCNAME[0]}" = '_is_sourced' ] \
|
||||
&& [ "${FUNCNAME[1]}" = 'source' ]
|
||||
}
|
||||
|
||||
# 使用root用户运行时,创建默认的数据库存储目录,并修改对应目录所属用户为"postgres"
|
||||
docker_create_db_directories() {
|
||||
local user; user="$(id -u)"
|
||||
|
||||
# default value: /srv/data/postgresql
|
||||
if [ ! -d "$PGDATA" ]; then
|
||||
mkdir -p "$PGDATA"
|
||||
chmod 755 "$PGDATA"
|
||||
fi
|
||||
|
||||
if [ ! -d /var/run/postgresql ]; then
|
||||
mkdir -p /var/run/postgresql || :
|
||||
chmod 755 /var/run/postgresql || :
|
||||
fi
|
||||
|
||||
if [ ! -d /var/log/postgresql ]; then
|
||||
mkdir -p /var/log/postgresql || :
|
||||
chmod 755 /var/log/postgresql || :
|
||||
fi
|
||||
|
||||
if [ ! -d /srv/conf/postgresql/initdb.d ]; then
|
||||
mkdir -p /srv/conf/postgresql/initdb.d
|
||||
chmod -R 755 /srv/conf/postgresql
|
||||
cp -rf /usr/share/postgresql/postgresql.conf.sample /srv/conf/postgresql/postgresql.conf
|
||||
fi
|
||||
|
||||
if [ ! -d /srv/conf/postgresql-common ]; then
|
||||
mkdir -p /srv/conf/postgresql-common
|
||||
chmod 755 /srv/conf/postgresql-common
|
||||
cp -rf /etc/postgresql-common/createcluster.conf /srv/conf/postgresql-common/createcluster.conf
|
||||
fi
|
||||
|
||||
# 创建数据库日志存储目录,修改相应目录的所属用户信息
|
||||
if [ -n "$POSTGRES_INITDB_WALDIR" ]; then
|
||||
mkdir -p "$POSTGRES_INITDB_WALDIR"
|
||||
if [ "$user" = '0' ]; then
|
||||
find "$POSTGRES_INITDB_WALDIR" \! -user postgres -exec chown postgres '{}' +
|
||||
fi
|
||||
chmod 700 "$POSTGRES_INITDB_WALDIR"
|
||||
fi
|
||||
|
||||
# 允许容器使用`--user`参数启动,修改相应目录的所属用户信息
|
||||
if [ "$user" = '0' ]; then
|
||||
find "$PGDATA" \! -user postgres -exec chown postgres '{}' +
|
||||
find /var/run/postgresql \! -user postgres -exec chown postgres '{}' +
|
||||
find /var/log/postgresql \! -user postgres -exec chown postgres '{}' +
|
||||
find /srv/conf/postgresql \! -user postgres -exec chown postgres '{}' +
|
||||
find /srv/conf/postgresql-common \! -user postgres -exec chown postgres '{}' +
|
||||
fi
|
||||
}
|
||||
|
||||
# 针对 PGDATA 目录为空时,使用'initdb'初始化数据目录;同时创建 POSTGRES_USER 定义的同名数据库用户
|
||||
# 用户需要传给`initdb`的参数,可通过环境变量 POSTGRES_INITDB_ARGS 传输,或直接使用命令行参数传输到当前函数
|
||||
# `initdb`会自动创建以下数据库:"postgres", "template0", "template1"
|
||||
docker_init_database_dir() {
|
||||
# "initdb" 需要当前用户UID在 "/etc/passwd" 中存在,因此,如果需要时, 我们使用"nss_wrapper"虚拟相关用户
|
||||
if ! getent passwd "$(id -u)" &> /dev/null && [ -e /usr/lib/libnss_wrapper.so ]; then
|
||||
export LD_PRELOAD='/usr/lib/libnss_wrapper.so'
|
||||
export NSS_WRAPPER_PASSWD="$(mktemp)"
|
||||
export NSS_WRAPPER_GROUP="$(mktemp)"
|
||||
echo "postgres:x:$(id -u):$(id -g):PostgreSQL:$PGDATA:/bin/false" > "$NSS_WRAPPER_PASSWD"
|
||||
echo "postgres:x:$(id -g):" > "$NSS_WRAPPER_GROUP"
|
||||
fi
|
||||
|
||||
if [ -n "$POSTGRES_INITDB_WALDIR" ]; then
|
||||
set -- --waldir "$POSTGRES_INITDB_WALDIR" "$@"
|
||||
fi
|
||||
|
||||
eval 'initdb --username="$POSTGRES_USER" --pwfile=<(echo "$POSTGRES_PASSWORD") '"$POSTGRES_INITDB_ARGS"' "$@"'
|
||||
|
||||
# unset/cleanup "nss_wrapper" bits
|
||||
if [ "${LD_PRELOAD:-}" = '/usr/lib/libnss_wrapper.so' ]; then
|
||||
rm -f "$NSS_WRAPPER_PASSWD" "$NSS_WRAPPER_GROUP"
|
||||
unset LD_PRELOAD NSS_WRAPPER_PASSWD NSS_WRAPPER_GROUP
|
||||
fi
|
||||
}
|
||||
|
||||
# 如果 POSTGRES_PASSWORD 超过100字节,打印警告信息
|
||||
# 如果 POSTGRES_PASSWORD 为空且 POSTGRES_HOST_AUTH_METHOD 不为 'trust',打印错误信息并退出
|
||||
# 如果 POSTGRES_HOST_AUTH_METHOD 设置为 'trust',打印警告信息
|
||||
docker_verify_minimum_env() {
|
||||
if [ "${#POSTGRES_PASSWORD}" -ge 100 ]; then
|
||||
cat >&2 <<-'EOWARN'
|
||||
WARNING: The supplied POSTGRES_PASSWORD is 100+ characters.
|
||||
This will not work if used via PGPASSWORD with "psql".
|
||||
https://www.postgresql.org/message-id/flat/E1Rqxp2-0004Qt-PL%40wrigleys.postgresql.org (BUG #6412)
|
||||
https://github.com/docker-library/postgres/issues/507
|
||||
EOWARN
|
||||
fi
|
||||
if [ -z "$POSTGRES_PASSWORD" ] && [ 'trust' != "$POSTGRES_HOST_AUTH_METHOD" ]; then
|
||||
# The - option suppresses leading tabs but *not* spaces. :)
|
||||
cat >&2 <<-'EOE'
|
||||
Error: Database is uninitialized and superuser password is not specified.
|
||||
You must specify POSTGRES_PASSWORD to a non-empty value for the
|
||||
superuser. For example, "-e POSTGRES_PASSWORD=password" on "docker run".
|
||||
You may also use "POSTGRES_HOST_AUTH_METHOD=trust" to allow all
|
||||
connections without a password. This is *not* recommended.
|
||||
See PostgreSQL documentation about "trust":
|
||||
https://www.postgresql.org/docs/current/auth-trust.html
|
||||
EOE
|
||||
exit 1
|
||||
fi
|
||||
if [ 'trust' = "$POSTGRES_HOST_AUTH_METHOD" ]; then
|
||||
cat >&2 <<-'EOWARN'
|
||||
********************************************************************************
|
||||
WARNING: POSTGRES_HOST_AUTH_METHOD has been set to "trust". This will allow
|
||||
anyone with access to the Postgres port to access your database without
|
||||
a password, even if POSTGRES_PASSWORD is set. See PostgreSQL
|
||||
documentation about "trust":
|
||||
https://www.postgresql.org/docs/current/auth-trust.html
|
||||
In Docker's default configuration, this is effectively any other
|
||||
container on the same system.
|
||||
It is not recommended to use POSTGRES_HOST_AUTH_METHOD=trust. Replace
|
||||
it with "-e POSTGRES_PASSWORD=password" instead to set a password in
|
||||
"docker run".
|
||||
********************************************************************************
|
||||
EOWARN
|
||||
fi
|
||||
}
|
||||
|
||||
# usage: docker_process_init_files [file [file [...]]]
|
||||
# ie: docker_process_init_files /always-initdb.d/*
|
||||
# process initializer files, based on file extensions and permissions
|
||||
docker_process_init_files() {
|
||||
# psql here for backwards compatiblilty "${psql[@]}"
|
||||
psql=( docker_process_sql )
|
||||
|
||||
echo
|
||||
local f
|
||||
for f; do
|
||||
case "$f" in
|
||||
*.sh)
|
||||
# https://github.com/docker-library/postgres/issues/450#issuecomment-393167936
|
||||
# https://github.com/docker-library/postgres/pull/452
|
||||
if [ -x "$f" ]; then
|
||||
echo "$0: running $f"
|
||||
"$f"
|
||||
else
|
||||
echo "$0: sourcing $f"
|
||||
. "$f"
|
||||
fi
|
||||
;;
|
||||
*.sql) echo "$0: running $f"; docker_process_sql -f "$f"; echo ;;
|
||||
*.sql.gz) echo "$0: running $f"; gunzip -c "$f" | docker_process_sql; echo ;;
|
||||
*.sql.xz) echo "$0: running $f"; xzcat "$f" | docker_process_sql; echo ;;
|
||||
*) echo "$0: ignoring $f" ;;
|
||||
esac
|
||||
echo
|
||||
done
|
||||
}
|
||||
|
||||
# Execute sql script, passed via stdin (or -f flag of pqsl)
|
||||
# usage: docker_process_sql [psql-cli-args]
|
||||
# ie: docker_process_sql --dbname=mydb <<<'INSERT ...'
|
||||
# ie: docker_process_sql -f my-file.sql
|
||||
# ie: docker_process_sql <my-file.sql
|
||||
docker_process_sql() {
|
||||
local query_runner=( psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --no-password )
|
||||
if [ -n "$POSTGRES_DB" ]; then
|
||||
query_runner+=( --dbname "$POSTGRES_DB" )
|
||||
fi
|
||||
|
||||
"${query_runner[@]}" "$@"
|
||||
}
|
||||
|
||||
# create initial database
|
||||
# uses environment variables for input: POSTGRES_DB
|
||||
docker_setup_db() {
|
||||
if [ "$POSTGRES_DB" != 'postgres' ]; then
|
||||
POSTGRES_DB= docker_process_sql --dbname postgres --set db="$POSTGRES_DB" <<-'EOSQL'
|
||||
CREATE DATABASE :"db" ;
|
||||
EOSQL
|
||||
echo
|
||||
fi
|
||||
}
|
||||
|
||||
# 加载在后续脚本命令中使用的参数信息,包括从"*_FILE"文件中导入的配置
|
||||
# 必须在其他函数使用前调用
|
||||
docker_setup_env() {
|
||||
file_env 'POSTGRES_PASSWORD'
|
||||
|
||||
file_env 'POSTGRES_USER' 'postgres'
|
||||
file_env 'POSTGRES_DB' "$POSTGRES_USER"
|
||||
file_env 'POSTGRES_INITDB_ARGS'
|
||||
# 变量 POSTGRES_HOST_AUTH_METHOD 不存在或值为空,赋值为默认值:md5
|
||||
: "${POSTGRES_HOST_AUTH_METHOD:=md5}"
|
||||
|
||||
declare -g DATABASE_ALREADY_EXISTS
|
||||
# look specifically for PG_VERSION, as it is expected in the DB dir
|
||||
if [ -s "$PGDATA/PG_VERSION" ]; then
|
||||
DATABASE_ALREADY_EXISTS='true'
|
||||
fi
|
||||
}
|
||||
|
||||
# 将环境变量 POSTGRES_HOST_AUTH_METHOD 定义的信息增加至配置文件 pg_hba.conf,保证允许本地连接
|
||||
pg_setup_hba_conf() {
|
||||
{
|
||||
echo
|
||||
if [ 'trust' = "$POSTGRES_HOST_AUTH_METHOD" ]; then
|
||||
echo '# warning trust is enabled for all connections'
|
||||
echo '# see https://www.postgresql.org/docs/12/auth-trust.html'
|
||||
fi
|
||||
echo "host all all all $POSTGRES_HOST_AUTH_METHOD"
|
||||
} >> "$PGDATA/pg_hba.conf"
|
||||
}
|
||||
|
||||
# start socket-only postgresql server for setting up or running scripts
|
||||
# all arguments will be passed along as arguments to `postgres` (via pg_ctl)
|
||||
docker_temp_server_start() {
|
||||
if [ "$1" = 'postgres' ]; then
|
||||
shift
|
||||
fi
|
||||
|
||||
# internal start of server in order to allow setup using psql client
|
||||
# does not listen on external TCP/IP and waits until start finishes
|
||||
set -- "$@" -c listen_addresses='' -p "${PGPORT:-5432}"
|
||||
|
||||
PGUSER="${PGUSER:-$POSTGRES_USER}" \
|
||||
pg_ctl -D "$PGDATA" \
|
||||
-o "$(printf '%q ' "$@")" \
|
||||
-w start
|
||||
}
|
||||
|
||||
# stop postgresql server after done setting up user and running scripts
|
||||
docker_temp_server_stop() {
|
||||
PGUSER="${PGUSER:-postgres}" \
|
||||
pg_ctl -D "$PGDATA" -m fast -w stop
|
||||
}
|
||||
|
||||
# 检测可能导致postgres执行后直接退出的命令,如"--help";如果存在,直接返回 0
|
||||
_pg_want_help() {
|
||||
local arg
|
||||
for arg; do
|
||||
case "$arg" in
|
||||
-'?'|--help|--describe-config|-V|--version)
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
_main() {
|
||||
# 如果命令行参数是以配置参数("-")开始,修改执行命令,确保使用postgres命令启动服务器
|
||||
if [ "${1:0:1}" = '-' ]; then
|
||||
set -- postgres "$@"
|
||||
fi
|
||||
|
||||
# 命令行参数以postgres起始,且不包含直接返回的命令(如:-V、--version、--help)时,执行初始化操作
|
||||
if [ "$1" = 'postgres' ] && ! _pg_want_help "$@"; then
|
||||
docker_setup_env
|
||||
|
||||
# 以root用户运行时,设置数据存储目录与权限;设置完成后,会使用gosu重新以"postgres"用户运行当前脚本
|
||||
docker_create_db_directories
|
||||
if [ "$(id -u)" = '0' ]; then
|
||||
echo "[i] Restart container with user: postgres"
|
||||
echo ""
|
||||
exec gosu postgres "$0" "$@"
|
||||
fi
|
||||
|
||||
# 检测数据库存储目录是否为空;如果为空,进行初始化操作
|
||||
if [ -z "$DATABASE_ALREADY_EXISTS" ]; then
|
||||
docker_verify_minimum_env
|
||||
|
||||
# 检测目录权限,防止初始化失败
|
||||
ls /srv/conf/postgresql/initdb.d/ > /dev/null
|
||||
|
||||
docker_init_database_dir
|
||||
pg_setup_hba_conf
|
||||
|
||||
# PGPASSWORD is required for psql when authentication is required for 'local' connections via pg_hba.conf and is otherwise harmless
|
||||
# e.g. when '--auth=md5' or '--auth-local=md5' is used in POSTGRES_INITDB_ARGS
|
||||
export PGPASSWORD="${PGPASSWORD:-$POSTGRES_PASSWORD}"
|
||||
docker_temp_server_start "$@"
|
||||
|
||||
docker_setup_db
|
||||
docker_process_init_files /srv/conf/postgresql/initdb.d/*
|
||||
|
||||
docker_temp_server_stop
|
||||
unset PGPASSWORD
|
||||
|
||||
echo
|
||||
echo "[i] PostgreSQL init process complete; ready for start up."
|
||||
echo
|
||||
else
|
||||
echo
|
||||
echo "[i] PostgreSQL Database directory appears to contain a database; Skipping initialization"
|
||||
echo
|
||||
fi
|
||||
|
||||
echo "[i] Start Application."
|
||||
fi
|
||||
|
||||
# 执行命令行
|
||||
exec "$@"
|
||||
}
|
||||
|
||||
if ! _is_sourced; then
|
||||
_main "$@"
|
||||
fi
|
||||
@@ -0,0 +1,335 @@
|
||||
# 简介
|
||||
|
||||
基于的Ubuntu系统的PostgreSQL Docker镜像。
|
||||
|
||||
|
||||
|
||||
## 基本信息
|
||||
|
||||
* 镜像地址:endial/postgres
|
||||
* 依赖镜像:endial/ubuntu:v18.04
|
||||
|
||||
|
||||
|
||||
## 数据卷
|
||||
|
||||
```shell
|
||||
/srv/data:数据存储目录
|
||||
/srv/conf:配置文件及初始化文件存储目录
|
||||
/var/run:运行时文件存储目录
|
||||
/var/log:日志文件存储目录
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 使用说明
|
||||
|
||||
### 启动容器
|
||||
|
||||
#### 通过默认方式启动
|
||||
|
||||
```shell
|
||||
$ docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d postgres
|
||||
```
|
||||
|
||||
- 由容器执行默认的`entrypoint.sh`脚本,并生成默认的用户及数据文件
|
||||
- `some-postgres`:容器名;命名后,可以直接使用该名字进行操作
|
||||
- `mysecretpassword`:数据库密码
|
||||
|
||||
|
||||
|
||||
#### 通过`psql`命令方式启动
|
||||
|
||||
```shell
|
||||
$ docker run -it --rm --network some-network postgres psql -h some-postgres -U postgres
|
||||
psql (10.12.0)
|
||||
Type "help" for help.
|
||||
|
||||
postgres=# SELECT 1;
|
||||
?column?
|
||||
----------
|
||||
1
|
||||
(1 row)
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### 通过`docker-compose`方式启动
|
||||
|
||||
docker-cpmpose.yml 参考:
|
||||
|
||||
```yaml
|
||||
# 使用 postgres/example 作为用户名/密码
|
||||
|
||||
version: '3.1'
|
||||
|
||||
services:
|
||||
|
||||
db:
|
||||
image: postgres
|
||||
restart: always
|
||||
environment:
|
||||
POSTGRES_PASSWORD: example
|
||||
|
||||
adminer:
|
||||
image: adminer
|
||||
restart: always
|
||||
ports:
|
||||
|
||||
- 8080:8080
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 镜像扩展使用
|
||||
|
||||
有多种方式可以扩展使用`postgres`镜像;这里仅列举部分,在实际使用时,不一定需要全部使用。
|
||||
|
||||
### 环境变量
|
||||
|
||||
PostgreSQL镜像定义了许多环境变量,但并不是所有都必须使用的;如果需要定制化启动镜像,可以选择需要的环境变量进行设置。
|
||||
|
||||
> 注意:部分环境变量仅在初始化时起作用。针对已经存在数据目录的情况,环境变量会被跳过。
|
||||
|
||||
#### POSTGRES_PASSWORD
|
||||
|
||||
该环境变量需要在启动镜像时使用。该环境变量定义了使用PostgreSQL时,超级用户对应的密码,不应当为空。默认的超级用户由环境变量`POSTGRES_USER`定义.
|
||||
|
||||
> 注意:
|
||||
>
|
||||
> - PostgreSQL镜像配置`localhost`为默认的`trust`认证方式,在同一容器内链接数据库时,可以不使用密码。但通过不同的`主机/容器`链接时,需要密码。
|
||||
> - 在使用PostgreSQL镜像创建容器时,通过`initdb脚本`在启动时定义该变量对应的值。但该值不影响尽在`psql`方式启动时设置的`PGPASSWORD`环境变量。`PGPASSWORD`环境变量在设置时仅作为一个独立的环境变量设置。
|
||||
|
||||
#### POSTGRES_USER
|
||||
|
||||
该可选环境环境变量与`POSTGRES_PASSWORD`环境变量一起使用,以在使用镜像创建容器时设置用户名和密码。使用该变量时,会创建用户对应的超级权限及同名数据库。如果该变量没有设置,默认使用用户`postgres`。
|
||||
|
||||
> 注意:即使使用了该变量,在初始化时,系统信息仍然会提示`The files belonging to this database system will be owned by user "postgres"`;这是因为在容器初始化时,是以Linux系统用户(镜像中`/etc/passwd`定义)`postgres`来运行的守护进程。
|
||||
|
||||
#### POSTGRES_DB
|
||||
|
||||
该可选环境变量在使用镜像创建容器时,定义一个不与默认的`POSTGRES_USER`同名的数据库。如果在创建容器时没有使用该变量,则创建`POSTGRES_USER`对应的同名数据库。
|
||||
|
||||
#### POSTGRES_INITDB_ARGS
|
||||
|
||||
该可选环境变量在使用镜像创建容器时,传递参数给`postgres initdb`。传递的参数是一个使用空格分隔的字符串。例如增加页校验码:`-e POSTGRES_INITDB_ARGS="--data-checksums"`。
|
||||
|
||||
#### POSTGRES_INITDB_WALDIR
|
||||
|
||||
该可选环境变量在使用镜像创建容器时,定义一个单独的PostgreSQL事务处理日志存储目录。相关的日志默认存储在PostgreSQL的数据存储目录(`PGDATA`)子目录中。部分情况下,用户可以定义该存储目录在不同的存储设备上,以提升性能或稳定性。
|
||||
|
||||
#### POSTGRES_HOST_AUTH_METHOD
|
||||
|
||||
该可选环境变量在使用镜像创建容器时,定义至服务器的`auth-method`,该定义针对所有数据库、用户、链接地址起作用。未定义该参数时,使用默认值`md5`密码认证方式。
|
||||
|
||||
对于一个未初始化的数据库,可以修改`pg_hba.conf`文件,增加以下命令行进行预定义:
|
||||
|
||||
```shell
|
||||
echo "host all all all $POSTGRES_HOST_AUTH_METHOD" >> pg_hba.conf
|
||||
```
|
||||
|
||||
或:
|
||||
|
||||
```shell
|
||||
echo "host all all 0.0.0.0/0 $POSTGRES_HOST_AUTH_METHOD" >> pg_hba.conf
|
||||
```
|
||||
|
||||
详细说明可参考官方针对[`pg_hba.conf`](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html)文档的介绍。
|
||||
|
||||
> 注意:
|
||||
>
|
||||
> - 不建议使用[`trust`](https://www.postgresql.org/docs/current/auth-trust.html)方式;该方式允许任意用户不使用密码连接数据库,即使部分用户设置了密码(如通过`POSTGRES_PASSWORD`)。更多介绍可参考[*Trust Authentication*](https://www.postgresql.org/docs/current/auth-trust.html)。
|
||||
> - 如果设置了`POSTGRES_HOST_AUTH_METHOD`为`trust`,那么`POSTGRES_PASSWORD`就不在需要,也不再起作用了。
|
||||
|
||||
#### PGDATA
|
||||
|
||||
该可选环境变量在使用镜像创建容器时,定义一个单独的PostgreSQL数据库存储目录。未定义该参数时,使用默认的`/var/lib/postgresql/data`目录。
|
||||
|
||||
如果使用的数据卷为文件系统挂载点(GCE persistent disks)或远程目录(NFS mounts),这些目录无法被更改所属用户为`postgres`,针对这种情况建议配置子目录以存储数据。例如:
|
||||
|
||||
```shell
|
||||
$ docker run -d \
|
||||
--name some-postgres \
|
||||
-e POSTGRES_PASSWORD=mysecretpassword \
|
||||
-e PGDATA=/var/lib/postgresql/data/pgdata \
|
||||
-v /custom/mount:/var/lib/postgresql/data \
|
||||
postgres
|
||||
```
|
||||
|
||||
该变量并不是为Docker定义的数据卷,而是由`postgres`服务本身使用(参考 [PostgreSQL docs](https://www.postgresql.org/docs/11/app-postgres.html#id-1.9.5.14.7)),entrypoing.sh脚本只是传输该值。
|
||||
|
||||
|
||||
|
||||
### 容器安全
|
||||
|
||||
作为敏感信息通过环境变量传输的可选替代方案,可以增加`_FILE`在部分环境变量末尾,以使容器的初始化脚本通过加载文件的方式,获取相关变量。例如,可以通过加载文件的方式加载密码:
|
||||
|
||||
```shell
|
||||
$ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgres-passwd -d postgres
|
||||
```
|
||||
|
||||
支持该方式的变量为: `POSTGRES_INITDB_ARGS`, `POSTGRES_PASSWORD`, `POSTGRES_USER`, `POSTGRES_DB`。
|
||||
|
||||
|
||||
|
||||
### 初始化脚本
|
||||
|
||||
如果需要在使用当前镜像时,增加一些附加的初始化操作,可以将相应的`*.sql`、 `*.sql.gz` 或 `*.sh`脚本文件放置在`initdb.d`目录中(使用数据卷映射方式时,可先创建相应的目录)。在`entrypoint.sh`调用`initdb`创建默认的`postgres`用户及数据库时,会执行所有在`initdb.d`目录下的`*.sql`及可执行`*.sh`脚本,并source所有不可执行的`*.sh`脚本,执行完成后,启动postgres服务。
|
||||
|
||||
> 注意:
|
||||
>
|
||||
> - 在`initdb.d`目录下的脚本,仅在数据库存储目录为空时才会执行。如果部分脚本执行失败(会导致容器退出),则可能数据库目录已经存在;此时,重新启动容器,则不会继续执行`initdb.d`目录下的初始化脚本。
|
||||
|
||||
|
||||
|
||||
### 数据库配置
|
||||
|
||||
有多种方式可以配置PostgreSQL服务器。详细信息可参考相关[docs](https://www.postgresql.org/docs/current/static/runtime-config.html)文档。部分常用配置项如下:
|
||||
|
||||
- 使用自定义的配置文件。可将容器内的模板配置文件 `/usr/share/postgresql/postgresql.conf.sample`导出后修改,并重新映射以启动容器。
|
||||
|
||||
```shell
|
||||
$ # 获取配置文件模板,存储为当前目录的my-postgres.conf
|
||||
$ docker run -i --rm endial/postgres-ubuntu:v10.12 cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf
|
||||
|
||||
$ # 个性化修改配置信息,至少增加`listen_addresses='*'`以确保其他容器可以访问
|
||||
$ echo "listen_addresses='*'" >> my-postgres.conf
|
||||
|
||||
$ # 使用定制后的配置文件启动容器
|
||||
$ docker run -d --name some-postgres -v "$PWD/my-postgres.conf":/etc/postgresql/postgresql.conf -e POSTGRES_PASSWORD=mysecretpassword endial/postgres-ubuntu:v10.12 -c 'config_file=/etc/postgresql/postgresql.conf'
|
||||
```
|
||||
|
||||
- 在命令行中设置相应参数。entrypoint.sh基本会将所有的启动时传递给Docker的配置参数传递给postgres服务进程。从官方 [docs](https://www.postgresql.org/docs/current/static/app-postgres.html)文档可以看出,所有在 `.conf`文件中的配置项都可以使用`-c`进行设置。
|
||||
|
||||
```shell
|
||||
$ docker run -d --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword endial/postgres-ubuntu:v10.12 -c 'shared_buffers=256MB' -c 'max_connections=200'
|
||||
```
|
||||
|
||||
> 注意:配置文件至少修改`listen_addresses='*'`以确保其他容器可以访问
|
||||
|
||||
配置文件模板:
|
||||
|
||||
- 基于Linux系列的镜像,默认配置文件在容器内为:`/usr/share/postgresql/postgresql.conf.sample`
|
||||
- 基于Alpine系统的镜像,默认配置文件在容器内为:`/usr/local/share/postgresql/postgresql.conf.sample`
|
||||
|
||||
|
||||
|
||||
导出模板文件:
|
||||
|
||||
```shell
|
||||
docker run -i --rm endial/postgres-ubuntu:v10.12 cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf
|
||||
```
|
||||
|
||||
- 使用的镜像:endial/postgres-ubuntu:v10.12
|
||||
- 原始文件:/usr/share/postgresql/postgresql.conf.sample
|
||||
- 导出后文件:my-postgres.conf
|
||||
|
||||
|
||||
|
||||
### 个性化配置Locale
|
||||
|
||||
PostgreSQL镜像使用的Ubuntu基础镜像默认的Locale配置为`en_US.UTF-8`,可以使用一个简单的 Dockerfile来设置为不同的Locale。比如设置为 `de_DE.utf8`:
|
||||
|
||||
```dockerfile
|
||||
FROM endial/postgres-ubuntu:v10.12
|
||||
RUN localedef -i de_DE -c -f UTF-8 -A /usr/share/locale/locale.alias de_DE.UTF-8
|
||||
ENV LANG de_DE.utf8
|
||||
```
|
||||
|
||||
因为数据库仅在容器启动时创建,使用这种方式,可以在创建数据库前设置默认语言。
|
||||
|
||||
|
||||
|
||||
### 扩展功能模块
|
||||
|
||||
使用默认的镜像时,安装扩展功能模块比较简单,可以参考文档 [github.com/postgis/docker-postgis](https://github.com/postgis/docker-postgis/blob/4eb614133d6aa87bfc5c952d24b7eb1f499e5c7c/12-3.0/Dockerfile) 。
|
||||
|
||||
使用基于Alpine的镜像时,没有在 [postgres-contrib](https://www.postgresql.org/docs/10/static/contrib.html) 列明的模块需要自己在镜像中编译,参见文档 [github.com/postgis/docker-postgis](https://github.com/postgis/docker-postgis/blob/4eb614133d6aa87bfc5c952d24b7eb1f499e5c7c/12-3.0/alpine/Dockerfile) 。
|
||||
|
||||
|
||||
|
||||
## 变参 --user 说明
|
||||
|
||||
本镜像允许使用变参`--user`指定运行时的用户信息。但需要注意的是,`postgres`可以允许使用任何UID执行(只需要需数据库目录所属账户一致),`initdb`需要确保该UID实际存在(用户需要在`/etc/passwd`文件中存在):
|
||||
|
||||
```shell
|
||||
$ docker run -it --rm --user www-data -e POSTGRES_PASSWORD=mysecretpassword endial/postgres-ubuntu:v10.12
|
||||
The files belonging to this database system will be owned by user "www-data".
|
||||
...
|
||||
|
||||
$ docker run -it --rm --user 1000:1000 -e POSTGRES_PASSWORD=mysecretpassword endial/postgres-ubuntu:v10.12
|
||||
initdb: could not look up effective user ID 1000: user does not exist
|
||||
```
|
||||
|
||||
针对类似问题,有三种解决方案:
|
||||
|
||||
1. 使用Linux系列镜像(Centos/Debian/Ubuntu/Redhat等),类似镜像允许使用 [ `nss_wrapper` 库](https://cwrap.org/nss_wrapper.html) 将系统`/etc/passwd`包含的用户伪装为容器内用户。但Alpine系列镜像不允许。
|
||||
|
||||
2. 如果宿主系统存在相应的用户,可以使用只读绑定将`/etc/passwd`文件映射为容器内对应文件:
|
||||
|
||||
```shell
|
||||
$ docker run -it --rm --user "$(id -u):$(id -g)" -v /etc/passwd:/etc/passwd:ro -e POSTGRES_PASSWORD=mysecretpassword endial/postgres-ubuntu:v10.12
|
||||
The files belonging to this database system will be owned by user "jsmith".
|
||||
...
|
||||
```
|
||||
|
||||
3. 单独初始化相应的数据库存储目录,并使用`chown`命令更改所属用户:
|
||||
|
||||
```shell
|
||||
$ docker volume create pgdata
|
||||
$ docker run -it --rm -v pgdata:/var/lib/postgresql/data -e POSTGRES_PASSWORD=mysecretpassword endial/postgres-ubuntu:v10.12
|
||||
The files belonging to this database system will be owned by user "postgres".
|
||||
...
|
||||
( once it's finished initializing successfully and is waiting for connections, stop it )
|
||||
|
||||
$ docker run -it --rm -v pgdata:/var/lib/postgresql/data endial/postgres-ubuntu:v10.12 bash chown -R 1000:1000 /var/lib/postgresql/data
|
||||
|
||||
$ docker run -it --rm --user 1000:1000 -v pgdata:/var/lib/postgresql/data endial/postgres-ubuntu:v10.12
|
||||
LOG: database system was shut down at 2017-01-20 00:03:23 UTC
|
||||
LOG: MultiXact member wraparound protections are now enabled
|
||||
LOG: autovacuum launcher started
|
||||
LOG: database system is ready to accept connections
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 使用预警
|
||||
|
||||
如果不存在数据库,容器启动时,会花费一定时间创建默认的数据库,在创建期间,容器不接受访问链接。如果使用`docker-compose`方式同时启动多个容器时,可能会产生问题。
|
||||
|
||||
容器默认的`/dev/shm` 大小为`64MB`。如果在容器运行过程中共享内存不足,可能会遇到错误``。针对这种情况,可以通过在启动容器时传递类似参数 [--shm-size=256MB ](https://docs.docker.com/engine/reference/run/#runtime-constraints-on-resources) 进行调整。
|
||||
|
||||
在Swarm模式中使用overlay网络模式时,针对长时间运行的IDLE链接,可能会遇到`IPVS connection timeouts`错误,可以参照以下信息解决: ["IPVS connection timeout issue" in the Docker Success Center](https://success.docker.com/article/ipvs-connection-timeout-issue) 。
|
||||
|
||||
|
||||
|
||||
## 如何存储数据
|
||||
|
||||
**重要**:针对运行在Docker容器中的应用,有几种不同的数据存储方式。如:
|
||||
|
||||
- 让Docker本身管理存储的数据(在容器内)。这是一种简单,也是默认的存储方式。这种方式存在的问题是:在宿主机上很难使用工具对存储的数据定位及处理。
|
||||
- 在宿主机上创建数据存储目录(在容器外)。使用这种方式,可以比较容易的在宿主机上使用工具对数据文件进行分析及处理。这种方式存在的问题是:使用镜像的用户需要保证相关目录的存在和权限的正确性。
|
||||
|
||||
详细说明,可参考Docker的相关文档或讨论区。简单举例使用方式:
|
||||
|
||||
1. 在宿主机上合适位置创建数据存储目录,如:`/absolute/host/datadir`.
|
||||
|
||||
2. 启动容器:
|
||||
|
||||
```shell
|
||||
$ docker run --name <instance-name> -v /absolute/host/datadir:/container/volume/dir -d image-name:tag
|
||||
```
|
||||
|
||||
其中,`-v /absolute/host/datadir:/container/volume/dir`参数部分,会将宿主机的`/absolute/host/datadir`目录挂载为容器中的`/var/lib/postgresql/data`目录。
|
||||
|
||||
|
||||
|
||||
## 参考
|
||||
|
||||
- [官方Docker](https://hub.docker.com/_/postgres?tab=description)
|
||||
- [官方介绍](http://www.postgresql.org/docs/9.5/interactive/app-initdb.html)
|
||||
|
||||
----
|
||||
|
||||
本文原始来源 [Endial Fang](https://github.com/endial) @ [Github.com](https://github.com)
|
||||
|
||||
Reference in New Issue
Block a user