Просмотр кода страницы Установка OneAgent с помощью Puppet

<code>Предварительный просмотр</code>

Ключ-АСТРОМ предоставляет модуль Puppet, который можно использовать для организации развертывания ЕдиногоАгента в вашей среде. Модуль ЕдиногоАгента Puppet выпущен в виде предварительной версии.

== Требования ==

*      Puppet 6.0+
*      ЕдиныйАгент версии 1.199+
*      Ключ-АСТРОМ версии 1.204+
*      Сценарий доступа к файлам установщика ЕдиногоАгента

== Зависимости ==

* puppet/archive
* puppetlabs/powershell (for Windows deployment)
* puppetlabs/reboot

== Скачать модуль ЕдиногоАгента Puppet ==
1. Выберите «'''Развернуть Ключ-АСТРОМ'''» в меню навигации, а затем выберите «'''Начать установку'''».

2. Выберите '''модуль Puppet''', чтобы загрузить архив модуля.

Это безопасный архив, размещенный в вашей среде Ключ-АСТРОМ. Поместите полученный артефакт на свой серверный узел.

3. необязательно В Linux вы можете проверить подлинность архива, используя отдельно предоставленный файл подписи:

*      Выберите '''Подпись''', чтобы загрузить файл <code>sig</code>.
*      Убедитесь, что загруженный tar-архив модуля Puppet и файл подписи хранятся в одном каталоге.
*      Перейдите в каталог, в котором вы сохранили файлы, и выполните следующую команду, заменив имена файлов фактическими именами загруженных файлов:

== Установите модуль Puppet ЕдиногоАгента ==
1. Сохраните tar-архив модуля в каталог на узле вашего сервера.

2. Чтобы установить модуль ASTROM-key/oneagent, перейдите в каталог, в котором вы сохранили tar-архив модуля, и выполните следующую команду:
 puppet module install ASTROM-key-oneagent-puppet-1.0.0.20200101-060000.tar.gz
     Модуль развертывает ЕдиныйАгент с использованием специальной конфигурации. Конфигурация гарантирует, что служба ЕдиногоАгента остается в рабочем состоянии. Дополнительные сведения см. в документации модуля Puppet.

== Настройка модуля Puppet ЕдиногоАгента ==
Модулю Puppet ЕдиногоАгента требуется доступ к соответствующим файлам установки ЕдиногоАгента.

* Если ваш серверный узел Puppet имеет доступ к вашей среде Ключ-АСТРОМ, вы можете настроить модуль для загрузки файлов установщика непосредственно из среды Ключ-АСТРОМ.
* Кроме того, вы можете самостоятельно загрузить файлы установщика с помощью веб-интерфейса Ключ-АСТРОМ и загрузить их на узел сервера. Это обеспечивает сценарий локальными копиями установщиков.

=== Вариант 1. Используйте прямую загрузку из среды Ключ-АСТРОМ. ===
Модуль использует Ключ-АСТРОМ Deployment API для загрузки установщиков для конкретной платформы на узлы агента Puppet. Вам нужно будет указать переменные для предоставления информации, необходимой для аутентификации вызова API в вашей среде:

* <code>environment_url</code>:
** '''Ключ-АСТРОМ SaaS''': <code><nowiki>https://{your-environment-id}.live.ruscomtech.ru</nowiki></code>
** '''Ключ-АСТРОМ''' '''Managed''': <code><nowiki>https://{ваш-домен}/e/{идентификатор-вашей-среды}</nowiki></code>
* <code>paas_token</code>
** Токен '''PaaS''' вашей среды

     Например:
      class { 'oneagent':
          # Set environment variables
          paas_token => 'abcdefjhij1234567890',
          environment_url => '<nowiki>https://your-environment.live.ruscomtech.ru'</nowiki>,
          # (...)
        }
Дополнительные примеры см. в разделе Примеры.

=== Вариант 2. Используйте локальные установщики ===
Используйте веб-интерфейс Ключ-АСТРОМ для загрузки необходимых файлов установщика ЕдиногоАгента, а затем загрузите их в соответствующую точку подключения на узле сервера. Затем модуль Puppet загрузит установщики с сервера Puppet на узлы агента Puppet.

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

Например:
 class { 'oneagent':
      # Set environment variables
      local_installer => mounting_point/path/of/oneagent-linux-installer.sh
      # (...)
    }
Обратите внимание, что для Windows, Linux и AIX требуются специальные программы установки. Исходные имена установщиков, загруженные с Ключ-АСТРОМ, включают обозначения целевых платформ. Если вы меняете имена установщиков, убедитесь, что модуль может их различать.

Если вы не укажете локальный установщик, модуль попытается использовать метод прямой загрузки для загрузки установщиков из среды Ключ-АСТРОМ.

