Systems Manager Distributor を活用してソフトウェア配布を行う！

園部治

2019.05.15

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

園部です。

Systems Manager Distributor 利用されていますでしょうか？
コチラの機能は2018年11月にリリースされた機能となります。

今まで、しっかり試す機会がなかったのですが、先日コチラ（ Packaging to Distribution – Using AWS Systems Manager Distributor to deploy Datadog ）で紹介されているのを拝見して改めてやってみました。

Systems Manager Distributor とは？

公式サイトより一部抜粋した内容は以下の通りです。

AWS Systems Manager は、ソフトウェアエージェントなどのソフトウェアパッケージを安全に配信およびインストールするのに役立ちます。
Systems Manager Distributor を使用すると、ソフトウェアパッケージを一元的に保存し、システムで配信しながら、バージョニング管理することができます。

ソフトウェアパッケージを作成および配信するにはディストリビューター、ソフトウェアパッケージをインストールするには Systems Manager の Run Command とステートマネージャーを使用します。

（引用： https://aws.amazon.com/jp/systems-manager/features/ ）

やってみた

ベースとしては、上記で紹介されているブログを踏襲した内容となります。

テストケース

管理組織（アカウントA）と利用組織（アカウントB）を分けて、管理組織で組織標準バージョン（パッケージ）を登録し、利用組織（アカウントB）ではそちらを利用しインストールを行います。

現場での大量（複数OS）対象に対するインストール作業も想定し、いくつかのOSを用意してインストールを実行します。

公式ドキュメントでも、「Distributor はどのようなユーザーに適していますか?」 にてユースケースが紹介されています。

• 一度に複数の AWS Systems Manager マネージドインスタンスに対して、AWS で公開されたパッケージを含む既存のソフトウェアパッケージを新規作成またはデプロイしたい AWS のお客様。
• ソフトウェアパッケージを作成するソフトウェア開発者。
• AWS Systems Manager のマネージドインスタンスを最新のソフトウェアパッケージで最新の状態に保つ責任がある管理者。

（引用： https://docs.aws.amazon.com/ja_jp/systems-manager/latest/userguide/what-is-distributor.html#distributor-who ）

テスト環境

必要なモノ
- AWS アカウント x2（今回テストケースでは2つですが、1つでも3つ以上でも可能です）
- Datadog アカウント（APIKEYが必要なため）
アカウント
- アカウントA：ソフトウェア（Datadog）を管理するアカウント
- アカウントB：ソフトウェアがインストールされるインスタンスを保有するアカウント
利用するAWSサービス
- S3（アカウントA）
- Systems Manager Distributor（アカウントA）
- EC2 インスタンス（アカウントB）
- Systems Manager Run Command（アカウントB）
- Systems Manager State Manager（アカウントB）
EC2 インスタンスの種類

OS AMI-ID

AmazonLinux 1 ami-00a5245b4816c38e6

AmazonLinux 2 ami-0f9ae750e8274075b

WindowsServer 2019 ami-0a39119ef6930f843

CentOS 7 ami-045f38c93733dd48d

OS	AMI-ID
AmazonLinux 1	ami-00a5245b4816c38e6
AmazonLinux 2	ami-0f9ae750e8274075b
WindowsServer 2019	ami-0a39119ef6930f843
CentOS 7	ami-045f38c93733dd48d

ソフトウェアをパッケージ化する（アカウントA）

ソフトウェアのダウンロード

各OSに対応する対象ソフトウェア（Datadog agent）をDatadogサイトからダウンロードします。

OS	ddagent
AmazonLinux 1	datadog-agent-6.11.1-1.x86_64.rpm
AmazonLinux 2	datadog-agent-6.11.1-1.x86_64.rpm
WindowsServer 2019	datadog-agent-6-latest.amd64.msi
CentOS 7	datadog-agent-6.11.1-1.x86_64.rpm

インストール用ファイル（install.sh / install.ps1）作成

