How to customize the configuration file of the official PostgreSQL Docker image?

时间:2015-06-15 15:08:31

标签: postgresql docker

I'm using the official Postgres Docker image trying to customize its configuration. For this purpose, I use the command sed to change max_connections for example:

sed -i -e"s/^max_connections = 100.*$/max_connections = 1000/" /var/lib/postgresql/data/postgresql.conf

I tried two methods to apply this configuration. The first is by adding the commands to a script and copying it within the init folder "/docker-entrypoint-initdb.d". The second method is by running them directly within my Dockerfile with "RUN" command (this method worked fine with a non-official Postgresql image with a different path to the configuration file "/etc/postgres/..."). In both cases the changes fail because the configuration file is missing (I think it's not created yet).

How should I change the configuration?

Edit 1:

Here is the Dockerfile used to create the image:

# Database (http://www.cs3c.ma/)

FROM postgres:9.4
MAINTAINER Sabbane <contact@cs3c.ma>

ENV TERM=xterm

RUN apt-get update
RUN apt-get install -y nano

ADD scripts /scripts
# ADD scripts/setup-my-schema.sh /docker-entrypoint-initdb.d/

# Allow connections from anywhere.
RUN sed -i -e"s/^#listen_addresses =.*$/listen_addresses = '*'/" /var/lib/postgresql/data/postgresql.conf
RUN echo "host    all    all    0.0.0.0/0    md5" >> /var/lib/postgresql/data/pg_hba.conf

# Configure logs
RUN sed -i -e"s/^#logging_collector = off.*$/logging_collector = on/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_directory = 'pg_log'.*$/log_directory = '\/var\/log\/postgresql'/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_filename = 'postgresql-\%Y-\%m-\%d_\%H\%M\%S.log'.*$/log_filename = 'postgresql_\%a.log'/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_file_mode = 0600.*$/log_file_mode = 0644/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_truncate_on_rotation = off.*$/log_truncate_on_rotation = on/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_rotation_age = 1d.*$/log_rotation_age = 1d/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_min_duration_statement = -1.*$/log_min_duration_statement = 0/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_checkpoints = off.*$/log_checkpoints = on/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_connections = off.*$/log_connections = on/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_disconnections = off.*$/log_disconnections = on/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^log_line_prefix = '\%t \[\%p-\%l\] \%q\%u@\%d '.*$/log_line_prefix = '\%t \[\%p\]: \[\%l-1\] user=\%u,db=\%d'/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_lock_waits = off.*$/log_lock_waits = on/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#log_temp_files = -1.*$/log_temp_files = 0/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#statement_timeout = 0.*$/statement_timeout = 1800000        # in milliseconds, 0 is disabled (current 30min)/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^lc_messages = 'en_US.UTF-8'.*$/lc_messages = 'C'/" /var/lib/postgresql/data/postgresql.conf

# Performance Tuning
RUN sed -i -e"s/^max_connections = 100.*$/max_connections = 1000/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^shared_buffers =.*$/shared_buffers = 16GB/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#effective_cache_size = 128MB.*$/effective_cache_size = 48GB/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#work_mem = 1MB.*$/work_mem = 16MB/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#maintenance_work_mem = 16MB.*$/maintenance_work_mem = 2GB/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#checkpoint_segments = .*$/checkpoint_segments = 32/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#checkpoint_completion_target = 0.5.*$/checkpoint_completion_target = 0.7/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#wal_buffers =.*$/wal_buffers = 16MB/" /var/lib/postgresql/data/postgresql.conf
RUN sed -i -e"s/^#default_statistics_target = 100.*$/default_statistics_target = 100/" /var/lib/postgresql/data/postgresql.conf


VOLUME ["/var/lib/postgresql/data", "/var/log/postgresql"]

CMD ["postgres"]

With this Dockerfile the build process shows the error: sed: can't read /var/lib/postgresql/data/postgresql.conf: No such file or directory

11 个答案:

答案 0 :(得分:59)

使用Docker Compose

使用Docker Compose时,您可以在command: postgres -c option=value中使用docker-compose.yml来配置Postgres。

例如,这会使Postgres记录到文件:

command: postgres -c logging_collector=on -c log_destination=stderr -c log_directory=/logs

调整Vojtech Vitek's answer,您可以使用

command: postgres -c config_file=/etc/postgresql.conf

更改Postgres将使用的配置文件。您将使用卷装载自定义配置文件:

volumes:
   - ./customPostgresql.conf:/etc/postgresql.conf

这是我的应用程序的docker-compose.yml,显示了如何配置Postgres:

# Start the app using docker-compose pull && docker-compose up to make sure you have the latest image
version: '2.1'
services:
  myApp:
    image: registry.gitlab.com/bullbytes/myApp:latest
    networks:
      - myApp-network
  db:
     image: postgres:9.6.1
     # Make Postgres log to a file.
     # More on logging with Postgres: https://www.postgresql.org/docs/current/static/runtime-config-logging.html
     command: postgres -c logging_collector=on -c log_destination=stderr -c log_directory=/logs
     environment:
       # Provide the password via an environment variable. If the variable is unset or empty, use a default password
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-4WXUms893U6j4GE&Hvk3S*hqcqebFgo!vZi}
     # If on a non-Linux OS, make sure you share the drive used here. Go to Docker's settings -> Shared Drives
     volumes:
       # Persist the data between container invocations
       - postgresVolume:/var/lib/postgresql/data
       - ./logs:/logs
     networks:
       myApp-network:
         # Our application can communicate with the database using this hostname
         aliases:
           - postgresForMyApp
