43.1. Создание экземпляра #

Важно

Агенты автоматически обнаруживают установленные на сервере хосты, экземпляры, объекты экземпляров и другие компоненты и создают их в веб-приложении. Автоматическое обнаружение можно настроить в файле конфигурации агента ppem-agent.yml.

Автоматическое обнаружение и ряд других возможностей не поддерживаются при установке PPEM с усиленными мерами безопасности.

43.1.1. Создание нового экземпляра #

Создание нового экземпляра подразумевает создание нового каталога данных и запуск службы экземпляра на сервере.

Чтобы создать новый экземпляр:

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

  2. В правом верхнем углу страницы нажмите Добавить экземпляр.

  3. Выберите Создать новый экземпляр, затем нажмите Далее.

  4. Укажите параметры нового экземпляра (помеченные звёздочкой параметры являются обязательными):

    • Имя.

    • Сервер: сервер, на котором установлен экземпляр.

    • Версия: версия Postgres Pro на сервере экземпляра.

    • Каталог данных: путь к каталогу на сервере, в который будут помещены основные каталоги и файлы экземпляра.

    • Бинарный каталог (bindir): путь к каталогу сервера, в котором размещены исполняемые файлы экземпляра.

    • Системный пользователь: пользователь операционной системы, которому принадлежат файлы и каталоги экземпляра, и от имени которого запускается служба экземпляра. В большинстве случаев это пользователь postgres.

      Убедитесь, что указанный пользователь существует в операционной системе.

    • Способ подключения: способ, который клиенты используют для подключения к экземпляру.

      Возможные значения:

      • Сетевой адрес.

        Для этого значения из выпадающего списка Адрес подключения выберите сетевой адрес, который экземпляр использует для приёма клиентских подключений.

      • Unix-сокет.

        Для этого значения в поле Каталог Unix-сокета введите путь к каталогу Unix-сокета, который экземпляр использует для приёма клиентских подключений.

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

    • Метод аутентификации: метод аутентификации, который экземпляр использует для проверки пользователей при приёме клиентских подключений.

      Возможные значения:

      • scram-sha-256.

      • md5.

      • trust: не выполнять аутентификацию.

        Рекомендуется выбирать это значение только для тестовой среды.

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

      Имя пользователя по умолчанию — postgres.

  5. Нажмите Далее, затем при необходимости укажите дополнительные параметры:

    • Пресет конфигурации: пресет конфигурации, который применяется к экземпляру.

      Возможные значения:

      • —: не применять к экземпляру пресет конфигурации.

      • Settings for 1C: применить к экземпляру пресет конфигурации для 1C.

      • Settings for OLTP: применить к экземпляру пресет конфигурации для OLTP (online transaction processing, обработка транзакций в реальном времени).

      Вы можете позже применить к экземпляру другой пресет конфигурации.

    • Параметры конфигурации: параметры конфигурации, которые применяются к экземпляру.

      Чтобы добавить параметр, укажите параметр и его значение, затем нажмите Добавить.

      Вы можете добавить несколько параметров. Добавленные параметры имеют приоритет перед ранее указанным пресетом конфигурации.

    • Теги: теги, которые назначены экземпляру.

    • Запустить экземпляр после создания: указывает, следует ли запустить службу экземпляра после его создания.

      За подробной информацией обратитесь к Разделу 43.6.

    • Имя сервиса: имя службы systemd для управления экземпляром.

      К указанному имени службы автоматически добавляется расширение .service.

  6. Нажмите Добавить экземпляр.

43.1.2. Создание экземпляра из резервной копии #

За подробной информацией обратитесь к Главе 71.

Перед выполнением этой инструкции создайте резервную копию.