Datadog アカウントからAPIKEYを取得

Datadog管理サイトへログイン >>> Integrations >>> APIs >>> API KEYS から取得（メモする）

AmazonLinux 1 < APIKEY > を先に取得したAPIKEYに置き換えます。

#!/bin/bash

sudo yum install -y datadog-agent-6.11.1-1.x86_64.rpm
sed 's/^[:space:]*api_key:.*/api_key: <APIKEY>/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml
sudo initctl start datadog-agent

AmazonLinux 2,CentOS < APIKEY > を先に取得したAPIKEYに置き換えます。

#!/bin/bash

sudo yum install datadog-agent-6.11.1-1.x86_64.rpm --assumeyes
sed 's/^[:space:]*api_key:.*/api_key: <APIKEY>/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml
sudo systemctl start datadog-agent

WindowsServer 2019 < APIKEY > を先に取得したAPIKEYに置き換えます。

msiexec /qn /i datadog-agent-6-latest.amd64.msi APIKEY="<APIKEY>" TAGS="Windows"

アンインストール用ファイル（uninstall.sh / uninstall.ps1）作成

AmazonLinux 1, AmazonLinux 2, CentOS

#!/bin/bash

sudo yum remove -y datadog-agent

WindowsServer 2019

(Get-WmiObject -Class Win32_Product -Filter "Name='Datadog Agent'").Uninstall()

zip化

各OSごとに、install.sh uninstall.sh インストーラーをzipで、１つのファイルにまとめます。
※ install.sh install.ps1 のファイル名は固定のようなので、各OS単位でリネームするなどしてzip化してください
例： AmazonAlinux1

$ zip datadog-al1_6-11.zip install.sh uninstall.sh datadog-agent-6.11.1-1.x86_64.rpm

sha256 ハッシュ値チェックサム取得

パッケージを登録する際に作成するマニフェストファイルで利用するため、zipファイル単位で、チェックサムを取得します。

$ sha256sum datadog-al1_6-11.zip
2b93f3c4cb5b4d348fa966dc1ff74f401e28bda21fecbecaca5465f83671da72  datadog-agent-6-11.zip

マニフェストファイル（manifest.json）の作成

Distributor では、各OSバージョンとファイルの関係をJSON形式で定義する必要があります。
方法として、以下の２通りがあります。

「パッケージから抽出」 ： manifest.json（ファイル名固定）として作成しS3へアップロードする
「新しいマニフェスト」 : パッケージ登録時にコンソール上で作成する

個人的には、管理の良さから「パッケージから抽出」をお勧めします。

今回はこのようなファイルを作成しました。

記述方法の詳細な説明は、公式ドキュメントをご確認ください。

{
    "schemaVersion": "2.0",
    "version": "6.11.0",
    "packages": {
        "windows": {
            "_any": {
                "x86_64": {
                    "file": "datadog-windows_6-11.zip"
                }
            }
        },
        "centos": {
            "_any": {
                "x86_64": {
                    "file": "datadog-al2_6-11.zip"
                }
            }
        },
        "amazon": {
            "2018.03": {
                "_any": {
                    "file": "datadog-al1_6-11.zip"
                }
            },
            "_any": {
                "x86_64": {
                    "file": "datadog-al2_6-11.zip"
                }
            }
        }
    },
    "files": {
        "datadog-windows_6-11.zip": {
            "checksums": {
                "sha256": "acd591e0940327bb7bedbff3f79fbaa14b154f0962b489530670ce795f8dbd13"
            }
        },
        "datadog-al1_6-11.zip": {
            "checksums": {
                "sha256": "430275340498a172fc9cf282eb565b7fe39c3ed87a9bef37ca1c24b6add5f1ed"
            }
        },
        "datadog-al2_6-11.zip": {
            "checksums": {
                "sha256": "5b20c4aed9347ad1aeb3d1b957c038f70ef009555fe676e88b1d3bd5787b781d"
            }
        }
    }
}