Red Hat Ansible Lightspeed with IBM watsonx Code Assistant ユーザーガイド

手順

1. Ansible Lightspeed portal に組織管理者としてログインします。
2. Log in → Log in with Red Hat をクリックします。

3. Red Hat アカウントのユーザー名とパスワードを入力します。Ansible Lightspeed Service は、認証に Red Hat Single Sign-On (RH-SSO) を使用します。

   認証プロセスの一環として、Ansible Lightspeed Service は、組織にアクティブな Ansible Automation Platform サブスクリプションがあるかどうかを確認します。認証が成功すると、ユーザー名と割り当てられたユーザーロールとともにログイン画面が表示されます。

4. ログイン画面で、Admin Portal をクリックします。

   Red Hat Ansible Lightspeed with IBM watsonx Code Assistant 管理者ポータルにリダイレクトされ、Red Hat Ansible Lightspeed を IBM watsonx Code Assistant インスタンスに接続できます。

手順

1. Ansible Lightspeed portal に組織管理者としてログインします。
2. ログイン画面で、Admin Portal をクリックします。

3. IBM watsonx Code Assistant インスタンスの API キーを指定します。

   1. IBM Cloud API Key で、Add API key をクリックします。API キー を入力する画面が表示されます。
   2. API Key を入力します。
   3. オプション: API キーを検証するには、Test をクリックします。
   4. Save をクリックします。

4. 使用するモデルのモデル ID を指定します。

   1. Model Settings をクリックします。
   2. Model ID で Add Model ID をクリックします。Model Id を入力する画面が表示されます。
   3. 組織のデフォルトモデルとして、前の手順で取得した Model ID を入力します。
   4. オプション: Test model ID をクリックしてモデル ID を検証します。

   5. Save をクリックします。

      API キーとモデル ID が正常に検証されると、Red Hat Ansible Lightspeed が IBM watsonx Code Assistant インスタンスに接続されます。

手順

1. Red Hat OpenShift Container Platform に管理者としてログインします。

2. namespace を作成します。

   1. Administration → Namespaces に移動します。
   2. Create Namespace をクリックします。
   3. namespace の一意の名前を入力します。
   4. Create をクリックします。

3. Operator をインストールします。

   1. Operators → OperatorHub に移動します。
   2. Red Hat Ansible Automation Platform Operator をインストールする namespace を選択します。
   3. Ansible Automation Platform Operator を検索します。
   4. 検索結果から、Ansible Automation Platform (provided by Red Hat) タイルを選択します。
   5. Update Channel を選択します。チャネルとして stable-2.x または stable-2.x-cluster-scoped のいずれかを選択できます。
   6. 更新チャネルとして “stable-2.x” を選択した場合は、宛先 namespace を選択します。
   7. Install を選択します。Operator のインストールには数分かかります。
4. View Operator をクリックすると、新しくインストールされた Red Hat Ansible Automation Platform Operator の詳細が表示されます。

手順

1. Automation Controller に管理者としてログインします。
2. Administration で、Applications → Add をクリックします。

