自動化コンテンツの開発

手順

1. VS Code でプロジェクトディレクトリーに移動します。
2. VS Code アクティビティーバーの Ansible アイコンをクリックして、Ansible 拡張機能を開きます。
3. Ansible 拡張機能の Ansible Development Tools セクションで、ADD オプションまでスクロールダウンし、Devcontainer を選択します。

4. Create a devcontainer ページで、Container image オプションから Downstream コンテナーイメージを選択します。

   このアクションにより、Podman と Docker の両方の devcontainer.json ファイルが .devcontainer ディレクトリーに追加されます。

5. プロジェクトディレクトリーを再度開くか、リロードします。

   • VS Code がディレクトリーに devcontainer.json ファイルが含まれていることを検出すると、以下の通知が表示されます。

     

     View larger image

     

     Reopen in Container をクリックします。

   • 通知が表示されない場合は、Remote ( ) アイコンをクリックします。表示されるドロップダウンメニューで、Reopen in Container を選択します。

6. 使用しているコンテナー化プラットフォームに応じて、Podman または Docker の開発コンテナーを選択します。

   VS Code ステータスバーの Remote() ステータスに opening Remote が表示され、通知にコンテナーを開く操作の進行状況が示されます。

手順

1. 次のコマンドを実行して、Simple Content Access (SCA) が有効化されているか確認します。

   $ sudo subscription-manager status

   Copy to Clipboard Toggle word wrap

   Simple Content Access が有効化されている場合、出力には次のメッセージが含まれます。

   Content Access Mode is set to Simple Content Access.

   Copy to Clipboard Toggle word wrap

   1. Simple Content Access が有効化されていない場合は、Red Hat Ansible Automation Platform SKU をアタッチします。

      $ sudo subscription-manager attach --pool=<sku-pool-id>

      Copy to Clipboard Toggle word wrap

2. 次のコマンドで Ansible 開発ツールをインストールします。

   $ sudo dnf install --enablerepo=ansible-automation-platform-2.5-for-rhel-8-x86_64-rpms ansible-dev-tools

   Copy to Clipboard Toggle word wrap

   $ sudo dnf install --enablerepo=ansible-automation-platform-2.5-for-rhel-9-x86_64-rpms ansible-dev-tools

   Copy to Clipboard Toggle word wrap

手順

1. VS Code で Playbook 用の新しい .yml ファイル (例: example_playbook.yml) を作成します。それを、サンプルの site.yml ファイルと同じディレクトリーレベルに配置します。

2. 次のサンプルコードを Playbook ファイルに追加し、ファイルを保存します。Playbook は、ローカルマシンへの ping を実行する単一のプレイで構成されます。

   ---
   - name: My first play
     hosts: localhost
     tasks:
       - name: Ping my hosts
         ansible.builtin.ping:

   Copy to Clipboard Toggle word wrap

   Ansible-lint は、バックグラウンドで実行され、ターミナルの Problems タブにエラーが表示されます。この Playbook にはエラーはありません。

   

   View larger image

   

3. Playbook に新しいコンテンツを追加する場合は、次のルールを使用します。

   • すべての Playbook ファイルは、空白行で終わる必要があります。
   • 行末の末尾にスペースを入れることはできません。
   • すべての Playbook とすべてのプレイには識別子 (名前) が必要です。
4. Playbook ファイルを保存します。

1. VS Code で Playbook を開きます。

2. キーワードまたはモジュール名の上にマウスを移動すると、Ansible 拡張機能によってドキュメントが表示されます。

   

   View larger image

   

3. モジュールの名前 (ansible.builtin.ping など) を入力し始めると、拡張機能によって候補のリストが表示されます。

   いずれかの候補を選択すると、行が自動補完されます。

   

   View larger image

   

1. 次の Playbook には複数のエラーが含まれています。これをコピーして、VS Code の新しいファイルに貼り付けます。

   - name:
     hosts: localhost
     tasks:
      - name:
        ansible.builtin.ping:

   Copy to Clipboard Toggle word wrap

   エラーは VS Code で波線の下線で示されます。

