DevOps チェンジベロシティへのオンボードGitLabワークスペース

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:6分
  • DevOps 変更ワークスペースプレイブックを使用して GitLab インスタンスに接続し、リポジトリとパイプラインを検出します。

    始める前に

    DevOps チェンジベロシティの開始トピックで指定されたタスクを完了します。

    必要なロール:sn_devops.admin または sn_devops.tool_owner

    手順

    1. 移動先 ワークスペース > DevOps 変更ワークスペース をクリックし、次のいずれかのオプションを使用してプレイブックを開き、 GitLabオンボーディングします。
      オプションステップ
      ホームページ
      1. [ ツールを接続] を選択します。
      2. [ツールに接続] モーダルで、適切なカテゴリからツールを選択します。たとえば、コーディングツールとしてGitLabに接続する場合は、[コード] カテゴリで [GitLab] を選択します。
      アプリケーションモジュール
      1. プライマリナビゲーションから [アプリケーション ] (アプリケーションアイコン) を選択します。
      2. 既存のアプリケーションを選択するか、アプリケーションを作成します。アプリケーションを作成するには、「 アプリケーションの作成 - ワークスペース」を参照してください。
      3. [推奨アクション] ペインから、[ ツールの接続 ] カードを選択します。
      4. [ツールに接続] モーダルで、適切なカテゴリからツールを選択します。たとえば、コーディングツールとしてGitLabに接続する場合は、[コード] カテゴリで [GitLab] を選択します。
      ツールモジュール
      1. プライマリナビゲーションから [ツール ] ([ツール] アイコン) を選択します。
      2. [機能] リストから、適切なカテゴリを選択します。たとえば、コーディングツールとして GitLab に接続する場合は、 コーディング カテゴリを選択します。
      3. [ ツールを接続] を選択します。
      4. [ツールに接続] モーダルで、[ GitLab] を選択します。
      重要:
      ツールへの接続中にパイプラインやリポジトリなどのツールオブジェクトを検出して追跡する場合は、アプリケーションモジュールからツールを接続する必要があります。
    2. [ツール名] フィールドに、ツールの名前を入力します。
      [GitLab ツールに接続] 画面
    3. [Next (次へ)] をクリックします。

      オンボーディングタスクを完了するのに役立つ DevOps プレイブックが開きます。

    4. GitLabインスタンスの詳細を入力します。
      1. GitLab インスタンスの URL を入力します。
      2. [ 認証情報タイプ ] フィールドで、1 つ選択します。
        • ベーシック認証
        • OAuth 2.0
      3. 認証情報を入力します。
        • 基本認証: GitLab インスタンスのユーザー名とパスワード/アクセストークンを入力します。
          注:
          個人アクセストークンのみがサポートされています。トークンを生成するときは、スコープ API を選択し、すべてのグループとプロジェクト、コンテナー レジストリ、パッケージ レジストリを含む読み取り/書き込みアクセス権を付与します。
        • OAuth 2.0:OAuth 認証情報を入力します。

          OAuth2.0 認証情報の詳細については、「 の GitLab OAuth 2.0 認証情報の設定 DevOps」を参照してください。

      4. オプション: GitLabインスタンスがMID サーバーに接続されている場合は、[MID サーバー] オプションを選択して、その詳細を入力します。

        MID サーバーの詳細については、「MID サーバーの選択」を参照してください。

      5. [接続] を選択します。

        Gitlab ツールに接続:インスタンスの詳細入力画面

    5. 入力した認証情報に対して権限チェックが実行されます。
      必要な権限と利用可能な権限が表示されます。より適切なアクセス許可を持つ資格情報を入力する場合は、 [ 資格情報の再入力] を選択します。必要なすべての権限の詳細については、「DevOpsツールに必要な権限GitLab権限」を参照してください。

      必要なすべての権限がない場合でも、ツール接続を続行することを選択できます。

      GitLab ツールに接続 - 権限確認画面

    6. [Next (次へ)] をクリックします。
    7. ツールのアクセス権を指定します。
      1. ツールへのアクセスを制御する場合は、ツールへのアクセス権を付与する必要があるグループを [保守担当者 ] フィールドに追加します。
        グループ内のこれらのユーザーが実行できるタスクは、割り当てられたロールによって異なります。
        • DevOps ツールオーナーロール:ツールを表示および編集できます。
        • DevOps アプリオーナーロール:ツールを表示し、ツールのオブジェクト (プラン、リポジトリ、パイプラインなど) の関連付け、検出、履歴データのインポート、パイプラインステップの変更 (該当する場合) を実行できます。
        • DevOps 管理者ロール:すべてのツールを編集できます。
        • その他の DevOps ロール:ツールを表示できます。
        注:
        グループを選択せずにこの手順をスキップすると、 DevOps ツールオーナーロールを持つすべてのユーザーがツールを編集できます。
      2. ツールへのアクセスを制御することを選択した場合は、[ すべてのアプリ所有者がツールオブジェクトを表示してアプリケーションに関連付けることができる ]オプションを選択できるようになります。

        このオプションを使用すると、 DevOps アプリオーナーロールを持つすべてのユーザーがツールにアクセスできます。選択すると、ツールのオブジェクトの表示、関連付け、検出、履歴データのインポート、およびパイプライン ステップの変更 (該当する場合) が可能になります。

      3. [アサイン] を選択します。

      ツールアクセスを指定

    8. Webhook を自動的に構成するプロジェクトを選択します。

      また、管理モジュールの [ポーリングを有効にする] プロパティオプションを選択することで、夜間ポーリングを有効にして追跡対象のパイプラインのデータを取得することもできます。「DevOps チェンジベロシティ のプロパティ」を参照してください。

    9. [構成] を選択します。
      GitLab ツールへの接続 - 画面の構成

      手動で構成するには、 [ 手動構成] を選択します。詳細については、「GitLab での Webhook の手動構成」を参照してください。

      重要:
      • ホームページまたはツールモジュールから接続している場合は、接続が完了し、[概要] ページに移動します。
      • アプリケーションモジュールから接続している場合は、プロジェクトで利用可能なリポジトリとパイプラインが検出されます。それらから履歴データを追跡してインポートできます。
    10. 追跡するリポジトリを選択します。
      1. 更新を追跡してアプリケーションに関連付けるリポジトリを選択します。
      2. [Next (次へ)] をクリックします。

        GitLab ツールに接続 - [追跡するリポジトリを選択] 画面

      3. リポジトリ データをインポートする場合は、日付範囲を選択して [送信] を選択します。

        最大 90 日分のデータをインポートできます。

    11. 追跡するパイプラインを選択し、 [ 次へ] を選択します。

      選択したパイプラインごとに、最後に成功した実行のすべてのステップがインポートされます。

      追跡するパイプラインを選択します。

    12. オプション: [パイプラインステップにサービスをアサイン] アクティビティで、各パイプラインステップの ステップタイプサービス を指定します。

      このステップをツールオンボーディングの一環として完了すると、 DevOps インサイト ダッシュボードに意味のあるデータがより多く即座に表示されるようになります。

    13. [Next (次へ)] をクリックします。
    14. [ 概要] ページで、正常に接続された GitLab ツールの詳細を確認します。

      [ ツールレコードを表示 ] を選択して、接続されたインスタンスの詳細を確認します。

      接続サマリー

    タスクの結果

    GitLab ツールが正常にオンボーディングされてDevOps チェンジベロシティされました。
    注:
    ツール認証情報が変更された場合は、 DevOps 変更認証情報も更新する必要があります。詳細については、「でのサードパーティツール認証情報の更新 DevOps チェンジベロシティ」を参照してください。