3. 以下の情報を入力します。

   1. Name: アプリケーションの一意の名前を指定します。
   2. Organization: 任意の組織を選択します。
   3. Authorization grant type: Authorization code を選択します。

   4. Redirect URIs: ひとまず一時的な URL を入力しておきます (例: https://temp/)。

      オンプレミスのデプロイメントが完了すると、正確な Red Hat Ansible Lightspeed アプリケーション URL が生成されます。デプロイメントが完了したら、生成された Red Hat Ansible Lightspeed アプリケーション URL を参照するように Redirect URI を変更する必要があります。詳細は、Redirect URIs の更新 を参照してください。

   5. Client type リストから、Confidential を選択します。

4. Save をクリックします。

   ポップアップウィンドウに、生成されたアプリケーションクライアント ID とクライアントシークレットが表示されます。

5. 生成されたクライアント ID とクライアントシークレットの両方をコピーして保存し、後で使用できるようにします。

   重要

   ポップアップウィンドウは、このときにしか表示されません。そのため、必ずクライアント ID とクライアントシークレットの両方をコピーしてください。これらのトークンは、Red Hat Ansible Automation Platform と IBM watsonx Code Assistant の両方の接続シークレットを作成するのに必要です。

   次のイメージは、生成されたクライアント ID とクライアントシークレットの例です。

   

手順

1. Red Hat OpenShift Container Platform にアクセスします。
2. Operators → Installed Operators を選択します。
3. Projects リストから、Red Hat Ansible Lightspeed インスタンスをインストールし、接続シークレットを作成した namespace を選択します。
4. 先ほどインストールした Ansible Automation Platform (provided by Red Hat) Operator を探して選択します。
5. All instances → Create new を選択します。
6. Create new リストから、Ansible Lightspeed モーダルを選択します。
7. 設定モードとして Form view が選択されていることを確認します。

8. 次の情報を指定します。

   1. Name: Red Hat Ansible Lightspeed インスタンスの一意の名前を入力します。
   2. Secret where the authentication information can be found: Red Hat Ansible Automation Platform に接続するために作成した認証シークレットを選択します。
   3. Secret where the model configuration can be found: IBM watsonx Code Assistant に接続するために作成したモデルシークレットを選択します。
9. オプション: カスタム認証局を信頼するためにバンドルシークレットを作成した場合は、Advanced → Bundle CA Certificate Secret リストから bundle_cacert_secret を選択します。

10. Create をクリックします。

    Red Hat Ansible Lightspeed インスタンスを namespace にデプロイするには数分かかります。インストールステータスが Successful と表示されたら、Red Hat OpenShift Container Platform の Networking → Routes で Ansible Lightspeed ポータル URL を取得できるようになります。

手順

1. Ansible Lightspeed インスタンスの URL を取得します。

   1. Red Hat OpenShift Container Platform にアクセスします。
   2. Networking → Routes の順に選択します。
   3. 作成した Red Hat Ansible Lightspeed インスタンスを見つけます。
   4. Red Hat Ansible Lightspeed インスタンスの Location URL をコピーします。

2. logout リダイレクト URI を更新します。

   1. Automation Controller で、Administration → Applications に移動します。
   2. 作成した Lightspeed Oauth アプリケーションを選択します。

   3. Oauth アプリケーションの Redirect URIs フィールドに、次の形式で URL を入力します。

      https://<lightspeed_route>/complete/aap/

      URL の例は https://lightspeed-on-prem-web-service.com/complete/aap/ です。

      重要

      リダイレクト URL には次の情報が含まれている必要があります。

      • 接頭辞 https://
      • <lightspeed_route> URL (先ほどコピーした Red Hat Ansible Lightspeed インスタンスの URL)
      • 末尾のバックスラッシュ記号 (/) を含む接尾辞 /complete/aap/
   4. Save をクリックします。

3. 設定に応じて logout リダイレクト URI を更新します。

   Ansible Automation Platform Operator を使用して Red Hat Ansible Lightspeed インスタンスと Automation Controller の両方をインストールする場合の手順:

   1. Ansible Automation Platform インスタンスが実行されているクラスターにログインします。
   2. AutomationController カスタムリソースを特定します。
   3. [YAML view] を選択します。

   4. YAML ファイルに次のエントリーを追加します。

      ```yaml
        spec:
        ...
        extra_settings:
          - setting: LOGOUT_ALLOWED_HOSTS
            value: "'<lightspeed_route-HostName>'"
        ```

      重要

      value: パラメーターを指定する際には、必ず以下を行ってください。

      • https:// など、ネットワークプロトコルなしでホスト名を指定します。

        たとえば、正しいホスト名は https://my-aiconnect-instance.somewhere.com ではなく、my-aiconnect-instance.somewhere.com になります。

      • コードブロックで指定されているとおりに、一重引用符と二重引用符を正確に使用します。

        一重引用符を二重引用符に変更したり、その逆を行ったりすると、ログアウト時にエラーが発生します。

      • Red Hat Ansible Lightspeed デプロイメントのインスタンスを複数指定するには、コンマを使用します。

        単一の Red Hat Ansible Automation Platform デプロイメントで Red Hat Ansible Lightspeed アプリケーションのインスタンスを複数実行している場合は、コンマ (,) を追加してから、他のホスト名の値を追加します。たとえば、"'my-lightspeed-instance1.somewhere.com','my-lightspeed-instance2.somewhere.com'" のように複数のホスト名を追加できます。

   5. 変更した YAML を適用します。これにより、Automation Controller Pod が再起動します。

1. Ansible Automation Platform コントローラーを使用して仮想マシンにログインします。

2. /etc/tower/conf.d/custom.py ファイルに次のパラメーターを追加します。
   LOGOUT_ALLOWED_HOSTS = "<lightspeed_route-HostName>"

   重要
   • /etc/tower/conf.d/custom.py ファイルが存在しない場合は作成します。

   • https:// など、ネットワークプロトコルなしでホスト名を指定します。

     たとえば、正しいホスト名は https://my-aiconnect-instance.somewhere.com ではなく、my-aiconnect-instance.somewhere.com になります。

   • 一重引用符と二重引用符はペアで使用します。一重引用符と二重引用符を混在させないでください。
3. 次のコマンドを実行して Automation Controller を再起動します。
   $ automation-controller-service restart

1. プラットフォームゲートウェイを使用して仮想マシンにログインします。

2. gateway/settings.py ファイルまたは ansible-automation-platform/gateway/settings.py ファイルのいずれかに
   LOGOUT_ALLOWED_HOSTS = "<lightspeed_route-HostName>" パラメーターを追加します。

   重要

   • https:// など、ネットワークプロトコルなしでホスト名を指定します。

     たとえば、正しいホスト名は https://my-aiconnect-instance.somewhere.com ではなく、my-aiconnect-instance.somewhere.com になります。

   • コードブロックで指定されたとおりに二重引用符を使用します。

手順

1. VS Code アプリケーションを開きます。
2. Activity バーから Extensions アイコンをクリックします。
3. Installed Extensions リストから、Ansible を選択します。
4. Ansible 拡張機能ページで、Settings アイコン ( ) をクリックし、Extension Settings を選択します。

5. Ansible Lightspeed 設定を選択し、次の情報を指定します。

   • URL for Ansible Lightspeed フィールドに、Red Hat Ansible Lightspeed オンプレミスデプロイメントの Route URL を入力します。Ansible ユーザーは、Ansible Automation Platform コントローラーの認証情報を持っている必要があります。

   • オプション: デフォルトモデルの代わりにカスタムモデルを使用する場合は、Model ID Override フィールドにカスタムモデル ID を入力します。設定は自動的に VS Code に保存されます。

     Ansible VS Code 拡張機能を Red Hat Ansible Lightspeed オンプレミスデプロイメントに接続するように設定した後、Ansible VS Code 拡張機能を介して Ansible Lightspeed にログイン する必要があります。

     注記

     組織が Red Hat Ansible Automation Platform にサブスクライブしてから間もない場合、Red Hat Ansible Lightspeed が新しいサブスクリプションを検出するまでに数時間かかることがあります。VS Code で、アクティビティーバーの Ansible 拡張機能の Refresh ボタンを使用して再度確認してください。

手順

1. Red Hat OpenShift Container Platform にアクセスします。
2. Operators → Installed Operators を選択します。
3. Projects リストから、Red Hat Ansible Lightspeed インスタンスをインストールした namespace を選択します。
4. 先ほどインストールした Ansible Automation Platform (provided by Red Hat) Operator を探して選択します。
5. Ansible Lightspeed タブを選択します。
6. 更新するインスタンスを見つけて選択します。
7. Actions → Edit AnsibleLightspeed をクリックします。エディターはテキストまたは YAML ビューに切り替わります。

8. テキストをスクロールして spec: セクションを見つけます。

   )