Чтобы создать экземпляр из резервной копии:

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

  2. В правом верхнем углу страницы нажмите Добавить экземпляр.

  3. Выберите Создать новый экземпляр из резервной копии, затем нажмите Далее.

  4. Укажите параметры резервной копии, из которой создан экземпляр (помеченные звёздочкой параметры являются обязательными):

    • Хранилище резервных копий: хранилище, в котором размещена резервная копия.

      Можно использовать локальное или S3-хранилище. Локальное хранилище должно находиться на одном сервере с экземпляром, для которого создана резервная копия.

    • Экземпляр: экземпляр, для которого создана резервная копия.

    • Период: период, в который была создана резервная копия.

    • Резервная копия: резервная копия, из которой создан экземпляр.

  5. Нажмите Далее, затем укажите параметры нового экземпляра (помеченные звёздочкой параметры являются обязательными):

    • Имя.

    • Сервер: сервер, на котором установлен экземпляр.

    • Версия: версия Postgres Pro на сервере экземпляра.

    • Каталог данных: путь к каталогу на сервере, в котором размещены основные каталоги и файлы экземпляра.

    • Бинарный каталог (bindir): путь к каталогу сервера, в котором размещены исполняемые файлы экземпляра.

    • Системный пользователь: пользователь операционной системы, которому принадлежат файлы и каталоги экземпляра, и от имени которого запускается служба экземпляра. В большинстве случаев это пользователь postgres.

      Убедитесь, что указанный пользователь существует в операционной системе.

    • Доступное пространство: позволяет проверить, достаточно ли на сервере дискового пространства для создания экземпляра из резервной копии.

      Чтобы запустить проверку, нажмите Проверить.

    • Внешние каталоги: если резервная копия включает каталоги, размещённые вне каталога данных экземпляра, этот параметр позволяет указать соответствующие каталоги для создаваемого экземпляра.

    • Точка восстановления: состояние, которое необходимо восстановить для экземпляра.

      Возможные значения:

      • Последнее состояние резервной копии: Восстановить последнее состояние экземпляра в рамках резервной копии.

      • Дата и время: восстановить состояние экземпляра на указанную дату и время в рамках резервной копии.

        Для этого значения в поле Дата и время укажите дату и время.

      • LSN: восстановить состояние экземпляра, соответствующее указанному последовательному номеру в WAL.

        Для этого значения в поле LSN введите последовательный номер в WAL.

      • Идентификатор транзакции: восстановить состояние экземпляра, соответствующее указанному идентификатору транзакции.

        Для этого значения в поле Идентификатор транзакции введите идентификатор транзакции.

      Для значений Дата и время, LSN и Идентификатор транзакции укажите следующий параметр:

      Восстановить состояние на указанные дату и время включительно / Восстановить состояние, соответствующее указанному LSN включительно / Восстановить состояние, соответствующее указанной транзакции включительно: указывает, следует ли восстановить экземпляр до указанного значения включительно.

      Например, если в поле Идентификатор транзакции вы вводите 123456 и устанавливаете флажок Восстановить состояние, соответствующее указанной транзакции включительно, для экземпляра восстанавливается состояние, соответствующее транзакции 123456. Если вы не устанавливаете флажок Восстановить состояние, соответствующее указанной транзакции включительно, для экземпляра восстанавливается состояние, соответствующее транзакции с идентификатором 123455.

    • Восстановление баз данных: указывает, какие базы данных восстанавливаются или наоборот исключаются из процесса восстановения.

      Возможные значения:

      • Восстановить все базы данных.

      • Исключить указанные базы данных.

      • Восстановить указанные базы данных.

      Для значений Исключить указанные базы данных и Восстановить указанные базы данных в поле Исключить базы данных или Восстановить базы данных введите уникальное имя базы данных, затем нажмите Добавить.

      Вы можете добавить несколько баз данных.

  6. Нажмите Далее, затем укажите дополнительные параметры (помеченные звёздочкой параметры являются обязательными):

    • После восстановления: действие, которое должно быть выполнено после восстановления экземпляра до выбранного состояния.

      Возможные значения:

      • Запустить экземпляр.

      • Не запускать экземпляр.

      За подробной информацией обратитесь к Разделу 43.6.

    • Способ подключения: способ, который клиенты используют для подключения к экземпляру.

      Возможные значения:

      • Сетевой адрес.

        Для этого значения из выпадающего списка Адрес подключения выберите сетевой адрес, который экземпляр использует для приёма клиентских подключений.

      • Unix-сокет.

        Для этого значения в поле Каталог Unix-сокета введите путь к каталогу Unix-сокета, который экземпляр использует для приёма клиентских подключений.

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

    • Пресет конфигурации: пресет конфигурации, который применяется к экземпляру.

      Возможные значения:

      • —: не применять к экземпляру пресет конфигурации.

      • Settings for 1C: применить к экземпляру пресет конфигурации для 1C.

      • Settings for OLTP: применить к экземпляру пресет конфигурации для OLTP (online transaction processing, обработка транзакций в реальном времени).

      Вы можете позже применить к экземпляру другой пресет конфигурации.

    • Параметры конфигурации: параметры конфигурации, которые применяются к экземпляру.

      Чтобы добавить параметр, укажите параметр и его значение, затем нажмите Добавить.

      Вы можете добавить несколько параметров. Добавленные параметры имеют приоритет перед ранее указанным пресетом конфигурации.

    • Теги: теги, которые назначены экземпляру.

    • Имя сервиса: имя службы systemd для управления экземпляром.

      К указанному имени службы автоматически добавляется расширение .service.

  7. Нажмите Добавить экземпляр.

