4.4. Playbook の作成と Playbook の説明の表示
Ansible VS Code 拡張機能を使用すると、英語の自然言語インターフェイスを使用して Ansible Playbook を作成できます。Red Hat Ansible Lightspeed with IBM watsonx Code Assistant は、自然言語のプロンプトを読み取り、ユーザーの目的に基づいて Playbook の推奨事項全体を生成します。新しい Playbook や既存の Playbook の説明を表示することもできます。Playbook の説明は、Playbook の実行内容と、その効果が得られる状況を説明しています。
これらの機能により、Ansible 開発者は自然言語のプロンプトを使用して新しい Ansible Playbook を迅速かつ効率的に作成できるほか、既存の Ansible Playbook の説明も得られるため、全体的なオンボーディング学習期間が短縮されます。Ansible Playbook の詳細は、Ansible Playbook のスタートガイド を参照してください。
Red Hat Ansible Lightspeed クラウドサービスおよびオンプレミスデプロイメントに接続するときに、Playbook を作成し、Playbook の説明を表示できます。
4.4.1. Playbook を作成するためのベストプラクティス
Playbook の推奨事項の品質を最適なものにするには、次のガイドラインに従ってください。
目標ステートメントで、Playbook で実行する必要がある内容を直接指定します。
ステートメントでは、まず Playbook の目標を指定する必要があります (例:
Apply security patches to RHEL9
)。Create a playbook that
、Please prepare a playbook that
、I need help with
などの文言を最初に指定するのは避けてください。- 目標ステートメントに新しい行を含めないでください。
目標ステートメントが 1 文を超えないようにしてください。
最良の結果を得るには、目標ステートメントの詳細を書き直す必要がある場合があります。生成されたアウトラインをフィードバックとして使用し、目標ステートメントの詳細を増やすか減らすかを検討して、必要に応じて目標ステートメントを変更することを推奨します。
アウトラインを編集するときは、次の点に注意してください。
- Playbook の目標を再度記述しないでください。
- 検討した手順に、Playbook の主要な手順が含まれていることを確認します。Playbook に期待されるすべてのタスクが手順に反映されている必要はありません。
- アウトラインに新しい行を追加せずに、手順の説明を 1 つの文にまとめます。
4.4.2. Ansible Playbook の生成
Ansible VS Code 拡張機能の自然言語インターフェイスを使用して、Ansible Playbook 全体を生成できます。
前提条件
次の いずれか の要件を満たしている。
- Red Hat Ansible Automation Platform と IBM watsonx Code Assistant の両方の試用版または有料サブスクリプションを組織で所有している。
- Red Hat Ansible Automation Platform の試用版または有料サブスクリプションと、Red Hat Ansible Lightspeed のトライアルアカウントを組織で所有している。
- Ansible VS Code 拡張機能をインストールして設定した。
手順
- Red Hat アカウントで VS Code にログインします。
- Activity バーから、Ansible アイコンをクリックします。
Ansible Creator の下の Get started をクリックします。Ansible Content Creator ページが表示されます。
次の図は、Ansible Content Creator ページを示しています。
図4.5 Ansible Playbook を作成するための設定
- Playbook with Ansible Lightspeed タイルを選択します。Create a playbook ページが表示されます。
What do you want the playbook to accomplish? フィールドに、Playbook を作成するためのプロンプトを入力し、Analyze をクリックします。
数秒後、Playbook の目的に応じた推奨手順が Review the suggested steps for your playbook and modify as needed フィールドに表示されます。
以下のいずれかのタスクを実行します。
- 手順が目的に合っている場合は、Generate Playbook をクリックします。
- 変更が必要な場合は、エディターをクリックし、目的に合わせてタスクまたは手順を更新します。
- 推奨タスクが目的に合っていない場合は、Back をクリックし、元のプロンプトを変更してやり直してください。
- 元の推奨タスクを復元する場合は、Reset をクリックして次の手順に進みます。
手順を確認したら、Generate playbook をクリックします。
Playbook の生成には数秒かかります。The following playbook was generated for you フィールドに新しく生成された Playbook が表示されます。
- Open editor をクリックします。生成された Playbook が、VS Code エディターで無題の YAML ファイルとして開きます。
- 無題の YAML ファイルを保存します。
4.4.3. Playbook の説明の表示
既存の Ansible Playbook だけでなく、新しく作成された Playbook についても説明を求めることができます。
前提条件
次の いずれか の要件を満たしている。
- Red Hat Ansible Automation Platform と IBM watsonx Code Assistant の両方の試用版または有料サブスクリプションを組織で所有している。
- Red Hat Ansible Automation Platform の試用版または有料サブスクリプションと、Red Hat Ansible Lightspeed のトライアルアカウントを組織で所有している。
- Ansible VS Code 拡張機能をインストールして設定した。
- 説明を表示する Playbook を開いた。
手順
- Red Hat アカウントで VS Code にログインします。
- VS Code で Ansible Playbook YAML ファイルを開きます。
次のいずれかの方法を使用して Playbook の説明を表示します。
アクティブな Playbook の YAML ファイルから:
- Playbook ファイル内の任意の場所にカーソルを置きます。
- 右クリックして、Explain the playbook with Ansible Lightspeed を選択します。
Ansible パネルから:
- ナビゲーションメニューから、Ansible アイコンをクリックします。
Explain the current playbook を選択します。
VS Code 画面の右側のパネルに Playbook の説明が表示されます。
次の図は、Playbook の説明の例を示しています。
図4.6 Playbook の説明の例