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

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間: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. [ 認証情報タイプ ] フィールドで、いずれかを選択します。
        • 基本認証
        • OAuth 2.0
      3. 認証情報を入力します。
        • 基本認証: GitLab インスタンスのユーザー名とパスワード/アクセストークンを入力します。
          注:
          個人アクセストークンのみがサポートされています。トークンを生成するときは、スコープ API を選択し、すべてのグループとプロジェクト、コンテナー レジストリ、パッケージ レジストリを含む読み取り/書き込みアクセス権を付与します。
        • OAuth 2.0:OAuth 認証情報を入力します。

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

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

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

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

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

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

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

      Gitlab ツールへの接続:権限チェック画面

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

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

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

      ツールアクセスを指定

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

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

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

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

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

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

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

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

    12. アプリケーションに関連付ける計画を選択し、[ 計画の関連付け] を選択します。
    13. アプリケーションに関連付けるリポジトリを選択し、 [リポジトリの関連付け] を選択します。
    14. [履歴データのインポート] ステップで、[ 開始日 ] フィールドと [終了日 ] フィールドで日付範囲を選択し、[ データのインポート] を選択します。
      注:
      最大 90 日間のデータをインポートできます。
    15. [Next] を選択します。
    16. [ サマリー ] ページで、正常に接続された GitLab ツールの詳細を確認します。

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

    タスクの結果

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