Cloud Assembly デザインに SaltStack Config リソースを追加する方法

SaltStack Config を vRealize Automation と統合した場合は、展開内の仮想マシンにミニオンをインストールするときに SaltStack Config リソースを適用できます。ミニオンを展開した後は、SaltStack Config の強力な構成管理、ドリフト修正、状態管理の各機能を使用してリソースを管理できます。

ミニオンとは、Salt ミニオンサービスを実行するエージェントです。このサービスは、Salt マスターサービスを実行するサーバである Salt マスターによって公開されたジョブをサブスクライブします。ミニオンに特定のジョブが適用されると、ミニオンがジョブを実行します。

Linux および Windows マシンを展開するときに、SaltStack Config リソースを使用してミニオンを展開し、状態ファイルを適用することができます。既存の展開でミニオンおよび状態ファイルを追加または更新するには、[SaltStack リソースの接続] Day 2 アクションを実行します。Day 2 アクションの詳細については、Cloud Assembly 環境で実行できるアクションを参照してください。

saltConfiguration プロパティを使用してミニオンおよび状態ファイルを Day 0 アクションとして展開する場合は、SaltStack Config リソースを使用するようにクラウドテンプレートを更新することを検討してください。saltConfiguration プロパティは廃止されました。クラウドテンプレートの saltConfiguration プロパティは引き続き使用できますが、SaltStack Config 統合機能は制限されます。

[Salt 構成の適用] Day 2 アクションは、saltConfiguration プロパティを使用するリソースで引き続き使用できます。

開始する前に

SaltStack Config をインストール済みで、統合が構成されていることを確認します。vRealize Automation での SaltStack Config 統合の作成を参照してください。
ミニオンの主要な概念など、SaltStack Config の仕組みを理解するには、SaltStack ユーザーインターフェイスについてを参照してください。
SaltStack Config で、ミニオンからマスターへの FQDN の名前解決が機能していることを確認します。
1. SaltStack Config で Salt マスターの FQDN を確認するには、[ミニオン] > [すべてのミニオン] の順に選択します。
2. [ミニオン ID] 列を値 [saltmaster] でフィルタリングします。
3. 詳細を表示するには、[saltmaster] をクリックします。
4. FQDN の値が正しいことを確認します。
Linux マシンにミニオンを展開する場合は、Salt ミニオンを使用して展開する vSphere 内のイメージで SSH 機能が有効になっていることを確認します。SSH は、リモートからマシンにアクセスし、ミニオンを展開するために使用されます。
Windows マシンにミニオンを展開する場合は、Windows 環境で API (RaaS) を使用してミニオンを展開する方法を参照してください。
展開するマシンに IP アドレスを割り当てることができることを確認します。
SaltStack Config では、マシンに IP アドレスが必要です。Salt マスターが配置されている SDDC (Software-Defined Datacenter) のパブリック IP CIDR 範囲内の IP アドレスを使用します。
SaltStack Config リソースプロパティを追加する前に、ミニオンの追加先のクラウドテンプレートが展開可能であることを確認します。
次のサービスロールがあることを確認します。
1. Cloud Assembly 管理者
2. Cloud Assembly ユーザー
3. Service Broker 管理者
SaltStack Config リソースを使用するには、これらのサービスロールが必要です。

クラウドテンプレートへの SaltStack Config リソースの追加

クラウドテンプレート開発者は、テンプレートの展開時に SaltStack Config ミニオンをインストールするプロパティを YAML に追加できます。

テンプレートに追加するコアプロパティには、展開するマシンへのリモートアクセスと、SaltStack Config リソースの構成プロパティが含まれます。この手順では、一部のプロパティのみを扱います。YAML には、この例で使用されていない他の SaltStack Config リソースプロパティが含まれています。詳細については、スキーマを確認してください。

この例では、リモートアクセスのプロパティにユーザー名とパスワードを追加する方法を示していますが、シークレットプロパティを構成して、テンプレートにそのプロパティを追加することもできます。例については、Cloud Assembly のシークレットプロパティを参照してください。

手順

Cloud Assembly で、[デザイン] > [クラウドテンプレート] の順に選択します。
既存のテンプレートを開きます。
[SaltStack Config] リソースを見つけて、キャンバスにドラッグします。
ミニオンをインストールするマシンに、[SaltStack Config] リソースを接続します。

コードペインで、Cloud_SaltStack_1 リソースにプロパティを追加します。

使用可能なすべてのプロパティを含める必要はありません。この例で使用している値については、表で説明しています。

Cloud_SaltStack_1:
    type: Cloud.SaltStack
    properties:
      masterId: saltstack_enterprise_installer
      hosts:
        - ${resource.Cloud_vSphere_Machine_1.id}
      saltEnvironment: sse
      stateFiles:
        - /doe.sls
      variables: 
        user: joe

この例で使用されている Cloud_SaltStack_1 プロパティの説明。

