postgresql_set – Изменение параметра конфигурации сервера PostgreSQL

Новое в версии 2.8.

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

Позволяет изменить параметр конфигурации сервера PostgreSQL.
Модуль использует команду ALTER SYSTEM и применяет изменения путем перезагрузки конфигурации сервера.
ALTER SYSTEM используется для изменения параметров конфигурации сервера по всему кластеру баз данных.
Это может быть более удобным и безопасным, чем традиционный метод ручной правки файла postgresql.conf.
ALTER SYSTEM записывает заданное значение параметра в файл $PGDATA/postgresql.auto.conf, который читается дополнительно к postgresql.conf.
Модуль позволяет сбросить параметр до значения boot_val (начальное значение кластера) с помощью reset=yes или удалить строку параметра из postgresql.auto.conf и перезагрузить сервер с value=default (для настроек с контекстом postmaster требуется перезапуск).
После изменения вы можете увидеть в выводе Ansible предыдущее и новое значение параметра, а также другую информацию, используя возвращаемые значения и модуль debug.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

psycopg2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca_cert строка		Указывает имя файла, содержащего сертификат(ы) SSL-центра сертификации (CA). Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров. псевдонимы: ssl_rootcert
db строка		Имя базы данных для подключения. псевдонимы: login_db
login_host строка		Хост, на котором работает база данных.
login_password строка		Пароль, используемый для аутентификации.
login_unix_socket строка		Путь к сокету Unix-домена для локальных подключений.
login_user строка	По умолчанию: "postgres"	Имя пользователя, используемое для аутентификации.
name строка / обязательно		Имя параметра сервера PostgreSQL.
port целое число	По умолчанию: 5432	Порт базы данных для подключения. псевдонимы: login_port
reset логическое значение	Варианты: нет ← да	Восстановить параметр до начального состояния (boot_val). Нельзя использовать совместно с value.
session_role строка		Переключиться на роль session_role после подключения. Указанная роль session_role должна быть ролью, членом которой является текущий login_user. Проверка разрешений для SQL-команд выполняется так, как будто роль session_role была той, которая первоначально вошла в систему.
ssl_mode строка	Варианты: разрешить отключить предпочитать ← требовать проверить-ca проверить-полностью	Определяет, будет ли и с каким приоритетом устанавливаться безопасное SSL-TCP/IP-соединение с сервером. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию `prefer` соответствует значению по умолчанию libpq.
value строка / обязательно		Значение параметра для установки. Чтобы удалить строку параметра из postgresql.auto.conf и перезагрузить конфигурацию сервера, необходимо передать value=default. С value=default в playбуке всегда возвращается changed=true.

Примечания

Примечание

Поддерживаемая версия PostgreSQL — 9.4 и более поздние.
Обратите внимание, что при изменении настроек с контекстом «postmaster» можно получить changed is true, когда фактически ничего не меняется, поскольку одно и то же значение может быть представлено в различных форматах, например, 1024MB, 1GB и т. д. Однако в системе pg_settings это значение может быть определено как число 131072 страниц по 8 КБ. Окончательная проверка значения параметра не может быть выполнена, так как сервер не был перезапущен, а значение в pg_settings еще не обновлено.
Для некоторых параметров требуется перезапуск сервера PostgreSQL. См. официальную документацию https://www.postgresql.org/docs/current/view-pg-settings.html.
По умолчанию аутентификация предполагает, что вы вошли в систему или используете sudo как учетная запись postgres на хосте.
Чтобы избежать ошибки «Ошибка проверки подлинности клиента для пользователя postgres», используйте пользователя postgres в качестве become_user.
Этот модуль использует psycopg2, адаптер базы данных Python для PostgreSQL. Вы должны убедиться, что psycopg2 установлен на хосте перед использованием этого модуля.
Если удалённый хост является сервером PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удалённом хосте.
Для систем на основе Ubuntu установите пакеты postgresql, libpq-dev и python-psycopg2 на удалённом хосте перед использованием этого модуля.
Для параметра ca_cert требуется как минимум версия Postgres 8.4 и версия psycopg2 2.4.3.

См. также

postgresql_info – Сбор информации о серверах PostgreSQL: Официальная документация по модулю postgresql_info.
Конфигурация сервера PostgreSQL: Общая информация о конфигурации сервера PostgreSQL.
Ссылка на документацию PostgreSQL для просмотра pg_settings: Полное описание документации по представлению pg_settings.
Ссылка на документацию PostgreSQL для команды ALTER SYSTEM: Полное описание документации команды ALTER SYSTEM.

Примеры

- name: Restore wal_keep_segments parameter to initial state
  postgresql_set:
    name: wal_keep_segments
    reset: yes

# Set work_mem parameter to 32MB and show what's been changed and restart is required or not
# (output example: "msg": "work_mem 4MB >> 64MB restart_req: False")
- name: Set work mem parameter
  postgresql_set:
    name: work_mem
    value: 32mb
  register: set

- debug:
    msg: "{{ set.name }} {{ set.prev_val_pretty }} >> {{ set.value_pretty }} restart_req: {{ set.restart_required }}"
  when: set.changed
# Ensure that the restart of PostgreSQL server must be required for some parameters.
# In this situation you see the same parameter in prev_val and value_prettyue, but 'changed=True'
# (If you passed the value that was different from the current server setting).

- name: Set log_min_duration_statement parameter to 1 second
  postgresql_set:
    name: log_min_duration_statement
    value: 1s

- name: Set wal_log_hints parameter to default value (remove parameter from postgresql.auto.conf)
  postgresql_set:
    name: wal_log_hints
    value: default

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
context строка	всегда	Контекст настройки PostgreSQL. Пример: user
name строка	всегда	Имя параметра сервера PostgreSQL. Пример: shared_buffers
prev_val_pretty строка	всегда	Информация о предыдущем состоянии параметра. Пример: 4МБ
restart_required булево	всегда	Информация о текущем состоянии параметра. Пример: True
value словарь	всегда	Словарь, содержащий текущее значение параметра (на момент завершения выполнения playbook). Обратите внимание, что для реального изменения некоторых параметров требуется перезапуск сервера PostgreSQL. Возвращает текущее значение в режиме проверки. Пример: {'value': 67108864, 'unit': 'b'}
value_pretty строка	всегда	Информация о текущем состоянии параметра. Пример: 64МБ

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Андрей Клычков (@Andersson007)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/postgresql_set_module.html