networks:
  myApp-network:
    driver: bridge
# Creates a named volume to persist our data. When on a non-Linux OS, the volume's data will be in the Docker VM
# (e.g., MobyLinuxVM) in /var/lib/docker/volumes/
volumes:
  postgresVolume:

写入日志目录的权限

请注意,在Linux上,主机上的日志目录必须具有正确的权限。 否则你会得到一个误导性的错误

  

致命:无法打开日志文件   “/logs/postgresql-2017-02-04_115222.log”:权限被拒绝

我说是误导,因为错误消息表明容器中的目录具有错误的权限,而实际上主机上的目录 不允许写入

要解决此问题,我使用

在主机上设置了正确的权限
chgroup ./logs docker && chmod 770 ./logs

答案 1 :(得分:36)

将自定义postgresql.conf注入postgres Docker容器

默认postgresql.conf文件位于PGDATA目录(/var/lib/postgresql/data)内,这使得事情变得更加复杂,尤其是第一次运行postgres容器时,因为docker-entrypoint.sh包装器调用initdb dir初始化的PGDATA步骤。

要在Docker中一致地自定义PostgreSQL配置,我建议将config_file postgres选项与Docker卷一起使用,如下所示:

生产数据库(PGDATA dir as Persistent Volume)

docker run -d \
-v $CUSTOM_CONFIG:/etc/postgresql.conf \
-v $CUSTOM_DATADIR:/var/lib/postgresql/data \
-e POSTGRES_USER=postgres \
-p 5432:5432 \
--name postgres \
postgres:9.6 postgres -c config_file=/etc/postgresql.conf

测试数据库(PGDATA dir将在docker rm之后丢弃)

docker run -d \
-v $CUSTOM_CONFIG:/etc/postgresql.conf \
-e POSTGRES_USER=postgres \
--name postgres \
postgres:9.6 postgres -c config_file=/etc/postgresql.conf

调试

  1. -d命令中删除docker run(分离选项)以直接查看服务器日志。
  2. 使用psql客户端连接到postgres服务器并查询配置:

    docker run -it --rm --link postgres:postgres postgres:9.6 sh -c 'exec psql -h $POSTGRES_PORT_5432_TCP_ADDR -p $POSTGRES_PORT_5432_TCP_PORT -U postgres'
    
    psql (9.6.0)
    Type "help" for help.
    
    postgres=# SHOW all;
    

