28.4. Настройка агентов #

На всех серверах:

  1. Установите агенты:

    # apt install ppem-agent
  2. Создайте пользователя СУБД, от имени которого агент будет подключаться к базам данных сервера СУБД:

    # sudo -u postgres createuser --pwprompt ppem_agent

    При выполнении этой команды укажите пароль пользователя СУБД.

  3. Предоставьте пользователю СУБД права на чтение системного каталога и запуск функций.

    Рекомендуется назначить следующие права:

    GRANT pg_monitor, pg_maintain, pg_signal_backend, pg_read_all_settings TO ppem_agent;

    Предоставьте пользователю СУБД следующие права на каждую базу данных в экземпляре:

    GRANT EXECUTE ON FUNCTION pg_catalog.pg_stat_file(TEXT) TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_stat_file(TEXT, BOOLEAN) TO ppem_agent;
    GRANT SELECT ON pg_catalog.pg_statistic TO ppem_agent;
    GRANT SELECT ON pg_catalog.pg_config TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_config() TO ppem_agent;
    GRANT SELECT ON pg_catalog.pg_file_settings TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_show_all_file_settings() TO ppem_agent;
    GRANT SELECT ON pg_catalog.pg_authid TO ppem_agent;

    Предоставьте пользователю СУБД следующие права на управление резервными копиями:

    ALTER ROLE ppem_agent WITH REPLICATION;
    
    GRANT USAGE ON SCHEMA pg_catalog TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.current_setting(text) TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.set_config(text, text, boolean) TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_is_in_recovery() TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_backup_start(text, boolean) TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_backup_stop(boolean) TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_create_restore_point(text) TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_switch_wal() TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_last_wal_replay_lsn() TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.txid_current() TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.txid_current_snapshot() TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.txid_snapshot_xmax(txid_snapshot) TO ppem_agent;
    GRANT EXECUTE ON FUNCTION pg_catalog.pg_control_checkpoint() TO ppem_agent;

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

    За подробной информацией о правах обратитесь к официальной документации Postgres Pro по pg_probackup.

  4. Убедитесь, что пользователь СУБД может подключиться к следующим базам данных:

    • К базе данных репозитория на сервере, где установлен менеджер.

      Например, чтобы проверить возможность доступа к базе данных ppem:

      # psql -h localhost -U ppem_agent -d ppem

      При проблемах с подключением убедитесь, что в файле конфигурации pg_hba.conf указаны метод авторизации и правило HBA, разрешающие пользователю СУБД подключаться к базе данных.

      Пример записей в pg_hba.conf:

      host    ppem  ppem_agent  ::1/128       trust
      host    ppem  ppem_agent  127.0.0.1/32  trust
    • Ко всем базам данных на сервере, где установлены СУБД, которыми нужно управлять.

      Например, чтобы проверить возможность доступа к базе данных db1:

      # psql -h localhost -U ppem_agent -d db1

      При проблемах с подключением убедитесь, что в файле конфигурации pg_hba.conf указаны метод авторизации и правило HBA, разрешающие пользователю СУБД подключаться к базе данных.

      Пример записей в pg_hba.conf:

      host    all  ppem_agent  ::1/128       trust
      host    all  ppem_agent  127.0.0.1/32  trust
  5. Получите API-ключ для настройки агента:

    1. Войдите в веб-приложение.

    2. В навигационной панели перейдите в Главная.

    3. Если на странице отображается инструкция по установке агента, скопируйте ключ из инструкции.

    4. Если инструкции нет, выполните следующие действия:

      1. В навигационной панели перейдите в Инфраструктура → Агенты.

      2. В столбце Ключ аутентификации для любого агента нажмите либо , чтобы скопировать ключ, либо , чтобы посмотреть ключ.

  6. В файле конфигурации агента /etc/ppem-agent.yml укажите значения для следующих параметров:

    • agent.name

      Укажите уникальное имя агента.

    • agent.manager.url

      Укажите следующие значение и замените необходимые данные:

      http://адрес_менеджера_ppem:8080
    • agent.manager.api_key

      Укажите значение API-ключа, которое было получено ранее.

    • agent.instance.connection_defaults

      Укажите параметры, которые используются агентом для подключения к экземплярам СУБД на хосте с установленным агентом.

  7. Создайте основной и дополнительный каталоги агентов и назначьте пользователя операционной системы их владельцем:

      sudo mkdir --parents /var/lib/ppem/{instances,postgresql,systemd,backups}
      sudo chown --recursive ppem:ppem /var/lib/ppem

    Основной каталог агентов используется для хранения экземпляров и их параметров, единиц измерения экземпляров, а также локальных хранилищ. При создании экземпляров необходимо указывать каталог /var/lib/ppem/instances, а при создании локальных хранилищ — каталог /var/lib/ppem/backups.

  8. Создайте каталог для настройки systemd:

      sudo mkdir /etc/systemd/system.conf.d
  9. Создайте файл конфигурации systemd:

      sudo nano /etc/systemd/system.conf.d/custom_path.conf
  10. В файле конфигурации systemd укажите:

      [Manager]
      ManagerEnvironment="SYSTEMD_UNIT_PATH=/var/lib/ppem/systemd:"
  11. Добавьте пользователя операционной системы в группу для работы с экземплярами:

      sudo usermod -aG postgres ppem
  12. В файле конфигурации sudoers разрешите пользователю операционной системы выполнять команды от имени суперпользователя, указав:

      Cmnd_Alias PG_SYS_V = /usr/bin/systemctl status *postgres*.service, \
      /usr/bin/systemctl start *postgres*.service, \
      /usr/bin/systemctl stop *postgres*.service, \
      /usr/bin/systemctl restart *postgres*.service, \
      /usr/bin/systemctl reload *postgres*.service, \
      /usr/bin/systemctl enable *postgres*.service, \
      /usr/bin/systemctl disable *postgres*.service, \
      /usr/bin/systemctl daemon-reload, \
      /usr/bin/mkdir --parents /var/lib/ppem/*, \
      /usr/bin/mkdir /var/lib/ppem/*, \
      /usr/bin/mkdir --parents /sys/fs/cgroup/ppem*, \
      /usr/bin/mkdir /sys/fs/cgroup/ppem*, \
      /usr/bin/chmod --recursive 0[5-7][0-7][0-7] /var/lib/ppem/*, \
      /usr/bin/chmod 0[5-7][0-7][0-7] /var/lib/ppem/*, \
      /usr/bin/chown --recursive [a-z]*\:[a-z]* /var/lib/ppem/*, \
      /usr/bin/chown [a-z]*\:[a-z]* /var/lib/ppem/*, \
      /usr/bin/chown [a-z]*\:[a-z]* /tmp/*, \
      /usr/bin/chown --recursive [a-z]*\:[a-z]* /tmp/*, \
      /usr/bin/echo, \
      /usr/bin/test, \
      /usr/bin/sh -c /usr/bin/echo, \
      /usr/bin/mv, \
      /usr/bin/rm /var/lib/ppem/*, \
      /usr/bin/rm /tmp/*, \
      /usr/bin/rm --recursive --force /var/lib/ppem/*
    
      Cmnd_Alias PG_CTL_V = /usr/lib/postgresql/[0-9][0-9]/bin/pg_ctl, \
      /usr/lib/postgresql/[0-9][0-9]/bin/initdb, \
      /usr/bin/pg_probackup-[0-9][0-9], \
      /opt/pgpro/ent-[0-9][0-9]/bin/initdb, \
      /opt/pgpro/ent-[0-9][0-9]/bin/pg_ctl, \
      /opt/pgpro/ent-[0-9][0-9]/bin/pg_probackup
    
      ppem ALL = (root) NOPASSWD:SETENV: PG_SYS_V
      ppem ALL = (postgres) NOPASSWD:SETENV: PG_CTL_V
  13. В файле конфигурации агента ppem-agent.yml укажите:

      system:
        postgresql_configs_path: "/var/lib/ppem/postgresql"
        systemd_units_path: "/var/lib/ppem/systemd"
  14. Настройте запуск службы агента от имени пользователя операционной системы:

    1. Начните редактирование модуля systemd:

      # systemctl edit ppem-agent
    2. В разделе [Service] укажите пользователя операционной системы:

      [Service]
      User=ppem
    3. Убедитесь, что пользователь операционной системы имеет право чтения файла конфигурации агента ppem-agent.yml.

      Если право отсутствует, выполните запрос:

      # chown ppem:ppem /etc/ppem-agent.yml
      # chmod 400 /etc/ppem-agent.yml
    4. Сохраните параметры модуля systemd, затем перезагрузите его:

      # systemctl daemon-reload
  15. Запустите службу агента и добавьте её в автозагрузку сервера:

    # systemctl start ppem-agent
    # systemctl enable ppem-agent
FAQ