== Переменные ==
Модуль Puppet ЕдиногоАгента поддерживает следующие переменные:
{| class="wikitable"
!Название
!Значение по умолчанию
!Описание
|-
|<code>environment_url</code>
|unset
|URL целевой среды Ключ-АСТРОМ (SaaS или Managed).
|-
|<code>paas_token</code>
|unset
|Токен PaaS, полученный со страницы установщика '''Развернуть''' '''Ключ-АСТРОМ'''.
|-
|<code>local_installer</code>
|unset
|Путь к установщику ЕдиногоАгента в настроенной точке подключения.
|-
|<code>installer_arch</code>
|unset
|Архитектура установщика ЕдиногоАгента
|-
|<code>version</code>
|<code>latest</code>
|Требуемая версия ЕдиногоАгента в виде <code>1.199.247.20200714-111723</code>. Дополнительные сведения см. в разделе, как составить список доступных версий установщика ЕдиногоАгента.
|-
|<code>download_dir</code>
|Linux/AIX: <code>$TEMP</code> or <code>/tmp</code>
Windows: <code>%TEMP%</code> or <code>C:\Windows\Temp</code>
|Каталог загрузки установщика. Каталог должен быть доступен модулю. Для Linux и AIX каталог не должен содержать пробелов.
|-
|<code>install_args</code>
|unset
|Параметры установки ЕдиногоАгента Ключ-АСТРОМ, определенные в виде списка элементов.
|-
|<code>platform_install_args</code>
|unset
|Дополнительный список параметров установки для конкретной платформы, добавляемый к `install_args' при запуске на соответствующей платформе.
|-
|<code>preserve_installer</code>
|<code>false</code>
|Возможность сохранить установщик на узле агента Puppet после развертывания.
|-
|<code>package_state</code>
|<code>present</code>
|Желаемое состояние пакета ЕдиногоАгента. Укажите <code>present</code> (текущую) или '''<code>latest</code>''' (последнюю) версию для установки. Укажите '''<code>absent</code>''' для удаления.
|-
|<code>validate_certs</code>
|<code>true</code>
|Возможность требовать сертификаты. Если установлено значение <code>false</code>, позволяет загружать ЕдиныйАгент с сервера с небезопасным SSL-сертификатом (истекшим сроком действия, самоподписанным и т. д.).
|-
|<code>proxy_server</code>
|unset
|Прокси-сервер, который будет использоваться для загрузки установщика ЕдиногоАгента.
|}

== Логирование ==
По умолчанию Puppet записывает сообщения в системный журнал (для хостов на базе Linux) или в журнал событий (для хостов на базе Windows). Однако Puppet можно настроить для хранения журналов, относящихся к конкретному развертыванию, в определенных файлах.

* Для Puppet Server вы можете настроить место ведения журнала, отредактировав файл /etc/puppetlabs/puppetlabs/logback.xml и заменив места, на которые указывают элементы <file>:

 (...)
     <appender name="F1" class="ch.qos.logback.core.FileAppender">
         <file>/new/log/location</file>
 (...)
Дополнительные сведения см. в разделе Конфигурация журнала.

* Для агентов Puppet отредактируйте файл puppet.conf и добавьте ключ файла журнала:

 (...)
 logdest=absolute_path_of_log_location.log
 (...)
Расположение файла конфигурации зависит от операционной системы:

* <code>/etc/puppetlabs/puppet/puppet.conf</code> для систем Linux,
* <code>C:\ProgramData\PuppetLabs\puppet\etc\puppet.conf</code> для Windows.

Дополнительные сведения см. в разделах Настройка агента UNIX и Настройка агента Windows.

== Примеры ==
Этот пример манифеста:

* Загружает установщик ЕдиногоАгента определенной версии (<code>version</code>) и сохраняет его в пользовательском каталоге (<code>download_dir</code>).
* Указывает модулю развернуть ЕдиныйАгент на хостах Linux и Windows с заданной конфигурацией.
* Указывает модулю использовать архитектуру установщика <code>ppcle</code>.
* Использует <code>install_args</code> для передачи параметров установки ЕдиногоАгента, которые назначают хосты группе хостов <code>My.HostGroup_123-456</code> и сетевой зоне <code>my.network.zone</code>.

 # Download OneAgent installer in specific version to a custom 
 # directory with additional OneAgent install parameters
 $env_url = '<nowiki>https://abc12345.live.ruscomtech.ru'</nowiki>
 $paas_token = 'abcdefghijk1234567890'
 $install_args = [ '--set-host-group=My.HostGroup_123-456', '--set-network-zone=my.network.zone' ]
 $preserve_installer = true
 $version = '1.219.0.20210422-111723'
 if $::osfamily == 'Windows' {
   class { 'oneagent':
     environment_url => $env_url,
     paas_token => $paas_token,
     preserve_installer => $preserve_installer,
     install_args => $install_args,
     platform_install_args => [ 'INSTALL_PATH=C:\\ASTROM-key', 'USER=LocalService' ],
     download_dir => 'C:\\temp',
     version => $version
   }
 } else {
   class { 'oneagent':
     environment_url => $env_url,
     paas_token => $paas_token,
     preserve_installer => $preserve_installer,
     install_args => $install_args,
     platform_install_args => [ 'INSTALL_PATH=/opt/ASTROM-key', 'USER=linux_user' ],
     download_dir => '/tmp',
     version => $version,
     installer_arch => 'ppcle'
   }
 }
Вы можете найти больше примеров манифестов в каталоге примеров. Каталог содержит следующие манифесты:

* <code>local_installer.yml</code> — установка ЕдиногоАгента с помощью локальной программы установки.
* <code>advanced_config.yml</code> — установка ЕдиногоАгента с пользовательским путем установки и каталогом загрузки.
* <code>oneagentctl_config.yml</code> — конфигурация ЕдиногоАгента с помощью команды <code>oneagentctl</code>.

Если у вас возникли проблемы с путями при установке в Windows, ознакомьтесь с разделом «Форматирование пути для Windows» в документации Puppet.