答案 2 :(得分:28)

您继承的postgres:9.4图片在/var/lib/postgresql/data处声明了一个卷。这实际上意味着您无法将任何文件复制到图像中的该路径;更改将被丢弃。

您有几个选择:

  • 您可以在运行时使用docker run -v postgresql.conf:/var/lib/postgresql/data/postgresql.conf ...将自己的配置文件添加为卷。但是,我不确定它将如何与现有卷进行交互。

  • 您可以在启动容器时复制文件。为此,请将文件复制到不在卷下面的位置,然后从入口点或cmd调用脚本,将脚本复制到正确的位置并启动postgres。

  • 克隆Postgres官方图像后面的项目并编辑Dockerfile,在声明VOLUME之前添加您自己的配置文件(在运行时自动复制VOLUME指令之前添加的任何内容)。

  • 在docker-compose文件中的命令选项中传递所有配置更改

像:

services:
  postgres:
    ...  
    command:
      - "postgres"
      - "-c"
      - "max_connections=1000"
      - "-c"
      - "shared_buffers=3GB"
      - "-c"
      ...

答案 3 :(得分:23)

当您运行官方入口点(启动容器时为AKA)时,它会在initdb(默认为$PGDATA)中运行/var/lib/postgresql/data,然后它会在该目录中存储这些2文件:

  • postgresql.conf,默认手动设置。
  • postgresql.auto.conf设置会自动覆盖ALTER SYSTEM个命令。

