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

Материал из Dynatrace
(Новая страница: «<code>Предварительный просмотр</code> Ключ-АСТРОМ предоставляет модуль Puppet, который можно ис...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
<code>Предварительный просмотр</code>
<code>Предварительный просмотр</code>


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


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


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


== Зависимости ==
== Зависимости ==
Строка 16: Строка 16:
* puppetlabs/reboot
* puppetlabs/reboot


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


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


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


3. необязательно В Linux вы можете проверить подлинность архива, используя отдельно предоставленный файл подписи:
3. необязательно В Linux вы можете проверить подлинность архива, используя отдельно предоставленный файл подписи:
Строка 29: Строка 29:
*      Перейдите в каталог, в котором вы сохранили файлы, и выполните следующую команду, заменив имена файлов фактическими именами загруженных файлов:
*      Перейдите в каталог, в котором вы сохранили файлы, и выполните следующую команду, заменив имена файлов фактическими именами загруженных файлов:


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


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


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


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


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


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


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


Используйте переменную local_installer, чтобы предоставить модулю путь к установщику в указанной точке монтирования. Для этого требуется настроенный файловый сервер на узле сервера.
Используйте переменную local_installer, чтобы предоставить модулю путь к установщику в указанной точке монтирования. Для этого требуется настроенный файловый сервер на узле сервера.
Строка 71: Строка 71:
       # (...)
       # (...)
     }
     }
Обратите внимание, что для Windows, Linux и AIX требуются специальные программы установки. Исходные имена установщиков, загруженные с Ключ-АСТРОМ, включают обозначения целевых платформ. Если вы меняете имена установщиков, убедитесь, что модуль может их различать.
Обратите внимание, что для Windows, Linux и AIX требуются специальные программы установки. Исходные имена установщиков, загруженные с Dynatrace, включают обозначения целевых платформ. Если вы меняете имена установщиков, убедитесь, что модуль может их различать.


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


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


Строка 158: Строка 158:
Этот пример манифеста:
Этот пример манифеста:


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


  # Download OneAgent installer in specific version to a custom  
  # Download OneAgent installer in specific version to a custom  
Строка 176: Строка 176:
      preserve_installer => $preserve_installer,
      preserve_installer => $preserve_installer,
      install_args => $install_args,
      install_args => $install_args,
      platform_install_args => [ 'INSTALL_PATH=C:\\ASTROM-key', 'USER=LocalService' ],
      platform_install_args => [ 'INSTALL_PATH=C:\\Dynatrace', 'USER=LocalService' ],
      download_dir => 'C:\\temp',
      download_dir => 'C:\\temp',
      version => $version
      version => $version
Строка 186: Строка 186:
      preserve_installer => $preserve_installer,
      preserve_installer => $preserve_installer,
      install_args => $install_args,
      install_args => $install_args,
      platform_install_args => [ 'INSTALL_PATH=/opt/ASTROM-key', 'USER=linux_user' ],
      platform_install_args => [ 'INSTALL_PATH=/opt/Dynatrace', 'USER=linux_user' ],
      download_dir => '/tmp',
      download_dir => '/tmp',
      version => $version,
      version => $version,
Строка 194: Строка 194:
Вы можете найти больше примеров манифестов в каталоге примеров. Каталог содержит следующие манифесты:
Вы можете найти больше примеров манифестов в каталоге примеров. Каталог содержит следующие манифесты:


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


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

Текущая версия на 11:40, 22 января 2023

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

Dynatrace предоставляет модуль Puppet, который можно использовать для организации развертывания OneAgent в вашей среде. Модуль OneAgent Puppet выпущен в виде предварительной версии.

Требования

  •      Puppet 6.0+
  •      OneAgent версии 1.199+
  •      Dynatrace версии 1.204+
  •      Сценарий доступа к файлам установщика OneAgent

Зависимости

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

Скачать модуль Puppet OneAgent

1. Выберите «Развернуть Dynatrace» в меню навигации, а затем выберите «Начать установку».

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

Это безопасный архив, размещенный в вашей среде Dynatrace. Поместите полученный артефакт на свой серверный узел.

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

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

Установите модуль Puppet OneAgent

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

2. Чтобы установить модуль Dynatrace/oneagent, перейдите в каталог, в котором вы сохранили tar-архив модуля, и выполните следующую команду:

puppet module install Dynatrace-oneagent-puppet-1.0.0.20200101-060000.tar.gz

     Модуль развертывает OneAgent с использованием специальной конфигурации. Конфигурация гарантирует, что служба OneAgent остается в рабочем состоянии. Дополнительные сведения см. в документации модуля Puppet.

