必要なロール
Gitサービスの接続を表示・追加・更新・解除できるのはSuper Adminだけです。他のロールには Integrations メニューが表示されず、URLを直接指定してもアクセスできません。
事前準備
- 接続するGitサービスの個人用アクセストークン（PAT）または相当するアクセストークン
- トークンを識別するための
Integration Token Name - GitHub.comまたはGitLab.com以外を使用する場合、XEIZEから到達できるサーバーのURL
接続画面には、Gitサービスの種類にかかわらず同じ api 権限の案内が表示されます。この表記は、各サービスの正式なスコープ名や最小権限を示すものではありません。以下の操作に必要な権限をトークンに付与してください。
- トークンの有効性の確認
- アクセス可能な組織、グループ、プロジェクトの一覧取得
- 対象リポジトリの一覧取得とソースの読み取り
トークンの種類と最小権限は、組織のGitサービスのポリシーとXEIZEの利用環境に合わせて設定します。トークンの値をドキュメント、チャット、ログに記録しないでください。
サービス別のURL設定
| サービス | 既定の接続先 | カスタムURL | 対応環境 |
|---|---|---|---|
| GitHub | https://github.com |
任意 | GitHub.comまたは独自に運用するGitHubサーバー |
| GitLab | https://gitlab.com |
任意 | GitLab.comまたは独自に運用するGitLabサーバー |
| Bitbucket | 自動入力なし | 必須 | 自社運用のBitbucket Data CenterまたはServer |
Bitbucketは、自社運用のData CenterまたはServerにのみ接続できます。サーバーのURLは必ず入力してください。
GitHubの接続
メニュー: Integrations > GitHub > Connect
- サイドバーで
Integrationsを選択します。 - GitHubカードで
Connectを選択します。 Account CredentialにGitHubのアクセストークンを入力します。Integration Token Nameに用途が分かる名前を入力します。例:github-production。- GitHub.com以外のサーバーを使用する場合は、
Use Custom GitHub URLを有効にしてURLを入力します。例:https://github.company.com。 Connectを選択します。- 成功メッセージと、
Current Connectionに接続名とURLが表示されることを確認します。
カスタムURLを有効にしない場合は、https://github.com に接続します。
GitLabの接続
メニュー: Integrations > GitLab > Connect
- サイドバーで
Integrationsを選択します。 - GitLabカードで
Connectを選択します。 Account CredentialにGitLabのアクセストークンを入力します。Integration Token Nameを入力します。例:gitlab-platform。- GitLab.com以外のサーバーを使用する場合は、
Use Custom GitLab URLを有効にしてURLを入力します。例:https://gitlab.company.com。 Connectを選択します。- 成功メッセージと接続情報を確認します。
カスタムURLを有効にしない場合は、https://gitlab.com に接続します。
Bitbucketの接続
メニュー: Integrations > Bitbucket > Connect
- サイドバーで
Integrationsを選択します。 - Bitbucketカードで
Connectを選択します。 Account CredentialにBitbucketのアクセストークンを入力します。Integration Token Nameを入力します。例:bitbucket-dc-production。- 必須項目の
Bitbucket Server URLにData CenterまたはServerのURLを入力します。例:https://bitbucket.company.com。 Connectを選択します。- 成功メッセージと接続情報を確認します。
GitHubやGitLabのカスタムURLとは異なり、BitbucketのサーバーURLは省略できません。
複数のトークンの管理
一つのGitサービスに複数の接続を登録できます。接続画面では以下の操作ができます。
- 接続の選択: 一覧から管理する接続を選びます。
Add: 同じGitサービスの接続を追加します。Update: 接続名、トークン、URLを更新します。更新時は有効なトークンを再入力してください。Disconnect: 選択した接続を無効にします。
最後に選択した接続は、Gitサービスごとにブラウザーに保存され、Add Project 画面でも最初に選択されます。
解除した接続は、新規プロジェクトの登録時に選択できなくなります。解除する前に、その接続を使用しているプロジェクトがないか確認してください。
接続のトラブルシューティング
接続に失敗する
- トークンが期限切れまたは失効していないか確認します。
- 対象の組織とリポジトリにアクセスできるトークンか確認します。
- カスタムURLには、
https://から始まる完全なサーバーURLを入力します。 - 自社運用のサーバーの場合は、XEIZEから接続できるか確認します。
組織やプロジェクトが表示されない
Updateでトークンを再登録し、接続を確認します。- トークンの所有者が、対象の組織、グループ、Bitbucketプロジェクトにアクセスできるか確認します。
- サービスや組織のポリシーでSSOの承認や個人用アクセストークンの利用承認が必要な場合は、サービス管理者に確認します。
別のトークンが使用される
Connect または Add Project 画面の Integration 一覧で、使用する接続名を選び直してください。