GitHub Enterprise Cloud のデータ所在地を使い始める

ユーザーのオンボード、課金の有効化、データの移行を行って、GHE.com で Enterprise を設定します。

この記事の内容

データ所在地付き GitHub Enterprise Cloud を採用すると、会社のコードとデータを格納する場所を選択できます。

GitHub の営業チーム と協力して GHE.com 上の専用の URL で Enterprise アカウントを作成した後、このガイドを使って Enterprise を設定します。 このチュートリアルの内容は次のとおりです。

  • 認証を構成し、ID 管理システムでプロビジョニングを行って、ユーザーを追加します
  • Enterprise の課金を設定します
  • 必要に応じて、別のプラットフォームからデータを移行します
  • 動作が異なる機能や追加の構成が必要な機能など、使用できる機能について理解します

この初期セットアップが済むと、organization とリポジトリの作成、コードでの共同作業、ポリシーの構成などを行うことができます。

前提条件

  • これを行うユーザーは、GHE.com で Enterprise にプロビジョニングされている必要があります。

  • Microsoft Azure サブスクリプションで支払う場合は、Azure portal への管理者アクセス権を持っているか、他のユーザーと協力して管理者の同意ワークフローを構成する必要があります。 すべての前提条件の一覧については、「Azure サブスクリプションを接続する」をご覧ください。

  • クライアント システムが GitHub の SSH キー フィンガープリントを信頼し、特定のホスト名と IP アドレスにアクセスできることを確認する必要があります。 「GHE.com のネットワークの詳細」をご覧ください。

1.Enterprise にユーザーを追加する

GHE.com 上の Enterprise は、Enterprise Managed Users を使います。 ユーザー アカウントを作成して GHE.com 上の新しい Enterprise へのアクセスを許可するには、認証と SCIM プロビジョニングを構成する必要があります。 「Enterprise Managed Users の概要」を参照してください。

セットアップ ユーザーとしてサインインする

Enterprise を作成すると、セットアップ ユーザーのパスワード (認証とプロビジョニングの構成に使用される) を選択するように求めるメールが届きます。 ユーザー名は、ランダムに生成されるショートコードに _admin というサフィックスが付いたものです。

シークレット ウィンドウまたはプライベート ブラウズ ウィンドウの使用:

  1. ユーザーのパスワードを設定します。
  2. ユーザーのリカバリー コードを保存します。

セットアップ ユーザーのパスワードをリセットする必要がある場合、GitHub Support ポータル から GitHub Support に問い合わせます。 メール アドレスを指定した通常のパスワードのリセット オプションは機能しません。

personal access token

を作成する

次に、プロビジョニングの構成に使用できる personal access token を作成します。

  • トークンを作成する際は、セットアップ ユーザーとしてサインインする必要があります。
  • トークンには、少なくとも scim:enterprise スコープが必要です。
  • トークンに有効期限は必要ありません。

personal access token (classic) を作成する方法については、「個人用アクセス トークンを管理する」を参照してください。

認証の構成

次に、メンバーの認証方法を構成します。

IdP として Entra ID を使用している場合は、OpenID Connect (OIDC) と Security Assertion Markup Language (SAML) のいずれかを選択できます。

  • 条件付きアクセス ポリシー (CAP) のサポートを含む OIDC をお勧めします。
  • 1 つのテナントからプロビジョニングされた複数のエンタープライズが必要な場合、最初のエンタープライズには SAML または OIDC を使用できますが、追加の各エンタープライズには SAML を使用する必要があります。

Okta や PingFederate などの別の IdP を使っている場合は、メンバーの認証に SAML を使う必要があります。

まず、選択した認証方法のガイドを参照してください。

プロビジョニングの構成

認証を構成したら、SCIM プロビジョニングを構成できます。これは、IdP が GitHub に マネージド ユーザー アカウント を作成する方法です。 「Getting started with data residency for GitHub Enterprise Cloud」をご覧ください。

Organization メンバーシップを管理する

認証とプロビジョニングが構成されたら、IdP グループをチームと同期することで、マネージド ユーザー アカウントの Organization メンバーシップの管理を開始できます。 「ID プロバイダー グループを使用したチーム メンバーシップの管理」をご覧ください。

2.請求の設定

ライセンスとサービスの料金を支払うには、クレジット カード、PayPal、または Microsoft Azure サブスクリプションを使用できます。

3.データの移行

既存のデータを GHE.com 上の新しい Enterprise に移行する必要がある場合は、GitHub の移行ツールを使用できます。

  • GitHub.com、GitHub Enterprise Server、Azure DevOps、または Bitbucket Server から移行する場合は、GitHub Enterprise Importer を使ってソース コードの履歴とメタデータを移行できます。 「GitHub Enterprise Importer について」を参照してください。
  • それ以外のプラットフォームから移行する場合は、「GitHub への移行パス」をご覧ください。

GitHub Enterprise Importer のスクリプトの例

次のスクリプトでは、GitHub Enterprise Importer を使って、個々のソース リポジトリを GitHub.com から GHE.com 上のターゲット リポジトリに移行する方法を示します。 --target-api-url パラメーターは、移行先として GHE.com 上の Enterprise を設定します。

スクリプトの環境変数の定義を例として使い、GitHub Enterprise Importer を使ってデータを移行する追加のコマンドを作成できます。

以下のスクリプトでは、次のプレースホルダー テキストを実際の値に置き換えます。

プレースホルダー説明
TARGET-TOKENGHE.com 上の移行先 Enterprise にアクセスするための Personal access token (PAT)
SOURCE-TOKENGitHub.com 上の移行元リソースにアクセスするための PAT
TARGET-GHE-API-URLEnterprise の API エンドポイントにアクセスするための URL。 たとえば、Enterprise のサブドメインが octocorp である場合、この値は https://api.octocorp.ghe.com でなければなりません。
SOURCE-GH-ORGANIZATION-NAMEGitHub.com 上の移行元 organization の名前。
SOURCE-GH-REPOSITORY-NAMEGitHub.com 上の移行元リポジトリの名前。
TARGET-GHE-ORGANIZATION-NAMEGHE.com 上の移行先 organization の名前。
TARGET-GHE-REPOSITORY-NAMEGHE.com 上の移行先リポジトリの名前。
Bash
#!/bin/sh

export GH_PAT="TARGET-TOKEN"
export GH_SOURCE_PAT="SOURCE-TOKEN"
export TARGET_API_URL="TARGET-GHE-API-URL"
export GITHUB_SOURCE_ORG="SOURCE-GH-ORGANIZATION-NAME"
export SOURCE_REPO="SOURCE-GH-REPOSITORY-NAME"
export GITHUB_TARGET_ORG="TARGET-GHE-ORGANIZATION-NAME"
export TARGET_REPO="TARGET-GHE-REPOSITORY-NAME"

gh gei migrate-repo --target-api-url $TARGET_API_URL --github-source-org $GITHUB_SOURCE_ORG --source-repo $SOURCE_REPO --github-target-org $GITHUB_TARGET_ORG --target-repo $TARGET_REPO --verbose

4.GitHub の機能を理解する

Enterprise の初期セットアップを終えると、ご自分とご自分の Enterprise のメンバーは GitHub の機能を使い始めることができます。

GHE.com の データ所在地が で使用できる機能は、GitHub.com の マネージド ユーザー アカウント が使用できる機能と似ていますが、いくつかの追加と例外があります。一部の機能は、GitHub.com での同等の機能と比べて、動作が異なるか、追加の構成が必要です。 「データ所在地付き GitHub Enterprise Cloud の機能の概要」を参照してください。

参考資料