Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в коллекцию community.postgresql (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.postgresql.

Для использования в плейбуке укажите: community.postgresql.postgresql_set.

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

Описание

  • Позволяет изменить параметр конфигурации сервера 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 можно увидеть предыдущее и новое значение параметра и другую информацию, используя возвращаемые значения и модуль ansible.builtin.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.
trust_input
булево
добавлен в 0.2.0 community.postgresql
    Варианты:
  • нет
  • да ←
Если no, проверьте, являются ли значения параметров потенциально опасными.
Использование no имеет смысл только в том случае, если возможны SQL-инъекции.
value
строка
Значение параметра, которое нужно установить.
Чтобы удалить строку параметра из postgresql.auto.conf и перезагрузить конфигурацию сервера, необходимо передать value=default. При value=default плейбук всегда возвращает changed is 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.

См. также

См. также

community.postgresql.postgresql_info

Официальная документация по модулю community.postgresql.postgresql_info.

Конфигурация сервера PostgreSQL

Общая информация о конфигурации сервера PostgreSQL.

Ссылка на документацию представления pg_settings PostgreSQL

Полное справочное руководство по документации представления pg_settings.

Справочная информация по команде ALTER SYSTEM PostgreSQL

Полное справочное руководство по документации команды ALTER SYSTEM.

Примеры

- name: Restore wal_keep_segments parameter to initial state
  community.postgresql.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
  community.postgresql.postgresql_set:
    name: work_mem
    value: 32mb
  register: set

- ansible.builtin.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_pretty and value_pretty, 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
  community.postgresql.postgresql_set:
    name: log_min_duration_statement
    value: 1s

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

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

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

Ключ Возвращаемое значение Описание
context
строка
всегда
Контекст параметра настройки PostgreSQL.

Пример:
пользователь
name
строка
всегда
Имя параметра сервера PostgreSQL.

Пример:
shared_buffers
prev_val_pretty
строка
всегда
Информация о предыдущем состоянии параметра.

Пример:
4МБ
restart_required
булево
всегда
Информация о текущем состоянии параметра.

Пример:
True
value
словарь
всегда
Словарь, содержащий текущее значение параметра (на момент завершения плейбука).
Обратите внимание, что для реального изменения некоторых параметров требуется перезапуск сервера PostgreSQL.
Возвращает текущее значение в режиме проверки.

Пример:
{'unit': 'b', 'value': 67108864}
value_pretty
строка
всегда
Информация о текущем состоянии параметра.

Пример:
64МБ


Авторы

  • Андрей Клычков (@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.10/collections/community/postgresql/postgresql_set_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API