Internal Developer Portal のオンボーディング

This product is not supported for your selected Datadog site. ().

概要

このオンボーディングガイドは、プラットフォームおよびエンジニアリングリーダーを対象に、Datadog の IDP (Internal Developer Portal) の実装フェーズを順番に説明します。

推奨:

  • まず 1、2 チームをオンボーディングし、そのフィードバックを使用して標準を改善します。
  • この過程を繰り返します。Internal Developer Portal を製品として扱います。
  • IDP の標準を、SLO、CI/CD パイプライン、インシデントワークフローなどのほかの取り組みと連携させます。

フェーズ 1: 実装を計画する

  1. 主要な概念を確認する: エンティティモデル、Scorecards、および Self-Service Actions について学びます。
  2. 組織の構造を取り込む: Teams を設定し、組織の階層を Datadog に反映させます。
  3. オントロジーを定義する: 既存のシステムをエンティティモデルにマッピングし、組織の構造と Datadog のスキーマとが整合するようにします。適用するエンティティタイプと検証を決定します。

フェーズ 2: ツールを習得する

  1. データソースを特定する: 3 種類のエンティティの取り込み方法を学び、カタログの信頼できる情報源として何を使用するかを決定します。

    • Datadog 製品からエントリを自動検出する: APM、RUM、USM など。インフラストラクチャーや Log Management からインポートすることもできます。
    • 外部システムからインポートする: Backstage や ServiceNow など。
    • エントリを直接作成する: Datadog UI を使用して作成するか、GitHub、GitLab、Terraform、Datadog ソフトウェアメタデータプロバイダー、またはサービス定義 API からインポートしてプログラムで作成します。

注: APM を使用している場合は、サービスのオーバーライドに頼るのではなく、unified service tagging と推論サービスをエントリポイントとして優先的に使用してください。

  1. 社内オンボーディングガイダンスを作成する: ドキュメントのタグ付け標準、サンプル entity.definition.yaml ファイル、およびアプリケーションチームへの期待事項を文書化します。
  2. 自動化を検討する: API または Terraform プロバイダーを使用して、エンティティ、Scorecards、およびワークフローをプログラムで管理します。

フェーズ3: データソースを統合する

  1. GitOps スタイルの管理を採用する: GitHub または GitLab を接続して、カタログを管理します。利用可能な場合は、既存の Backstage マニフェストをインポートします。
  2. ServiceNow からインポートする: ServiceNow CMDB から IDP へ CI を同期します。
  3. On-Call ツールおよびインシデントツールを接続する: Jira、PagerDuty、またはその他のインテグレーションを設定します。

フェーズ 4: スキーマをカスタマイズおよび拡張する

  1. エンティティ定義標準を確立する: 重要度、ライフサイクル、環境をどのように表現するかを決定します。定義スキーマについては、「エンティティモデル」を参照してください。
  2. メタデータの期待事項を設定する: カスタムタグと拡張機能を含めるかどうかを決定します。コンポーネント間の関係を定義する方法と、自動検出された関係を監査する方法を決定します。
  3. 社内ガイダンスを保守管理する: インスツルメンテーションやタグ付けの標準、エンティティ定義マニフェストのサンプルなど、開発者向けのドキュメントを管理します。

フェーズ 5: 標準を確立して伝達する

  1. 推奨される Scorecards を確認する: Datadog の標準ルールから始めます。自分の組織に関係のあるものを選択します。
  2. 組織固有のルールを追加する: カスタムセキュリティチェック、デプロイ頻度の要件、またはタグ付け標準を使用して、Scorecards を拡張します。
  3. 重要度レベルを設定する: 重要度を示すために、ルールをレベルに分類します。

フェーズ 6: ゴールデンパスを設定する

  1. サンプルブループリントを確認する: インフラストラクチャーのプロビジョニングと管理、プロジェクトのスキャフォールディングなどのサンプルパスを示す、セルフサービスブループリントを確認します。組織のスタックに合わせてブループリントを調整してみてください。
  2. Action Catalog を調べる: サポートされているインテグレーションを確認するか、HTTP リクエストと Private Actions で拡張します。
  3. 最初のワークフローを公開する: ゴールデンパスを作成し、開発者からのフィードバックに基づいて反復します。

フェーズ 7: エンジニアリングレポートを調べる

  1. 進捗を追跡する: 組み込みのエンジニアリングレポートを使用して、本番環境への準備状況、信頼性、およびベストプラクティスの導入状況を監視します。
  2. エンゲージメントを測定する: 組み込みの使用状況分析ダッシュボードを使用して、開発者のエンゲージメントを監視します。

参考資料