2. エラーの上にマウスをかざすと、詳細が表示されます。

   

   View larger image

   
3. エラーを含む Playbook ファイルが、Explorer ペインに番号で示されます。

4. VS Code ターミナルの Problems タブを選択して、エラーのリストを表示します。

   

   View larger image

   

   $[0].tasks[0].name None is not of type 'string' は、Playbook にラベルがないことを示します。

手順

1. プロジェクトディレクトリーを Git リポジトリーとして初期化します。
2. プロジェクトを GitHub などのソース管理システムにプッシュします。

手順

1. ブラウザーで、Automation Controller にログインします。
2. 必要に応じて、ソース管理システムの Source Control 認証情報タイプを設定します。詳細は、自動化実行の使用 の 新しい認証情報の作成 セクションを参照してください。https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_execution/controller-credentials#controller-create-credential
3. Automation Controller で、Playbook プロジェクトを保存した GitHub リポジトリーのプロジェクトを作成します。自動化実行の使用 の プロジェクト の章を参照してください。
4. 作成したプロジェクトの Playbook を使用するジョブテンプレートを作成します。自動化実行の使用 の ジョブテンプレート の章を参照してください。
5. ジョブテンプレートを起動することで、Automation Controller から Playbook を実行します。自動化実行の使用 の ジョブテンプレートの起動 セクションを参照してください。

手順

1. VS Code を開きます。
2. ロールのコレクションを作成するディレクトリーに移動します。
3. VS Code アクティビティーバーの Ansible アイコンをクリックして、Ansible 拡張機能を開きます。

4. Ansible content creator セクションで Get started を選択します。

   Ansible content creator タブが開きます。

5. Create セクションで、Ansible collection project をクリックします。

   Create new Ansible project タブが開きます。

6. Create Ansible project タブのフォームに、以下を入力します。

   • Namespace: 名前空間の名前を入力します (例: company_namespace)。
   • Collection: コレクションの名前を入力します (例: myapp_network)。

   • Init path: 新しいコレクションをスキャフォールディングするディレクトリーへのパスを入力します。

     既存のディレクトリー名を入力すると、スキャフォールディングプロセスによってそのディレクトリーの内容が上書きされます。スキャフォールディングプロセスでは、Force オプションを有効にした場合にのみ、既存のディレクトリーを使用できます。

     • コンテナー化されたバージョンの Ansible 開発ツールを使用している場合、宛先ディレクトリーのパスは、コンテナーを基準とした相対パスであり、ローカルシステム内のパスではありません。コンテナー内の現在のディレクトリー名を確認するには、VS Code のターミナルで pwd コマンドを実行します。コンテナー内のカレントディレクトリーが workspaces の場合は、workspaces/<current_project>/collections と入力します。
     • ローカルにインストールされたバージョンの Ansible Dev ツールを使用している場合は、ディレクトリーへのフルパスを入力します (例: /user/<username>/path/to/<collection_directory>)。
7. Create をクリックします。

手順

1. 必要に応じて、ロールを含むディレクトリーの名前を、その中身に合わせて変更します (例: acl_config や tacacs)。

   コレクション内のロールの名前にハイフンを含めることはできません。代わりにアンダースコア文字 (_) を使用してください。

2. スタンドアロンロールの roles ディレクトリーを、コレクション内の roles/ ディレクトリーにコピーします。

   たとえば、myapp_network というコレクションの場合は、myapp_network/roles/ ディレクトリーにロールを追加します。