43.1.3. Добавление существующего экземпляра #

Добавление существующего экземпляра может потребоваться, если у агента выключена функция автоматического обнаружения установленных на сервере экземпляров.

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

Чтобы добавить существующий экземпляр:

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

  2. В правом верхнем углу страницы нажмите Добавить экземпляр.

  3. Выберите Добавить существующий экземпляр, затем нажмите Далее.

  4. Существующий экземпляр можно добавить либо автоматически, либо вручную, указав все параметры.

    • Что обнаружить экземпляр автоматически:

      1. Из выпадающего списка Агент выберите агента, который будет управлять экземпляром.

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

        Можно добавить несколько каталогов.

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

      3. Нажмите Начать поиск.

      4. Выберите экземпляр.

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

    • Чтобы добавить экземпляр вручную:

      Пропустите шаги обнаружения и перейдите непосредственно к указанию параметров экземпляра.

  5. Нажмите Далее, затем укажите параметры нового экземпляра (помеченные звёздочкой параметры являются обязательными):

    • Имя.

    • Сервер: сервер, на котором установлен экземпляр.

    • Версия: версия Postgres Pro на сервере экземпляра.

    • Каталог данных: путь к каталогу на сервере, в котором размещены основные каталоги и файлы экземпляра.

    • Бинарный каталог (bindir): путь к каталогу сервера, в котором размещены исполняемые файлы экземпляра.

    • Системный пользователь: пользователь операционной системы, которому принадлежат файлы и каталоги экземпляра, и от имени которого запускается служба экземпляра. В большинстве случаев это пользователь postgres.

      Убедитесь, что указанный пользователь существует в операционной системе.

    • Способ подключения: способ, который клиенты используют для подключения к экземпляру.

      Возможные значения:

      • Сетевой адрес.

        Для этого значения из выпадающего списка Адрес подключения выберите сетевой адрес, который экземпляр использует для приёма клиентских подключений.

      • Unix-сокет.

        Для этого значения в поле Каталог Unix-сокета введите путь к каталогу Unix-сокета, который экземпляр использует для приёма клиентских подключений.

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

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

      Имя пользователя по умолчанию — postgres.

    • Способ запуска: указывает способ запуска экземпляра.

      Возможные значения:

      • systemd: запустить экземпляр с помощью модуля systemd.

        Это рекомендуемый способ запуска.

      • pg_ctl: запустить экземпляр с помощью утилиты pg_ctl.

    • Имя сервиса: имя службы systemd для управления экземпляром.

      К указанному имени службы автоматически добавляется расширение .service.

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

    • Теги: теги, которые назначены экземпляру.

  6. Нажмите Добавить экземпляр.

43.1. Creating an Instance #

Important

Agents automatically discover hosts, instances, instance objects, and other components installed on the server and create them in the web application. You can configure the automatic discovery in the ppem-agent.yml agent configuration file.

The automatic discovery and a number of other features are not supported when PPEM is installed in a secure environment.

43.1.1. Creating a New Instance #

Creating a new instance includes creating a new data directory and starting an instance service on the server.

