Ansible plug-ins for Red Hat Developer Hub の使用
Ansible plug-ins for Red Hat Developer Hub の使用
概要
はじめに リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Ansible Automation Platform に興味をお持ちいただきありがとうございます。Ansible Automation Platform は、Ansible を装備した環境に、制御、ナレッジ、委譲の機能を追加して、チームが複雑かつ複数層のデプロイメントを管理できるように支援する商用サービスです。
このガイドでは、Ansible plug-ins for Red Hat Developer Hub の使用方法を説明します。このガイドの更新により、Ansible Automation Platform の最新リリースの情報が追加されました。
Red Hat ドキュメントへのフィードバック (英語のみ) リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントの改善に関するご意見がある場合や、エラーを発見した場合は、https://access.redhat.com から Technical Support チームに連絡してください。
Ansible plug-ins for Red Hat Developer Hub はテクノロジープレビュー機能としてのみご利用いただけます。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat では、実稼働環境での使用を推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
第1章 Ansible プラグインの使用 リンクのコピーリンクがクリップボードにコピーされました!
Ansible plug-ins for Red Hat Developer Hub (RHDH) を使用すると、Ansible について学習し、自動化プロジェクトを作成して、独自のワークフローとツールにアクセスして自動化コードを開発およびテストすることができます。Red Hat Developer Hub UI から Ansible Automation Platform インスタンスに移動し、自動化ジョブを設定および実行できます。
このドキュメントでは、Ansible plug-ins for Red Hat Developer Hub の使用方法について説明します。また、RHEL システム上のファイアウォール設定の更新を自動化するための Playbook プロジェクトを開発する実例を紹介します。
1.1. オプションの要件 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub の Ansible プラグインには、Red Hat 開発者ポータル (developers.redhat.com/learn) の学習パスへのリンクがあります。
ラーニングパスにアクセスするには、Red Hat アカウントが必要です。また、developers.redhat.com にログインできる必要があります。
1.2. ダッシュボードナビゲーション リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub (RHDH) にログインすると、メインの RHDH メニューとダッシュボードが表示されます。
Ansible plug-ins for Red Hat Developer Hub のダッシュボードを表示するには、Red Hat Developer Hub ナビゲーションパネルで Ansible をクリックします。
プラグインダッシュボードには、Ansible に関する説明から Ansible Automation Platform からの自動化ジョブのデプロイにいたるまで、必要な手順が示されています。
- Overview には、メインのダッシュボードページが表示されます。
- LEARN では、Red Hat がキュレートした Ansible に関するリソースへのリンクのほか、Ansible を使い始めるための段階的な手順の例が提供されます。詳細は、Ansible について学ぶ を参照してください。
- DISCOVER EXISTING COLLECTIONS では、Private Automation Hub (プラグインで設定されている場合) へのリンク、または Red Hat Hybrid Cloud Console でホストされている Automation Hub へのリンクが提供されます。Automation Hub は、プロジェクトで使用できる既存のコレクションと実行環境を保存します。詳細は、既存のコレクションの検出 を参照してください。
- CREATE は、GitHub などの設定されたソースコントロール管理プラットフォームに新しいプロジェクトを作成します。詳細は、プロジェクトの作成 を参照してください。
- DEVELOP では、Ansible プラグインのインストールで設定されている場合、OpenShift Dev Spaces へのリンクが提供されます。OpenShift Dev Spaces は、自動化コンテンツを開発できるオンデマンドの Web ベース統合開発環境 (IDE) を提供します。詳細は、プロジェクトの開発 を参照してください。
- Operate は、Ansible Automation Platform に接続します。これにより、ユーザーは、自身で開発したプロジェクトを使用する自動化ジョブを作成および実行できます。詳細は、Playbook プロジェクトを実行するためのコントローラープロジェクトのセットアップ を参照してください。
1.3. Ansible について学ぶ リンクのコピーリンクがクリップボードにコピーされました!
自動化の開始方法に関する詳細は、プラグインダッシュボードの Overview ページで LEARN をクリックしてください。LEARN ページには、学習用に以下のオプションが用意されています。
Learning Paths には、developers.redhat.com でホストされているキュレートされたラーニングツールのリストが記載されています。これらのツールでは、Ansible、Ansible VS Code エクステンション、および YAML の使用に関する基礎が説明されています。
USEFUL LINKS セクションでは、他の Ansible ラーニングパスを選択できます。
- Labs は、Ansible コンテンツの作成と Ansible 開発者ツールの使用に関する実践的な経験が得られるように設計されたセルフガイドラボです。
1.4. 既存のコレクションの検出 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub の Ansible プラグインダッシュボードの Overview ページで、Discover Existing Collections をクリックします。
このペインのリンクを使用すると、プラグインのインストール時に設定した再利用可能な自動化コンテンツコレクションのソースにアクセスできます。
プラグインのインストール時に Private Automation Hub を設定した場合は、Go to Automation Hub をクリックして、ユーザーの企業がキュレートしたコレクションと実行環境を表示できます。
プラグインのインストール時に Private Automation HubURL を設定しなかった場合は、Discover existing collection ペインに console.redhat.com の Red HatAutomation Hub へのリンクが表示されます。このサイトでは、認定および検証済みの Ansible コンテンツコレクションを参照できます。
1.5. プロジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
前提条件
- Red Hat Developer Hub でテンプレートを表示するための適切なアクセス権 (RBAC) がある。必要に応じて、管理者にアクセス権の割り当てを依頼してください。
手順:
- Red Hat Developer Hub UI にログインします。
-
Red Hat Developer Hub ナビゲーションパネルで Ansible の
Aアイコンをクリックします。 - Overview ページに移動します。
- Create をクリックします。
- Create Ansible Git Project をクリックします。Available Templates ページが開きます。
- Create Ansible Playbook project をクリックします。
Create Ansible Playbook Project ページで、フォームに新しいプロジェクトの情報を入力します。
このフォームのサンプル値は、サンプルプロジェクトで確認できます。
Expand フィールド 説明 ソースコードリポジトリーの組織名またはユーザー名
ソースコードリポジトリーのユーザー名または組織名
Playbook のリポジトリー名
新しい Git リポジトリーの名前
Playbook の説明 (オプション)
新しい Playbook プロジェクトの説明
Playbook プロジェクトのコレクション namespace
新しい Playbook Git プロジェクトにより、サンプルコレクションフォルダーが作成されます。コレクション namespace の値を入力します。
Playbook プロジェクトのコレクション名
コレクションの名前。
カタログの所有者名
Developer Hub カタログアイテムの所有者名。これは Red Hat Developer Hub のフィールドです。
ソースコードリポジトリーの組織名またはユーザー名
ソースコードリポジトリーのユーザー名または組織名
Playbook のリポジトリー名
新しい Git リポジトリーの名前
Playbook の説明 (オプション)
新しい Playbook プロジェクトの説明
システム (オプション)
これは Red Hat Developer Hub のフィールドです。
注記コレクションの名前空間は、Python モジュールの命名規則に従う必要があります。コレクションの名前はすべて小文字で短くする必要があります。読みやすさが向上する場合は、コレクション名にアンダースコアを使用できます。
詳細は、Ansible コレクションの命名規則に関するドキュメント を参照してください。
- Review をクリックします。
1.6. プロジェクトの表示 リンクのコピーリンクがクリップボードにコピーされました!
プラグインで作成したプロジェクトを表示するには、Ansible プラグインの Overview ページに移動し、My Items をクリックします。
1.7. プロジェクトの開発 リンクのコピーリンクがクリップボードにコピーされました!
1.7.1. Dev Spaces でのプロジェクトの開発 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Dev Spaces は、Ansible Automation Platform サブスクリプションまたは Ansible plug-ins for Red Hat Developer Hub には含まれていません。
プラグインは、Dev Spaces でプロジェクトを編集するためのコンテキスト認識リンクを提供します。
Dev Spaces インスタンスは、Ansible VS Code エクステンションをインストールし、Ansible コマンドラインツールを提供するデフォルト設定を提供します。Ansible VS Code エクステンションで Ansible Lightspeed を有効化できます。詳細は、Red Hat Ansible Lightspeed with IBM watsonx Code Assistant ユーザーガイド を参照してください。
1.7.2. Dev Spaces での自動化タスクの実行 リンクのコピーリンクがクリップボードにコピーされました!
Dev Spaces のデフォルト設定では、Ansible コマンドラインツールにアクセスできます。
VSCode ユーザーインターフェイスから Dev Spaces で自動化タスクを実行するには、ファイルのリストで Playbook 名を右クリックし、Run Ansible Playbook via ansible-navigator run または Run playbook via ansible-playbook を選択します。
1.8. Playbook プロジェクトを実行するためのコントローラープロジェクトのセットアップ リンクのコピーリンクがクリップボードにコピーされました!
手順
- Ansible プラグインは、Ansible Automation Platform へのリンクを提供します。
- Red Hat Developer Hub UI にログインします。
-
Red Hat Developer Hub ナビゲーションパネルで Ansible の
Aアイコンをクリックします。 Operate をクリックすると、Ansible Automation Platform インスタンスへのリンクが表示されます。
プラグインのインストールに Automation Controller が含まれていない場合は、製品機能ページへのリンクが表示されます。
Go to Ansible Automation Platform をクリックして、新しいブラウザータブでプラットフォームインスタンスを開きます。
あるいは、Ansible プラグインのインストール中にプラットフォームインスタンスが設定されなかった場合は、ブラウザーで Automation Controller インスタンスに移動してログインします。
- Automation Controller にログインします。
- Playbook プロジェクトを保存した GitHub リポジトリー用に、Ansible Automation Platform でプロジェクトを作成します。Automation Controller ユーザーガイド の プロジェクト の章を参照してください。
- 作成したプロジェクトの Playbook を使用するジョブテンプレートを作成します。Automation Controller ユーザーガイド の ジョブテンプレート の章を参照してください。
第2章 Ansible プラグインでフィードバックを提供する リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインには、一般的なフィードバックだけでなく、新しい機能やコンテンツを提案できるフィードバックフォームが用意されています。
-
Red Hat Developer Hub ナビゲーションパネルで Ansible の
Aアイコンをクリックします。 フィードバック アイコンをクリックすると、フィードバックフォームが表示されます。
- フィードバックを入力してください。
- I understand that feedback is shared with Red Hat のチェックボックスを選択します。
- Submit をクリックします。
お客様からのフィードバックが確実に Red Hat に届くようにするには、ブラウザーの広告ブロッカーやプライバシーツールで Red Hat Developer Hub の URL を除外してください。
第3章 例: Red Hat Enterprise Linux ファイアウォール設定の自動化 リンクのコピーリンクがクリップボードにコピーされました!
この例では、高品質の Ansible コンテンツを作成する際に、Ansible プラグインがどのようにあらゆるスキルレベルの Ansible ユーザーの役に立つかを紹介しています。
Ansible を初めて使用するインフラストラクチャーエンジニアが、Red Hat Enterprise Linux (RHEL) ホストファイアウォールを設定するための Playbook を作成するというタスクを与えられたとします。
次の手順では、Ansible プラグインと Dev Spaces を使用して Playbook を開発する方法を紹介しています。
3.1. Playbook についてさらに学習する リンクのコピーリンクがクリップボードにコピーされました!
最初の手順は、利用可能なラーニングパスを使用して Ansible Playbook についてさらに詳しく学習することです。
-
Red Hat Developer Hub ナビゲーションパネルで Ansible の
Aアイコンをクリックします。 - LEARN をクリックし、Getting Started with Ansible Playbooks のラーニングパスを選択します。これにより、Red Hat Developer の Web サイトにリダイレクトされます。
- ログインを求められた場合は、Red Hat Developer アカウントを作成するか、詳細を入力します。
- ラーニングパスを完了します。
3.2. RHEL システムロールの既存の Ansible コンテンツの検出 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat では、Red Hat またはユーザーの組織によってテストおよび承認された信頼できる自動化コンテンツを使用することを推奨します。
Automation Hub は、Red Hat とそのパートナーからの信頼できるコンテンツコレクションを検出、ダウンロード、管理するための中央リポジトリーです。Private Automation Hub は、コンテンツコレクションを管理するためのオンプレミスソリューションを提供します。
-
Red Hat Developer Hub ナビゲーションパネルで Ansible の
Aアイコンをクリックします。 - Discover existing collections をクリックします。
Go to Automation Hub をクリックします。
- Ansible プラグインで Private Automation Hub が設定されている場合は、PrivateHubName インスタンスにリダイレクトされます。
- Ansible プラグインのインストール設定で Private Automation Hub が設定されていない場合は、Red Hat Hybrid Console (RHCC) Automation Hub にリダイレクトされます。
この例では、RHCC Automation Hub にリダイレクトされます。
- ログインを求められた場合は、Red Hat カスタマーポータルの認証情報を入力します。
rhel firewallキーワードを使用してコレクションをフィルターします。検索結果には、
rhel_system_rolesコレクションが返されます。
RHEL システムロールコレクションには、ファイアウォールを設定するために再利用できる認定済みの Ansible コンテンツが含まれています。
3.3. ファイアウォールを設定するための新しい Playbook プロジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインを使用して、新しい Ansible Playbook プロジェクトを作成します。
-
Red Hat Developer Hub ナビゲーションパネルで Ansible の
Aアイコンをクリックします。 - ランディングページの Create ドロップダウンメニューから、Create Ansible Git Project を選択します。
- Create Ansible Playbook Project ソフトウェアテンプレートで Choose をクリックします。
- Create Ansible Playbook Project ページで以下の情報を入力します。
| フィールド | 必須 | 説明 | 値の例 |
|---|---|---|---|
| ソースコードリポジトリーの組織名またはユーザー名 | はい | ソースコードリポジトリーのユーザー名または組織名。 |
|
| Playbook のリポジトリー名 | はい | 新しい Git リポジトリーの名前。 |
|
| Playbook の説明 | いいえ | 新しい Playbook プロジェクトの説明。 |
|
| Playbook プロジェクトのコレクション namespace | はい | 新しい Playbook Git プロジェクトにより、サンプルコレクションフォルダーが作成されます。コレクション namespace の値を入力します。 |
|
| Playbook プロジェクトのコレクション名 | はい | これはサンプルコレクションの名前です。 |
|
| カタログの所有者名 | はい | Developer Hub カタログアイテムの所有者名。これは Red Hat Developer Hub のフィールドです。 |
|
| システム | いいえ | これは Red Hat Developer Hub のフィールドです。 |
|
- Review をクリックします。
- Create をクリックして、新しい Playbook プロジェクトをプロビジョニングします。
- Open in catalog をクリックして、プロジェクトを表示します。
3.4. ファイアウォール設定を自動化するための新しい Playbook の作成 リンクのコピーリンクがクリップボードにコピーされました!
新しい Playbook を作成し、RHEL システムロールコレクションを使用して Red Hat Enterprise Linux ファイアウォールの設定を自動化します。
- Dev Spaces インスタンスで、 → をクリックします。
-
ファイル名に
firewall.ymlと入力し、OK をクリックしてルートディレクトリーに保存します。 以下の行を
firewall.ymlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Ansible VS Code エクステンションから Ansible Lightspeed with IBM watsonx Code Assistant を使用して、Playbook を生成できます。詳細は、Red Hat Ansible Lightspeed with IBM watsonx Code Assistant ユーザーガイド を参照してください。
3.5. ファイアウォール Playbook プロジェクトの編集 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインは OpenShift Dev Spaces を統合して Ansible プロジェクトを編集します。OpenShift Dev Spaces は、オンデマンドの Web ベース統合開発環境 (IDE) を提供します。
Ansible プラグインを使用してプロビジョニングされた Ansible Git プロジェクトには、OpenShift Dev Spaces のベストプラクティス設定が含まれています。これらの設定には、Ansible VS Code エクステンションのインストールと、IDE ターミナルから Ansible Navigator や Ansible Lint などの Ansible 開発ツールへのアクセスの提供が含まれます。
OpenShift Dev Spaces はオプションであり、Ansible プラグインを実行する上で必須ではありません。これは別の Red Hat 製品であり、Ansible Automation Platform または Red Hat Developer Hub サブスクリプションには含まれていません。
この例では、Ansible プラグインのインストールで OpenShift Dev Spaces が設定されていることを前提としています。
手順
Playbook プロジェクトの catalog item ビューで、Open Ansible project in OpenShift Dev Spaces をクリックします。
OpenShift Dev Spaces の VS Code インスタンスが新しいブラウザータブで開きます。新しい Ansible Playbook Git プロジェクトが自動的に読み込まれます。