3. スタンドアロンロールのすべてのプラグインを、新しいコレクションの plugins directory/ にコピーします。コレクションのディレクトリー構造は次のようになります。

   company_namespace
   └── myapp_network
       ├── ...
       ├── galaxy.yml
       ├── docs
       ├── extensions
       ├── meta
       ├── plugins
       ├── roles
       │   ├── acl_config
       │   │   ├── README.md
       │   │   ├── defaults
       │   │   ├── files
       │   │   ├── handlers
       │   │   ├── meta
       │   │   ├── tasks
       │   │   ├── templates
       │   │   ├── tests
       │   │   └── vars
       │   └── tacacs
       │       ├── README.md
       │       ├── default
       │       ├── files
       │       ├── handlers
       │       ├── meta
       │       ├── tasks
       │       ├── templates
       │       ├── tests
       │       └── vars
       │   ├── run
       ├── ...
       ├── tests
       └── vars

   Copy to Clipboard Toggle word wrap

   run ロールは、コレクションをスキャフォールディングするときに作成されるデフォルトのロールディレクトリーです。

4. コレクション内の新しいロールの完全修飾コレクション名 (FQCN) を使用するように Playbook を更新します。

   注記

   すべてのスタンドアロンロールが、コードの変更なしで、コレクションにシームレスに統合されるわけではありません。たとえば、プラグインを含む Galaxy のサードパーティーのスタンドアロンロールが module_utils/ ディレクトリーを使用する場合、そのプラグイン自体にインポートステートメントを追加します。

手順

1. 新しいロールを作成するには、コレクションを作成したときにスキャフォールディングされたデフォルトの run ロールディレクトリーをコピーします。
2. ロールが実行する必要があるタスクを、tasks/main.yml ファイルで定義します。既存の Playbook 内のタスクを再利用するためのロールを作成する場合は、Playbook YAML ファイルの tasks ブロック内の内容をコピーします。tasks の左側の空白を削除します。VS Code で ansible-lint を使用して YAML コードをチェックします。
3. ロールが別のロールに依存している場合は、meta/main.yml ファイルに依存関係を追加します。

1. ロールのドキュメントを追加するために、ロールディレクトリーに移動します。
2. README.md ファイルをエディターで開きます。このファイルは、コレクションのディレクトリーをスキャフォールディングしたときに、ロールディレクトリーに追加されたものです。

3. コレクション内の各ロールの README.md ファイルに、次の情報を記載します。

   • ロールの説明: ロールの機能の簡単な概要
   • 要件: コレクション、ライブラリー、および必要なインストールのリスト
   • 依存関係

   • ロール変数: ロールが使用する変数に関する次の情報を記載します。

     • 説明
     • デフォルト
     • 値の例
     • 必須の変数

   • Playbook の例: ロールを使用する Playbook の例を示します。Playbook 内のコメントを使用して、ユーザーが変数を設定する箇所がわかるようにします。

     controller_configuration.ad_hoc_command_cancel の README.md ファイルは、標準ドキュメントを含むロールの例です。

4. ロールコレクションのドキュメントを追加するために、コレクションのディレクトリーに移動します。

5. コレクションの README.md ファイルに次の情報を記載します。

   • コレクションの説明: コレクションの機能を説明します。
   • 要件: 必要なコレクションのリストを記載します。
   • コレクションのコンポーネントであるロールのリストを記載します。
   • コレクションの使用: コレクションのコンポーネントを実行する方法を説明します。
   • トラブルシューティングのセクションを追加します。
   • バージョン管理: コレクションのリリースサイクルを説明します。

1. 前提条件

   • コレクションを tarball にパッケージ化します。コレクションのファイル名の形式は次のとおりです。

手順

1. Private Automation Hub でコレクションの名前空間を作成します。自動化コンテンツの管理 ガイドの 名前空間の作成 を参照してください。
2. オプション: 名前空間に情報を追加します。自動化コンテンツの管理 ガイドの 名前空間への情報およびリソースの追加 を参照してください。
3. ロールコレクションの tarball を名前空間にアップロードします。自動化コンテンツの管理 ガイドの 名前空間へのコレクションのアップロード を参照してください。
4. コレクションを内部公開のために承認します。自動化コンテンツの管理 ガイドの 名前空間へのコレクションのアップロード を参照してください。