Настройка модуля Puppet OneAgent

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

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

Вариант 1. Используйте прямую загрузку из среды Dynatrace.

Модуль использует Dynatrace Deployment API для загрузки установщиков для конкретной платформы на узлы агента Puppet. Вам нужно будет указать переменные для предоставления информации, необходимой для аутентификации вызова API в вашей среде:

  • environment_url:
    • Dynatrace SaaS: https://{your-environment-id}.live.ruscomtech.ru
    • Dynatrace Managed: https://{ваш-домен}/e/{идентификатор-вашей-среды}
  • paas_token
    • Токен PaaS вашей среды

     Например:

     class { 'oneagent':
         # Set environment variables
         paas_token => 'abcdefjhij1234567890',
         environment_url => 'https://your-environment.live.ruscomtech.ru',
         # (...)
       }

Дополнительные примеры см. в разделе Примеры.

Вариант 2. Используйте локальные установщики

Используйте веб-интерфейс Dynatrace для загрузки необходимых файлов установщика OneAgent, а затем загрузите их в соответствующую точку подключения на узле сервера. Затем модуль Puppet загрузит установщики с сервера Puppet на узлы агента Puppet.

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

Например:

class { 'oneagent':
     # Set environment variables
     local_installer => mounting_point/path/of/oneagent-linux-installer.sh
     # (...)
   }

Обратите внимание, что для Windows, Linux и AIX требуются специальные программы установки. Исходные имена установщиков, загруженные с Dynatrace, включают обозначения целевых платформ. Если вы меняете имена установщиков, убедитесь, что модуль может их различать.

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

Переменные

Модуль Puppet OneAgent поддерживает следующие переменные:

Название Значение по умолчанию Описание
environment_url unset URL целевой среды Dynatrace (SaaS или Managed).
paas_token unset Токен PaaS, полученный со страницы установщика Развернуть Dynatrace.
local_installer unset Путь к установщику OneAgent в настроенной точке подключения.
installer_arch unset Архитектура установщика OneAgent
version latest Требуемая версия OneAgent в виде 1.199.247.20200714-111723. Дополнительные сведения см. в разделе, как составить список доступных версий установщика OneAgent.
download_dir Linux/AIX: $TEMP or /tmp

Windows: %TEMP% or C:\Windows\Temp

Каталог загрузки установщика. Каталог должен быть доступен модулю. Для Linux и AIX каталог не должен содержать пробелов.
install_args unset Параметры установки Dynatrace OneAgent, определенные в виде списка элементов.
platform_install_args unset Дополнительный список параметров установки для конкретной платформы, добавляемый к `install_args' при запуске на соответствующей платформе.
preserve_installer false Возможность сохранить установщик на узле агента Puppet после развертывания.
package_state present Желаемое состояние пакета OneAgent. Укажите present (текущую) или latest (последнюю) версию для установки. Укажите absent для удаления.
validate_certs true Возможность требовать сертификаты. Если установлено значение false, позволяет загружать OneAgent с сервера с небезопасным SSL-сертификатом (истекшим сроком действия, самоподписанным и т. д.).
proxy_server unset Прокси-сервер, который будет использоваться для загрузки установщика OneAgent.

Логирование

По умолчанию 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
(...)

Расположение файла конфигурации зависит от операционной системы:

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

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

Примеры

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

  • Загружает установщик OneAgent определенной версии (version) и сохраняет его в пользовательском каталоге (download_dir).
  • Указывает модулю развернуть OneAgent на хостах Linux и Windows с заданной конфигурацией.
  • Указывает модулю использовать архитектуру установщика ppcle.
  • Использует install_args для передачи параметров установки OneAgent, которые назначают хосты группе хостов My.HostGroup_123-456 и сетевой зоне my.network.zone.
# Download OneAgent installer in specific version to a custom 
# directory with additional OneAgent install parameters
$env_url = 'https://abc12345.live.ruscomtech.ru'
$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:\\Dynatrace', '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/Dynatrace', 'USER=linux_user' ],
    download_dir => '/tmp',
    version => $version,
    installer_arch => 'ppcle'
  }
}

Вы можете найти больше примеров манифестов в каталоге примеров. Каталог содержит следующие манифесты:

  • local_installer.yml — установка OneAgent с помощью локальной программы установки.
  • advanced_config.yml — установка OneAgent с пользовательским путем установки и каталогом загрузки.
  • oneagentctl_config.yml — конфигурация OneAgent с помощью команды oneagentctl.

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