プロパティ	説明
masterId	この例のスキーマでは、`masterId` 値は `saltstack_enterprise_installer` です。SaltStack Config の [管理] > [マスターキー] で、マスター ID を定義してある場合があります。
ホスト	`hosts` 値は、ミニオンのインストール先となるマシンまたはマシンクラスタの ID です。SaltStack Config のデフォルトでは、マシンの名前がミニオン ID として渡されます。 Windows にミニオンを展開する場合は特に、マシン名を 15 文字以下にすることを推奨します。Windows では、15 文字を超えるホスト名は許可されません。展開するマシンに対してカスタム命名規則を定義する場合は、Cloud Assembly に展開されたリソースのカスタム命名を参照してください。
saltEnvironment	この例では、`sse` が状態ファイルの配置場所です。SaltStack Config の [構成] > [ファイルサーバ] により、状態ファイルを他のファイルサーバに置くこともできます。
stateFiles	この例で、`doe.sls` は、saltEnvironment で指定されるファイルサーバディレクトリに格納される状態ファイルです。
variables	変数は、状態ファイルで使用される値です。この例では、`doe.sls` は `user` 値を受け入れます。

Salt ミニオンをホストするマシンに、remoteAccess プロパティを追加します。
authentication キーの値は、usernamePassword または generatedPublicPrivateKey にする必要があります。publicPrivateKey はサポートされていません。
```
 remoteAccess:
        authentication: usernamePassword
        username: adminUser
        password: adminPassword
```

YAML に次のサンプルのようなプロパティが含まれていることを確認します。

resources:
  Cloud_vSphere_Machine_1:
    type: Cloud.vSphere.Machine
    properties:
      image: ubuntu
      flavor: small
      remoteAccess:
        authentication: usernamePassword
        username: adminUser
        password: adminPassword
  Cloud_SaltStack_1:
    type: Cloud.SaltStack
    properties:
      masterId: saltstack_enterprise_installer
      hosts:
        - ${resource.Cloud_vSphere_Machine_1.id}
      saltEnvironment: sse
      stateFiles:
        - /doe.sls
      variables: 
        user: joe

クラウドテンプレートをテストして展開します。
ミニオンの展開が失敗する場合は、ミニオンの展開のトラブルシューティングを参照してください。
展開されたマシンの Salt 構成プロパティを確認します。
1. [展開] > [展開] の順に選択して、展開の詳細を開きます。
2. [トポロジ] タブでマシンをクリックし、右側のペインでプロパティを展開します。

SaltStack Config でのミニオンの確認

仮想マシンにミニオンをインストールしたら、ミニオンを特定し、リソースに対してジョブまたはコマンドを実行します。

手順

SaltStack Config を開くには、右上隅にあるアプリケーションメニューをクリックし、[Cloud Services コンソール] をクリックします。
[SaltStack Config] サービスタイルをクリックします。
SaltStack Config で、[ミニオンキー] を展開し、[受け入れ済み] をクリックします。
[ミニオン ID] 列で、フィルタアイコンをクリックし、ミニオンの名前を入力します。
デフォルトでは、ミニオンの名前は仮想マシンのホスト名になります。この例では、ミニオン ID は vra-vm-05 です。
詳細を表示するには、ミニオンの名前をクリックします。
ミニオンに対してジョブまたはコマンドを実行できます。たとえば、[ディスク使用率のサンプル] などです。このジョブは、ミニオンのディスク使用率の統計を返します。

ミニオンの展開のトラブルシューティング

SaltStack Config リソースまたは saltConfiguration プロパティを使用して Salt ミニオンを展開するときにユーザーに発生する一般的なエラーについて確認します。

ホストの起動の遅延

クラウドテンプレートを展開した後でホスト上の Windows または Linux のサービスの準備ができていない場合、Cloud Assembly に「ミニオンの展開または状態ファイルの実行に失敗しました」というエラーが表示されることがあります。

このエラーを解決するには、マスタープラグインを最新の安定バージョンにアップグレードします。アップグレード後、Salt ミニオンを展開する前に Windows および Linux のサービスが有効になる構成設定を /etc/salt/master.d/raas.conf で有効にできます。

マスタープラグインの最新バージョンにアップグレードした後、次の手順を実行してホストの起動を遅らせます。

展開の詳細ページで [履歴] タブを確認します。
「ミニオンの展開または状態ファイルの実行に失敗しました」というエラーメッセージが表示された場合は、ジョブ ID (JID) をコピーし、SaltStack Config を開きます。
SaltStack Config で、[アクティビティ] > [完了] の順に選択して、完了したジョブを開きます。
[JID] 列でフィルタアイコンをクリックし、JID を入力します。
JID をクリックして、ジョブの結果ページを確認します。
[未フォーマット] タブをクリックすると、ジョブの未フォーマット出力が表示されます。
Windows
ジョブの未フォーマット出力の最後の行に「ホストに接続できませんでした: タイムアウト」が含まれている場合は、起動を 180 秒遅らせるために、次の構成設定を /etc/salt/master.d/raas.conf に追加する必要があります。
```
sseapi_win_minion_deploy_delay: 180
```
Linux
ジョブの未フォーマット出力の最後の行に「指定された認証情報を使用してリモートホストに接続できません」が含まれている場合は、起動を 90 秒遅らせるために、次の構成設定を /etc/salt/master.d/raas.conf に追加する必要があります。
```
sseapi_linux_minion_deploy_delay: 90
```
Salt マスターサービスの再起動：
```
systemctl restart salt-master
```
クラウドテンプレートを再展開します。
展開が成功しなかった場合は、遅延パラメータの値を大きくしてテンプレートを再展開することができます。

次の手順

SaltStack Config 機能を使用してリソースを管理するには、SaltStack Config のドキュメントを参照してください。