検索

第8章 Ansible コードボットのインストールと設定

download PDF

Ansible コードボットは、GitHub リポジトリーを通じて既存のコンテンツコレクション、ロール、Playbook をスキャンし、ベストプラクティスや品質向上に関する推奨事項が利用できるたびにプルリクエストを前もって作成します。

Ansible コードボットは、コードリポジトリーをスキャンして、コードの品質の改善を推奨します。Ansible のベストプラクティスを推奨し、バグにつながる可能性があったり、コードの管理を困難にする可能性のある一般的なエラーを回避します。ボットはプルリクエストをリポジトリーに自動的に送信し、コンテンツに対する推奨される変更をリポジトリー所有者に事前に通知します。既存の Git リポジトリー (パブリックとプライベートの両方) をスキャンするように Ansible コードボットを設定できます。

注記

Ansible コードボットを使用するには、組織に Red Hat Ansible Automation Platform への有効なサブスクリプションが必要です。ただし、Ansible コードボットを使用するために IBM watsonx Code Assistant は必要ありません。

Ansible コードボットをインストールすると、ボットがインストールされているすべてのリポジトリーとそのスキャンステータスが表示される Ansible コードボットダッシュボードにアクセスできます。ダッシュボードから、手動スキャンの開始、スキャン履歴の表示、およびリポジトリーの表示を行うことができます。GitHub から、定期的にリポジトリーをスキャンするようにスケジュールを設定したり、スキャンされないようにリポジトリーを追加または削除したりできます。詳細は、リポジトリースキャンの管理 を参照してください。

重要

Ansible コードボットは、次の GitHub バージョンでサポートされています。

  • GitHub.com
  • GitHub Enterprise Cloud

    Ansible コードボットは GitHub Enterprise Server ではサポートされていません。詳細は、GitHub ドキュメントの GitHub の計画 を参照してください。

次の例は、Ansible コードボットが提案できるコードの推奨事項です。

  • 非推奨のレガシー構文または実装パターンに利用可能な代替手段
  • モジュールのバージョンの変更と更新:

    • 新しい必須パラメーターの追加
    • 非推奨のパラメーターのフラグ付け
    • 未使用のパラメーターの削除
  • YAML ベストプラクティスの適用
  • コメントブロックの追加
  • 名前フィールドの大文字と小文字の問題を修正

8.1. Ansible コードボットのインストール

Ansible コードボットをインストールしてリポジトリーのコード推奨を取得し、Ansible コードボットダッシュボードにログインしてリポジトリースキャンを監視および管理します。

手順

  1. 組織に関連付けられたアカウントを使用して Github にログインします。
  2. Ansible code bot GitHub アプリケーションに移動します。
  3. アプリケーションがアクセスする Ansible リポジトリーを選択します。

    • All repositories: 全リポジトリーのメタデータを読み取るアクセス権を提供します。
    • Only select repositories: 選択したリポジトリーのメタデータだけを読み取るアクセス権を提供します。
  4. オプション: 前の手順で Only select repositories を選択した場合は、Ansible コードボットにアクセスさせるリポジトリーを Select repositories リストから選択します。
  5. Install & Authorize をクリックします。インストール中に次の権限がボットに自動的に付与される旨のメッセージが表示されます。

    • メタデータへの読み取りアクセス
    • コードおよびプルリクエストへの読み取りおよび書き込みアクセス
  6. プロンプトが表示されたら、組織管理者として Red Hat Single Sign-On アカウントにログインします。
  7. Ansible コードボットダッシュボードにログインします。

    1. Authorize Ansible code bot ページで、アカウントおよびリポジトリーのパーミッションを確認します。
    2. Authorize Ansible をクリックします。

      Authorize Ansible code bot ページから、次のアクションが実行されます。

      • Ansible コードボットは、Red Hat Ansible Automation Platform への有効なサブスクリプションを持つ組織に所属しているかどうかを確認します。
      • GitHub は、ご使用中のアカウントに関連付けられたリポジトリーに対する読み取り権限をリクエストします。

認証に成功すると、Ansible コードボットダッシュボードにログインし、Ansible コードボットがインストールされているすべてのリポジトリーとそのスキャンステータスが表示されます。以前にスキャンスケジュールを設定していなかった場合、ダッシュボードには関連するスキャン履歴なしでリポジトリーが表示されます。手動スキャンを開始して Git リポジトリーをスキャンすることも、定期的にリポジトリーをスキャンするスケジュールを設定することもできます。スキャン対象のリポジトリーを追加したり、既存のリポジトリーをスキャン対象から削除したりすることもできます。詳細は、リポジトリースキャンの管理 を参照してください。

8.1.1. Ansible コードボットのアンインストール

Ansible コードボットを使用しない場合は、GitHub からアンインストールできます。アンインストールした後も、Ansible コードボットダッシュボードにアクセスできますが、ダッシュボード上でリポジトリーの表示やリポジトリーのスキャンはできません。

手順

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

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

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.