To create a new instance:

  1. In the navigation panel, go to Infrastructure → Instances.

  2. In the top-right corner of the page, click Add instance.

  3. Select Create a new instance, and then click Next.

  4. Specify parameters of the new instance (parameters marked with an asterisk are required):

    • Name.

    • Server: The server where the instance is installed.

    • Version: The version of Postgres Pro on the instance server.

    • Data directory: The path to the server directory where the main instance directories and files will be located.

    • Binary directory: The path to the server directory where executable files of the instance are located.

    • System user: The operating system user that owns instance files and catalogs and on behalf of which the instance service runs. In most cases, it is the postgres user.

      Ensure that the specified user exists in the operating system.

    • Connection method: The method that clients use for connecting to the instance.

      Possible values:

      • Network address.

        For this value, in Network address, select the network address that the instance uses for receiving client connections.

      • Unix socket.

        For this value, in Unix socket directory, enter the path to the Unix socket directory that the instance uses for receiving client connections.

    • Port: The port number that the instance uses for receiving client connections.

    • Authentication method: The authentication method that the instance uses to verify users when receiving client connections.

      Possible values:

      • scram-sha-256.

      • md5.

      • trust: Do not perform authentication.

        It is recommended to select this value only for test environments.

    • DB superuser and DB superuser password: The name and password of the DBMS user that is created and on behalf of which the agent connects to the instance.

      The default username is postgres.

  5. Click Next and then specify additional parameters if required:

    • Configuration preset: The configuration preset that is applied to the instance.

      Possible values:

      • —: Do not apply a configuration preset to the instance.

      • Settings for 1C: Apply the 1C configuration preset to the instance.

      • Settings for OLTP: Apply the OLTP (Online Transaction Processing) configuration preset to the instance.

      You can apply another configuration preset to the instance later.

    • Configuration parameters: Configuration parameters that are applied to the instance.

      To add a parameter, specify the parameter and its value, and then click Add.

      You can add multiple parameters. Added parameters take precedence over the previously specified configuration preset.

    • Tags: Tags that are assigned to the instance.

    • Start instance after creation: Specifies whether the instance is started after creation.

      For more information, refer to Section 43.6.

    • Service name: The name of the systemd service for managing the instance.

      The .service extension is automatically added to the specified instance service name.

  6. Click Add instance.

43.1.2. Creating an Instance from a Backup #

For more information about backups, refer to Chapter 71.

Before performing this instruction, create a backup.

To create an instance from a backup:

  1. In the navigation panel, go to Infrastructure → Instances.

  2. In the top-right corner of the page, click Add instance.

  3. Select Create from a backup, and then click Next.

  4. Specify parameters of the backup from which the instance is created (parameters marked with an asterisk are required):

    • Backup storage: The storage where the backup is located.

      You can use a local or S3 storage. The local storage must be located on the same server as the instance for which the backup is created.

    • Instance: The instance for which the backup is created.

    • Period: The period when the backup was created.

    • Backup: The backup from which the instance is created.

  5. Click Next and then specify parameters of the new instance (parameters marked with an asterisk are required):

    • Name.

    • Server: The server where the instance is installed.

    • Version: The version of Postgres Pro on the instance server.

    • Data directory: The path to the server directory where the main instance directories and files are located.

    • Binary directory: The path to the server directory where executable files of the instance are located.

    • System user: The operating system user that owns instance files and catalogs and on behalf of which the instance service runs. In most cases, it is the postgres user.

      Ensure that the specified user exists in the operating system.

    • Available space: Allows checking whether there is enough disk space on the server for creating the instance from the backup.

      To start the check, click Check.

    • External directories: If the backup includes directories located outside of the instance data directory, this parameter allows specifying the corresponding directories for the instance that is created.

    • Restore point: The state to which the instance must be restored.

      Possible values:

      • Last backup state: Restore the instance to the last state covered by the backup.

      • Date and time: Restore the instance state to the specified date and time covered by the backup.

        For this value, in Date and time, specify the date and time.

      • LSN: Restore the instance to the state corresponding to the specified WAL LSN.

        For this value, in LSN, enter the WAL LSN.

      • Transaction ID: Restore the instance state to the specified transaction ID.

        For this value, in Transaction ID, enter the transaction ID.

      For Date and time, LSN, and Transaction ID, specify the following parameter:

      Restore the state at the specified date and time inclusive / Restore the state corresponding to the specified LSN inclusive / Restore the state corresponding to the specified transaction inclusive: Specifies whether the instance state is restored, including the specified value.

      For example, if you enter 123456 in Transaction ID and enable Restore the state corresponding to the specified transaction inclusive, the instance state is restored to the transaction with ID 123456. If you do not enable Restore the state corresponding to the specified transaction inclusive, the instance state is restored to the transaction with ID 123455.

    • Database recovery: Specifies instance databases that are restored or excluded from the restoration process.

      Possible values:

      • Restore all databases.

      • Exclude specified databases.

      • Restore specified databases.

      For Exclude specified databases and Restore specified databases, in Exclude databases or Restore databases, enter the unique database name, and then click Add.

      You can add multiple databases.

  6. Click Next and then specify additional parameters (parameters marked with an asterisk are required):

    • After restore: The action that must be performed after restoring the instance to the selected state.

      Possible values:

      • Start instance.

      • Do not start instance.

      For more information, refer to Section 43.6.

    • Connection method: The method that clients use for connecting to the instance.

      Possible values:

      • Network address.

        For this value, in Network address, select the network address that the instance uses for receiving client connections.

      • Unix socket.

        For this value, in Unix socket directory, enter the path to the Unix socket directory that the instance uses for receiving client connections.

    • Port: The port number that the instance uses for receiving client connections.

    • Configuration preset: The configuration preset that is applied to the instance.

      Possible values:

      • —: Do not apply a configuration preset to the instance.

      • Settings for 1C: Apply the 1C configuration preset to the instance.

      • Settings for OLTP: Apply the OLTP (Online Transaction Processing) configuration preset to the instance.

      You can apply another configuration preset to the instance later.

    • Configuration parameters: Configuration parameters that are applied to the instance.

      To add a parameter, specify the parameter and its value, and then click Add.

      You can add multiple parameters. Added parameters take precedence over the previously specified configuration preset.

    • Tags: Tags that are assigned to the instance.

    • Service name: The name of the systemd service for managing the instance.

      The .service extension is automatically added to the specified instance service name.

  7. Click Add instance.

