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 からテクニカルサポートに連絡してリクエストを送信してください。
第1章 Ansible plug-ins for Red Hat Developer Hub リンクのコピーリンクがクリップボードにコピーされました!
1.1. Red Hat Developer Hub リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub (RHDH) は、開発者ポータルをビルドするために設計されたオープンな開発者プラットフォームです。
1.2. Ansible plug-ins for Red Hat Developer Hub リンクのコピーリンクがクリップボードにコピーされました!
Ansible plug-ins for Red Hat Developer Hub は、Ansible ファーストの Red Hat Developer Hub のユーザーエクスペリエンスを提供し、すべてのスキルレベルの Ansible ユーザーの自動化エクスペリエンスを簡素化します。Ansible プラグインは、Ansible 学習者のオンボーディングを加速し、組織全体で Ansible ユースケースの導入を効率化するためのキュレートされたコンテンツと機能を提供します。
Ansible プラグインは以下を提供します。
- Ansible ユーザー向けにカスタマイズされたホームページとナビゲーション。
- Ansible を初めて使用するユーザーを支援するために、キュレートされた Ansible ラーニングパス。
- ベストプラクティスに従う Ansible Playbook およびコレクションプロジェクトを作成するためのソフトウェアテンプレート。
- 独自の設定を持つ、サポートされている開発環境とツールへのリンク。
1.3. アーキテクチャー リンクのコピーリンクがクリップボードにコピーされました!
第2章 Helm チャートを使用した OpenShift Container Platform への Ansible プラグインのインストール リンクのコピーリンクがクリップボードにコピーされました!
以下の手順では、Helm チャートを使用して Red Hat OpenShift Container Platform 上の Red Hat Developer Hub インスタンスに Ansible プラグインをインストールする方法を説明します。
ワークフローは次のとおりです。
- Ansible プラグインファイルをダウンロードします。
- Ansible プラグインをホストするために、OpenShift クラスターにプラグインレジストリーを作成します。
- プラグインを Helm チャートに追加します。
- カスタム ConfigMap を作成します。
- カスタム ConfigMap を Helm チャートに追加します。
必須設定および任意設定の手順に従って、カスタム ConfigMap と Helm チャートを編集します。
注記設定を更新するたびに、Helm と ConfigMap への変更を保存できます。これらのファイルに対するすべての変更を 1 回のセッションで行う必要はありません。
2.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat OpenShift Container Platform にインストールされた Red Hat Developer Hub。
- Helm のインストールは、OpenShift Container Platform への Red Hat Developer Hub のインストール の Helm チャートを使用した OpenShift Container Platform への Red Hat Developer Hub のインストール セクションの手順に従ってください。
- Operator のインストールは、OpenShift Container Platform への Red Hat Developer Hub のインストール の Operator を使用した OpenShift Container Platform への Red Hat Developer Hub のインストール セクションの手順に従ってください。
- Red Hat Ansible Automation Platform への有効なサブスクリプション。
- アプリケーションを作成するための適切な権限がプロジェクト内で設定されている OpenShift Container Platform インスタンス。
- Red Hat Developer Hub インスタンスが Automation Controller API をクエリーできる。
- オプション: 統合されたラーニングパスを使用するには、developers.redhat.com への発信アクセスが必要です。
2.2. 推奨される RHDH 事前設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat は、RHDH で次の初期設定タスクを実行することを推奨します。ただし、Ansible plug-ins for Red Hat Developer Hub のインストールは、これらのタスクを完了する前に実行できます。
Red Hat は、publish:github アクションを使用する RHDH 用のソフトウェアテンプレートのリポジトリー を提供しています。このソフトウェアテンプレートを使用するには、必要な GitHub 動的プラグインをインストールする必要があります。
2.3. Ansible プラグインファイルのダウンロード リンクのコピーリンクがクリップボードにコピーされました!
-
Red Hat Ansible Automation Platform 製品ソフトウェアのダウンロードページ から、プラグインの最新の
.tarファイルをダウンロードします。ファイル名の形式はansible-backstage-rhaap-bundle-x.y.z.tar.gzです。Ansible プラグインリリースバージョン (1.0.0など) を、x.y.zに置き換えます。 .tarファイルを保存するディレクトリーをローカルマシンに作成します。mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>
$ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ディレクトリーパスを表す環境変数 (
$DYNAMIC_PLUGIN_ROOT_DIR) を設定します。export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>
$ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ansible-backstage-rhaap-bundle-<version-number>.tar.gzの内容を$DYNAMIC_PLUGIN_ROOT_DIRに展開します。tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR
$ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIRCopy to Clipboard Copied! Toggle word wrap Toggle overflow Ansible プラグインリリースバージョン (
1.0.0など) を、x.y.zに置き換えます。
検証
ls を実行して、展開されたファイルが $DYNAMIC_PLUGIN_ROOT_DIR ディレクトリーにあることを確認します。
.integrity ファイルタイプのファイルには、プラグインの SHA 値が含まれています。SHA 値は、プラグインの設定時に使用されます。
2.4. Ansible プラグインのレジストリーの作成 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift クラスターにレジストリーを設定して Ansible プラグインをホストし、プラグインを Red Hat Developer Hub (RHDH) にインストールできるようにします。
手順
- 認証情報を使用して OpenShift Container Platform インスタンスにログインし、新しいアプリケーションを作成します。
Red Hat Developer Hub OpenShift プロジェクトを開きます。
oc project <YOUR_DEVELOPER_HUB_PROJECT>
$ oc project <YOUR_DEVELOPER_HUB_PROJECT>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下のコマンドを実行して、OpenShift クラスターにプラグインレジストリービルドを作成します。
oc new-build httpd --name=plugin-registry --binary oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait oc new-app --image-stream=plugin-registry
$ oc new-build httpd --name=plugin-registry --binary $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait $ oc new-app --image-stream=plugin-registryCopy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
プラグインレジストリーが正常にデプロイされたことを確認するには、OpenShift Web コンソールの Red Hat Developer Hub アプリケーションの Developer パースペクティブで Topology ビューを開きます。
プラグインレジストリーをクリックしてログを表示します。
(1) Developer Hub インスタンス
(2) プラグインレジストリー
- ターミナルのタブをクリックし、コンテナーにログインします。
ターミナルで
lsを実行して、.tarファイルがプラグインレジストリーにあることを確認します。ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgzCopy to Clipboard Copied! Toggle word wrap Toggle overflow バージョン番号とファイル名は異なる場合があります。
2.5. 必須設定 リンクのコピーリンクがクリップボードにコピーされました!
2.5.1. Ansible プラグイン設定の追加 リンクのコピーリンクがクリップボードにコピーされました!
- OpenShift Developer UI で、 → → → → に移動します。
Helm チャート設定を更新して、Red Hat Developer Hub インスタンスに動的プラグインを追加します。YAML ファイルの
pluginsセクションで、有効にする動的プラグインを追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
パッケージセクションで、プラグインファイル名のx.y.zを、Ansible プラグインの正しいバージョン番号に置き換えます。 -
各 Ansible プラグインの対応する
.integrityファイルの内容を使用して、インテグリティーの値を更新します。 をクリックします。
開発者ハブ Pod が再起動し、プラグインがインストールされます。
検証
プラグインがインストールされたことを確認するには、install-dynamic-plugin コンテナーのログを開き、Ansible プラグインが Red Hat Developer Hub に表示されることを確認します。
- OpenShift Web コンソールで Red Hat Developer Hub アプリケーションの Developer パースペクティブを開きます。
- Topology ビューを選択します。
- Red Hat Developer Hub のデプロイメント Pod を選択して、情報ペインを開きます。
- 情報ペインの Resources タブを選択します。
- Pod セクションで、View logs をクリックして Pod details ページを開きます。
- Pod details ページで、Logs タブを選択します。
-
コンテナーのドロップダウンリストから
install-dynamic-pluginsを選択して、コンテナーログを表示します。 install-dynamic-pluginコンテナーログで、Ansible プラグインを検索します。ログから抜粋した次の例は、プラグインの 1 つが正常にインストールされたことを示しています。
=> Successfully installed dynamic plugin http://plugin-registry-1:8080/ansible-plugin-backstage-rhaap-dynamic-1.1.0.tgz
=> Successfully installed dynamic plugin http://plugin-registry-1:8080/ansible-plugin-backstage-rhaap-dynamic-1.1.0.tgzCopy to Clipboard Copied! Toggle word wrap Toggle overflow 次の画像は、Pod details ページのコンテナーログを示しています。バージョン番号とファイル名は異なる場合があります。
2.5.2. Ansible Development Tools サイドカーコンテナーの追加 リンクのコピーリンクがクリップボードにコピーされました!
プラグインがロードされたら、Red Hat Developer Hub Pod に Ansible Development Container (ansible-devtools-server) をサイドカーコンテナーとして追加します。
2.5.2.1. Red Hat Developer Hub Helm 設定へのプルシークレットの追加 リンクのコピーリンクがクリップボードにコピーされました!
前提条件
Ansible Development Container のダウンロードには、Red Hat カスタマーポータルアカウントおよび Red Hat Service Registry アカウントが必要です。
手順
- 必要に応じて、新しい Red Hat Registry Service アカウント を作成します。
- Account name 列の下にあるトークン名をクリックします。
- OpenShift Secret タブを選択し、指示に従ってプルシークレットを Red Hat Developer Hub OpenShift プロジェクトに追加します。
新しいシークレットを Red Hat Developer Hub の Helm 設定に追加し、
<your-redhat-registry-pull-secret>を Red Hat Registry Service Account の Web サイトで生成したシークレットの名前に置き換えます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
詳細は、Red Hat Container Registry のドキュメント を参照してください。
2.5.2.2. Ansible Developer Tools コンテナーの追加 リンクのコピーリンクがクリップボードにコピーされました!
コンテナーを追加するには、Helm チャート設定を更新する必要があります。
手順
- OpenShift UI にログインします。
- → → → → に移動し、Helm チャートを開きます。
YAML ファイルの
extraContainersセクションを更新します。次のコードを追加します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記イメージプルポリシーは
imagePullPolicy: IfNotPresentです。イメージは、そのイメージがノード上にない場合にのみプルされます。常に最新のイメージを使用する場合は、imagePullPolicy: Alwaysに更新してください。- をクリックします。
検証
コンテナーが実行中であることを確認するには、コンテナーログを確認します。
2.5.3. カスタム ConfigMap の追加 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform ノード ガイドの config map の作成および使用 セクションの手順に従って、Red Hat Developer Hub ConfigMap を作成します。次の例では、app-config-rhdh という名前のカスタム ConfigMap を使用します。
カスタム ConfigMap を編集するには、OpenShift UI にログインし、 → → → → に移動します。
2.5.4. Ansible Dev Tools Server の設定 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインが提供されるソフトウェアテンプレートを使用して新しいプロジェクトをプロビジョニングするには、creatorService URL が必要です。
手順
-
カスタム ConfigMap の追加 で作成したカスタム Red Hat Developer Hub の config map
app-config-rhdhを編集します。 以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.5.5. Ansible Automation Platform の詳細の設定 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインはトークンを使用して、コントローラー API で Ansible Automation Platform サブスクリプションステータスをクエリーします。
Ansible プラグインは、Ansible Automation Platform のサブスクリプションステータスに関係なく引き続き機能します。
手順
- Automation Controller ユーザーガイド の アプリケーション セクションに従って、Automation Controller で「読み取り」スコープを持つ Personal Access Token (PAT) を作成します。
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 Ansible Automation Platform の詳細を
app-config-rhdh.yamlに追加します。-
Automation Controller URL で
baseURLキーを設定します。 -
手順 1 で作成したトークン値を使用して
tokenキーを設定します。 checkSSLキーをtrueまたはfalseに設定します。checkSSLがtrueに設定されている場合、Ansible プラグインは SSL 証明書が有効であるかどうかを確認します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
Automation Controller URL で
Red Hat Developer Hub インストールは、ユーザー自身で外部および不正アクセスから保護する必要があります。バックエンド認証キーを他のシークレットと同様に管理します。強力なパスワード要件を満たし、パスワードを設定ファイルで公開せず、環境変数としてのみ設定ファイルに挿入します。
2.5.6. showCaseLocation の設定 リンクのコピーリンクがクリップボードにコピーされました!
カスタム config map で showCaseLocation を設定する必要があります。
手順
-
カスタム ConfigMap の追加 で作成したカスタム Red Hat Developer Hub の config map
app-config-rhdhを編集します。 以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.5.7. Ansible プラグインソフトウェアテンプレートの追加 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Ansible は、Ansible のベストプラクティスに基づいて新しい Playbook とコレクションプロジェクトをプロビジョニングする Red Hat Developer Hub のソフトウェアテンプレートを提供します。
手順
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 -
以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。
詳細は、Red Hat Developer Hub の管理ガイド の テンプレートの管理 セクションを参照してください。
2.5.8. ロールベースアクセス制御の設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub は、ロールベースアクセス制御 (RBAC) 機能を提供します。その後、RBAC を Ansible プラグインコンテンツに適用できます。
次のロールを割り当てます。
-
admin:superUsersグループのメンバーは、Ansible プラグインの Create タブでテンプレートを選択して、Playbook およびコレクションプロジェクトを作成できます。 -
admin:usersグループのメンバーは、Ansible プラグインの Create タブでテンプレートを表示できます。
次の例では、Red Hat Developer Hub に RBAC を追加します。
権限ポリシーと RBAC の管理の詳細は、Red Hat Developer Hub の 認可 ガイドを参照してください。
2.6. Ansible プラグインの任意設定 リンクのコピーリンクがクリップボードにコピーされました!
2.6.1. Red Hat Developer Hub 認証の有効化 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub (RHDH) は、複数のソースコントロール管理 (SCM) システムのインテグレーションを提供します。これは、プラグインがリポジトリーを作成するために必要です。
Red Hat Developer Hub の管理ガイド の Red Hat Developer Hub での認証の有効化 の章を参照してください。
2.6.2. Ansible プラグインのオプションのインテグレーションの設定 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインは、Ansible Automation Platform およびその他のオプションの Red Hat 製品とのインテグレーションを提供します。
カスタム ConfigMap を編集するには、OpenShift UI にログインし、 → → → に移動します。
2.6.2.1. OpenShift Dev Spaces の設定 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Dev Spaces が Ansible プラグイン用に設定されている場合、ユーザーは Red Hat Developer Hub のカタログ項目ビューからリンクをクリックし、Dev Spaces を使用してプロビジョニングされた Ansible Git プロジェクトを編集できます。
OpenShift Dev Spaces は別の製品であり、オプションです。プラグインはこれがなくても機能します。
これは別の Red Hat 製品であり、Ansible Automation Platform または Red Hat Developer Hub サブスクリプションには含まれていません。
Ansible プラグインで OpenShift Dev Spaces リンクが設定されていない場合、Ansible プラグインランディングページの DEVELOP セクションにある Go to OpenShift Dev Spaces dashboard リンクをクリックすると、Ansible 開発ツールのホームページ にリダイレクトされます。
前提条件
- Dev Spaces のインストール。Red Hat OpenShift Dev Spaces 管理ガイド の Dev Spaces のインストール セクションを参照してください。
手順
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
<Your OpenShft Dev Spaces URL>を OpenShift Dev Spaces URL に置き換えます。 -
OpenShift Developer UI で、
Red Hat Developer HubPod を選択します。 - Actions を開きます。
- Restart rollout をクリックします。
2.6.2.2. Private Automation Hub URL の設定 リンクのコピーリンクがクリップボードにコピーされました!
Private Automation Hub は、認定された Ansible コレクション、実行環境、および組織によって提供される追加の検証済みコンテンツ用の集中型オンプレミスリポジトリーを提供します。
Ansible プラグインで Private Automation Hub の URL が設定されていない場合、ユーザーは Red Hat Hybrid Cloud Console Automation Hub にリダイレクトされます。
Private Automation Hub 設定はオプションですが、推奨されます。Ansible プラグインはこれがなくても機能します。
前提条件:
Private Automation Hub インスタンス。
Private Automation Hub のインストールに関する詳細は、Ansible Automation Platform ドキュメントの インストールとアップグレード ガイドを参照してください。
手順:
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
<https://MyOwnPAHUrl/>を Private Automation Hub URL に置き換えます。 -
OpenShift Developer UI で、
Red Hat Developer HubPod を選択します。 - Actions を開きます。
- Restart rollout をクリックします。
2.7. 完全な例 リンクのコピーリンクがクリップボードにコピーされました!
2.7.1. Ansible プラグインエントリーの完全な app-config-rhdh ConfigMap の例 リンクのコピーリンクがクリップボードにコピーされました!
2.7.2. Ansible プラグインの完全な Helm チャート設定例 リンクのコピーリンクがクリップボードにコピーされました!
第3章 Operator を使用した OpenShift Container Platform への Ansible プラグインのインストール リンクのコピーリンクがクリップボードにコピーされました!
以下の手順では、Operator を使用して Red Hat OpenShift Container Platform 上の Red Hat Developer Hub インスタンスに Ansible プラグインをインストールする方法を説明します。
3.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat OpenShift Container Platform にインストールされた Red Hat Developer Hub。
- Helm のインストールは、OpenShift Container Platform への Red Hat Developer Hub のインストール の Helm チャートを使用した OpenShift Container Platform への Red Hat Developer Hub のインストール セクションの手順に従ってください。
- Operator のインストールは、OpenShift Container Platform への Red Hat Developer Hub のインストール の Operator を使用した OpenShift Container Platform への Red Hat Developer Hub のインストール セクションの手順に従ってください。
- Red Hat Ansible Automation Platform への有効なサブスクリプション。
- アプリケーションを作成するための適切な権限がプロジェクト内で設定されている OpenShift Container Platform インスタンス。
- Red Hat Developer Hub インスタンスが Automation Controller API をクエリーできる。
- オプション: 統合されたラーニングパスを使用するには、developers.redhat.com への発信アクセスが必要です。
3.2. 推奨される RHDH 事前設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat は、RHDH で次の初期設定タスクを実行することを推奨します。ただし、Ansible plug-ins for Red Hat Developer Hub のインストールは、これらのタスクを完了する前に実行できます。
Red Hat は、publish:github アクションを使用する RHDH 用のソフトウェアテンプレートのリポジトリー を提供しています。このソフトウェアテンプレートを使用するには、必要な GitHub 動的プラグインをインストールする必要があります。
3.3. Ansible 開発ツール用のサイドカーコンテナーを RHDH Operator カスタムリソースに追加する リンクのコピーリンクがクリップボードにコピーされました!
Ansible 開発ツール用のサイドカーコンテナーを Developer Hub Pod に追加します。これを行うには、Red Hat Developer Hub デプロイメントのベース ConfigMap を変更する必要があります。
- OpenShift コンソールで、Topology ビューを選択します。
- developer-hub のインスタンスで、More actions ⋮ をクリックし、Edit backstage を選択して、Backstage details ページを開きます。
- YAML タブを選択します。
編集ペインで、
spec.deployment.patch.spec.template.specブロックにcontainersブロックを追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - をクリックします。
デプロイメントに環境変数をさらに追加する場合は、spec.application.extraEnvs ブロックにその環境変数を追加できます。
3.4. Ansible プラグインファイルのダウンロード リンクのコピーリンクがクリップボードにコピーされました!
-
Red Hat Ansible Automation Platform 製品ソフトウェアのダウンロードページ から、プラグインの最新の
.tarファイルをダウンロードします。ファイル名の形式はansible-backstage-rhaap-bundle-x.y.z.tar.gzです。Ansible プラグインリリースバージョン (1.0.0など) を、x.y.zに置き換えます。 .tarファイルを保存するディレクトリーをローカルマシンに作成します。mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>
$ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ディレクトリーパスを表す環境変数 (
$DYNAMIC_PLUGIN_ROOT_DIR) を設定します。export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>
$ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ansible-backstage-rhaap-bundle-<version-number>.tar.gzの内容を$DYNAMIC_PLUGIN_ROOT_DIRに展開します。tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR
$ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIRCopy to Clipboard Copied! Toggle word wrap Toggle overflow Ansible プラグインリリースバージョン (
1.0.0など) を、x.y.zに置き換えます。
検証
ls を実行して、展開されたファイルが $DYNAMIC_PLUGIN_ROOT_DIR ディレクトリーにあることを確認します。
.integrity ファイルタイプのファイルには、プラグインの SHA 値が含まれています。SHA 値は、プラグインの設定時に使用されます。
3.5. Ansible プラグインのレジストリーの作成 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift クラスターにレジストリーを設定して Ansible プラグインをホストし、プラグインを Red Hat Developer Hub (RHDH) にインストールできるようにします。
手順
- 認証情報を使用して OpenShift Container Platform インスタンスにログインし、新しいアプリケーションを作成します。
Red Hat Developer Hub OpenShift プロジェクトを開きます。
oc project <YOUR_DEVELOPER_HUB_PROJECT>
$ oc project <YOUR_DEVELOPER_HUB_PROJECT>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下のコマンドを実行して、OpenShift クラスターにプラグインレジストリービルドを作成します。
oc new-build httpd --name=plugin-registry --binary oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait oc new-app --image-stream=plugin-registry
$ oc new-build httpd --name=plugin-registry --binary $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait $ oc new-app --image-stream=plugin-registryCopy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
プラグインレジストリーが正常にデプロイされたことを確認するには、OpenShift Web コンソールの Red Hat Developer Hub アプリケーションの Developer パースペクティブで Topology ビューを開きます。
プラグインレジストリーをクリックしてログを表示します。
(1) Developer Hub インスタンス
(2) プラグインレジストリー
- ターミナルのタブをクリックし、コンテナーにログインします。
ターミナルで
lsを実行して、.tarファイルがプラグインレジストリーにあることを確認します。ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgzCopy to Clipboard Copied! Toggle word wrap Toggle overflow バージョン番号とファイル名は異なる場合があります。
3.6. 動的プラグインのインストール リンクのコピーリンクがクリップボードにコピーされました!
動的プラグインをインストールするには、RHDH プラグイン設定の ConfigMap にプラグインを追加します (例: rhaap-dynamic-plugins-config)。
RHDH プラグイン設定用の ConfigMap ファイルをまだ作成していない場合は、OpenShift Container Platform ノード ガイドの config map の作成および使用 セクションの手順に従って作成してください。
次の手順で使用する ConfigMap の例は、rhaap-dynamic-plugins-config という名前です。
手順
- OpenShift コンソールのナビゲーションペインで ConfigMaps を選択します。
-
リストから
rhaap-dynamic-plugins-configConfigMap を選択します。 -
YAML タブを選択して、
rhaap-dynamic-plugins-configConfigMap を編集します。 data.dynamic-plugins.yaml.pluginsブロックに、プラグインレジストリーからの 3 つの動的プラグインを追加します。-
integrityのハッシュ値には、各プラグインに対応する$DYNAMIC_PLUGIN_ROOT_DIRディレクトリー内の.integrityファイルを使用します。たとえば、ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgzプラグインの場合は、ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrityを使用します。 xyzは、プラグインの正しいバージョンに置き換えます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
- をクリックします。
ローリング再起動の進捗を表示するには、次の手順を実行します。
- Topology ビューで、デプロイメント Pod を選択し、View logs をクリックします。
-
コンテナーのリストから
install-dynamic-pluginsを選択します。
検証
- OpenShift コンソールで、Topology ビューを選択します。
- デプロイメント Pod の Open URL アイコンをクリックして、ブラウザーウィンドウで Red Hat Developer Hub インスタンスを開きます。
Ansible プラグインがナビゲーションペインに表示されます。Administration を選択すると、インストールされているプラグインが Plugins タブにリスト表示されます。
3.7. カスタム ConfigMap の追加 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform ノード ガイドの config map の作成および使用 セクションの手順に従って、Red Hat Developer Hub ConfigMap を作成します。次の例では、app-config-rhdh という名前のカスタム ConfigMap を使用します。
カスタム ConfigMap を編集するには、OpenShift UI にログインし、 → → → → に移動します。
3.8. Ansible Dev Tools Server の設定 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインが提供されるソフトウェアテンプレートを使用して新しいプロジェクトをプロビジョニングするには、creatorService URL が必要です。
手順
-
カスタム ConfigMap の追加 で作成したカスタム Red Hat Developer Hub の config map
app-config-rhdhを編集します。 以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.9. Ansible Automation Platform の詳細の設定 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインはトークンを使用して、コントローラー API で Ansible Automation Platform サブスクリプションステータスをクエリーします。
Ansible プラグインは、Ansible Automation Platform のサブスクリプションステータスに関係なく引き続き機能します。
手順
- Automation Controller ユーザーガイド の アプリケーション セクションに従って、Automation Controller で「読み取り」スコープを持つ Personal Access Token (PAT) を作成します。
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 Ansible Automation Platform の詳細を
app-config-rhdh.yamlに追加します。-
Automation Controller URL で
baseURLキーを設定します。 -
手順 1 で作成したトークン値を使用して
tokenキーを設定します。 checkSSLキーをtrueまたはfalseに設定します。checkSSLがtrueに設定されている場合、Ansible プラグインは SSL 証明書が有効であるかどうかを確認します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
Automation Controller URL で
Red Hat Developer Hub インストールは、ユーザー自身で外部および不正アクセスから保護する必要があります。バックエンド認証キーを他のシークレットと同様に管理します。強力なパスワード要件を満たし、パスワードを設定ファイルで公開せず、環境変数としてのみ設定ファイルに挿入します。
3.10. Ansible プラグインソフトウェアテンプレートの追加 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Ansible は、Ansible のベストプラクティスに基づいて新しい Playbook とコレクションプロジェクトをプロビジョニングする Red Hat Developer Hub のソフトウェアテンプレートを提供します。
手順
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 -
以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。
詳細は、Red Hat Developer Hub の管理ガイド の テンプレートの管理 セクションを参照してください。
3.11. ロールベースアクセス制御の設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub は、ロールベースアクセス制御 (RBAC) 機能を提供します。その後、RBAC を Ansible プラグインコンテンツに適用できます。
次のロールを割り当てます。
-
admin:superUsersグループのメンバーは、Ansible プラグインの Create タブでテンプレートを選択して、Playbook およびコレクションプロジェクトを作成できます。 -
admin:usersグループのメンバーは、Ansible プラグインの Create タブでテンプレートを表示できます。
次の例では、Red Hat Developer Hub に RBAC を追加します。
権限ポリシーと RBAC の管理の詳細は、Red Hat Developer Hub の 認可 ガイドを参照してください。
3.12. Ansible プラグインの任意設定 リンクのコピーリンクがクリップボードにコピーされました!
3.12.1. Red Hat Developer Hub 認証の有効化 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub (RHDH) は、複数のソースコントロール管理 (SCM) システムのインテグレーションを提供します。これは、プラグインがリポジトリーを作成するために必要です。
Red Hat Developer Hub の管理ガイド の Red Hat Developer Hub での認証の有効化 の章を参照してください。
3.12.2. Ansible プラグインのオプションのインテグレーションの設定 リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインは、Ansible Automation Platform およびその他のオプションの Red Hat 製品とのインテグレーションを提供します。
カスタム ConfigMap を編集するには、OpenShift UI にログインし、 → → → に移動します。
3.12.2.1. OpenShift Dev Spaces の設定 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Dev Spaces が Ansible プラグイン用に設定されている場合、ユーザーは Red Hat Developer Hub のカタログ項目ビューからリンクをクリックし、Dev Spaces を使用してプロビジョニングされた Ansible Git プロジェクトを編集できます。
OpenShift Dev Spaces は別の製品であり、オプションです。プラグインはこれがなくても機能します。
これは別の Red Hat 製品であり、Ansible Automation Platform または Red Hat Developer Hub サブスクリプションには含まれていません。
Ansible プラグインで OpenShift Dev Spaces リンクが設定されていない場合、Ansible プラグインランディングページの DEVELOP セクションにある Go to OpenShift Dev Spaces dashboard リンクをクリックすると、Ansible 開発ツールのホームページ にリダイレクトされます。
前提条件
- Dev Spaces のインストール。Red Hat OpenShift Dev Spaces 管理ガイド の Dev Spaces のインストール セクションを参照してください。
手順
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
<Your OpenShft Dev Spaces URL>を OpenShift Dev Spaces URL に置き換えます。 -
OpenShift Developer UI で、
Red Hat Developer HubPod を選択します。 - Actions を開きます。
- Restart rollout をクリックします。
3.12.2.2. Private Automation Hub URL の設定 リンクのコピーリンクがクリップボードにコピーされました!
Private Automation Hub は、認定された Ansible コレクション、実行環境、および組織によって提供される追加の検証済みコンテンツ用の集中型オンプレミスリポジトリーを提供します。
Ansible プラグインで Private Automation Hub の URL が設定されていない場合、ユーザーは Red Hat Hybrid Cloud Console Automation Hub にリダイレクトされます。
Private Automation Hub 設定はオプションですが、推奨されます。Ansible プラグインはこれがなくても機能します。
前提条件:
Private Automation Hub インスタンス。
Private Automation Hub のインストールに関する詳細は、Ansible Automation Platform ドキュメントの インストールとアップグレード ガイドを参照してください。
手順:
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 以下のコードを Red Hat Developer Hub の
app-config-rhdh.yamlファイルに追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
<https://MyOwnPAHUrl/>を Private Automation Hub URL に置き換えます。 -
OpenShift Developer UI で、
Red Hat Developer HubPod を選択します。 - Actions を開きます。
- Restart rollout をクリックします。
3.13. Ansible プラグインエントリーの完全な app-config-rhdh ConfigMap の例 リンクのコピーリンクがクリップボードにコピーされました!
第4章 Ansible プラグインサブスクリプションの警告メッセージ リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインは、以下のシナリオのユーザーインターフェイスで、サブスクリプション警告バナーを表示します。
4.1. Ansible Automation Platform に接続できない リンクのコピーリンクがクリップボードにコピーされました!
以下の警告は、Automation Controller の詳細が設定されていないか、コントローラーインスタンス API がサブスクリプションステータスをクエリーできないことを示しています。
Unable to connect to Ansible Automation Platform Verify that Ansible Automation Platform is reachable and correctly configured in the Ansible plug-ins. To get help, please refer to the Ansible plug-ins installation guide.
Unable to connect to Ansible Automation Platform
Verify that Ansible Automation Platform is reachable and correctly configured in the Ansible plug-ins.
To get help, please refer to the Ansible plug-ins installation guide.
修復手順
-
Ansible Automation Platform に到達可能で、ConfigMap の
rhaapセクションで正しく設定されていることを確認します。 -
ご使用の環境に対して
checkSSLキーが正しく設定されていることを確認します。 - 設定の詳細を修正したら、Red Hat Developer Hub Pod を再起動してサブスクリプションクエリーを開始します。
4.2. Ansible Automation Platform に対して認証できない リンクのコピーリンクがクリップボードにコピーされました!
以下の警告は、Ansible プラグインがサブスクリプションステータスをクエリーするために Ansible Automation Platform で認証できなかったことを示しています。
Unable to authenticate to Ansible Automation Platform Verify that the authentication details for Ansible Automation Platform are correctly configured in the Ansible plug-ins. For help, please refer to the Ansible plug-ins installation guide.
Unable to authenticate to Ansible Automation Platform
Verify that the authentication details for Ansible Automation Platform are correctly configured in the Ansible plug-ins.
For help, please refer to the Ansible plug-ins installation guide.
修復手順
- Ansible プラグインで設定された Automation Controller の Personal Access Token (PAT) が正しいことを確認します。詳細は、Automation Controller ユーザーガイド の アプリケーション セクションを参照してください。
- 認証情報の修正後に、Red Hat Developer Hub Pod を再起動してサブスクリプションクエリーを開始します。
4.3. 無効な Ansible Automation Platform 設定 リンクのコピーリンクがクリップボードにコピーされました!
以下の警告は、Ansible Automation Platform 設定セクションが無効または不完全であることを示しています。
Invalid resource for Ansible Automation Platform Verify that the resource url for Ansible Automation Platform are correctly configured in the Ansible plug-ins. For help, please refer to the Ansible plug-ins installation guide.
Invalid resource for Ansible Automation Platform
Verify that the resource url for Ansible Automation Platform are correctly configured in the Ansible plug-ins.
For help, please refer to the Ansible plug-ins installation guide.
修復手順
-
Ansible プラグイン ConfigMap の
rhaapセクションが正しく設定されており、必要なすべてのエントリーが含まれていることを確認します。詳細は、Ansible Automation Platform の詳細の設定 を参照してください。 - 設定の修正後に、Red Hat Developer Hub Pod を再起動してサブスクリプションクエリーを開始します。
4.4. Ansible Automation Platform サブスクリプションがコンプライアンス違反である リンクのコピーリンクがクリップボードにコピーされました!
以下の警告は、Ansible プラグインが Ansible Automation Platform サブスクリプションステータスを正常に取得したことを示しています。ただし、このサブスクリプションはコンプライアンス違反になります。
Subscription non-compliant The connected Ansible Automation Platform subscription is out of compliance. Contact your Red Hat account team to obtain a new subscription entitlement. Learn more about account compliance.
Subscription non-compliant
The connected Ansible Automation Platform subscription is out of compliance.
Contact your Red Hat account team to obtain a new subscription entitlement.
Learn more about account compliance.
修復手順
- 新しいサブスクリプションエンタイトルメントを取得するには、Red Hat Account チームにお問い合わせください。
- アカウントコンプライアンス の詳細を確認してください。
- サブスクリプションがコンプライアンスに準拠している場合は、Red Hat Developer Hub Pod を再起動して、新しいサブスクリプションクエリーを開始します。
4.5. 無効な Ansible Automation Platform サブスクリプション リンクのコピーリンクがクリップボードにコピーされました!
以下の警告は、Ansible プラグインが Ansible Automation Platform サブスクリプションステータスを正常に取得したことを示しています。ただし、Ansible Automation Platform ではサブスクリプションタイプが無効です。
Invalid subscription The connected Ansible Automation Platform subscription is invalid. Contact your Red Hat account team, or start an Ansible Automation Platform trial.
Invalid subscription
The connected Ansible Automation Platform subscription is invalid.
Contact your Red Hat account team, or start an Ansible Automation Platform trial.
修復手順
- 新しいサブスクリプションエンタイトルメントを取得するか、Ansible Automation Platform のトライアルを開始する には、Red Hat Account チームにお問い合わせください。
- サブスクリプションを更新したら、Red Hat Developer Hub Pod を再起動して、新しいサブスクリプションクエリーを開始します。
第5章 OpenShift Container Platform 上の Helm インストールにおける Ansible プラグインのアップグレード リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインをアップグレードするには、最新の Ansible プラグインファイルで plugin-registry アプリケーションを更新する必要があります。
5.1. Ansible プラグインファイルのダウンロード リンクのコピーリンクがクリップボードにコピーされました!
-
Red Hat Ansible Automation Platform 製品ソフトウェアのダウンロードページ から、プラグインの最新の
.tarファイルをダウンロードします。ファイル名の形式はansible-backstage-rhaap-bundle-x.y.z.tar.gzです。Ansible プラグインリリースバージョン (1.0.0など) を、x.y.zに置き換えます。 .tarファイルを保存するディレクトリーをローカルマシンに作成します。mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>
$ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ディレクトリーパスを表す環境変数 (
$DYNAMIC_PLUGIN_ROOT_DIR) を設定します。export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>
$ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ansible-backstage-rhaap-bundle-<version-number>.tar.gzの内容を$DYNAMIC_PLUGIN_ROOT_DIRに展開します。tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR
$ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIRCopy to Clipboard Copied! Toggle word wrap Toggle overflow Ansible プラグインリリースバージョン (
1.0.0など) を、x.y.zに置き換えます。
検証
ls を実行して、展開されたファイルが $DYNAMIC_PLUGIN_ROOT_DIR ディレクトリーにあることを確認します。
.integrity ファイルタイプのファイルには、プラグインの SHA 値が含まれています。SHA 値は、プラグインの設定時に使用されます。
5.2. プラグインレジストリーの更新 リンクのコピーリンクがクリップボードにコピーされました!
最新の Ansible プラグインファイルを使用して、OpenShift クラスターでプラグインレジストリーアプリケーションを再ビルドします。
前提条件
- Ansible プラグインファイルをダウンロードした。
-
.tarファイルを保存したローカルディレクトリーへのパスを表す環境変数 (たとえば、$DYNAMIC_PLUGIN_ROOT_DIR) を設定した。
手順
- 認証情報を使用して OpenShift Container Platform インスタンスにログインし、新しいアプリケーションを作成します。
Red Hat Developer Hub OpenShift プロジェクトを開きます。
oc project <YOUR_DEVELOPER_HUB_PROJECT>
$ oc project <YOUR_DEVELOPER_HUB_PROJECT>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを実行して、OpenShift クラスターのプラグインレジストリービルドを更新します。このコマンドは、
$DYNAMIC_PLUGIN_ROOT_DIRが.tarファイルのディレクトリーを表すことを前提としています。別の環境変数名を選択した場合は、コマンド内の環境変数名を置き換えてください。oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
$ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --waitCopy to Clipboard Copied! Toggle word wrap Toggle overflow oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
$ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --waitCopy to Clipboard Copied! Toggle word wrap Toggle overflow レジストリーが起動すると、出力に次のメッセージが表示されます。
Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build … Uploading finished build.build.openshift.io/plugin-registry-1 started
Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build … Uploading finished build.build.openshift.io/plugin-registry-1 startedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
plugin-registry が更新されたことを確認します。
- OpenShift UI で、Topology をクリックします。
- redhat-developer-hub アイコンをクリックして、プラグインレジストリーの Pod を表示します。
- プラグインレジストリー Pod の View logs をクリックします。
-
Terminal タブを開き、
lsを実行してplug-in registry内の.tarファイルを表示します。 -
新しい
.tarファイルがアップロードされていることを確認します。
5.3. Helm インストールにおける Ansible プラグインのバージョン番号の更新 リンクのコピーリンクがクリップボードにコピーされました!
手順
- OpenShift Container Platform インスタンスにログインします。
- OpenShift Developer UI で、 → → → → に移動します。
Ansible プラグインのバージョン番号と関連する
.integrityファイル値を更新します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow をクリックします。
開発者ハブ Pod が再起動し、プラグインがインストールされます。
検証
- OpenShift UI で、Topology をクリックします。
- Red Hat Developer Hub インスタンスが利用可能であることを確認します。
第6章 OpenShift Container Platform 上の Operator インストールにおける Ansible プラグインのアップグレード リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインをアップグレードするには、最新の Ansible プラグインファイルで plugin-registry アプリケーションを更新する必要があります。
6.1. Ansible プラグインファイルのダウンロード リンクのコピーリンクがクリップボードにコピーされました!
-
Red Hat Ansible Automation Platform 製品ソフトウェアのダウンロードページ から、プラグインの最新の
.tarファイルをダウンロードします。ファイル名の形式はansible-backstage-rhaap-bundle-x.y.z.tar.gzです。Ansible プラグインリリースバージョン (1.0.0など) を、x.y.zに置き換えます。 .tarファイルを保存するディレクトリーをローカルマシンに作成します。mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>
$ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ディレクトリーパスを表す環境変数 (
$DYNAMIC_PLUGIN_ROOT_DIR) を設定します。export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>
$ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ansible-backstage-rhaap-bundle-<version-number>.tar.gzの内容を$DYNAMIC_PLUGIN_ROOT_DIRに展開します。tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR
$ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIRCopy to Clipboard Copied! Toggle word wrap Toggle overflow Ansible プラグインリリースバージョン (
1.0.0など) を、x.y.zに置き換えます。
検証
ls を実行して、展開されたファイルが $DYNAMIC_PLUGIN_ROOT_DIR ディレクトリーにあることを確認します。
.integrity ファイルタイプのファイルには、プラグインの SHA 値が含まれています。SHA 値は、プラグインの設定時に使用されます。
6.2. プラグインレジストリーの更新 リンクのコピーリンクがクリップボードにコピーされました!
最新の Ansible プラグインファイルを使用して、OpenShift クラスターでプラグインレジストリーアプリケーションを再ビルドします。
前提条件
- Ansible プラグインファイルをダウンロードした。
-
.tarファイルを保存したローカルディレクトリーへのパスを表す環境変数 (たとえば、$DYNAMIC_PLUGIN_ROOT_DIR) を設定した。
手順
- 認証情報を使用して OpenShift Container Platform インスタンスにログインし、新しいアプリケーションを作成します。
Red Hat Developer Hub OpenShift プロジェクトを開きます。
oc project <YOUR_DEVELOPER_HUB_PROJECT>
$ oc project <YOUR_DEVELOPER_HUB_PROJECT>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを実行して、OpenShift クラスターのプラグインレジストリービルドを更新します。このコマンドは、
$DYNAMIC_PLUGIN_ROOT_DIRが.tarファイルのディレクトリーを表すことを前提としています。別の環境変数名を選択した場合は、コマンド内の環境変数名を置き換えてください。oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
$ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --waitCopy to Clipboard Copied! Toggle word wrap Toggle overflow oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
$ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --waitCopy to Clipboard Copied! Toggle word wrap Toggle overflow レジストリーが起動すると、出力に次のメッセージが表示されます。
Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build … Uploading finished build.build.openshift.io/plugin-registry-1 started
Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build … Uploading finished build.build.openshift.io/plugin-registry-1 startedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
plugin-registry が更新されたことを確認します。
- OpenShift UI で、Topology をクリックします。
- redhat-developer-hub アイコンをクリックして、プラグインレジストリーの Pod を表示します。
- プラグインレジストリー Pod の View logs をクリックします。
-
Terminal タブを開き、
lsを実行してplug-in registry内の.tarファイルを表示します。 -
新しい
.tarファイルがアップロードされていることを確認します。
6.3. Operator インストールにおける Ansible プラグインのバージョン番号の更新 リンクのコピーリンクがクリップボードにコピーされました!
手順
- OpenShift Container Platform インスタンスにログインします。
-
OpenShift UI で、インストール時に Ansible プラグインを追加した ConfigMap を開きます。この例では、
rhaap-dynamic-plugins-configという ConfigMap ファイルを使用します。 -
xyzを、更新された Ansible プラグインのバージョン番号で更新します。 各プラグインの integrity 値を、対応する展開された Ansible プラグインの
.tarファイルの.integrity値で更新します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow をクリックします。
開発者ハブ Pod が再起動し、プラグインがインストールされます。
検証
- OpenShift UI で、Topology をクリックします。
- Red Hat Developer Hub インスタンスが利用可能であることを確認します。
第7章 OpenShift Container Platform 上の Helm インストールからの Ansible プラグインのアンインストール リンクのコピーリンクがクリップボードにコピーされました!
Ansible プラグインをアンインストールするには、Red Hat Developer Hub から ansible:content:create アクションを使用するソフトウェアテンプレートをすべて削除し、OpenShift の Helm チャートからプラグイン設定を削除する必要があります。
7.1. Helm チャートインストールのアンインストール リンクのコピーリンクがクリップボードにコピーされました!
手順
-
Red Hat Developer Hub で、
ansible:content:createアクションを使用するソフトウェアテンプレートを削除します。 - OpenShift Developer UI で、 → → → → に移動します。
pluginsセクションで Ansible プラグイン設定を削除します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow extraContainersセクションを削除します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - をクリックします。
-
カスタム Red Hat Developer Hub config map (例:
app-config-rhdh) を編集します。 ansibleセクションを削除します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Red Hat Developer Hub のデプロイメントを再起動します。
plugin-registryOpenShift アプリケーションを削除します。oc delete all -l app=plugin-registry
oc delete all -l app=plugin-registryCopy to Clipboard Copied! Toggle word wrap Toggle overflow
第8章 OpenShift Container Platform 上の Operator インストールのアンインストール リンクのコピーリンクがクリップボードにコピーされました!
インストールから動的プラグインを削除するには、Ansible を参照する ConfigMaps を編集する必要があります。
ConfigMap を更新すると、デプロイメントが自動的にリロードされます。デプロイメントを手動でリロードする必要はありません。
8.1. ConfigMap から Ansible プラグインを削除する リンクのコピーリンクがクリップボードにコピーされました!
手順
-
Ansible プラグインを参照するカスタム ConfigMap を開きます。この例では、ConfigMap 名は
rhaap-dynamic-plugins-configです。 plugins:ブロックで動的プラグインを見つけます。-
プラグインを無効にするには、3 つのプラグインの
disabled属性をtrueに更新します。 プラグインを削除するには、
plugins:ブロックからプラグインを参照する行を削除します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
プラグインを無効にするには、3 つのプラグインの
- をクリックします。
8.2. Red Hat Developer Hub のカスタム ConfigMap から Ansible Automation Platform と Dev Spaces を削除する リンクのコピーリンクがクリップボードにコピーされました!
手順
テンプレートの設定と Ansible Automation Platform および Dev Spaces への接続設定を追加した Red Hat Developer Hub のカスタム ConfigMap を開きます。この例では、Red Hat Developer Hub の ConfigMap 名は
app-config-rhdhです。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
locations:ブロック内のURLを削除して、RHDH インスタンスからテンプレートを削除します。 -
ansible:ブロックを削除して、Ansible 固有の設定を削除します。 - をクリックします。
8.3. サイドカーコンテナーのアンインストール リンクのコピーリンクがクリップボードにコピーされました!
Ansible 開発ツール用のサイドカーコンテナーを developer-hub Pod から削除するには、Red Hat Developer Hub デプロイメントのベース ConfigMap を変更する必要があります。
手順
- OpenShift コンソールで、Topology ビューを選択します。
- developer-hub のインスタンスで、More actions ⋮ をクリックし、Edit backstage を選択してベース ConfigMap を編集します。
- YAML タブを選択します。
編集ペインで、
spec.deployment.patch.spec.template.specブロックからサイドカーコンテナーのcontainersブロックを削除します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - をクリックします。
第9章 Red Hat Developer Hub データ telemetry のキャプチャー リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub (RHDH) は、デフォルトで有効になっている backstage-plugin-analytics-provider-segment プラグインを使用して、telemetry データを Red Hat に送信します。これには、Ansible プラグインからの telemetry データが含まれます。
Red Hat は、以下のデータを収集および分析して、Red Hat Developer Hub のエクスペリエンスを改善します。
- ページ訪問やリンクまたはボタンのクリックのイベント。
- システム関連の情報 (ロケール、タイムゾーン、ブラウザーや OS の詳細を含むユーザーエージェントなど)。
- ページ関連の情報 (タイトル、カテゴリー、拡張機能名、URL、パス、リファラー、検索パラメーターなど)。
- 匿名の IP アドレス (0.0.0.0 として記録)。
- 匿名化されたユーザー名ハッシュ。これは、RHDH アプリケーションの一意のユーザー数を識別するためにのみ使用される一意の識別子です。
- Ansible プラグインのフィードバックフォームで提供されるフィードバックと感想。
Red Hat Developer Hub では、テレメトリーデータ収集機能を無効化またはカスタマイズできます。詳細は、Red Hat Developer Hub ドキュメントの テレメトリーデータの収集と分析 ガイドを参照してください。