Red Hat Summitコンテンツナビゲーターの使用
Ansible Automation Platform と互換性のあるコンテンツの開発
概要
Red Hat ドキュメントへのフィードバック (英語のみ)
このドキュメントの改善に関するご意見がある場合や、エラーを発見した場合は、https://access.redhat.com から Technical Support チームに連絡してください。
第1章 Automation content navigator の概要
コンテンツ作成者は、Automation content navigator を使用して、Red Hat Ansible Automation Platform と互換性のある Ansible Playbook、コレクション、およびロールを開発できます。以下の環境で Automation content navigator を使用すると、すべての環境でシームレスかつ予測可能な結果が得られます。
- ローカルの開発マシン
- 自動化実行環境
また、Automation content navigator は、Playbook の開発および問題領域のトラブルシューティングに役立つアーティファクトファイルも作成します。
Automation content navigator は、Ansible 開発ツールのコンポーネントです。Automation content navigator を使用するには、Ansible 開発ツールをインストールする必要があります。
1.2. Automation content navigator のモード
Automation content navigator は 2 つのモードで動作します。
- 標準出力 (stdout) モード
- コマンドラインで既存の Ansible コマンドおよび拡張機能の大部分を受け入れます。
- テキストベースのユーザーインターフェイスモード
- Ansible コマンドに対する、インタラクティブなテキストベースのインターフェイスを提供します。このモードを使用して、コンテンツを評価し、Playbook を実行し、アーティファクトファイルを使用して実行した後に Playbook のトラブルシューティングを行います。
1.2.1. 標準出力 (stdout) モード
Automation content navigator で -m stdout サブコマンドを使用して、自動化実行環境内やローカルの開発環境上で ansible-playbook などの一般的な Ansible コマンドを使用します。使い慣れたコマンドを使用して、素早くタスクを実行することができます。
また、このモードの Automation content navigator には、広範にわたるヘルプが含まれています。
--help-
ansible-navigatorコマンドまたはサブコマンド (ansible-navigator config --helpなど) からアクセスできます。 - サブコマンドのヘルプ
-
サブコマンド (例:
ansible-navigator config --help-config) からアクセスできます。このヘルプには、関連する Ansible コマンドでサポートされているすべてのパラメーターの詳細が表示されます。
1.2.2. テキストベースのユーザーインターフェイスモード
テキストベースのユーザーインターフェイスモードは、自動化実行環境、コレクション、Playbook、およびインベントリーとの対話を強化します。このモードは、Visual Studio Code などの統合開発環境 (IDE) と互換性があります。
このモードには、便利なユーザーインターフェイスオプションが多数含まれています。
- コロンコマンド
-
:run、:collectionsなど、コロンを使用して、すべての Automation content navigator コマンドにアクセスできます。 - テキストベースのインターフェイスの移動
-
この画面には、ページアップまたはページダウン、スクロール、前の画面へのエスケープ、または
:helpへのアクセス方法が表示されます。 - 行番号による出力
-
表示された出力の行番号の前にコロンを付ける (例:
:12) と、その行にアクセスできます。 - 色でコーディングされた出力
- 色を有効にすると、Automation content navigator は非推奨のモジュールなどのアイテムを赤で表示します。
- ページネーションおよびスクロール
- 各 Automation content navigator 画面の下部に表示されるオプションを使用して、ページを上下に移動したり、スクロールしたり、エスケープしたりできます。
Automation content navigator の実行後は、モード間の切り替えができません。
このドキュメントでは、ほとんどの手順でテキストベースのユーザーインターフェイスモードを使用します。
第2章 Ansible 開発ツールのインストール
Red Hat は、Ansible 開発ツールをインストールするための 2 つの選択肢を提供しています。
- VS Code 内で実行されている RHEL コンテナーへのインストール。このオプションは、MacOS、Windows、Linux システムにインストールできます。
RPM (Red Hat Package Manager) パッケージを使用した、ローカルの RHEL 8 または RHEL 9 システムへのインストール。
注記RHEL 10 では RPM インストールはサポートされていません。
2.1. 要件
Ansible 開発ツールをインストールして使用するには、次の要件を満たす必要があります。Windows インストールおよびコンテナーインストールの追加要件は、手順に記載されています。
- Python 3.10 以降。
- Ansible 拡張機能を追加した VS Code (Visual Studio Code)。VS Code のインストール 参照してください。
- コンテナーインストールの場合は、Microsoft Dev Containers VS Code 拡張機能。Dev Containers 拡張機能のインストールと設定 を参照してください。
コンテナー化プラットフォーム (例: Podman、Podman Desktop、Docker、Docker Desktop)。
注記Windows での Ansible 開発ツールのインストール手順では、Podman Desktop の使用方法だけを取り上げています。Windows での Ansible 開発ツールの要件 を参照してください。
-
Red Hat アカウントをお持ちの場合は、
registry.redhat.ioで Red Hat コンテナーレジストリーにログインできます。registry.redhat.ioへのログインは、Red Hat コンテナーレジストリーでの認証 を参照してください。
2.1.1. Windows での Ansible 開発ツールの要件
Windows 上の VS Code のコンテナーに Ansible 開発ツールをインストールする場合は、追加の要件があります。
- Windows Subsystem for Linux (WSL2)
- Podman Desktop
手順
ディストリビューションなしで WSL2 をインストールします。
$ `wsl --install --no-distribution`WSL2 の
cgroupsv1を無効にしてcgroupsv2を使用します。%USERPROFILE%/wsl.confファイルを編集し、次の行を追加してcgroupv2の使用を強制します。[wsl2] kernelCommandLine = cgroup_no_v1="all"Podman Desktop をインストールします。Podman Desktop ドキュメントの Installing Podman Desktop and Podman on Windows の手順を実行します。
セットアップウィザードでデフォルト設定を変更する必要はありません。
podman マシンが
cgroupsv2を使用していることを確認します。$ podman info | findstr cgroupPodman デスクトップをテストします。
$ podman run helloPodman Desktop を設定します。次の内容を含む
%USERPROFILE%\bin\docker.batファイルを追加します。@echo off podman %*これにより、VS Code の
Dev Container拡張機能に必要な Docker をインストールする必要がなくなります。%USERPROFILE%\binディレクトリーをPATHに追加します。- Settings を選択し、"Edit environment variables for your account" を検索して、すべてのユーザー環境変数を表示します。
- 上部のユーザー変数ボックスで "Path" を強調表示し、 をクリックしてパスを追加します。
- をクリックして、新しく開くコンソールのパスを設定します。
2.1.2. Red Hat コンテナーレジストリーでの認証
Red Hat Container Catalog を通じて利用できるすべてのコンテナーイメージは、イメージレジストリーの registry.redhat.io でホストされています。イメージにアクセスするには、レジストリーで認証が必要です。
registry.redhat.io レジストリーを使用するには、Red Hat ログイン情報が必要です。これは、Red Hat カスタマーポータル (access.redhat.com) にログインして Red Hat サブスクリプションを管理するために使用するアカウントと同じものです。
VS Code 内のコンテナーに Ansible 開発ツールをインストールする予定の場合は、VS Code を起動する前に registry.redhat.io にログインして、VS Code が registry.redhat.io から devtools コンテナーをプルできるようにする必要があります。
VS Code 内のコンテナーで Ansible 開発ツールを実行中で、実行環境または devcontainer をプルして実行環境として使用する場合は、VS Code 内のターミナルから devcontainer 内のターミナルプロンプトにログインする必要があります。
認証情報を使用して podman login または docker login コマンドを使用すると、レジストリーのコンテンツにアクセスできます。
- Podman
$ podman login registry.redhat.io Username: my__redhat_username Password: ***********- Docker
$ docker login registry.redhat.io Username: my__redhat_username Password: ***********
Red Hat コンテナーレジストリー認証の詳細は、Red Hat カスタマーポータルの Red Hat Container Registry Authentication を参照してください。
2.1.3. VS Code のインストール
- VS Code をインストールするには、Visual Studio Code ドキュメントの Download Visual Studio Code page の指示に従ってください。
2.1.4. VS Code Ansible 拡張機能のインストール
Ansible 拡張機能は、VS Code に Ansible の言語サポートを追加します。この拡張機能には、自動化コンテンツの作成と実行を容易にするために、Ansible 開発ツールが組み込まれています。
Ansible 拡張機能の詳細な説明は、Visual Studio Code Marketplace を参照してください。
拡張機能の操作に関するチュートリアルは、Learning path - Getting Started with the Ansible VS Code Extension を参照してください。
Ansible VS Code 拡張機能をインストールするには、以下を実行します。
- VS Code を開きます。
-
アクティビティーバーの Extensions (
) アイコンをクリックするか、 → をクリックして Extensions ビューを表示します。
-
Extensions ビューの検索フィールドに
Ansible Red Hatと入力します。 - Ansible 拡張機能を選択し、 をクリックします。
ファイルの言語が Ansible として認識されると、Ansible 拡張機能によってオートコンプリート、ホバー、マウスオーバー、goto などの機能が提供されます。認識されたファイルの言語は、VS Code ウィンドウの下部にあるステータスバーに表示されます。
Ansible 言語は次のファイルに割り当てられています。
-
/playbooksディレクトリー内の YAML ファイル -
二重拡張子
.ansible.ymlまたは.ansible.yamlを持つファイル -
Ansible が認識する特定の YAML 名 (例:
site.ymlやsite.yaml) -
ファイル名に "playbook" が含まれる YAML ファイル (
playbook.ymlまたはplaybook.yaml)
拡張機能が Playbook ファイルの言語を Ansible として認識しない場合は、Ansible 言語を YAML ファイルに関連付ける の手順に従ってください。
2.1.5. Ansible 拡張機能の設定
Ansible 拡張機能は複数の設定方法をサポートしています。
拡張機能の設定は、ユーザーレベル、ワークスペースレベル、または特定のディレクトリーで設定できます。ユーザーベースの設定は、開かれている VS Code のすべてのインスタンスに対し、グローバルに適用されます。ワークスペース設定はワークスペース内に保存され、現在のワークスペースを開いたときにのみ適用されます。
ワークスペースを設定すると、以下の点で便利です。
- Playbook プロジェクトに固有の設定を定義して維持すると、他の作業の優先設定を変更することなく、個々のプロジェクトに合わせて Ansible 開発環境をカスタマイズできます。Python プロジェクト、Ansible プロジェクト、C++ プロジェクトごとに異なる設定が可能で、それぞれのスタックに合わせて最適化されているため、プロジェクトを切り替えるたびに手動で再設定する必要はありません。
- チームと共有するプロジェクトのバージョン管理をセットアップするときにワークスペース設定を含めると、全員がそのプロジェクトに対して同じ設定を使用します。
手順
Ansible 拡張機能の設定を開きます。
- アクティビティーバーで、'Extensions' アイコンをクリックします。
Ansible 拡張機能を選択し、'歯車' アイコン、Extension Settings の順にクリックして拡張機能設定を表示します。
または、 → → をクリックして Settings ページを開きます。
-
検索バーに
Ansibleと入力して拡張機能の設定を表示します。
- 現在の VS Code ワークスペースの設定を行うには、Workspace タブを選択します。
Ansible 拡張機能の設定は事前に入力されています。要件に合わせて設定を変更します。
- ansible-lint を有効にするには、 → → ボックスをオンにします。
-
実行環境を使用するには、
Ansible Execution Environment: Enabledボックスをオンにします。 - Ansible > Execution Environment: image フィールドで使用する実行環境イメージを指定します。
- Red Hat Ansible Lightspeed を使用するには、Ansible > Lightspeed: Enabled ボックスをオンにし、Lightspeed の URL を入力します。
設定は、VisualStudio マーケットプレイスのドキュメントの Ansible VS Code Extension by Red Hat ページに記載されています。
2.1.6. Ansible 言語を YAML ファイルに関連付ける
Ansible VS Code 拡張機能は、ファイルに関連付けられた言語が Ansible に設定されている場合にのみ機能します。この拡張機能は、自動補完、マウスオーバー、診断など、Ansible Playbook の作成に役立つ機能を提供します。
Ansible VS Code 拡張機能は、Ansible 言語をファイルに自動的に関連付けます。以下の手順では、Ansible ファイルとして認識されないファイルの言語を設定する方法を説明します。
Ansible 言語を YAML ファイルに手動で関連付ける
次の手順では、VS Code で開いている YAML ファイルに Ansible 言語を手動で割り当てる方法を説明します。
- VS Code で YAML ファイルを開くか作成します。
- VS Code ウィンドウの下部にあるステータスバーに表示されている言語の上にカーソルを置き、Select Language Mode リストを開きます。
リストから Ansible を選択します。
ファイルの VS Code ウィンドウの下部にあるステータスバーに表示される言語が Ansible に変更されます。
Ansible 言語の永続的なファイル関連付けを settings.json に追加する
または、settings.json ファイルに Ansible 言語のファイル関連付けを追加することもできます。
settings.jsonファイルを開きます。- → をクリックして、コマンドパレットを開きます。
-
検索ボックスに
Workspace settingsと入力し、Open Workspace Settings (JSON) を選択します。
次のコードを
settings.jsonに追加します。{ ... "files.associations": { "*plays.yml": "ansible", "*init.yml": "yaml", } }
2.1.7. Dev Containers 拡張機能のインストールと設定
コンテナー化されたバージョンの Ansible 開発ツールをインストールする場合は、VS Code に Microsoft Dev Containers 拡張機能をインストールする必要があります。
- VS Code を開きます。
-
アクティビティーバーの Extensions (
) アイコンをクリックするか、 → をクリックして Extensions ビューを表示します。
-
Extensions ビューの検索フィールドに
Dev Containersと入力します。 - Microsoft の Dev Containers 拡張機能を選択し、 をクリックします。
コンテナー化プラットフォームとして Podman または Podman Desktop を使用する場合は、Dev Containers 拡張機能のデフォルト設定を変更する必要があります。
Dev Containers拡張設定で docker を podman に置き換えます。- VS Code で設定エディターを開きます。
@ext:ms-vscode-remote.remote-containersを検索します。または、アクティビティーバーの Extensions アイコンをクリックし、
Dev Containers拡張機能の歯車アイコンをクリックします。
-
Dev > Containers:Docker Pathをpodmanに設定します。 -
Dev > Containers:Docker Compose Pathをpodman-composeに設定します。
2.2. VS Code 内のコンテナーに Ansible 開発ツールをインストールする
Dev Containers VS Code 拡張機能には、開発コンテナーの設定を保存するための .devcontainer ファイルが必要です。Ansible 拡張機能を使用して、開発コンテナー用の設定ファイルをスキャフォールディングし、VS Code のコンテナーでディレクトリーを再度開く必要があります。
前提条件
- Podman、Podman Desktop、Docker、Docker Desktop などのコンテナー化プラットフォームをインストール済みである。
-
Red Hat ログイン情報をお持ちであり、
registry.redhat.ioの Red Hat レジストリーにログインしている。registry.redhat.ioへのログインは、Red Hat コンテナーレジストリーでの認証 を参照してください。 - VS Code がインストールされていること。
- VS Code に Ansible 拡張機能をインストール済みである。
- VS Code に Microsoft Dev Containers 拡張機能をインストール済みである。
Windows に Ansible 開発ツールをインストールする場合は、VS Code を起動して WSL マシンに接続する。
-
Remote(
) アイコンをクリックします。
- 表示されるドロップダウンメニューで、WSL マシンに接続するオプションを選択します。
-
手順
- VS Code でプロジェクトディレクトリーに移動します。
- VS Code アクティビティーバーの Ansible アイコンをクリックして、Ansible 拡張機能を開きます。
- Ansible 拡張機能の Ansible Development Tools セクションで、ADD オプションまでスクロールダウンし、Devcontainer を選択します。
Create a devcontainer ページで、Container image オプションから Downstream コンテナーイメージを選択します。
このアクションにより、Podman と Docker の両方の
devcontainer.jsonファイルが.devcontainerディレクトリーに追加されます。プロジェクトディレクトリーを再度開くか、リロードします。
VS Code がディレクトリーに
devcontainer.jsonファイルが含まれていることを検出すると、以下の通知が表示されます。
Reopen in Container をクリックします。
-
通知が表示されない場合は、
Remote(
) アイコンをクリックします。表示されるドロップダウンメニューで、Reopen in Container を選択します。
使用しているコンテナー化プラットフォームに応じて、Podman または Docker の開発コンテナーを選択します。
VS Code ステータスバーの Remote() ステータスに
opening Remoteが表示され、通知にコンテナーを開く操作の進行状況が示されます。
検証
コンテナー内でディレクトリーが再度開かれると、Remote() ステータスに Dev Container: ansible-dev-container と表示されます。
コンテナーのベースイメージは、パッケージマネージャーとして microdnf を使用する Universal Base Image Minimal (UBI Minimal) イメージです。dnf および yum パッケージマネージャーはコンテナーでは使用できません。
UBI Minimal イメージベースのコンテナーで microdnf を使用する方法は、Red Hat Enterprise Linux の コンテナーの構築、実行、および管理 ガイドの UBI minimal コンテナーへのソフトウェアの追加 を参照してください。
2.3. RHEL のパッケージから Ansible 開発ツールをインストールする
Ansible 開発ツールは、Ansible Automation Platform RPM (Red Hat Package Manager) パッケージにバンドルされています。Ansible Automation Platform のインストールは、RPM インストール ドキュメントを参照してください。
前提条件
RHEL 8 または RHEL 9 をインストールした。
注記RHEL 10 では RPM インストールはサポートされていません。
- Red Hat Subscription Manager でシステムを登録済みである。
- Podman や Docker などのコンテナー化プラットフォームをインストール済みである。
手順
次のコマンドを実行して、Simple Content Access (SCA) が有効化されているか確認します。
$ sudo subscription-manager statusSimple Content Access が有効化されている場合、出力には次のメッセージが含まれます。
Content Access Mode is set to Simple Content Access.Simple Content Access が有効化されていない場合は、Red Hat Ansible Automation Platform SKU をアタッチします。
$ sudo subscription-manager attach --pool=<sku-pool-id>
次のコマンドで Ansible 開発ツールをインストールします。
$ sudo dnf install --enablerepo=ansible-automation-platform-2.5-for-rhel-8-x86_64-rpms ansible-dev-tools$ sudo dnf install --enablerepo=ansible-automation-platform-2.5-for-rhel-9-x86_64-rpms ansible-dev-tools
検証:
Ansible 開発ツールコンポーネントがインストールされていることを確認します。
$ rpm -aq | grep ansible出力には、インストールされている Ansible パッケージが表示されます。
ansible-sign-0.1.1-2.el9ap.noarch
ansible-creator-24.4.1-1.el9ap.noarch
python3.11-ansible-runner-2.4.0-0.1.20240412.git764790f.el9ap.noarch
ansible-runner-2.4.0-0.1.20240412.git764790f.el9ap.noarch
ansible-builder-3.1.0-0.2.20240413.git167ed5c.el9ap.noarch
ansible-dev-environment-24.1.0-2.el9ap.noarch
ansible-core-2.16.6-0.1.20240413.gite636132.el9ap.noarch
python3.11-ansible-compat-4.1.11-2.el9ap.noarch
python3.11-pytest-ansible-24.1.2-1.el9ap.noarch
ansible-lint-6.14.3-4.el9ap.noarch
ansible-navigator-3.4.1-2.el9ap.noarch
python3.11-tox-ansible-24.2.0-1.el9ap.noarch
ansible-dev-tools-2.5-2.el9ap.noarchインストールが成功すると、ansible-creator のヘルプドキュメントを表示できます。
$ ansible-creator --help
usage: ansible-creator [-h] [--version] command ...
The fastest way to generate all your ansible content.
Positional arguments:
command
add Add resources to an existing Ansible project.
init Initialize a new Ansible project.
Options:
--version Print ansible-creator version and exit.
-h --help Show this help message and exit第3章 Automation content navigator を使用した自動化実行環境の確認
コンテンツ開発者は、Automation content navigator で自動化実行環境を確認し、自動化実行環境に含まれるパッケージとコレクションを表示できます。Automation content navigator は Playbook を実行して結果を抽出し、表示します。
3.1. Automation content navigator からの自動化実行環境の確認
Automation content navigator のテキストベースのユーザーインターフェイスを使用して、自動化実行環境を確認できます。
前提条件
- 自動化実行環境
手順
Automation content navigator 設定に含まれる自動化実行環境を確認します。
$ ansible-navigator images
詳細を確認する自動化実行環境の番号を入力します。
インストールされている各自動化実行環境のパッケージおよびバージョン、ならびに Ansible バージョンに含まれるコレクションを確認できます。
オプション: 使用する自動化実行環境を渡します。これはプライマリーであり、Automation content navigator が使用する自動化実行環境です。
$ ansible-navigator images --eei registry.example.com/example-enterprise-ee:latest
検証
自動化実行環境の出力を確認します。
第5章 Automation content navigator を使用したコレクションの参照
コンテンツ作成者は、Automation content navigator で Ansible コレクションを参照し、ローカルまたは自動化実行環境で開発した各コレクションをインタラクティブに調べることができます。
5.1. Automation content navigator コレクションの表示
Automation content navigator は、各コレクションに以下の詳細を含むコレクションに関する情報を表示します。
- SHADOWED
- コレクションの追加コピーが検索順序の上位にあり、Playbook がそのコレクションを優先することを示します。
- TYPE
-
コレクションが自動化実行環境にマウントされている自動化実行環境またはボリュームに
bind_mountとして含まれるかどうかを示します。 - PATH
- コレクション TYPE フィールドに基づいて、自動化実行環境またはローカルファイルシステム内のコレクションの場所を反映します。
5.2. Automation content navigator からのコレクションの参照
Automation content navigator テキストベースのユーザーインターフェイスを使用して、インタラクティブモードで Ansible コレクションを参照し、各コレクションを詳しく調べることができます。Automation content navigator は、現在のプロジェクトディレクトリー内のコレクションと、自動化実行環境で利用可能なコレクションを表示します。
前提条件
- ローカルでアクセス可能なコレクションまたはインストールされた自動化実行環境。
手順
Automation content navigator を起動します。
$ 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. Automation content navigator のドキュメントの確認
インタラクティブモードで Automation content navigator テキストベースのユーザーインターフェイスを使用して、コレクションとプラグインの Ansible ドキュメントを確認できます。Automation content navigator は、現在のプロジェクトディレクトリー内のコレクションと自動化実行環境で利用可能なコレクションを表示します。
前提条件
- ローカルでアクセス可能なコレクションまたはインストールされた自動化実行環境。
手順
Automation content navigator を起動します。
$ ansible-navigator対象のモジュールを確認します。または、
ansible-navigator docと入力してドキュメントにアクセスすることもできます。:doc ansible.utils.ip_addressANSIBLE.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
エディターのセットアップ方法の詳細は、Automation content navigator の一般設定 を参照してください。
第6章 Automation content navigator を使用した Ansible Playbook の実行
コンテンツ作成者は、Automation content navigator を使用して Ansible Playbook を実行し、各プレイとタスクの結果をインタラクティブに調べて、Playbook を検証またはトラブルシューティングできます。また、実行環境内で Ansible Playbook を実行すれば、実行環境がなくても、問題を比較してトラブルシューティングできます。
6.1. Automation content navigator からの Playbook の実行
Automation contents navigator のテキストベースのユーザーインターフェイスで Ansible Playbook を実行して、タスクの実行を追跡し、各タスクの結果を詳しく調べることができます。
前提条件
- Playbook
-
localhostまたは inventory プラグインを使用しない場合は有効なインベントリーファイル。
手順
Automation content navigator を起動します。
$ ansible-navigatorPlaybook を実行します。
$ :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>と入力します。
Automation content navigator で色を有効にしている場合は、失敗したタスクが赤で表示されることに注意してください。
タスクの結果を確認するタスクの横に番号を入力します。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. Automation content navigator アーティファクトファイルを使用した Playbook の結果の確認
Automation content navigator は、JSON アーティファクトファイルに Playbook 実行の結果を保存します。このファイルを使用して、Playbook の結果を他の人と共有したり、セキュリティーやコンプライアンスの理由で保存したり、後で確認してトラブルシューティングしたりできます。Playbook の実行を確認するには、アーティファクトファイルのみが必要です。Playbook 自体またはインベントリーアクセスを使用する必要はありません。
前提条件
- Playbook 実行からの Automation content navigator アーティファクトの JSON ファイル。
手順
アーティファクトファイルを使用して Automation content navigator を起動します。
$ ansible-navigator replay simple_playbook_artifact.jsonPlaybook の実行時に一致する Playbook の結果を確認します。
これで、Playbook を実行した後と同じように、プレイとタスクの横に番号を入力して、それぞれに移動して結果を確認できるようになりました。
第7章 Automation content navigator を使用した Ansible 設定の確認
コンテンツ作成者は、Automation content navigator で Ansible 設定を確認し、インタラクティブに設定を調べることができます。
7.1. Automation content navigator で Ansible 設定の確認
Ansible 設定は、Automation content navigator のテキストベースのユーザーインターフェイスを対話モードで確認でき、設定を詳しく調べることができます。Automation content navigator は、アクセス可能な Ansible 設定ファイルから結果をプルするか、設定ファイルが存在しない場合にはデフォルトを返します。
前提条件
- 追加の自動化実行環境にアクセスする必要がある場合は、Red Hat レジストリーに対して認証されている。詳細は、Red Hat コンテナーレジストリーの認証 を参照してください。
手順
Automation content navigator を起動します。
$ 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章 Automation content navigator を使用した Ansible コンテンツのトラブルシューティング
コンテンツ作成者は、Automation content navigator で Ansible コンテンツ (コレクション、自動化実行環境、および Playbook) をトラブルシューティングしたり、Playbook を対話形式でトラブルシューティングしたりできます。自動化実行環境の内外で結果を比較し、問題をトラブルシューティングすることもできます。
9.1. Automation content navigator アーティファクトファイルを使用した Playbook の結果の確認
Automation content navigator は、JSON アーティファクトファイルに Playbook 実行の結果を保存します。このファイルを使用して、Playbook の結果を他の人と共有したり、セキュリティーやコンプライアンスの理由で保存したり、後で確認してトラブルシューティングしたりできます。Playbook の実行を確認するには、アーティファクトファイルのみが必要です。Playbook 自体またはインベントリーアクセスを使用する必要はありません。
前提条件
- Playbook 実行からの Automation content navigator アーティファクトの JSON ファイル。
手順
アーティファクトファイルを使用して Automation content navigator を起動します。
$ ansible-navigator replay simple_playbook_artifact.jsonPlaybook の実行時に一致する Playbook の結果を確認します。
これで、Playbook を実行した後と同じように、プレイとタスクの横に番号を入力して、それぞれに移動して結果を確認できるようになりました。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}