DevOps チェンジベロシティ への Azure DevOps のオンボーディング - ワークスペース

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:21分
  • DevOps 変更ワークスペースプレイブックを使用して Azure DevOps インスタンスに接続し、計画、コーディング、オーケストレーション、アーティファクト、およびソフトウェア品質機能のデータを収集します。

    Azure DevOps (ADO) には、組織レベルまたは個々のプロジェクト レベルで接続できます。プロジェクト レベルで接続する場合は、組織のプロジェクトごとに、接続プロセスを繰り返す必要があります。ツールのインスタンスに接続した後、 DevOps がパイプライン、タスク実行レコード、およびステップ実行レコードをインポートできるようにする追加の設定を構成できます。

    DevOps チェンジベロシティ にデータを送信するように Azure DevOps インスタンスの Webhook を構成すると、Azure DevOps はデフォルトで統合ユーザーのトークン認証を使用します。DevOps チェンジベロシティ API はトークン認証を使用して呼び出されるため、構成中に統合ユーザー名とパスワードを入力する必要はありません。devops.system ユーザーが ServiceNow インスタンスで利用できない場合は、[ トークンベースの認証が成功した後、このユーザーに切り替え る] プロパティを設定する必要があります。詳細については、「DevOps チェンジベロシティ のプロパティ」を参照してください。統合ユーザー名とパスワードを入力するステップは、次のシナリオでのみ必要です。
    • DevOps コンフィグがインストールされている場合、DevOps コンフィグ API はベーシック認証を使用して呼び出されます。
    • Azure Invoke REST API サービス接続を使用する場合。この場合、 This property decides whether to create a Generic Connection on configure operation for Azure DevOps プロパティを有効にする必要があります。
    注:
    DevOps チェンジベロシティインスタンスという用語は、ツールの特定のオカレンスを指すために使用されます。Azure DevOps では、代わりに「プロジェクト」という用語を使用しています。

    組織を接続

    Azure DevOps インスタンスをAzure DevOps組織レベルで直接接続して構成します。組織内のすべてのプロジェクトを検出でき、組織内で複数のプロジェクトを構成することを選択できます。組織レベルでツールを管理できます。

    始める前に

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

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

    手順

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

        組織に接続します。

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

    3. ツールのインスタンスの詳細を入力します。
      1. このインスタンスにアクセスするためのパスワードまたはアクセストークンを入力します。
        PAT の作成については、「 個人用アクセス トークン (PAT)」を参照してください。
      2. オプション: ツールインスタンスが MID サーバーに接続されている場合は、[ MID サーバー ] オプションを選択し、その詳細を入力します。

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

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

        Azure インスタンスの詳細。

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

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

        注:
        組織をオンボードする場合、 プロジェクト管理者 特権では、PAT の所有者が組織の プロジェクト コレクション管理者 グループのメンバーである必要があります。

        プロジェクト管理者権限は、ツールのオンボーディングにのみ必要です。ツールが正常にオンボードされたら、PAT からプロジェクト管理者特権をオフにすることを選択できます。

        Azure PAT に必要なアクセス許可。

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

      ServiceNow DevOps拡張機能は、Webhook の構成中にサービス接続を自動的に作成します。Azure DevOps からビルド通知とリリース通知を送信するには、サービス接続が必要です。拡張には、変更コントロール、アーティファクト、およびパッケージの Azure DevOps パイプラインを変更するカスタムタスクも含まれています。

      拡張機能の詳細については、「 カスタムアクションのAzure DevOpsとAzure DevOpsに ServiceNow DevOps 拡張機能を使用する」を参照してください。

      注:
      このステップをスキップして Azure DevOps から通知を送信する場合は、Webhook を構成した後にサービス接続を手動で作成する必要があります。

      拡張機能をインストールした後、 [インストール済みとしてマーク] を選択します。

      ServiceNow DevOps 拡張をインストールします。

    6. Azure DevOps インスタンスで Webhook を自動的に構成して、DevOps チェンジベロシティ にデータを送信します。
      夜間ポーリングによってデータを送信するか、リアルタイムデータを送信するように Webhook を構成するかを選択します。
      • Webhook:パイプライン実行のリアルタイム通知を有効にします。リアルタイム通知は、特に変更要求を自動化する場合に最新の情報を維持するのに理想的です。

        Webhook を使用するには、 [構成] を選択します。

      • 夜間ポーリング: 今すぐ構成しない場合は、 Enable Polling プロパティを [はい] に設定することで、後で夜間ポーリングを有効にして追跡対象プランのデータをフェッチできます。
      1. DevOps統合ユーザー名とパスワードを入力します。

        DevOps統合ユーザーとパスワードの作成については、「で統合ユーザーアカウントを設定する DevOps チェンジベロシティ」を参照してください。

        注:
        • 統合ユーザー名とパスワードを入力するステップは、DevOps コンフィグがインストールされているか、 This property decides whether to create a Generic Connection on configure operation for Azure DevOps プロパティが有効になっている場合にのみ構成する必要があります。この手順が不要な場合、Webhook はトークンベースの認証を使用して構成されます。
        • DevOps コンフィグがインストールされているか、Azure DevOps の構成操作の汎用接続プロパティが有効になっている場合は、ワークスペース UI からのみトークンを再生成 (新しいトークンを使用した自動構成) できます。これにより、統合ユーザーのパスワードが更新されます。DevOps コンフィグがインストールされていない場合、トークンベースの認証のために、ワークスペースとクラシック UI の両方からトークンを再生成できます。セキュリティを強化するために、トークンを定期的に再生成します。
      2. Webhook を構成するプロジェクトを選択します。
      3. [構成] を選択します。

        組織の Azure DevOps を構成します。

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

      Webhook の構成と検出はバックグラウンドで行われ、 [概要] ページに移動します。

      組織接続の概要。

    7. [概要] ページで [ ツール レコードの表示 ] を選択して、接続されているツールの詳細を確認します。

    タスクの結果

    組織レベルでDevOps チェンジベロシティするためのAzure DevOpsツールが正常にオンボーディングされました。

    次のタスク

    ツールレコードページの [プロジェクト ] タブから、プロジェクトを選択してプロジェクトレコードページに移動します。ここから、プロジェクトオブジェクトを検出し、プロジェクトの Webhook を構成できます。
    • [検出] を選択して、既存の計画 (ボード)、リポジトリ、パイプラインなどのプロジェクト オブジェクトを検出します。
    • プロジェクトレベルでツールを直接作成した場合は、ツールレコードページの [プロジェクト] タブから [プロジェクトの検出] を選択すると、組織内のすべてのプロジェクトも検出されます。
    • [ 構成 ] を選択し、統合ユーザーの認証情報を入力して、プロジェクトの Webhook を構成します。
    • ツールレコードページを表示している場合は、 [ プロジェクトの構成 ] を選択し、統合ユーザーの資格情報を入力すると、組織内の未構成プロジェクトの一覧が表示されます。Webhook を構成するプロジェクトを選択し、 [ 構成] を選択します。
      注:
      統合ユーザー名とパスワードを入力するステップは、DevOps コンフィグがインストールされているか、Azure DevOps の構成操作の汎用接続プロパティが無効になっている場合にのみ、Webhook を構成するために必要です。この手順が不要な場合、Webhook はトークンベースの認証を使用して構成されます。
    • 計画、リポジトリ、パイプラインなどのプロジェクトオブジェクトに履歴データをインポートするには、オブジェクトをアプリケーションに関連付け、データをインポートします。詳細については、「ツールオブジェクトをアプリケーションに関連付ける:ワークスペース」を参照してください。

    プロジェクトを接続

    プロジェクトレベルで Azure DevOps インスタンスを直接接続して構成します。組織内に複数のプロジェクトがある場合は、それぞれを個別に接続する必要があります。

    始める前に

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

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

    手順

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

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

      プロジェクトに接続します。

    3. ツールのインスタンスの詳細を入力します。
      1. このインスタンスにアクセスするためのパスワードまたはアクセストークンを入力します。
        PAT の作成については、「 個人用アクセス トークン (PAT)」を参照してください。
      2. オプション: ツールインスタンスが MID サーバーに接続されている場合は、[ MID サーバー ] オプションを選択し、その詳細を入力します。

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

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

        Azure インスタンスの詳細。

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

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

        注:
        プロジェクトをオンボーディングする場合、 プロジェクト管理者 権限では、PAT の所有者がプロジェクトの プロジェクト管理者 グループのメンバーである必要があります。

        プロジェクト管理者権限は、ツールのオンボーディングにのみ必要です。ツールが正常にオンボードされたら、PAT からプロジェクト管理者特権をオフにすることを選択できます。

        Azure PAT に必要なアクセス許可。

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

      ServiceNow DevOps拡張機能は、Webhook の構成中にサービス接続を自動的に作成します。Azure DevOps からビルド通知とリリース通知を送信するには、サービス接続が必要です。拡張には、変更コントロール、アーティファクト、およびパッケージの Azure DevOps パイプラインを変更するカスタムタスクも含まれています。

      拡張機能の詳細については、「 カスタムアクションのAzure DevOpsとAzure DevOpsに ServiceNow DevOps 拡張機能を使用する」を参照してください。

      注:
      このステップをスキップして Azure DevOps から通知を送信する場合は、Webhook を構成した後にサービス接続を手動で作成する必要があります。

      拡張機能をインストールした後、 [インストール済みとしてマーク] を選択します。

      ServiceNow DevOps 拡張をインストールします。

    6. Azure DevOps インスタンスで Webhook を自動的に構成して、DevOps チェンジベロシティ にデータを送信します。
      夜間ポーリングによってデータを送信するか、リアルタイムデータを送信するように Webhook を構成するかを選択します。
      • Webhook:パイプライン実行のリアルタイム通知を有効にします。リアルタイム通知は、特に変更要求を自動化する場合に最新の情報を維持するのに理想的です。

        Webhook を使用するには、 [構成] を選択します。

      • 夜間ポーリング: 今すぐ構成しない場合は、 Enable Polling プロパティを [はい] に設定することで、後で夜間ポーリングを有効にして追跡対象プランのデータをフェッチできます。
      1. DevOps統合ユーザー名とパスワードを入力します。

        DevOps統合ユーザーとパスワードの作成については、「で統合ユーザーアカウントを設定する DevOps チェンジベロシティ」を参照してください。

        注:
        • 統合ユーザー名とパスワードを入力するステップは、DevOps コンフィグがインストールされているか、 This property decides whether to create a Generic Connection on configure operation for Azure DevOps プロパティが有効になっている場合にのみ構成する必要があります。この手順が不要な場合、Webhook はトークンベースの認証を使用して構成されます。
        • DevOps コンフィグがインストールされているか、Azure DevOps の構成操作の汎用接続プロパティが有効になっている場合は、ワークスペース UI からのみトークンを再生成 (新しいトークンを使用した自動構成) できます。これにより、統合ユーザーのパスワードが更新されます。DevOps コンフィグがインストールされていない場合、トークンベースの認証のために、ワークスペースとクラシック UI の両方からトークンを再生成できます。セキュリティを強化するために、トークンを定期的に再生成します。
      2. [構成] を選択します。

        プロジェクトの Azure DevOps を構成します。

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

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

        追跡する計画を選択します。

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

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

        計画データをインポートします。

    8. 追跡するリポジトリを選択します。
      1. 更新を追跡してアプリケーションに関連付けるリポジトリを選択します。
      2. [Next (次へ)] をクリックします。

        追跡するリポジトリを選択します。

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

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

        リポジトリデータをインポートします。

    9. 追跡するパイプラインを選択します。
      1. 更新を追跡し、アプリケーションに関連付けるパイプラインを選択します。

      2. [Next (次へ)] をクリックします。

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

      3. 選択したパイプラインごとに、最後に成功した実行のすべてのステップまたはステージがインポートされます。[パイプラインステップにサービスをアサイン] アクティビティでは、各パイプラインステップに対して以下を選択できます。
        1. パイプラインステップタイプ:サービスを割り当てるステップタイプを選択します。

          ヒント:
          本番展開を表すステップには少なくとも Prod deploy ステップタイプを指定して、成功したパイプライン実行を本番展開として識別できるように DevOps します。
        2. サービス:パイプラインステップがマップされる CMDB アプリケーションサービスを選択します。

          アプリケーションサービスは環境に近似的にマッピングされます。同じパイプラインステップを使用して異なる環境に展開する場合は、フィールドを空のままにします。サービス情報により、 DevOps インシデントや機能停止などの運用評価指標を識別してレポートすることができます。

      4. [Next (次へ)] をクリックします。

        パイプラインステップにサービスを割り当てます。

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

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

        過去のパイプラインデータをインポートします。

    10. [概要] ページが表示されます。

      [概要] ページで [ ツール レコードの表示 ] を選択して、接続されているツールの詳細を確認します。

      プロジェクト接続の概要。

    タスクの結果

    プロジェクトレベルでDevOps チェンジベロシティするためのAzure DevOpsツールが正常にオンボーディングされました。

    次のタスク

    ツールレコードページの [プロジェクト ] タブから、プロジェクトを選択してプロジェクトレコードページに移動します。ここから、プロジェクトオブジェクトを検出し、プロジェクトの Webhook を構成できます。
    • [ プロジェクトの検出 ] を選択して、既存の計画 (ボード)、リポジトリ、パイプラインなどのプロジェクト オブジェクトを検出します。これにより、組織内のすべてのプロジェクトも検出されます。
    • [ プロジェクトの構成 ] を選択して、プロジェクトの Webhook を構成します。
    • ツールレコードページを表示している場合は、 [ プロジェクトの構成 ] を選択し、統合ユーザーの資格情報を入力すると、組織内の未構成プロジェクトの一覧が表示されます。Webhook を構成するプロジェクトを選択し、 [ 構成] を選択します。
      注:
      統合ユーザー名とパスワードを入力するステップは、DevOps コンフィグがインストールされているか、Azure DevOps の構成操作の汎用接続プロパティが無効になっている場合にのみ、Webhook を構成するために必要です。この手順が不要な場合、Webhook はトークンベースの認証を使用して構成されます。
    • 計画、リポジトリ、パイプラインなどのプロジェクトオブジェクトに履歴データをインポートするには、オブジェクトをアプリケーションに関連付け、データをインポートします。詳細については、「ツールオブジェクトをアプリケーションに関連付ける:ワークスペース」を参照してください。