9. 変更して新しい名前で保存したシークレットのエントリーを見つけます。
10. シークレットの名前を新しいシークレットに変更します。

11. Save をクリックします。

    新しい Ansible Lightspeed Pod が作成されます。新しい Pod が正常に実行されると、古い Ansible Lightspeed Pod が終了します。

手順

1. システム監査者 ユーザーを作成します。

   1. Red Hat Ansible Automation Platform で システム監査者 ロールを持つユーザーを作成します。手順は、Ansible Automation Platform のスタートガイド の ユーザーの作成 セクションを参照してください。
   2. 新しく作成したシステム監査者ユーザーとして、オンプレミスデプロイメントの Ansible Lightspeed ポータル (https://<lightspeed_route>/) にログインできることを確認し、ログアウトします。

2. システム監査者 ユーザーのトークンを作成します。

   1. 次の認証情報を使用して、オンプレミスデプロイメントの Ansible Lightspeed ポータル (https://<lightspeed_route>/admin) に管理者としてログインします。

      • ユーザー名: admin
      • パスワード: Red Hat Ansible Lightspeed がデプロイされている Red Hat OpenShift Container Platform クラスターの namespace 内の <lightspeed-custom-resource-name>-admin-password という名前のシークレット。
   2. Django 管理ウィンドウで、Users エリアから Users を選択します。ユーザーのリストが表示されます。
   3. システム監査者ロールを持つユーザーが Users リストに表示されていることを確認します。
   4. Django Oauth ツールキットエリアから、Access tokens → Add を選択します。

   5. 以下の情報を入力し、Save をクリックします。

      • User: 虫眼鏡アイコンを使用して、システム監査者ロールを持つユーザーを検索して選択します。
      • Token: ユーザーのトークンを指定します。後で使用するためにこのトークンをコピーします。
      • Id token: トークン ID を選択します。
      • Application: Ansible Lightspeed for VS Code を選択します。
      • Expires: トークンを有効期限切れにする日時を選択します。

      • Scope: スコープを read write として指定します。

        システム監査者ロールを持つユーザー用にアクセストークンが作成されます。

   6. オンプレミスデプロイメントの Ansible Lightspeed ポータルからログアウトします。
3. システム監査者ロールを持つユーザーの認可トークンを使用してメトリクスエンドポイント https://<lightspeed_route>/metrics にアクセスし、Red Hat Ansible Lightspeed オンプレミスデプロイメントを監視します。

1. コンテンツパーサーツールを使用してトレーニングデータセットを作成する
2. IBM watsonx Code Assistant を使用してカスタムモデルを作成およびデプロイする
3. カスタムモデルを使用するように Red Hat Ansible Lightspeed を設定する

1. VS Code アプリケーションを開きます。

2. Ansible Lightspeed ビューの [ Connect ボタンまたは Account メニューを使用してサインインします。

   • Connect ボタンを使用してサインインします。

     1. VS Code アクティビティーバーから、Ansible アイコンをクリックします。
     2. Ansible Lightspeed ビューで Connect をクリックします。
     3. 画面上のプロンプトに従って、Ansible Lightspeed にサインインします。

   • Accounts メニューを使用してサインインします。

     1. VS Code アクティビティーバーから、Accounts メニューをクリックします。

     2. 表示されるサインインオプションに応じて、Ansible Lightspeed でサインインして Ansible を使用するか、Red Hat でサインインして Ansible を使用します。

        注記
        • サインインオプションは、VS Code 拡張機能がアクティブになると表示されます。エクステンションは、Ansible サイドパネルを開いた後、または VS Code エディターで Ansible ファイルを開いた後にアクティブになります。このオプションが表示されない場合は、Connect ボタンを使用して Ansible Lightspeed サービスにリンクします。
        • オンプレミスの Red Hat OpenShift Dev Spaces など、Ansible Lightspeed が認識しないドメインのクラウド開発環境を使用している場合は、Accounts のサインインメニューに、Sign-in with Red Hat to use Ansible オプションが表示されます。このオプションでは、デバイスコードフローを使用してサインインプロセスを正常に完了し、Red Hat Authentication 拡張機能 v0.2.0 以降が必要です。この認証フローが必要であるにもかかわらず、Sign-in with Red Hat to use Ansible オプションが表示されない場合は、Ansible VS Code 拡張機能 v24.5.2 以降を使用していることを確認してください。
     3. 画面上のプロンプトに従って、Ansible Lightspeed にサインインします。

   認証が成功すると、ユーザー名と割り当てられたユーザーロールとともにログイン画面が表示されます。

手順

1. 提案された変更について初期 PR を確認し、PR をマージします。

   初期 PR をマージすると、設定されたスキャンスケジュールがトリガーされ、後続のリポジトリースキャンが毎週実行されます。

   注記

   初期 PR をマージしないと、週次スキャンスケジュールがトリガーされず、関連するスキャン履歴がない状態で Ansible コードボットダッシュボードにリポジトリーが表示されます。

   次の図は、作成される初期 PR の例です。

   
2. オプション: 必要に応じて、リポジトリーを手動でスキャン したり、スキャンスケジュールを毎日または毎月に変更 したりできます。
3. リポジトリーを追加するか、既存のリポジトリーをスキャン対象から削除 して、スキャン対象のリポジトリーを変更します。

手順

1. 組織に関連付けられたアカウントを使用して GitHub にログインします。
2. GitHub で、プロファイルの写真 > Settings をクリックします。
3. Integrations で、Applications > Installed GitHub Apps の順にクリックします。
4. Ansible コードボットアプリケーションの横にある Configure をクリックします。

5. Danger zone エリアの下にある Uninstall をクリックします。

   Ansible コードボットアプリケーションが GitHub アカウントからアンインストールされました。

手順

1. GitHub で、スキャンするリポジトリーに移動します。
2. リポジトリーの .github フォルダーに ansible-code-bot.yml という名前の .yml 設定ファイルを作成します。
   たとえば、.github/ansible-code-bot.yml です。

3. 設定ファイルで、interval パラメーターにスキャンスケジュールを指定します。interval パラメーターは、daily、weekly、または monthly として指定できます。以下に例を示します。

   schedule:
     interval: daily

4. 変更をコミットします。

手順

1. Ansible code bot dashboard にログインします。

   Ansible コードボットダッシュボードには、コードボットがインストールされているリポジトリーのリストが表示され、スキャンスケジュールが設定されていないのか、手動スキャンまたはスケジュールスキャンに設定されているかが示されます。

2. リポジトリーのスキャン履歴を表示するには、Ellipsis アイコン ( ) リポジトリーの横にある View scan history を選択します。

   リポジトリーのスキャン履歴は、スキャン開始時刻、スキャンステータス、スキャンの種類 (スケジュールまたは手動)、作成された場合はプルリクエストへのリンク、スキャンが失敗した場合はログメッセージとともに表示されます。

3. GitHub 上のリポジトリーを表示するには、Ellipsis アイコン ( ) リポジトリーの横にある View repository を選択します。

手順

1. Ansible code bot dashboard にログインします。
2. Manage Code Bot on GitHub をクリックします。
3. GitHub で、プロファイルの写真 > Settings をクリックします。
4. Integrations で、Applications をクリックします。

5. Repository access 領域から、次のいずれかのタスクを実行します。

   • Add a new repository: Select repositories リストから、追加するリポジトリーを選択します。新たに追加したリポジトリーが Ansible code bot ダッシュボードに表示されます。
   • Remove an existing repository: Select repositories リストから、削除するリポジトリーの横にある 十字 アイコンをクリックします。削除されたリポジトリーの詳細が、Ansible コードボットダッシュボードに表示されなくなります。
6. Save をクリックします。

手順

1. Red Hat OpenShift Container Platform にアクセスします。
2. Operators → Installed Operators を選択します。
3. Projects リストから、Red Hat Ansible Automation Platform Operator をインストールしたときに作成した namespace を選択します。
4. 先ほどインストールした Ansible Automation Platform (provided by Red Hat) Operator を探して選択します。
5. Ansible Lightspeed タブを選択します。
6. 更新するインスタンスを見つけて選択します。
7. YAML タブを選択します。エディターが YAML エディタービューに切り替わります。

8. スクロールして spec: セクションを見つけ、spec: セクションの下に次のパラメーターを追加します。

   extra_settings:
       - setting: ANSIBLE_AI_MODEL_MESH_API_VERIFY_SSL
         value: false

9. Save をクリックします。

10. Automation Controller Pod を再起動して、修正した YAML を適用します。
    以下の手順を実行します。

    1. Red Hat OpenShift Container Platform から、Workloads → Pods を選択します。
    2. 更新した Ansible Lightspeed Pod を見つけて選択します。
    3. Pod の横にある Edit アイコンをクリックし、Delete Pod を選択します。
       選択した Pod が削除され、新しい Pod が作成されます。