自動化ハブの使用開始
Ansible コレクションコンテンツのデフォルトサーバーとしての Red Hat Automation Hub の設定
概要
はじめに リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Ansible Automation Hub は、Red Hat サブスクリプションをお持ちのお客様が、Red Hat および弊社のテクノロジーパートナーがサポートするコンテンツをすばやく見つけて使用できる場所を提供し、最も要求の厳しい環境にさらなる安心を提供します。
Ansible Galaxy クライアント ansible-galaxy は、コマンドラインからロールおよびコレクションを管理します。ansible-galaxy クライアントが認定済みでサポートされている Ansible Collection を可能な限り使用するようにするには、ansible.cfg ファイルを更新して、Ansible Collection のプライマリーソースとして Red Hat Automation Hub を使用します。
このガイドでは、Red Hat Automation Hub を認定 Ansible Collection コンテンツのデフォルトソースとして使用するように ansible.cfg ファイルを設定する際に必要な手順を説明します。
多様性を受け入れるオープンソースの強化 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、用語の置き換えは、今後の複数のリリースにわたって段階的に実施されます。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。
第1章 Red Hat Automation Hub API トークンの作成 リンクのコピーリンクがクリップボードにコピーされました!
コレクションをアップロードまたはダウンロードすることで、Automation Hub と対話できるようにする前に、API トークンを作成する必要があります。Automation Hub API トークンは、ansible-galaxy クライアントを Red Hat Automation Hub サーバーに対して認証します。
API トークンは、Automation Hub のトークン 管理 または Private Automation Hub (PAH)の API トークン管理 を使用して作成できます。
1.1. Red Hat Automation Hub API トークンの作成 リンクのコピーリンクがクリップボードにコピーされました!
コレクションをアップロードまたはダウンロードすることで、Automation Hub と対話できるようにする前に、API トークンを作成する必要があります。Automation Hub API トークンは、ansible-galaxy クライアントを Red Hat Automation Hub サーバーに対して認証します。
Automation Hub Token management を使用すると、API トークンを作成できます。
前提条件
- Red Hat Ansible Automation Platform の有効なサブスクリプション認証情報。
手順
- https://cloud.redhat.com/ansible/automation-hub/token/ に移動します。
- をクリックします。
- アイコンをクリックして、API トークンをクリップボードにコピーします。
- API トークンをファイルに貼り付け、安全な場所に保存します。
API トークンは、コンテンツを保護するために使用されるシークレットトークンです。API トークンを安全な場所に保存します。
API トークンは、Automation Hub をデフォルトのコレクションサーバーとして設定するか、ansible-galaxy コマンドラインツールを使用してコレクションをアップロードできるようになりました。
1.2. Private Automation Hub での API トークンの作成 リンクのコピーリンクがクリップボードにコピーされました!
プライベート Automation Hub の API トークン 管理 を使用して、API トークンを作成できます。
前提条件
- Red Hat Ansible Automation Platform の有効なサブスクリプション認証情報。
手順
- PAH に移動します。
- サイドバーから、 → に移動します。
- をクリックします。
- copy アイコンをクリックして、API トークンをクリップボードにコピーします。
- API トークンをファイルに貼り付け、安全な場所に保存します。
API トークンは、コンテンツを保護するために使用されるシークレットトークンです。API トークンを安全な場所に保存します。
API トークンは、Automation Hub をデフォルトのコレクションサーバーとして設定するか、ansible-galaxy コマンドラインツールを使用してコレクションをアップロードできるようになりました。
1.3. オフライントークンをアクティブな状態に維持 リンクのコピーリンクがクリップボードにコピーされました!
オフライントークンをアクティブな状態にしておくと、ユーザーがオフラインの場合でも、アプリケーションがユーザーの代わりにアクションを実行する必要がある場合に便利です。たとえば、ルーチンデータのバックアップです。
オフライントークンは、30 日の非アクティブ後に有効期限が切れます。オフライントークンを定期的に更新することで、オフライントークンの有効期限が切れないようにすることができます。
オフライントークンの期限が切れたら、新しいトークンを要求する必要があります。
定期的に以下のコマンドを実行して、トークンの有効期限が切れないようにします。
curl https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token -d grant_type=refresh_token -d client_id="cloud-services" -d refresh_token="{{ user_token }}" --fail --silent --show-error --output /dev/null
curl https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token -d grant_type=refresh_token -d client_id="cloud-services" -d refresh_token="{{ user_token }}" --fail --silent --show-error --output /dev/null
第2章 Red Hat Automation Hub をコンテンツのプライマリーソースとして設定する リンクのコピーリンクがクリップボードにコピーされました!
Ansible Certified Content Collections にアクセスするためのコンテンツのプライマリーソースとして Red Hat Automation Hub を設定します。Automation Hub は、コマンドラインインターフェイス (CLI) または Web コンソールで設定できます。
2.1. CLI を使用したコンテンツのプライマリーソースとしての Red Hat Automation Hub の設定 リンクのコピーリンクがクリップボードにコピーされました!
CLI を使用して、Red Hat Automation Hub をコンテンツのプライマリーソースとして設定します。Automation Hub を設定するには、ansible.cfg 設定ファイルを変更する必要があります。Automation Hub を使用すると、認定され、サポートされているコレクションにアクセスできます。
前提条件
- Automation Hub サーバーの API トークンを取得している。詳細は、Red Hat Automation Hub API トークンの作成 を参照してください。
Creating a new token revokes any previous tokens
generated for {PrivateHubName}. Ensure that you update any Controller or scripts that you created with the previous token.
Creating a new token revokes any previous tokens
generated for {PrivateHubName}. Ensure that you update any Controller or scripts that you created with the previous token.
手順
-
[galaxy]セクション配下にserver_listオプションを追加し、1 つ以上のサーバー名を指定します。 各サーバー名に新しいセクションを作成します。
[galaxy_server._<server_name>_]
[galaxy_server._<server_name>_]Copy to Clipboard Copied! Toggle word wrap Toggle overflow 各サーバー名に
urlオプションを設定します。サーバー URL にapi/galaxy/サブディレクトリーを含める必要があります。https://<server_fully_qualified_domain_name>/api/galaxy/
https://<server_fully_qualified_domain_name>/api/galaxy/Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
オプション:
auth_urlオプションを設定します。コミュニティーの Ansible Galaxy にはauth_urlが必要ありません。 - Automation Hub サーバーの API トークンを設定します。
以下の ansible.cfg 設定ファイルの例は、優先順位の高い順に複数のサーバーを設定する方法を示しています。Automation Hub がプライマリーソースとして設定され、Ansible Galaxy サーバーがセカンダリーソースとして設定されています。
ansible.cfg
301 リダイレクトの受信を防ぐために、すべての API URL は末尾のスラッシュ / で終わる必要があります。
これで、CLI を使用して Automation Hub をプライマリーサーバーとして設定できました。次に、サポートされているコレクションのダウンロードとインストールに進むことができます。
2.2. Web コンソールを使用したコンテンツのプライマリーソースとしての Red Hat Automation Hub の設定 リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールを使用して、Red Hat Automation Hub をコンテンツのプライマリーソースとして設定します。Automation Hub を設定するには、認証情報を作成し、それを組織の Galaxy 認証情報フィールドに追加する必要があります。Automation Hub を使用すると、認定され、サポートされているコレクションにアクセスできます。
前提条件
- Automation Hub サーバーの API トークンを取得している。詳細は、Red Hat Automation Hub API トークンの作成 を参照してください。
Creating a new token revokes any previous tokens
generated for {PrivateHubName}. Ensure that you update any Controller or scripts that you created with the previous token.
Creating a new token revokes any previous tokens
generated for {PrivateHubName}. Ensure that you update any Controller or scripts that you created with the previous token.
手順
- Automation Controller に移動します。
新規認証情報を作成します。
- Credentials 画面で をクリックします。
- Name フィールドに新規の認証情報の名前を入力します。
- オプションで、説明を入力し、認証情報が関連付けられている組織の名前を入力するか、選択します。
- Organization で、認証情報を使用する組織を選択します。
- 認証情報のタイプとして Ansible Galaxy/Automation Hub API Token を選択します。
- Type Details に、前提条件で作成した Galaxy サーバー URL、認証サーバー URL、および API トークン を入力します。
- をクリックします。
組織の Galaxy Credentials フィールドから作成した認証情報を選択します。
- → に移動します。
- Galaxy 認証情報を追加する組織を選択します。
- をクリックします。
- Galaxy 認証情報 で、Search アイコンをクリックします。
- Automation Hub 用に作成した認証情報を選択し、リストの先頭に配置します。
- オプション: Ansible Galaxy などのコンテンツのセカンダリーソースがある場合は、Automation Hub 用に作成した認証情報の後にこの認証情報を配置します。
- をクリックします。
- をクリックします。
検証
認証情報を検証するには、既存のソース管理管理 (SCM) ベースのプロジェクトを選択し、Refresh アイコンをクリックして更新します。
- プロジェクトリポジトリーに移動します。
-
collections/requirements.ymlファイルを使用するプロジェクトを選択します。 - 更新アイコン [refresh icon] をクリックしてプロジェクトを更新します。
プロジェクトのステータスが Successful になると、認証情報は有効です。
Web コンソールを使用して Automation Hub をプライマリーサーバーとして設定したので、サポートされているコレクションのダウンロードとインストールに進むことができます。