This article instructs on how to create a Breeze Agent Deployment via AWS Systems Manager Distributor.
Description
The user creates a package with Breeze Agent. The distributor publishes this package to System Manager managed instances. Then the agent can be installed or uninstalled:
one time by using AWS Systems Manager Run Command
on a schedule by using AWS Systems Manager State Manager
Prerequisites
The distributor package consists of a manifest and two .zip
archive files for Windows and Linux platforms. Each archive contains install and uninstall scripts, as well as Breeze Agent distro respectively to the platform. The manifest template and scripts can be obtained from Github repository.
In the file manifest.json
find the field "version"
and change its value to something meaningful. This is also the value of Version name that should be specified when the package will be added to the Distributor (it becomes part of the AWS Systems Manager document). A version value can contain letters, numbers, underscores, hyphens, and periods, and be from 3 to 128 characters in length. It is recommended to use a human-readable value.
Preparing Package Files
A Linux archive named breeze-agent-linux.zip
should contain next files: install.sh
, uninstall.sh
and agent.XXX.YY.Z.x86_64.linux.tgz
(the Linux Breeze Agent distro as it was downloaded from CMDB).
A Windows archive named breeze-agent-windows.zip
should contain such files as: install.ps1
, uninstall.ps1
and agent.XXX.YY.Z.windows.signed.exe
(the Windows Breeze Agent distro as it was downloaded from CMDB).
Ensure that the script files have the correct lines breaks, namely LF
(\n
== 0x0A
) on Linux and CRLF
(\r\n
== 0x0D 0x0A
) on Windows.
For each archive file mentioned in the manifest should be specified a sha256
checksum. In order to calculate it, the following commands can be used:
Linux:
shasum -a 256 file-name.zip
oropenssl dgst -sha256 file-name.zip
Windows:
Get-FileHash -Path file-name.zip
(PowerShell)
In the manifest.json
find the section "files"
and replace ARCHIVE_CHECKSUM
placeholders with the calculated checksums.
Distributor Package
In the AWS Systems Manager create an Advanced
package as described in AWS documentation.