自動化コンテンツナビゲーターCreator ガイド
Ansible Automation Platform と互換性のあるコンテンツの開発
概要
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。
Red Hat ドキュメントへのフィードバック (英語のみ)
技術的な内容に関するフィードバックをお寄せいただきありがとうございます。皆様のご意見をお待ちしています。コメントの追加、Insights の提供、誤字の修正、および質問を行う必要がある場合は、ドキュメントで直接行うこともできます。
Red Hat アカウントがあり、カスタマーポータルにログインしている必要があります。
カスタマーポータルからドキュメントのフィードバックを送信するには、以下の手順を実施します。
- Multi-page HTML 形式を選択します。
- ドキュメントの右上にある Feedback ボタンをクリックします。
- フィードバックを提供するテキストのセクションを強調表示します。
- 強調表示されたテキストの横にある Add Feedback ダイアログをクリックします。
- ページの右側のテキストボックスにフィードバックを入力し、Submit をクリックします。
フィードバックを送信すると、自動的に問題の追跡が作成されます。Submit をクリックすると表示されるリンクを開き、問題の監視を開始するか、さらにコメントを追加します。
第1章 自動化コンテンツナビゲーターの概要
コンテンツ作成者は、自動化コンテンツナビゲーターを使用して、Red Hat Ansible Automation Platform と互換性のある Ansible Playbook、コレクション、およびロールを開発できます。以下の環境で自動化コンテンツナビゲーターを使用すると、すべての環境でシームレスかつ予測可能な結果が得られます。
- ローカルの開発マシン
- 自動化実行環境
また、自動化コンテンツナビゲーターは、Playbook の開発および問題領域のトラブルシューティングに役立つアーティファクトファイルも作成します。
1.2. 自動化コンテンツナビゲーターのモード
自動化コンテンツナビゲーターは 2 つのモードで動作します。
- 標準出力 (stdout) モード
- コマンドラインで既存の Ansible コマンドおよび拡張機能の大部分を受け入れます。
- テキストベースのユーザーインターフェイスモード
- Ansible コマンドに対する、インタラクティブなテキストベースのインターフェイスを提供します。このモードを使用して、コンテンツを評価し、Playbook を実行し、アーティファクトファイルを使用して実行した後に Playbook のトラブルシューティングを行います。
1.2.1. 標準出力 (stdout) モード
自動化コンテンツナビゲーターで -m stdout サブコマンドを使用して、自動化実行環境内やローカルの開発環境上で ansible-playbook などの一般的な Ansible コマンドを使用します。使い慣れたコマンドを使用して、素早くタスクを実行することができます。
また、このモードの自動化コンテンツナビゲーターには、広範にわたるヘルプが含まれています。
--help-
ansible-navigatorコマンドまたはサブコマンド (ansible-navigator config --helpなど) からアクセスできます。 - サブコマンドのヘルプ
-
サブコマンド (例:
ansible-navigator config --help-config) からアクセスできます。このヘルプには、関連する Ansible コマンドでサポートされているすべてのパラメーターの詳細が表示されます。
1.2.2. テキストベースのユーザーインターフェイスモード
テキストベースのユーザーインターフェイスモードは、自動化実行環境、コレクション、Playbook、およびインベントリーとの対話を強化します。このモードは、Visual Studio Code などの統合開発環境 (IDE) と互換性があります。
このモードには、便利なユーザーインターフェイスオプションが多数含まれています。
- コロンコマンド
-
:run、:collectionsなど、コロンを使用して、すべての自動化コンテンツナビゲーターコマンドにアクセスできます。 - テキストベースのインターフェイスの移動
-
この画面には、ページアップまたはページダウン、スクロール、前の画面へのエスケープ、または
:helpへのアクセス方法が表示されます。 - 行番号による出力
-
表示された出力の行番号の前にコロンを付ける (例:
:12) と、その行にアクセスできます。 - 色でコーディングされた出力
- 色を有効にすると、自動化コンテンツナビゲーターは非推奨のモジュールなどのアイテムを赤で表示します。
- ページネーションおよびスクロール
- 各自動化コンテンツナビゲーター画面の下部に表示されるオプションを使用して、ページを上下に移動したり、スクロールしたり、エスケープしたりできます。
自動化コンテンツナビゲーターの実行後は、モード間の切り替えができません。
本書では、ほとんどの手順でテキストベースのユーザーインターフェイスモードを使用します。
第2章 RHEL への自動コンテンツナビゲーターのインストール
コンテンツ作成者は、Red Hat Enterprise Linux (RHEL) 8.6 以降に、自動化コンテンツナビゲーターをインストールできます。
2.1. RPM からの RHEL への自動化コンテンツナビゲーターのインストール
RPM から、Red Hat Enterprise Linux (RHEL) に自動化コンテンツナビゲーターをインストールできます。
前提条件
- RHEL 8.6 以降をインストールしている。
- Red Hat Subscription Manager でシステムを登録している。
現在の Red Hat Ansible Automation Platform 環境に一致するナビゲーターのみをインストールしてください。
手順
Red Hat Ansible Automation Platform SKU を割り当てます。
$ subscription-manager attach --pool=<sku-pool-id>
次のコマンドを使用して、自動化コンテンツナビゲーターをインストールします。
v.2.4 for RHEL 8 for x86_64
$ sudo dnf install --enablerepo=ansible-automation-platform-2.4-for-rhel-8-x86_64-rpms ansible-navigator
v.2.4 for RHEL 9 for x86-64
$ sudo dnf install --enablerepo=ansible-automation-platform-2.4-for-rhel-9-x86_64-rpms ansible-navigator
検証
自動化コンテンツナビゲーターのインストールを確認します。
$ ansible-navigator --help
以下の例は、インストールの成功を示しています。
第3章 自動化コンテンツナビゲーターを使用した自動化実行環境の確認
コンテンツ開発者は、自動化コンテンツナビゲーターで自動化実行環境を確認し、自動化実行環境に含まれるパッケージとコレクションを表示できます。自動化コンテンツナビゲーターは Playbook を実行して結果を抽出し、表示します。
3.1. 自動化コンテンツナビゲーターからの自動化実行環境の確認
自動化コンテンツナビゲーターのテキストベースのユーザーインターフェイスを使用して、自動化実行環境を確認できます。
前提条件
- 自動化実行環境
手順
自動化コンテンツナビゲーター設定に含まれる自動化実行環境を確認します。
$ ansible-navigator images
詳細を確認する自動化実行環境の番号を入力します。
インストールされている各自動化実行環境のパッケージおよびバージョン、ならびに Ansible バージョンに含まれるコレクションを確認できます。
オプション: 使用する自動化実行環境を渡します。これはプライマリーであり、自動化コンテンツナビゲーターが使用する自動化実行環境です。
$ ansible-navigator images --eei registry.example.com/example-enterprise-ee:latest
検証
自動化実行環境の出力を確認します。
第5章 自動化コンテンツナビゲーターを使用したコレクションを参照
コンテンツ作成者は、自動化コンテンツナビゲーターで Ansible コレクションを参照し、ローカルまたは自動化実行環境で開発した各コレクションをインタラクティブに調べることができます。
5.1. 自動化コンテンツナビゲーターコレクションの表示
自動化コンテンツナビゲーターは、各コレクションに以下の詳細を含むコレクションに関する情報を表示します。
- SHADOWED
- コレクションの追加コピーが検索順序の上位にあり、Playbook がそのコレクションを優先することを示します。
- TYPE
-
コレクションが自動化実行環境にマウントされている自動化実行環境またはボリュームに
bind_mountとして含まれるかどうかを示します。 - PATH
- コレクション TYPE フィールドに基づいて、自動化実行環境またはローカルファイルシステム内のコレクションの場所を反映します。
5.2. 自動化コンテンツナビゲーターからのコレクションの参照
インタラクティブモードの自動化コンテンツナビゲーターのテキストベースのユーザーインターフェイスを使用して Ansible コレクションを参照し、各コレクションを詳しく調べることができます。自動化コンテンツナビゲーターは、現在のプロジェクトディレクトリー内のコレクションと自動化実行環境で利用可能なコレクションを表示します。
前提条件
- ローカルでアクセス可能なコレクションまたはインストールされた自動化実行環境。
手順
自動化コンテンツナビゲーターを起動します。
$ ansible-navigator
コレクションを参照します。または、
ansible-navigator collectionsと入力してコレクションを直接参照することもできます。$ :collections
確認するコレクションの数を入力します。
:4
調べるモジュールに対応する番号を入力します。
ANSIBLE.UTILS.IP_ADDRESS: Test if something in an IP address 0│--- 1│additional_information: {} 2│collection_info: 3│ authors: 4│ - Ansible Community 5│ dependencies: {} 6│ description: Ansible Collection with utilities to ease the management, manipulation, 7│ and validation of data within a playbook 8│ documentation: null 9│ homepage: null 10│ issues: null 11│ license: [] 12│ license_file: LICENSE 13│ name: ansible.utils 14│ namespace: ansible 15│ path:/usr/share/ansible/collections/ansible_collections/ansible/utils/ 16│ readme: README.md <... output truncated...>オプション: このモジュールのドキュメントの例に移動します。
:{{ examples }} 0│ 1│ 2│#### Simple examples 3│ 4│- name: Check if 10.1.1.1 is a valid IP address 5│ ansible.builtin.set_fact: 6│ data: "{{ '10.1.1.1' is ansible.utils.ip_address }}" 7│ 8│# TASK [Check if 10.1.1.1 is a valid IP address] ********************* 9│# ok: [localhost] => { 10│# "ansible_facts": { 11│# "data": true 12│# }, 13│# "changed": false 14│# } 15│オプション: エディターでサンプルを開き、それを Playbook にコピーします。
:open
検証
コレクション一覧を参照します。
5.3. 自動化コンテンツナビゲーターのドキュメントの確認
対話モードで自動化コンテンツナビゲーターのテキストベースのユーザーインターフェイスを使用して、コレクションおよびプラグインの Ansible ドキュメントを確認できます。自動化コンテンツナビゲーターは、現在のプロジェクトディレクトリー内のコレクションと自動化実行環境で利用可能なコレクションを表示します。
前提条件
- ローカルでアクセス可能なコレクションまたはインストールされた自動化実行環境。
手順
自動化コンテンツナビゲーターを起動します。
$ ansible-navigator
対象のモジュールを確認します。または、
ansible-navigator docと入力してドキュメントにアクセスすることもできます。:doc ansible.utils.ip_address
ANSIBLE.UTILS.IP_ADDRESS: Test if something in an IP address 0│--- 1│additional_information: {} 2│collection_info: 3│ authors: 4│ - Ansible Community 5│ dependencies: {} 6│ description: Ansible Collection with utilities to ease the management, manipulation, 7│ and validation of data within a playbook 8│ documentation: null 9│ homepage: null 10│ issues: null 11│ license: [] 12│ license_file: LICENSE 13│ name: ansible.utils 14│ namespace: ansible 15│ path:/usr/share/ansible/collections/ansible_collections/ansible/utils/ 16│ readme: README.md <... output truncated...>このモジュールのドキュメント例に移動します。
:{{ examples }} 0│ 1│ 2│#### Simple examples 3│ 4│- name: Check if 10.1.1.1 is a valid IP address 5│ ansible.builtin.set_fact: 6│ data: "{{ '10.1.1.1' is ansible.utils.ip_address }}" 7│ 8│# TASK [Check if 10.1.1.1 is a valid IP address] ********************* 9│# ok: [localhost] => { 10│# "ansible_facts": { 11│# "data": true 12│# }, 13│# "changed": false 14│# } 15│オプション: エディターでサンプルを開き、それを Playbook にコピーします。
:open
エディターのセットアップ方法の詳細は、自動化コンテンツナビゲーターの一般設定 を参照してください。
第6章 自動化コンテンツナビゲーターを使用した Ansible Playbook の実行
コンテンツ作成者は、自動化コンテンツナビゲーターを使用して Ansible Playbook を実行し、各プレイとタスクの結果をインタラクティブに調べて、Playbook を検証またはトラブルシューティングできます。また、実行環境内で Ansible Playbook を実行すれば、実行環境がなくても、問題を比較してトラブルシューティングできます。
6.1. 自動化コンテンツナビゲーターからの Playbook の実行
自動化ナビゲーターのテキストベースのユーザーインターフェイスで Ansible Playbook を実行して、タスクの実行を追跡し、各タスクの結果を詳しく調べることができます。
前提条件
- Playbook
-
localhostまたは inventory プラグインを使用しない場合は有効なインベントリーファイル。
手順
自動化コンテンツナビゲーターを起動します。
$ ansible-navigator
Playbook を実行します。
$ :run
-
オプション:
ansible-navigator run simple-playbook.yml -i inventory.ymlを入力して Playbook を実行します。 インベントリーおよびその他のコマンドラインパラメーターを確認または追加します。
INVENTORY OR PLAYBOOK NOT FOUND, PLEASE CONFIRM THE FOLLOWING ───────────────────────────────────────────────────────────────────────── Path to playbook: /home/ansible-navigator_demo/simple_playbook.yml Inventory source: /home/ansible-navigator-demo/inventory.yml Additional command line parameters: Please provide a value (optional) ────────────────────────────────────────────────────────────────────────── Submit CancelTab キーを押して
Submitに移動し、Enter キーを押します。実行中のタスクが表示されるはずです。
プレイ結果を確認するプレイの横に番号を入力します。9 を超える数字の場合は
:<number>と入力します。
自動化コンテンツナビゲーターで色を有効にしている場合は、失敗したタスクが赤で表示されることに注意してください。
タスクの結果を確認するタスクの横に番号を入力します。9 を超える番号の場合は
:<number>と入力します。
オプション:
:docと入力し、トラブルシューティングを支援するタスクで使用されるモジュールまたはプラグインのドキュメントを起動します。ANSIBLE.BUILTIN.PACKAGE_FACTS (MODULE) 0│--- 1│doc: 2│ author: 3│ - Matthew Jones (@matburt) 4│ - Brian Coca (@bcoca) 5│ - Adam Miller (@maxamillion) 6│ collection: ansible.builtin 7│ description: 8│ - Return information about installed packages as facts. <... output omitted ...> 11│ module: package_facts 12│ notes: 13│ - Supports C(check_mode). 14│ options: 15│ manager: 16│ choices: 17│ - auto 18│ - rpm 19│ - apt 20│ - portage 21│ - pkg 22│ - pacman <... output truncated ...>
6.2. 自動化コンテンツナビゲーターアーティファクトファイルを使用した Playbook の結果の確認
自動化コンテンツナビゲーターは、JSON アーティファクトファイルに Playbook 実行の結果を保存します。このファイルを使用して、Playbook の結果を他の人と共有したり、セキュリティーやコンプライアンスの理由で保存したり、後で確認してトラブルシューティングしたりできます。Playbook の実行を確認するには、アーティファクトファイルのみが必要です。Playbook 自体またはインベントリーアクセスを使用する必要はありません。
前提条件
- Playbook 実行からの自動化コンテンツナビゲーターアーティファクトの JSON ファイル。
手順
アーティファクトファイルを使用して自動化コンテンツナビゲーターを起動します。
$ ansible-navigator replay simple_playbook_artifact.json
Playbook の実行時に一致する Playbook の結果を確認します。
これで、Playbook を実行した後と同じように、プレイとタスクの横に番号を入力して、それぞれに移動して結果を確認できるようになりました。
第7章 自動化コンテンツナビゲーターを使用した Ansible 設定の確認
コンテンツ作成者は、自動化コンテンツナビゲーターで Ansible 設定を確認し、インタラクティブに設定を調べることができます。
7.1. 自動化コンテンツナビゲーターで Ansible 設定の確認
Ansible 設定は、自動化コンテンツナビゲーターのテキストベースのユーザーインターフェイスを対話モードで確認でき、設定を詳しく調べることができます。自動化コンテンツナビゲーターは、アクセス可能な Ansible 設定ファイルから結果をプルするか、設定ファイルが存在しない場合にはデフォルトを返します。
前提条件
- 追加の自動化実行環境にアクセスする必要がある場合は、Red Hat レジストリーに対して認証されている。詳細は、Red Hat コンテナーレジストリーの認証 を参照してください。
手順
自動化コンテンツナビゲーターを起動します。
$ ansible-navigator
オプション: コマンドラインから
ansible-navigator configを入力し、Ansible 設定にアクセスします。Ansible 設定を確認します。
:config
一部の値は、自動化実行環境が機能するために必要な自動化実行環境の設定を反映しています。これらは、Ansible 設定ファイルでは設定できないデフォルト以外の設定として表示されます。
詳細を確認する設定に当たる番号を入力します。番号が 9 以上になる場合は、
:<number>と入力します。ANSIBLE COW ACCEPTLIST (current: ['bud-frogs', 'bunny', 'cheese']) (default: 0│--- 1│current: 2│- bud-frogs 3│- bunny 4│- cheese 5│default: 6│- bud-frogs 7│- bunny 8│- cheese 9│- daemon
出力には、現在の setting と default が表示されます。設定は自動化実行環境のものであるため、この例の source は env であることに注意してください。
検証
設定出力を確認します。
第9章 自動化コンテンツナビゲーターを使用した Ansible コンテンツのトラブルシューティング
コンテンツ作成者は、自動化コンテンツナビゲーターで Ansible コンテンツ (コレクション、自動化実行環境、および Playbook) をトラブルシューティングしたり、Playbook を対話形式でトラブルシューティングしたりできます。自動化実行環境の内外で結果を比較し、問題をトラブルシューティングすることもできます。
9.1. 自動化コンテンツナビゲーターアーティファクトファイルを使用した Playbook の結果の確認
自動化コンテンツナビゲーターは、JSON アーティファクトファイルに Playbook 実行の結果を保存します。このファイルを使用して、Playbook の結果を他の人と共有したり、セキュリティーやコンプライアンスの理由で保存したり、後で確認してトラブルシューティングしたりできます。Playbook の実行を確認するには、アーティファクトファイルのみが必要です。Playbook 自体またはインベントリーアクセスを使用する必要はありません。
前提条件
- Playbook 実行からの自動化コンテンツナビゲーターアーティファクトの JSON ファイル。
手順
アーティファクトファイルを使用して自動化コンテンツナビゲーターを起動します。
$ ansible-navigator replay simple_playbook_artifact.json
Playbook の実行時に一致する Playbook の結果を確認します。
これで、Playbook を実行した後と同じように、プレイとタスクの横に番号を入力して、それぞれに移動して結果を確認できるようになりました。