43.1.3. Adding an Existing Instance #

You may need to add an existing instance if the automatic discovery of instances installed on the server is disabled.

Before performing this instruction, ensure that the instance is running on the server and is ready to receive client connections.

To add an existing instance:

  1. In the navigation panel, go to Infrastructure → Instances.

  2. In the top-right corner of the page, click Add instance.

  3. Select Add an existing instance, and then click Next.

  4. You can either discover an existing instance automatically or add it manually by specifying all parameters directly.

    • To discover an instance automatically:

      1. From Agent, select the agent that will manage the instance.

      2. In Search in directories, click Add to specify the server directories where the agent must discover instances.

        You can add multiple directories.

        If you do not add any directories, the agent searches in all server directories.

      3. Click Start search.

      4. Select the instance.

        If there are no instances, review and correct instance discovery parameters, then click Start search again.

    • To add an instance manually:

      Skip the discovery steps and proceed directly to configuring the instance parameters.

  5. Click Next and then specify parameters of the new instance (parameters marked with an asterisk are required):

    • Name.

    • Server: The server where the instance is installed.

    • Version: The version of Postgres Pro on the instance server.

    • Data directory: The path to the server directory where the main instance directories and files are located.

    • Binary directory: The path to the server directory where executable files of the instance are located.

    • System user: The operating system user that owns instance files and catalogs and on behalf of which the instance service runs. In most cases, it is the postgres user.

      Ensure that the specified user exists in the operating system.

    • Connection method: The method that clients use for connecting to the instance.

      Possible values:

      • Network address.

        For this value, in Network address, select the network address that the instance uses for receiving client connections.

      • Unix socket.

        For this value, in Unix socket directory, enter the path to the Unix socket directory that the instance uses for receiving client connections.

    • Port: The port number that the instance uses for receiving client connections.

    • DB superuser and DB superuser password: The name and password of the DBMS user that is created and on behalf of which the agent connects to the instance.

      The default username is postgres.

    • Startup method: Specifies the instance startup method.

      Possible values:

      • systemd: Start the instance using the systemd unit.

        This is the recommended startup method.

      • pg_ctl: Start the instance using the pg_ctl utility.

    • Service name: The name of the systemd service for managing the instance.

      The .service extension is automatically added to the specified instance service name.

      This parameter is available only if you add the instance manually.

    • Tags: Tags that are assigned to the instance.

  6. Click Add instance.

FAQ