入口点还执行任何/docker-entrypoint-initdb.d/*.{sh,sql}个文件。

所有这些意味着你可以在该文件夹中提供一个shell / SQL脚本,用于配置服务器以进行下一次启动(在数据库初始化之后,或者下次启动容器时)。

示例:

conf.sql档案:

ALTER SYSTEM SET max_connections = 6;
ALTER SYSTEM RESET shared_buffers;

Dockerfile档案:

FROM posgres:9.6-alpine
COPY *.sql /docker-entrypoint-initdb.d/
RUN chmod a+r /docker-entrypoint-initdb.d/*

然后您必须在现有数据库中手动执行conf.sql。由于配置存储在卷中,因此它将在重建后继续存在。

另一种方法是根据需要多次传递-c标志:

docker container run -d postgres -c max_connections=6 -c log_lock_waits=on

这样您就不需要构建新映像了,也不需要关心已经存在或不存在的数据库;一切都会受到影响。

答案 4 :(得分:7)

您可以将自定义postgresql.conf放在容器内的临时文件中,并在运行时覆盖默认配置。

要做到这一点:

  • 将自定义postgresql.conf复制到容器中
  • 复制updateConfig.sh
  • 中的/docker-entrypoint-initdb.d/文件

Dockerfile

FROM postgres:9.6

COPY postgresql.conf      /tmp/postgresql.conf
COPY updateConfig.sh      /docker-entrypoint-initdb.d/_updateConfig.sh

updateConfig.sh

#!/usr/bin/env bash

cat /tmp/postgresql.conf > /var/lib/postgresql/data/postgresql.conf

在运行时,容器将执行/docker-entrypoint-initdb.d/内的脚本,并使用自定义配置覆盖默认配置。

答案 5 :(得分:5)

我查看了所有答案,还剩下另一个选项。您可以在docker文件中更改您的CMD值(这不是最好的,但仍然可以实现您的目标)。

基本上我们需要

  • 在docker容器中复制配置文件
  • 覆盖postgres启动选项

Docker文件示例:

FROM postgres:9.6
USER postgres

# Copy postgres config file into container
COPY postgresql.conf /etc/postgresql

# Override default postgres config file
CMD ["postgres", "-c", "config_file=/etc/postgresql/postgresql.conf"]

虽然我认为在Matthias Braun提议的command: postgres -c config_file=/etc/postgresql/postgresql.conf文件中使用docker-compose.yml是最佳选择。

答案 6 :(得分:2)

这个问题的一个相当低技术的解决方案似乎是声明服务(我在AWS和yaml文件上使用swarm),并将数据库文件挂载到持久卷(此处为AWS EFS,如cloudstor所示) :aws驱动程序规范)。

  version: '3.3'
  services:
    database:
      image: postgres:latest
      volumes:
        - postgresql:/var/lib/postgresql
        - postgresql_data:/var/lib/postgresql/data
    volumes:
       postgresql:
         driver: "cloudstor:aws" 
       postgresql_data:
         driver: "cloudstor:aws"
  1. 使用图像默认设置初始化数据库。
  2. 您可以编辑容器内的conf设置,例如,如果要增加需要重新启动的最大并发连接数
  3. 停止正在运行的容器(或将服务缩减为零,然后再缩减为一个)
  4. swarm会生成一个新容器,这次会收集你的持久化配置设置并快速应用它们。
  5. 持久化您的配置的一个令人愉快的副作用是它也会持久存储您的数据库(或者反之亦然);-)

答案 7 :(得分:2)

这对我有用:

FROM postgres:9.6
USER postgres

# Copy postgres config file into container
COPY postgresql.conf /etc/postgresql

# Override default postgres config file
CMD ["postgres", "-c", "config_file=/etc/postgresql/postgresql.conf"]

答案 8 :(得分:0)

我的解决方案适用于需要在启动docker-entrypoint-initdb.d之前更改配置的同事

我需要更改'shared_preload_libraries'设置,因此在工作期间postgres已经预先加载了新库,并且docker-entrypoint-initdb.d中的代码可以使用它。

所以我只是在Dockerfile中修补了postgresql.conf.sample文件:

RUN echo "shared_preload_libraries='citus,pg_cron'" >> /usr/share/postgresql/postgresql.conf.sample
RUN echo "cron.database_name='newbie'" >> /usr/share/postgresql/postgresql.conf.sample

通过此补丁,可以在docker-entrypoint-initdb.d /中的.sql文件中添加扩展名:

CREATE EXTENSION pg_cron;

答案 9 :(得分:0)

使用docker compose,您可以使用filemove()挂载卷。 示例:

postgresql.auto.conf

答案 10 :(得分:0)

我也在使用官方图片(FROM postgres) 我可以通过执行以下命令来更改配置。

第一件事是找到PostgreSQL配置文件。 这可以通过在正在运行的数据库中执行此命令来完成。

SHOW config_file;

我的情况是它返回/data/postgres/postgresql.conf

下一步是找出正在运行的PostgreSQL Docker容器的哈希值。

docker ps -a

这应该返回所有正在运行的容器的列表。就我而言,看起来像这样。

...
0ba35e5427d9    postgres    "docker-entrypoint.s…" ....
...

现在,您必须通过执行以下操作切换到容器内的bash:

docker exec -it 0ba35e5427d9 /bin/bash

在容器内部检查配置是否位于正确的路径并显示它。

cat /data/postgres/postgresql.conf

我想将最大连接数从100更改为1000,并将共享缓冲区从128MB更改为3GB。 使用sed命令,我可以搜索并用config中的相应变量替换。

sed -i -e"s/^max_connections = 100.*$/max_connections = 1000/" /data/postgres/postgresql.conf
sed -i -e"s/^shared_buffers = 128MB.*$/shared_buffers = 3GB/" /data/postgres/postgresql.conf

我们要做的最后一件事是在容器中重新启动数据库。 找出您使用的PostGres版本。

cd /usr/lib/postgresql/
ls 

就我而言,其12 因此,您现在可以通过在适当位置执行以下命令来重新启动数据库。

su - postgres -c "PGDATA=$PGDATA /usr/lib/postgresql/12/bin/pg_ctl -w restart"