docs: 更新说明文档错误
This commit is contained in:
@@ -14,11 +14,10 @@
|
||||
|
||||
* 镜像地址:
|
||||
- 阿里云: registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest
|
||||
- DockerHub:colovu/postgresql:latest
|
||||
- Colovu Registry: docker.colovu.com/colovu/postgresql:latest
|
||||
- 依赖镜像:colovu/debian:12
|
||||
|
||||
> 后续相关命令行默认使用`[Colovu Registry](https://docker.colovu.com)`镜像服务器做说明
|
||||
> 后续相关命令行默认使用 Aliyun ACR 镜像服务器做说明
|
||||
|
||||
## TL;DR
|
||||
|
||||
@@ -26,10 +25,10 @@ Docker 快速启动命令:
|
||||
|
||||
```shell
|
||||
# 从 Registry 服务器下载镜像并启动
|
||||
$ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes --name imgname docker.colovu.com/colovu/postgresql:latest
|
||||
$ docker run -d -e ALLOW_ANONYMOUS=yes --name postgres docker.colovu.com/colovu/postgresql:latest
|
||||
```
|
||||
|
||||
- `docker.colovu.com/colovu/postgresql:<TAG>`:镜像名称及版本标签 TAG;标签不指定时默认使用`latest`
|
||||
- `registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:<TAG>`:镜像名称及版本标签 TAG;标签不指定时默认使用最新版本
|
||||
|
||||
|
||||
Docker-Compose 快速启动命令:
|
||||
@@ -39,7 +38,7 @@ Docker-Compose 快速启动命令:
|
||||
$ curl -sSL -o https://gitee.com/colovu/docker-postgres/raw/master/docker-compose.yml
|
||||
|
||||
# 从 Github 下载 Compose 文件
|
||||
$ curl -sSL https://raw.githubusercontent.com/colovu/docker-postgres/master/docker-compose.yml
|
||||
$ curl -sSL -o https://raw.githubusercontent.com/colovu/docker-postgres/master/docker-compose.yml
|
||||
|
||||
# 创建并启动容器
|
||||
$ docker-compose up -d
|
||||
@@ -55,16 +54,18 @@ $ docker-compose up -d
|
||||
|
||||
### 数据卷
|
||||
|
||||
镜像默认提供以下数据卷定义,默认数据分别存储在自动生成的应用名对应`postgres`子目录中:
|
||||
镜像默认提供以下数据卷定义:
|
||||
|
||||
```shell
|
||||
/var/log # 日志输出,应用日志输出,非数据日志输出
|
||||
/srv/conf # 配置文件
|
||||
/srv/data # 数据文件
|
||||
/srv/datalog # 数据操作日志文件
|
||||
/srv/postgresql/conf # 配置文件
|
||||
/srv/postgresql/data # 数据文件,主要存放应用数据
|
||||
/srv/postgresql/cert # 证书文件存放目录
|
||||
/srv/postgresql/log # 日志输出
|
||||
|
||||
/var/run/postgresql # 系统运行时文件,如 PID 文件
|
||||
```
|
||||
|
||||
如果需要持久化存储相应数据,需要在宿主机建立本地目录,并在使用镜像初始化容器时进行数据卷映射。
|
||||
如果需要持久化存储相应数据,需要**在宿主机建立本地目录**,并在使用镜像初始化容器时进行映射。宿主机相关的目录中如果不存在对应应用`postgresql`的子目录或相应数据文件,则容器会在初始化时创建相应目录及文件。
|
||||
|
||||
举例:
|
||||
|
||||
@@ -75,7 +76,7 @@ $ docker-compose up -d
|
||||
创建以上相应的宿主机目录后,容器启动命令中对应的数据卷映射参数类似如下:
|
||||
|
||||
```shell
|
||||
-v /host/dir/to/conf:/srv/conf -v /host/dir/to/data:/srv/data -v /host/dir/to/log:/var/log
|
||||
-v /host/dir/to/conf:/srv/postgresql/conf -v /host/dir/to/data:/srv/postgresql/data -v /host/dir/to/log:/srv/postgresql/log
|
||||
```
|
||||
|
||||
使用 Docker Compose 时配置文件类似如下:
|
||||
@@ -85,9 +86,9 @@ services:
|
||||
postgresql:
|
||||
...
|
||||
volumes:
|
||||
- /host/dir/to/conf:/srv/conf
|
||||
- /host/dir/to/data:/srv/data
|
||||
- /host/dir/to/log:/var/log
|
||||
- /host/dir/to/conf:/srv/postgresql/conf
|
||||
- /host/dir/to/data:/srv/postgresql/data
|
||||
- /host/dir/to/log:/srv/postgresql/log
|
||||
...
|
||||
```
|
||||
|
||||
@@ -100,27 +101,13 @@ services:
|
||||
#### 通过默认方式启动
|
||||
|
||||
```shell
|
||||
$ docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d docker.colovu.com/colovu/postgresql:latest
|
||||
$ docker run --name some-postgres -e PG_PASSWORD=mysecretpassword -d -p 5432:5432 registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest
|
||||
```
|
||||
|
||||
- 由容器执行默认的`entry.sh`脚本,并生成默认的用户及数据文件
|
||||
- `some-postgres`:容器名;命名后,可以直接使用该名字进行操作
|
||||
- `mysecretpassword`:数据库密码
|
||||
|
||||
#### 通过`psql`命令方式启动
|
||||
|
||||
```shell
|
||||
$ docker run -it --rm --network some-network docker.colovu.com/colovu/postgresql:latest 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 参考:
|
||||
@@ -128,21 +115,17 @@ docker-cpmpose.yml 参考:
|
||||
```yaml
|
||||
# 使用 postgres/example 作为用户名/密码
|
||||
|
||||
version: '3.1'
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
|
||||
db:
|
||||
image: docker.colovu.com/colovu/postgresql:latest
|
||||
image: registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest
|
||||
restart: always
|
||||
ports:
|
||||
- 5432:5432
|
||||
environment:
|
||||
POSTGRES_PASSWORD: example
|
||||
|
||||
adminer:
|
||||
image: adminer
|
||||
restart: always
|
||||
ports:
|
||||
- 8080:8080
|
||||
PG_PASSWORD: example
|
||||
```
|
||||
|
||||
## 镜像扩展使用
|
||||
@@ -155,86 +138,121 @@ PostgreSQL镜像定义了许多环境变量,但并不是所有都必须使用
|
||||
|
||||
> 注意:部分环境变量仅在初始化时起作用。针对已经存在数据目录的情况,环境变量会被跳过。
|
||||
|
||||
#### POSTGRES_PASSWORD
|
||||
### 自动变量替换
|
||||
|
||||
该环境变量需要在启动镜像时使用。该环境变量定义了使用PostgreSQL时,超级用户对应的密码,不应当为空。默认的超级用户由环境变量`POSTGRES_USER`定义.
|
||||
针对应用配置文件中的配置项,支持由环境变量名自动替换生成,该类环境变量需要使用统一前缀,定义规则为:`PG_CFG_*=<val>`
|
||||
|
||||
> 注意:
|
||||
>
|
||||
> - PostgreSQL镜像配置`localhost`为默认的`trust`认证方式,在同一容器内链接数据库时,可以不使用密码。但通过不同的`主机/容器`链接时,需要密码。
|
||||
> - 在使用PostgreSQL镜像创建容器时,通过`initdb脚本`在启动时定义该变量对应的值。但该值不影响尽在`psql`方式启动时设置的`PGPASSWORD`环境变量。`PGPASSWORD`环境变量在设置时仅作为一个独立的环境变量设置。
|
||||
- `PG_CFG_`:环境变量自动替换标识,具备该前缀的环境变量会被自动处理并更新至配置文件
|
||||
- `*`:配置文件中对应的配置项名,大小写需要符合实际参数名要求;特殊字符需要符合`特殊字符替换规则`
|
||||
- `<val>`:配置项对应值
|
||||
|
||||
#### POSTGRES_USER
|
||||
**特殊字符替换规则**:
|
||||
|
||||
该可选环境环境变量与`POSTGRES_PASSWORD`环境变量一起使用,以在使用镜像创建容器时设置用户名和密码。使用该变量时,会创建用户对应的超级权限及同名数据库。如果该变量没有设置,默认使用用户`postgres`。
|
||||
因为 Shell 变量只能以字母、数字和下划线组成,针对'xml'、'ini'等配置文件中使用的'.'、'-'等特殊字符,需要进行重定义及转换。预定义如下:
|
||||
|
||||
> 注意:即使使用了该变量,在初始化时,系统信息仍然会提示`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
|
||||
# 容器启动时的环境变量(大小写无关)
|
||||
PG_CFG_MIN_WAL_SIZE=100MB
|
||||
PG_CFG_max_wal_size="400MB"
|
||||
|
||||
# 容器启动后,应用配置文件中对应配置项生效,且设置为相应值:
|
||||
min_wal_size = '100MB'
|
||||
max_wal_size = '400MB'
|
||||
```
|
||||
|
||||
或:
|
||||
### 常规配置参数
|
||||
|
||||
```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)文档的介绍。
|
||||
- `PG_USERNAME`:默认值:**postgres**。设置用户名,可针对不同应用设置不同用户名
|
||||
- `PG_PASSWORD`:默认值:**无**。设置用户密码,生产环境中不应当为空
|
||||
- `PG_DATABASE`:默认值:**postgres**。设置用户默认使用的数据库
|
||||
- `PG_POSTGRES_PASSWORD`:默认值:**无**。设置超级用户密码,未设置时,默认密码同`PG_PASSWORD`
|
||||
|
||||
> 注意:
|
||||
>
|
||||
> - 不建议使用[`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`目录。
|
||||
- `ENV_DEBUG`:默认值:**false**。设置是否输出容器调试信息。可选值:false、no、true、yes
|
||||
- `ALLOW_ANONYMOUS`:默认值:**no**。设置是否允许匿名链接。可选值:false、no、true、yes
|
||||
- `TZ`:默认值:**Asia/Shanghai**。设置默认时区
|
||||
- `PG_USER_IP4_RANGE`:默认值:**0.0.0.0/0**。设置允许访问的 IPv4 地址范围
|
||||
- `PG_USER_IP6_RANGE`:默认值:**::0/0**。设置允许访问的 IPv6 地址范围
|
||||
- `PG_INITSCRIPTS_USERNAME`:默认值:**`PG_USERNAME`**。设置数据库SQL初始化使用的用户名
|
||||
- `PG_INITSCRIPTS_PASSWORD`:默认值:**`PG_PASSWORD`**。设置数据库SQL初始化时的用户密码
|
||||
|
||||
如果使用的数据卷为文件系统挂载点(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 \
|
||||
docker.colovu.com/colovu/postgresql:latest
|
||||
```
|
||||
配置服务为集群工作模式时,通过以下参数进行配置:
|
||||
|
||||
该变量并不是为Docker定义的数据卷,而是由`postgres`服务本身使用(参考 [PostgreSQL docs](https://www.postgresql.org/docs/11/app-postgres.html#id-1.9.5.14.7)),entrypoing.sh脚本只是传输该值。
|
||||
- `PG_REPLICATION_MODE`:默认值:**primary**。设置当前容器中服务的工作模式。可选值:primary、standby
|
||||
|
||||
### 容器安全
|
||||
**Primary(Master)配置:**
|
||||
|
||||
作为敏感信息通过环境变量传输的可选替代方案,可以增加`_FILE`在部分环境变量末尾,以使容器的初始化脚本通过加载文件的方式,获取相关变量。例如,可以通过加载文件的方式加载密码:
|
||||
- `PG_SYNCHRONOUS_REPLICAS_NUM`:默认值:**0**。设置备机的数量,从备机列表中选取
|
||||
- `PG_SYNCHRONOUS_REPLICAS_METHOD`:默认值:**无**。设置备机选择模式。可选值:无、FIRST、ANY
|
||||
- `PG_SYNCHRONOUS_REPLICAS_NAMES`:默认值:**无**。设置备机列表
|
||||
|
||||
```shell
|
||||
$ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgres-passwd -d docker.colovu.com/colovu/postgresql:latest
|
||||
```
|
||||
- `PG_CFG_MAX_WAL_SENDERS`:默认值:**10**。
|
||||
- `PG_CFG_WAL_LEVEL`:默认值:**logical**。
|
||||
- `PG_CFG_WAL_LOG_HINTS`:默认值:**on**。
|
||||
|
||||
支持该方式的变量为: `POSTGRES_INITDB_ARGS`, `POSTGRES_PASSWORD`, `POSTGRES_USER`, `POSTGRES_DB`。
|
||||
**Standby(Slave)配置:**
|
||||
|
||||
- `PG_REPLICATION_APP_NAME`:默认值:**cvcluster**。设置本机应用默认名称
|
||||
- `PG_REPLICATION_HOST`:默认值:**无**。设置 Master 服务地址
|
||||
- `PG_REPLICATION_PORT`:默认值:**5432**。设置 Master 服务端口
|
||||
- `PG_REPLICATION_USER`:默认值:**无**。设置访问 Master 的用户名
|
||||
- `PG_REPLICATION_PASSWORD`:默认值:**无**。设置访问 Master 用户的密码
|
||||
- `PG_REPLICATION_CONNECT_TIMEOUT`:默认值:**10**。设置连接超时时间
|
||||
|
||||
默认,配置允许从备机备份,参考[官方说明](http://www.postgres.cn/docs/9.4/app-pgbasebackup.html):
|
||||
|
||||
- `PG_CFG_FULL_PAGE_WRITES`:默认值:**on**。
|
||||
- `PG_CFG_HOT_STANDBY`:默认值:**on**。
|
||||
- `PG_CFG_MAX_WAL_SENDERS`:默认值:**16**。
|
||||
|
||||
### TLS配置参数
|
||||
|
||||
配置服务使用 TLS 加密时,可通过`PG_CFG_SSL_*`相关参数进行配置,容器启动时会自动替换`postgresql.conf`中对应配置项。
|
||||
|
||||
TLS 加密使用的相关秘钥文件,默认存放在容器的`/srv/postgresql/cert`目录中,需提前进行映射。
|
||||
|
||||
- `PG_CFG_SSL`:默认值:**off**。设置是否使用 SSL 加密。可选值:off / on
|
||||
|
||||
### LDAP认证配置参数
|
||||
|
||||
配置服务使用 LDAP 进行用户认证时,通过以下参数进行配置:
|
||||
|
||||
- `PG_ENABLE_LDAP`:默认值:**no**。设置是否使用 LDAP 认证。可选值:yes / no
|
||||
|
||||
以 URL 方式配置认证地址:
|
||||
|
||||
- `PG_LDAP_URL`:默认值:**无**。设置 LDAP 连接地址,如果配置该参数,则后续单独的配置信息不用配置
|
||||
|
||||
或,以单独参数方式配置认证地址:
|
||||
|
||||
- `PG_LDAP_PREFIX`:默认值:**无**。设置前缀
|
||||
- `PG_LDAP_SUFFIX`:默认值:**无**。设置后缀
|
||||
- `PG_LDAP_SERVER`:默认值:**无**。设置 LDAP 服务器访问 IP
|
||||
- `PG_LDAP_PORT`:默认值:**无**。设置 LDAP 服务器访问端口
|
||||
- `PG_LDAP_SCHEME`:默认值:**无**。
|
||||
- `PG_LDAP_TLS`:默认值:**无**。设置 LDAP 服务器使用启用 TLS
|
||||
- `PG_LDAP_BASE_DN`:默认值:**无**。设置搜索的基 DN
|
||||
- `PG_LDAP_BIND_DN`:默认值:**无**。设置绑定用户的 DN
|
||||
- `PG_LDAP_BIND_PASSWORD`:默认值:**无**。设置绑定用户的密码
|
||||
- `PG_LDAP_SEARCH_ATTR`:默认值:**无**。设置搜索参数
|
||||
- `PG_LDAP_SEARCH_FILTER`:默认值:**无**。设置搜索过滤器
|
||||
|
||||
### 初始化脚本
|
||||
|
||||
如果需要在使用当前镜像时,增加一些附加的初始化操作,可以将相应的`*.sql`、 `*.sql.gz` 或 `*.sh`脚本文件放置在`initdb.d`目录中(使用数据卷映射方式时,可先创建相应的目录)。在`entrypoint.sh`调用`initdb`创建默认的`postgres`用户及数据库时,会执行所有在`initdb.d`目录下的`*.sql`及可执行`*.sh`脚本,并source所有不可执行的`*.sh`脚本,执行完成后,启动postgres服务。
|
||||
如果需要在使用当前镜像时,增加一些附加的初始化操作,可以将相应的`*.sql`、 `*.sql.gz` 或 `*.sh`脚本文件放置在配置文件目录的`initdb.d`子目录中(使用数据卷映射方式时,可先创建相应的目录)。容器在初始化时,会执行所有在`initdb.d`目录下的`*.sql`及可执行`*.sh`脚本,并`source`所有不可执行的`*.sh`脚本,执行完成后,启动`postgres`服务。
|
||||
|
||||
> 注意:
|
||||
>
|
||||
@@ -242,104 +260,35 @@ $ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgre
|
||||
|
||||
### 数据库配置
|
||||
|
||||
有多种方式可以配置PostgreSQL服务器。详细信息可参考相关[docs](https://www.postgresql.org/docs/current/static/runtime-config.html)文档。部分常用配置项如下:
|
||||
有多种方式可以配置 PostgreSQL 服务器。详细信息可参考相关[docs](https://www.postgresql.org/docs/current/static/runtime-config.html)文档。部分常用配置项如下:
|
||||
|
||||
- 使用自定义的配置文件。可将容器内的模板配置文件 `/usr/share/postgresql/postgresql.conf.sample`导出后修改,并重新映射以启动容器。
|
||||
- 使用自定义的配置文件。可将容器内的模板配置文件 `/usr/local/postgresql/share/postgresql.conf.sample`导出后修改,并重新映射以启动容器。
|
||||
|
||||
```shell
|
||||
$ # 获取配置文件模板,存储为当前目录的my-postgres.conf
|
||||
$ docker run -i --rm docker.colovu.com/colovu/postgresql:latest cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf
|
||||
$ docker run -i --rm registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest cat /usr/local/postgresql/share/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 docker.colovu.com/colovu/postgresql:latest -c 'config_file=/etc/postgresql/postgresql.conf'
|
||||
$ docker run -d --name some-postgres -v "$PWD/my-postgres.conf":/etc/postgresql/postgresql.conf -e POSTGRES_PASSWORD=mysecretpassword registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest -c 'config_file=/etc/postgresql/postgresql.conf'
|
||||
```
|
||||
|
||||
- 在命令行中设置相应参数。entrypoint.sh基本会将所有的启动时传递给Docker的配置参数传递给postgres服务进程。从官方 [docs](https://www.postgresql.org/docs/current/static/app-postgres.html)文档可以看出,所有在 `.conf`文件中的配置项都可以使用`-c`进行设置。
|
||||
- 在命令行中设置相应参数。`entry.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 docker.colovu.com/colovu/postgresql:latest -c 'shared_buffers=256MB' -c 'max_connections=200'
|
||||
$ docker run -d --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest -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 docker.colovu.com/colovu/postgresql:latest cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf
|
||||
```
|
||||
|
||||
- 使用的镜像:colovu/postgres:12.4
|
||||
- 原始文件:/usr/share/postgresql/postgresql.conf.sample
|
||||
- 导出后文件:my-postgres.conf
|
||||
|
||||
### 个性化配置Locale
|
||||
|
||||
PostgreSQL镜像使用的Ubuntu基础镜像默认的Locale配置为`en_US.UTF-8`,可以使用一个简单的 Dockerfile来设置为不同的Locale。比如设置为 `de_DE.utf8`:
|
||||
|
||||
```dockerfile
|
||||
FROM docker.colovu.com/colovu/postgresql:latest
|
||||
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 docker.colovu.com/colovu/postgresql:latest
|
||||
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 docker.colovu.com/colovu/postgresql:latest
|
||||
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 docker.colovu.com/colovu/postgresql:latest
|
||||
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 docker.colovu.com/colovu/postgresql:latest
|
||||
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 colovu/postgres:latest bash chown -R 1000:1000 /var/lib/postgresql/data
|
||||
|
||||
$ docker run -it --rm --user 1000:1000 -v pgdata:/var/lib/postgresql/data docker.colovu.com/colovu/postgresql:latest
|
||||
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
|
||||
```
|
||||
|
||||
## 使用预警
|
||||
|
||||
@@ -347,16 +296,16 @@ initdb: could not look up effective user ID 1000: user does not exist
|
||||
|
||||
容器默认的`/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) 。
|
||||
在 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本身管理存储的数据(在容器内)。这是一种简单,也是默认的存储方式。这种方式存在的问题是:在宿主机上很难使用工具对存储的数据定位及处理。
|
||||
- 让 Docker 本身管理存储的数据(在容器内)。这是一种简单,也是默认的存储方式。这种方式存在的问题是:在宿主机上很难使用工具对存储的数据定位及处理。
|
||||
- 在宿主机上创建数据存储目录(在容器外)。使用这种方式,可以比较容易的在宿主机上使用工具对数据文件进行分析及处理。这种方式存在的问题是:使用镜像的用户需要保证相关目录的存在和权限的正确性。
|
||||
|
||||
详细说明,可参考Docker的相关文档或讨论区。简单举例使用方式:
|
||||
详细说明,可参考 Docker 的相关文档或讨论区。简单举例使用方式:
|
||||
|
||||
1. 在宿主机上合适位置创建数据存储目录,如:`/absolute/host/datadir`.
|
||||
|
||||
@@ -375,13 +324,13 @@ initdb: could not look up effective user ID 1000: user does not exist
|
||||
PostgreSQL 镜像默认禁用了无密码访问功能,在实际生产环境中建议使用用户名及密码控制访问;如果为了测试需要,可以使用以下环境变量启用无密码访问功能:
|
||||
|
||||
```shell
|
||||
ALLOW_EMPTY_PASSWORD=yes
|
||||
ALLOW_ANONYMOUS=yes
|
||||
```
|
||||
|
||||
通过配置环境变量`PG_PASSWORD`,可以启用基于密码的用户认证功能。命令行使用参考:
|
||||
|
||||
```shell
|
||||
$ docker run -d -e PG_USERNAME=postgres -e PG_PASSWORD=colovu colovu/postgres:12.4
|
||||
$ docker run -d -e PG_USERNAME=postgres -e PG_PASSWORD=colovu registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest
|
||||
```
|
||||
|
||||
使用 Docker-Compose 时,`docker-compose.yml`应包含类似如下配置:
|
||||
@@ -400,7 +349,10 @@ services:
|
||||
|
||||
本容器默认使用`non-root`运行应用,以加强容器的安全性。在使用`non-root`用户运行容器时,相关的资源访问会受限;应用仅能操作镜像创建时指定的路径及数据。使用`non-root`方式的容器,更适合在生产环境中使用。
|
||||
|
||||
如果需要赋予容器内应用访问外部设备的权限,可以使用以下两种方式:
|
||||
|
||||
- 启动参数增加`--privileged=true`选项
|
||||
- 针对特定权限需要使用`--cap-add`单独增加特定赋权,如:ALL、NET_ADMIN、NET_RAW
|
||||
|
||||
如果需要切换为`root`方式运行应用,可以在启动命令中增加`-u root`以指定运行的用户。
|
||||
|
||||
@@ -414,7 +366,6 @@ services:
|
||||
|
||||
## 参考
|
||||
|
||||
- [官方Docker](https://hub.docker.com/_/postgres?tab=description)
|
||||
- [官方介绍](http://www.postgresql.org/docs/9.5/interactive/app-initdb.html)
|
||||
- [官方中文手册](http://www.postgres.cn/v2/document)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user