Amazon Web Services(AWS)にGitLab POCをインストールする
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab Self-Managed
このページでは、公式Linuxパッケージを使用してAWS上にGitLabを構築する一般的な設定の流れを説明します。ニーズに合わせてカスタマイズしてください。
1,000ユーザー以下の組織の場合、推奨されるAWSインストール方法は、EC2シングルボックスのLinuxパッケージインストールを開始し、データのバックアップにスナップショット戦略を実装することです。詳細については、20 RPSまたは1,000ユーザーのリファレンスアーキテクチャを参照してください。
本番環境グレードのGitLabの使用を開始する
このドキュメントは、概念実証インスタンスのインストールガイドです。これはリファレンスアーキテクチャではなく、高可用性設定にもなりません。代わりに、GitLab Environment Toolkit(GET)を使用することを強くおすすめします。
このガイドに正確に従うと、概念実証インスタンスを構築できます。これは、非HA構成の40 RPSまたは2,000ユーザーのリファレンスアーキテクチャにおける2つのアベイラビリティーゾーン実装を縮小した形に相当します。2,000ユーザーのリファレンスアーキテクチャは、コストと複雑さを抑えながらある程度のスケーリングを実現することを主な目的としているため、HAではありません。60 RPSまたは3,000ユーザーのリファレンスアーキテクチャが、GitLab HAとしての最小構成です。この構成では、HAを実現するための追加のサービスロールを含みます。特筆すべき点は、GitリポジトリストレージをGitaly Cluster (Praefect)でHA化し、三重冗長を規定していることです。
GitLabは、主に2種類のリファレンスアーキテクチャを維持およびテストしています。Linuxパッケージアーキテクチャはインスタンスのコンピューティングリソース上に実装され、クラウドネイティブハイブリッドアーキテクチャはKubernetesクラスターを最大限に活用します。クラウドネイティブハイブリッドのリファレンスアーキテクチャ仕様は、リファレンスアーキテクチャのサイズ別ページの追補セクションとして掲載されています。これらのページは、Linuxパッケージアーキテクチャの説明から始まります。たとえば、60 RPSまたは3,000ユーザーのクラウドネイティブリファレンスアーキテクチャは、60 RPSまたは3,000ユーザーのリファレンスアーキテクチャページの、Helmチャートを使用したクラウドネイティブハイブリッドのリファレンスアーキテクチャ(代替)というサブセクションに掲載されています。
本番環境グレードのLinuxパッケージインストールの使用を開始する
Infrastructure as CodeツールであるGitLab Environment Tool(GET)は、AWS上でLinuxパッケージを使用して構築する際の出発点として最適です。とりわけ、HA構成を目標とする場合に有用です。GETはすべてを自動化するわけではありませんが、Gitaly Cluster (Praefect)のような複雑なセットアップを自動構成します。GETはオープンソースであるため、誰でも機能を追加したり、改善にコントリビュートしたりできます。
本番環境グレードのクラウドネイティブハイブリッドGitLabの使用を開始する
GitLab Environment Toolkit(GET)は、明確な設計思想に基づいたTerraformおよびAnsibleのスクリプト群です。これらのスクリプトは、選択したクラウドプロバイダー上でLinuxパッケージまたはクラウドネイティブハイブリッド環境をデプロイする際に役立ち、GitLabデベロッパーがGitLab Dedicated(例)で使用します。
GitLab Environment Toolkitを使用して、AWS上にクラウドネイティブハイブリッド環境をデプロイできます。ただし必須ではなく、すべての有効な組み合わせをサポートしているとは限りません。なお、スクリプトは現状のまま提供されており、必要に応じて調整できます。
はじめに
このセットアップでは主にLinuxパッケージを使用しますが、ネイティブAWSサービスも活用します。LinuxパッケージにバンドルされているPostgreSQLやRedisの代わりに、Amazon RDSとElastiCacheを使用します。
このガイドでは、マルチノードのセットアップについて説明します。まず、Virtual Private Cloudとサブネットを設定し、その後、データベースサーバー用のRDS、Redisクラスター構成のElastiCacheなどのサービスを統合し、最終的にカスタムスケーリングポリシーを適用したオートスケールグループでそれらを管理します。
要件
AWSおよびAmazon EC2の基本的な知識に加えて、次のものが必要です。
- AWSアカウント
- SSHキーを作成またはアップロードして、SSH経由でインスタンスに接続していること。
- GitLabインスタンスのドメイン名。
- ドメインを保護するSSL/TLS証明書。まだお持ちでない場合は、AWS Certificate Manager(ACM)を使用して無料のパブリックSSL/TLS証明書をプロビジョニングし、このガイドで作成するElastic Load Balancerで使用できます。
ACMを介してプロビジョニングされた証明書を検証するには数時間かかる場合があります。後の作業を遅らせないために、できるだけ早く証明書をリクエストしてください。
アーキテクチャ
次の図は、推奨アーキテクチャの概要を示しています。
AWSのコスト
GitLabは次のAWSサービスを使用しています。各サービスの価格情報はリンク先を参照してください:
- EC2: GitLabは共有ハードウェアにデプロイされ、オンデマンド料金が適用されます。専有インスタンスまたはリザーブドインスタンスでGitLabを実行する場合、コストの詳細についてはEC2の料金ページを参照してください。
- S3: GitLabはS3(料金ページ)を使用して、バックアップ、アーティファクト、LFSオブジェクトを保存します。
- NLB: GitLabインスタンスにリクエストをルーティングするためのネットワークロードバランサー(料金ページ)。
- RDS: PostgreSQLを使用するAmazon Relational Database Service(料金ページ)。
- ElastiCache: Redis構成を提供するために使用するインメモリキャッシュ環境(料金ページ)。
IAM EC2インスタンスのロールとプロファイルを作成する
Amazon S3オブジェクトストレージを使用しているため、EC2インスタンスにはS3バケットに対する読み取り、書き込み、一覧表示の権限が必要です。GitLabの設定にAWSキーを埋め込むのを避けるため、IAMロールを使用して、GitLabインスタンスにこのアクセス権を付与します。IAMロールにアタッチするためのIAMポリシーを作成する必要があります。
IAMポリシーを作成する
IAMダッシュボードに移動し、左側のメニューでPoliciesを選択します。
Create policyを選択し、
JSONタブを選択して、ポリシーを追加します。セキュリティのベストプラクティスに従い、_最小権限_の原則を適用することで、必要なアクションを実行するために必要な権限のみをロールに付与します。- 図に示すように、S3バケット名のプレフィックスが
gl-であると仮定して、次のポリシーを追加します。
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:PutObject", "s3:GetObject", "s3:DeleteObject", "s3:PutObjectAcl" ], "Resource": "arn:aws:s3:::gl-*/*" }, { "Effect": "Allow", "Action": [ "s3:ListBucket", "s3:AbortMultipartUpload", "s3:ListMultipartUploadParts", "s3:ListBucketMultipartUploads" ], "Resource": "arn:aws:s3:::gl-*" } ] }- 図に示すように、S3バケット名のプレフィックスが
Nextを選択して、ポリシーを確認します。ポリシーに名前を付け(この例では
gl-s3-policy)、Create policyを選択します。
IAMロールを作成する
- 引き続きIAMダッシュボードで、左側のメニューのRolesを選択し、Create roleを選択します。
- Trusted entity typeで、
AWS serviceを選択します。Use caseで、ドロップダウンリストとラジオボタンの両方でEC2を選択し、Nextを選択します。 - ポリシーフィルターで、先ほど作成した
gl-s3-policyを検索して選択し、Nextを選択します。 - ロールに名前を付けます(この例では
GitLabS3Access)。必要に応じてタグを追加します。Create roleを選択します。
このロールは、後で起動テンプレートを作成するときに使用します。
GitLabは、AWSインスタンスメタデータサービスバージョン2 (IMDSv2)をサポートしています。GitLabは、利用可能な場合は自動的にIMDSv2を使用し、必要に応じてIMDSv1にフォールバックします。セキュリティを強化するために、EC2インスタンスでIMDSv2を安全に要求できます。
ネットワークを設定する
まず、GitLabクラウドインフラストラクチャ用のVPCを作成します。次に、少なくとも2つのアベイラビリティーゾーン(AZ)にパブリックインスタンスとプライベートインスタンスを配置するためのサブネットを作成します。パブリックサブネットには、ルートテーブルの設定と関連付けられたインターネットゲートウェイが必要です。
Virtual Private Cloud(VPC)を作成する
ここで、ユーザーが制御する仮想ネットワーキング環境であるVPCを作成します:
Amazon Web Servicesにサインインします。
左側のメニューからYour VPCsを選択し、Create VPCを選択します。「Name tag」に
gitlab-vpcと入力し、「IPv4 CIDR block」に10.0.0.0/16と入力します。専用ハードウェアが不要な場合、「Tenancy」はデフォルトのままでかまいません。準備ができたら、Create VPCを選択します。VPCを選択し、Actions、Edit VPC Settingsの順に選択し、Enable DNS resolutionをオンにします。完了したら、Saveを選択します。
サブネット
ここでは、さまざまなアベイラビリティーゾーンにサブネットをいくつか作成します。各サブネットが、先ほど作成したVPCに関連付けられ、CIDRブロックが重複していないことを確認してください。これにより、冗長性を確保するためのマルチAZを有効にすることもできます。
ロードバランサーとRDSインスタンスに対応するように、プライベートサブネットとパブリックサブネットも作成します。
左側のメニューからSubnetsを選択します。
Create subnetを選択します。IPに基づいたわかりやすい名前タグ(例:
gitlab-public-10.0.0.0)を付け、先ほど作成したVPCを選択します。アベイラビリティーゾーンを選択し(この例ではus-west-2a)、IPv4 CIDR blockには/24サブネットの10.0.0.0/24を指定します:同様の手順に従って、次のすべてのサブネットを作成します。
名前タグ タイプ アベイラビリティーゾーン CIDRブロック gitlab-public-10.0.0.0public us-west-2a10.0.0.0/24gitlab-private-10.0.1.0private us-west-2a10.0.1.0/24gitlab-public-10.0.2.0public us-west-2b10.0.2.0/24gitlab-private-10.0.3.0private us-west-2b10.0.3.0/24すべてのサブネットを作成したら、2つのパブリックサブネットに対してAuto-assign IPv4を有効にします。
- 各パブリックサブネットを順番に選択し、Actions、Edit subnet settingsの順に選択します。Enable auto-assign public IPv4 addressオプションをオンにして、保存します。
インターネットゲートウェイ
次に、同じダッシュボードで、Internet Gatewaysに移動して、新しいゲートウェイを作成します。
左側のメニューからInternet Gatewaysを選択します。
Create internet gatewayを選択し、
gitlab-gatewayという名前を付けて、Createを選択します。作成したインターネットゲートウェイをテーブルから選択し、Actionsドロップダウンリストから「Attach to VPC」を選択します。
リストから
gitlab-vpcを選択し、Attachをクリックします。
NATゲートウェイを作成する
プライベートサブネットにデプロイされたインスタンスは、アップデートのためにインターネットに接続する必要がありますが、パブリックインターネットからアクセスされないように設定します。そのために、各パブリックサブネットにデプロイされたNATゲートウェイを使用します。
- VPCダッシュボードに移動し、左側のメニューバーでNAT Gatewaysを選択します。
- Create NAT Gatewayを選択し、次の項目を設定します。
- Availability mode:
Zonalを選択します。 - Subnet: ドロップダウンリストから
gitlab-public-10.0.0.0を選択します。 - Elastic IP Allocation ID: 既存のElastic IPを入力するか、Allocate Elastic IP addressを選択し、NATゲートウェイに新しいIPを割り当てます。
- 必要に応じてタグを追加します。
- Create NAT Gatewayを選択します。
- Availability mode:
2つ目のNATゲートウェイを作成します。今回は、2つ目のパブリックサブネットであるgitlab-public-10.0.2.0に配置します。
ルートテーブル
パブリックルートテーブル
前の手順で作成したインターネットゲートウェイ経由でパブリックサブネットがインターネットにアクセスできるように、ルートテーブルを作成する必要があります。
VPCダッシュボードで、次の手順に従います。
- 左側のメニューからRoute Tablesを選択します。
- Create Route Tableを選択します。
- 「Name tag」に
gitlab-publicと入力し、「VPC」でgitlab-vpcを選択します。 - Createを選択します。
次に、インターネットゲートウェイを新しいターゲットとして追加し、すべての宛先からトラフィックを受信するように設定する必要があります。
- 左側のメニューからRoute Tablesを選択し、
gitlab-publicルートを選択して、下部のオプションを表示します。 - Routesタブを選択し、Edit routes > Add routeを選択して、宛先に
0.0.0.0/0を設定します。ターゲット列で、Internet Gatewayを選択し、先ほど作成したgitlab-gatewayを選択します。完了したらSave changesを選択します。
次に、パブリックサブネットをルートテーブルに関連付ける必要があります。
- Subnet Associationsタブを選択し、Edit subnet associationsを選択します。
- パブリックサブネットのチェックボックスのみをオンにし、Save associationsを選択します。
プライベートルートテーブル
各プライベートサブネット内のインスタンスが、同じアベイラビリティーゾーン内の対応するパブリックサブネットにあるNATゲートウェイ経由でインターネットにアクセスできるように、2つのプライベートルートテーブルを作成する必要があります。
- 先ほどと同様の手順に従って、プライベートルートテーブルを2つ作成し、
gitlab-private-aおよびgitlab-private-bという名前を付けます。 - 次に、各プライベートルートテーブルに新しいルートを追加します。宛先を
0.0.0.0/0とし、ターゲットには先ほど作成したNATゲートウェイのいずれかを指定します。gitlab-private-aルートテーブルの新しいルートには、gitlab-public-10.0.0.0に作成したNATゲートウェイをターゲットとして追加します。- 同様に、
gitlab-private-bの新しいルートには、gitlab-public-10.0.2.0にあるNATゲートウェイをターゲットとして追加します。
- 最後に、各プライベートサブネットをプライベートルートテーブルに関連付けます。
gitlab-private-10.0.1.0をgitlab-private-aに関連付けます。gitlab-private-10.0.3.0をgitlab-private-bに関連付けます。
ロードバランサー
ロードバランサーを作成し、GitLabアプリケーションサーバー全体に受信トラフィックを均等に分散します。後ほど作成するスケーリングポリシーに基づいて、必要に応じてインスタンスがロードバランサーに追加または削除されます。さらに、ロードバランサーはインスタンスに対してヘルスチェックを実行します。
AWSはこのアーキテクチャに2つのアプローチを提供します:
- Network Load Balancer (NLB) only: 小規模なデプロイに適した、よりシンプルなセットアップです。NLBは、すべてのトラフィック (SSH (ポート22)、HTTP (ポート80)、HTTPS (ポート443))をRailsノードに直接処理し、NLBでSSL/TLS終端を行います。
- Hybrid NLB->ALB approach: 懸念事項を分離する、よりスケーラブルなセットアップです。NLBはTCPトラフィック (SSH (ポート22))を処理し、Application Load Balancer (ALB)はSSL/TLS終端を伴うHTTP/HTTPSトラフィックを処理します。このアプローチにより、AWS WAFインテグレーションと、より優れたトラフィック管理が可能になります。
あなたのデプロイに最適なアプローチを選択してください:
NLBのみ:
graph TB subgraph Diagram1["NLB Only"] U1["Users"] NLB1["Network Load Balancer<br/>(Port 22, 80, 443)"] R1A["Rails Node 1<br/>(Port 22, 80)"] R1B["Rails Node 2<br/>(Port 22, 80)"] U1 -->|SSH| NLB1 U1 -->|HTTP| NLB1 U1 -->|HTTPS| NLB1 NLB1 -->|Port 22| R1A NLB1 -->|Port 22| R1B NLB1 -->|"Port 80, 443"| R1A NLB1 -->|"Port 80, 443"| R1B endハイブリッドNLB/ALB:
graph TB subgraph Diagram2["Hybrid NLB/ALB"] U2["Users"] NLB2["Network Load Balancer<br/>(Port 22, 443)"] ALB["Application Load Balancer<br/>(Port 443)"] R2A["Rails Node 1<br/>(Port 22, 80)"] R2B["Rails Node 2<br/>(Port 22, 80)"] U2 -->|SSH| NLB2 U2 -->|HTTPS| NLB2 NLB2 -->|Port 22| R2A NLB2 -->|Port 22| R2B NLB2 -->|Port 443| ALB ALB -->|Port 80| R2A ALB -->|Port 80| R2B end
このセクションでは、単一のNetwork Load Balancerがすべてのトラフィックタイプを処理し、SSH、HTTP、およびHTTPSをRailsノードに直接ルーティングする、よりシンプルなNLBのみのアプローチについて説明します。
このアーキテクチャにはセキュリティグループが必要です:
- NLB Security Group (
gitlab-nlb-sec-group):- 受信: 任意の場所からのTCPポート22 (SSHの場合は信頼されたIP範囲に制限することも可能)
- 受信: 任意の場所からのTCPポート80
- 受信: 任意の場所からのTCPポート443
- 送信: すべてのトラフィック
このセキュリティグループを作成するには:
- EC2ダッシュボードで、左側のメニューバーからSecurity Groupsを選択します。
- Create security groupを選択します。
- 説明的な名前と説明を付け、VPCドロップダウンリストから
gitlab-vpcを選択します。 - 上記で指定した受信ルールを追加する。
- 設定が完了したら、Create security groupを選択します。
ターゲットグループを作成します:
EC2ダッシュボードで、左側のメニューバーからTarget Groupsを選択します。
SSH Target Groupに対してCreate target groupを選択します:
設定 値 ターゲットタイプ インスタンス ターゲットグループ名 gitlab-nlb-ssh-targetプロトコル TCP ポート 22 VPC gitlab-vpcヘルスチェックプロトコル TCP Nextを2回選択し、次にCreate target groupを選択します。ターゲットは以降に登録します。
HTTP Target Groupに対して再度Create target groupを選択します:
設定 値 ターゲットタイプ インスタンス ターゲットグループ名 gitlab-nlb-http-targetプロトコル TCP ポート 80 VPC gitlab-vpcヘルスチェックプロトコル HTTP ヘルスチェックパス /-/readinessヘルスチェックエンドポイントについては、VPC IPアドレス範囲 (CIDR)をIP許可リストに追加する必要があります。
Nextを選択し、Register Laterを選択し、次にNextを2回選択してからCreate target groupを選択します。
ネットワークロードバランサーを作成します:
EC2ダッシュボードで、左側のナビゲーションバーにあるLoad Balancersを探し、Create Load Balancerを選択します。
Network Load Balancerを選択し、作成を選択します。
ロードバランサーを次の設定で設定します:
設定 値 Load Balancer name gitlab-nlbScheme インターネット向け IPアドレスタイプ IPv4 VPC gitlab-vpcマッピング 両方のパブリックサブネットを選択します セキュリティグループ gitlab-nlb-sec-groupListeners and routingセクションで、次を設定します:
プロトコル ポート ターゲットグループ TCP 22 gitlab-nlb-ssh-targetTCP 80 gitlab-nlb-http-targetTLS 443 gitlab-nlb-http-targetポート443のTLSリスナーの場合、Security Policy設定で:
- Policy name: ドロップダウンリストから定義済みのセキュリティポリシーを選択します。AWSドキュメントのPredefined SSL Security Policies for Network Load Balancersを参照してください。サポートされているSSL暗号およびプロトコルの一覧は、GitLabコードベースで確認できます。
- Default SSL/TLS server certificate: ACMからSSL/TLS証明書を選択するか、証明書をIAMにアップロードします。
Create load balancerを選択します。
gitlab-nlb-ssh-targetとgitlab-nlb-http-targetターゲットグループのターゲットは、このガイドの以降で作成されるオートスケールグループでインスタンスが起動されると自動的に登録されます。
このセクションでは、Network Load BalancerがSSHトラフィックを処理し、Application Load BalancerがHTTP/HTTPSトラフィックを処理するハイブリッドアプローチについて説明します。NLBはTCPポート22 (SSH)をRailsノードに直接ルーティングし、TCPポート443 (HTTPS)をALBにルーティングします。ALBはSSL/TLSを終端し、HTTPトラフィックをポート80のRailsノードにルーティングします。このアプローチにより、AWS WAFインテグレーションと、より優れたトラフィック管理が可能になります。
このアーキテクチャには3つのセキュリティグループが必要です:
NLB Security Group (
gitlab-nlb-sec-group):- 受信: 任意の場所からのTCPポート22 (SSHの場合は信頼されたIP範囲に制限することも可能)
- 受信: 任意の場所からのTCPポート443 (HTTPSの場合は信頼されたIP範囲に制限することも可能)
- 送信: TCPポート22を
gitlab-rails-sec-groupへ - 送信: TCPポート443を
gitlab-alb-sec-groupへ
ALB Security Group (
gitlab-alb-sec-group):- 受信:
gitlab-nlb-sec-groupからのTCPポート443 - 受信:
gitlab-rails-sec-groupからのTCPポート80 - 送信: TCPポート80を
gitlab-rails-sec-groupへ
- 受信:
Rails Security Group (
gitlab-rails-sec-group):- 受信:
gitlab-nlb-sec-groupからのTCPポート22 - 受信:
gitlab-alb-sec-groupからのTCPポート80
- 受信:
これらのセキュリティグループを作成するには:
- EC2ダッシュボードで、左側のメニューバーからSecurity Groupsを選択します。
- SSH Target Groupに対してCreate security groupを選択します:
- それぞれに説明的な名前と説明を付け、VPCドロップダウンリストから
gitlab-vpcを選択します。 - 上記で指定した受信ルールを追加する。ソースを選択する際は、Security groupを選択し、ドロップダウンから適切なセキュリティグループを選択します。
- 設定が完了したら、Create security groupを選択します。
ターゲットグループを作成します:
EC2ダッシュボードで、左側のメニューバーからTarget Groupsを選択します。
次の設定でNLB SSH Target Groupを作成します:
設定 値 ターゲットタイプ インスタンス ターゲットグループ名 gitlab-nlb-ssh-targetプロトコル TCP ポート 22 VPC gitlab-vpcヘルスチェックプロトコル TCP Nextを2回選択し、次にCreate target groupを選択します。ターゲットは以降に登録します。
NLB to ALB Target Groupに対して再度Create target groupを選択します:
設定 値 ターゲットタイプ Application Load Balancer ターゲットグループ名 gitlab-nlb-alb-targetプロトコル TCP ポート 443 VPC gitlab-vpcヘルスチェックプロトコル HTTPS ヘルスチェックパス /-/readinessNextを選択し、Application Load Balancerに対してRegister Laterを選択し、次にNextを選択してからCreate target groupを選択します。
ALB HTTP Target Groupに対して再度Create target groupを選択します:
設定 値 ターゲットタイプ インスタンス ターゲットグループ名 gitlab-alb-http-targetプロトコル HTTP ポート 80 VPC gitlab-vpcプロトコルバージョン HTTP1.1 ヘルスチェックプロトコル HTTP ヘルスチェックパス /-/readinessヘルスチェックエンドポイントについては、VPC IPアドレス範囲 (CIDR)をIP許可リストに追加する必要があります。
Nextを選択し、Register Laterを選択し、次にNextを2回選択してからCreate target groupを選択します。
アプリケーションロードバランサーを作成します:
EC2ダッシュボードで、左側のナビゲーションバーにあるLoad Balancersを探し、Create Load Balancerを選択します。
Application Load Balancerを選択し、作成を選択します。
ロードバランサーを次の設定で設定します:
設定 値 Load Balancer name gitlab-albScheme インターネット向け IPアドレスタイプ IPv4 VPC gitlab-vpcマッピング 両方のパブリックサブネット gitlab-public-10.0.0.0とgitlab-public-10.0.2.0を選択しますセキュリティグループ gitlab-alb-sec-groupListeners and routingセクションで、次を設定します:
プロトコル ポート アクション ターゲットグループ HTTPS 443 転送先 gitlab-alb-http-targetHTTPSリスナーの場合、ACM証明書を選択し、適切なセキュリティポリシーを選択します (Predefined SSL Security Policies for Application Load Balancersを参照)。
Create load balancerを選択します。
ネットワークロードバランサーを作成します:
EC2ダッシュボードで、左側のナビゲーションバーにあるLoad Balancersを探し、Create Load Balancerを選択します。
Network Load Balancerを選択し、作成を選択します。
ロードバランサーを次の設定で設定します:
設定 値 Load Balancer name gitlab-nlbScheme インターネット向け IPアドレスタイプ IPv4 VPC gitlab-vpcマッピング 両方のパブリックサブネット gitlab-public-10.0.0.0とgitlab-public-10.0.2.0を選択しますセキュリティグループ gitlab-nlb-sec-groupListeners and routingセクションで、次を設定します:
プロトコル ポート ターゲットグループ TCP 22 gitlab-nlb-ssh-targetTCP 443 gitlab-nlb-alb-targetCreate load balancerを選択します。
ALBをNLBのターゲットとして登録します:
- EC2ダッシュボードで、左側のメニューバーからTarget Groupsを選択します。
gitlab-nlb-alb-targetターゲットグループを選択します。- Targetsタブで、Register targetsを選択します。
gitlab-albApplication Load Balancerを選択し、Register pending targetsを選択します。- 保存を選択します。
gitlab-nlb-ssh-targetとgitlab-alb-http-targetターゲットグループのターゲットは、このガイドの以降で作成されるオートスケールグループでインスタンスが起動されると自動的に登録されます。
NLBロードバランサーが稼働したら、Security Groupsを再確認して、NLBを介したアクセスのみに制限し、その他の要件を設定できます。
一部の属性は、ロードバランサーが作成された後にのみ設定できます。以下は、要件に基づいて設定できるいくつかの機能です:
- Client IP preservationは、ターゲットグループではデフォルトで有効になっています。これにより、ロードバランサーに接続しているクライアントのIPがGitLabアプリケーションで保持されます。要件に基づいてこれを有効/無効にできます。
- Proxy Protocolは、ターゲットグループではデフォルトで無効になっています。これにより、ロードバランサーがプロキシプロトコルヘッダーを使用して追加情報を送信できるようになります。この機能を有効にする場合は、内部ロードバランサーやNGINXなど、他の環境コンポーネントも同様に設定されていることを確認してください。このPOCの場合、後でGitLabノードで有効にするだけで、プロキシプロトコルの設定が完了します。
ロードバランサーのDNSを設定する
Route 53ダッシュボードで、左側のナビゲーションバーのHosted zonesを選択します。
- 既存のホストゾーンを選択するか、ドメインのホストゾーンがまだない場合は、Create Hosted Zoneを選択し、ドメイン名を入力してCreateを選択します。
- Create recordを選択し、次の値を指定します。
- Name: ドメイン名(デフォルト値)を使用するか、サブドメインを入力します。
- Type: A - IPv4 addressを選択します。
- Alias: デフォルトではdisabledになっています。このオプションを有効にします。
- Route traffic to: Alias to Network Load Balancerを選択します。
- Region: ネットワークロードバランサーが存在するリージョンを選択します。
- Choose network load balancer: 先ほど作成したネットワークロードバランサーを選択します。
- Routing Policy: ここではSimpleを使用しますが、ユースケースに応じて別のポリシーを選択することもできます。
- Evaluate Target Health: この値はNoに設定しますが、ターゲットヘルスに基づいてロードバランサーがトラフィックをルーティングするよう設定することもできます。
- Createを選択します。
- Route 53を通じてドメインを登録した場合、これで完了です。別のドメインレジストラを使用している場合は、そのドメインレジストラでDNSレコードを更新する必要があります。これを行うには、次の手順に従います。
- Hosted zonesを選択し、先ほど追加したドメインを選択します。
NSレコードの一覧が表示されます。ドメインレジストラの管理者パネルから、これらの各NSレコードをドメインのDNSレコードに追加します。この手順は、ドメインレジストラによって異なる場合があります。行き詰まった場合は、「レジストラの名前」DNSレコードの追加をGoogleで検索すると、ドメインレジストラに固有のヘルプ記事が見つかります。
具体的な手順は使用するレジストラによって異なり、このガイドの範囲外です。
PostgreSQLとRDS
データベースサーバーには、冗長性を確保するためにマルチAZを提供するAmazon RDS for PostgreSQLを使用します(Auroraはサポートしていません)。まず、セキュリティグループとサブネットグループを作成し、次に実際のRDSインスタンスを作成します。
RDSセキュリティグループ
データベース用のセキュリティグループを作成し、後でgitlab-nlb-sec-groupにデプロイするインスタンスからの受信トラフィックを許可します。
- EC2ダッシュボードで、左側のメニューバーからSecurity Groupsを選択します。
- Create security groupを選択します。
- 名前(この例では
gitlab-rds-sec-group)と説明を入力し、VPCドロップダウンリストからgitlab-vpcを選択します。 - Inbound rulesセクションで、Add ruleを選択し、次の項目を設定します。
- Type: PostgreSQLルールを検索して選択します。
- Source type: 「Custom」に設定します。
- ソース: ロードバランサーのアプローチに基づいて適切なセキュリティグループを選択します:
- NLB only:
gitlab-nlb-sec-group - Hybrid NLB->ALB:
gitlab-rails-sec-group
- NLB only:
- 設定が完了したら、Create security groupを選択します。
RDSサブネットグループ
- RDSダッシュボードに移動し、左側のメニューからSubnet Groupsを選択します。
- Create DB Subnet Groupを選択します。
- Subnet group detailsで、名前(この例では
gitlab-rds-group)と説明を入力し、VPCドロップダウンリストからgitlab-vpcを選択します。 - Availability Zonesドロップダウンリストから、設定済みのサブネットを含むアベイラビリティーゾーンを選択します。この例では、
us-west-2aとus-west-2bを追加します。 - Subnetsドロップダウンリストから、サブネットセクションで定義した2つのプライベートサブネット(
10.0.1.0/24と10.0.3.0/24)を選択します。 - 準備ができたらCreateを選択します。
データベースを作成する
CPUクレジットが持続的な高負荷時に枯渇するため、データベースにバースト可能なインスタンス (tクラスインスタンス)を使用することは避けてください。パフォーマンスの問題につながる可能性があります。
それでは、データベースを作成しましょう。
RDSダッシュボードに移動し、左側のメニューからDatabasesを選択し、Create databaseを選択します。
データベースの作成方法ではStandard Createを選択します。
データベースエンジンとしてPostgreSQLを選択し、GitLabバージョンのデータベース要件で定義されている最小PostgreSQLバージョンを選択します。
これは本番環境サーバーであるため、TemplatesセクションでProductionを選択します。
Availability & durabilityで、Multi-AZ DB instanceを選択し、別のアベイラビリティーゾーンにスタンバイRDSインスタンスをプロビジョニングします。
Settings(設定)で、次の値を使用します。
- DB instance identifier:
gitlab-db-ha。 - master username:
gitlab。 - master password: 非常に安全なパスワード。
これらの情報は後で必要になるため、メモしておきます。
- DB instance identifier:
DB instance sizeにはStandard classesを選択し、要件を満たすインスタンスサイズをドロップダウンリストから選択します。ここでは
db.m5.largeインスタンスを使用します。Storageで、次の項目を設定します。
- ストレージタイプのドロップダウンリストから**Provisioned IOPS(SSD)**を選択します。Provisioned IOPS(SSD)ストレージは、この用途に最適です(ただし、コスト削減のためにGeneral Purpose(SSD)を選択することもできます)。詳細については、Amazon RDSのストレージを参照してください。
- ストレージを割り当て、プロビジョニングされたIOPSを設定します。ここでは、最小値である
100と1000を使用します。 - ストレージのオートスケールを有効にし(オプション)、ストレージの最大しきい値を設定します。
Connectivityで、次の項目を設定します。
- **Virtual Private Cloud(VPC)**ドロップダウンリストで、先ほど作成したVPC(
gitlab-vpc)を選択します。 - DB subnet groupで、先ほど作成したサブネットグループ(
gitlab-rds-group)を選択します。 - パブリックアクセスをNoに設定します。
- VPC security groupで、Choose existingを選択し、ドロップダウンリストから先ほど作成した
gitlab-rds-sec-groupを選択します。 - Additional configurationで、データベースポートをデフォルトの
5432のままにします。
- **Virtual Private Cloud(VPC)**ドロップダウンリストで、先ほど作成したVPC(
Database authenticationで、Password authenticationを選択します。
Additional configurationセクションを展開し、次の項目を設定します。
- 初期データベース名(この例では
gitlabhq_production)。 - 必要に応じてバックアップを設定します。
- 最後に、Maintenanceでマイナーバージョンの自動更新を無効にします。
- その他すべての設定はそのままにするか、必要に応じて微調整します。
- 問題がなければ、Create databaseを選択します。
- 初期データベース名(この例では
これで、データベースが作成されました。次に、ElastiCacheを使用してRedisをセットアップします。
ElastiCacheを使用したRedis
ElastiCacheは、ホストされるインメモリキャッシュ型のソリューションです。Redisは独自の永続性を保持し、GitLabアプリケーションのセッションデータ、一時的なキャッシュ情報、バックグラウンドジョブキューの保存に使用されます。
Redisセキュリティグループを作成する
- EC2ダッシュボードに移動します。
- 左側のメニューからSecurity Groupsを選択します。
- Create security groupを選択し、詳細を入力します。名前(この例では
gitlab-redis-sec-group)を付けて説明を追加し、先ほど作成したVPC(gitlab-vpc)を選択します。 - Inbound rulesセクションで、ルールを追加するを選択し、Custom TCPルールを追加してポート
6379を設定し、ロードバランサーのアプローチに基づいて"Custom" ソースを設定します:- NLB only:
gitlab-nlb-sec-group - Hybrid NLB->ALB:
gitlab-rails-sec-group
- NLB only:
- 設定が完了したら、Create security groupを選択します。
Redisサブネットグループ
AWSコンソールからElastiCacheダッシュボードに移動します。
左側のメニューのSubnet Groupsに移動し、新しいサブネットグループを作成します(この例では
gitlab-redis-groupという名前を付けます)。先ほど作成したVPC(gitlab-vpc)を選択し、Selected subnetsテーブルにプライベートサブネットのみが含まれていることを確認します。準備ができたらCreateを選択します。
Redisクラスターを作成する
ElastiCacheダッシュボードに戻ります。
左側のメニューでRedis cachesを選択し、Create Redis cacheを選択して、新しいRedisクラスターを作成します。
Deployment optionで、Design your own cacheを選択します。
Creation methodで、Cluster cacheを選択します。
Cluster modeはサポートされていないため、Disabledを選択します。クラスターモードを無効にしても、複数のアベイラビリティーゾーンにRedisをデプロイすることは可能です。
Cluster infoで、クラスター名(
gitlab-redis)と説明を入力します。Locationで、AWS Cloudを選択し、Multi-AZオプションを有効にします。
Cluster settingsセクション:
- Engine versionでは、Redis要件に記載されている、ご利用のGitLabバージョンに対応するRedisバージョンを選択します。
- ポートは
6379のままにします。これは先ほどRedisセキュリティグループで使用した値です。 - ノードタイプ(少なくとも
cache.t3.medium、必要に応じて調整)とレプリカの数を選択します。
Connectivity settingsセクション:
- Network type: IPv4
- Subnet groups: Choose existing subnet groupを選択し、先ほど作成した
gitlab-redis-groupを選択します。
Availability Zone placementsセクション:
Nextを選択します。
セキュリティ設定で、セキュリティグループを編集し、先ほど作成した
gitlab-redis-sec-groupを選択します。Nextを選択します。残りの設定はデフォルト値のままにするか、必要に応じて編集します。
完了したらCreateを選択します。
踏み台ホストを設定する
GitLabインスタンスはプライベートサブネット内にあるため、設定変更やアップグレードなどを行う際に、SSHを使用してこれらのインスタンスに接続する方法が必要です。その手段の1つが、踏み台ホストを使用することです。ジャンプボックスとも呼ばれます。
バスティオンホストを維持したくない場合は、インスタンスにアクセスするためにAWS Systems Manager Session Managerをセットアップできます。この設定は、このドキュメントの範囲外です。
踏み台ホストAを作成する
- EC2ダッシュボードに移動し、Launch instanceを選択します。
- Name and tagsセクションで、Nameに
Bastion Host Aと指定します。 - 最新のUbuntu Server LTS (HVM) AMIを選択します。サポート対象の最新のOSバージョンについては、GitLabドキュメントを確認してください。
- インスタンスタイプを選択します。ここでは、踏み台ホストを使用して他のインスタンスにSSHで接続するだけなので、
t2.microを使用します。 - Key pairセクションで、Create new key pairを選択します。
- キーペアに名前(この例では
bastion-host-a)を付け、後で使用するためにbastion-host-a.pemファイルを保存します。
- キーペアに名前(この例では
- Network settingsセクションを編集します。
- VPCで、ドロップダウンリストから
gitlab-vpcを選択します。 - Subnetで、先ほど作成したパブリックサブネット(
gitlab-public-10.0.0.0)を選択します。 - Auto-assign Public IPで、Disabledが選択されていることを確認します。Elastic IPアドレスは、次のセクションでホストに割り当てます。
- Firewallで、Create security groupを選択し、Security group name(この例では
bastion-sec-group)を入力し、説明を追加します。 - すべての送信元からのSSHアクセスを有効にします(
0.0.0.0/0)。より厳密なセキュリティを適用する必要がある場合は、単一のIPアドレスまたはCIDR表記のIPアドレス範囲を指定します。
- VPCで、ドロップダウンリストから
- ストレージについては、すべてをデフォルトのままにし、8 GBのルートボリュームのみを追加します。このインスタンスには何も保存しません。
- すべての設定を確認し、問題がなければ、Launch Instanceを選択します。
踏み台ホストAにElastic IPを割り当てる
- EC2ダッシュボードに移動し、Network & Securityを選択します。
- Elastic IPsを選択し、
Network border groupをus-west-2に設定します。 - Allocateを選択します。
- 作成されたElastic IPアドレスを選択します。
- Actions、Associate Elastic IP addressの順に選択します。
- Resource TypeでInstanceを選択し、Instanceドロップダウンリストから
Bastion Host Aホストを選択します。 - Associateを選択します。
インスタンスにSSHで接続できることを確認する
- EC2ダッシュボードで、左側のメニューからInstancesを選択します。
- インスタンスの一覧からBastion Host Aを選択します。
- Connectを選択し、表示される接続手順に従います。
- 正常に接続できたら、冗長性を確保するために2つ目の踏み台ホストの設定に進みます。
踏み台ホストBを作成する
- 先ほどと同じ手順に従ってEC2インスタンスを作成しますが、次の点を変更します。
- Subnetには、先ほど作成した2つ目のパブリックサブネット(
gitlab-public-10.0.2.0)を選択します。 - Add Tagsセクションで、2つのインスタンスを識別できるように
Key: NameとValue: Bastion Host Bを設定します。 - セキュリティグループには、先ほど作成した既存の
bastion-sec-groupを選択します。
- Subnetには、先ほど作成した2つ目のパブリックサブネット(
SSHエージェント転送を使用する
Linuxを実行するEC2インスタンスでは、SSH認証に秘密キーファイルを使用します。SSHクライアントを使用し、クライアントに保存されている秘密キーファイルで踏み台ホストに接続します。踏み台ホストには秘密キーファイルが存在しないため、プライベートサブネット内のインスタンスには接続できません。
踏み台ホストに秘密キーファイルを保存するのは不適切です。この問題を回避するには、クライアントでSSHエージェント転送を使用します。
たとえば、コマンドラインのsshクライアントは、次のような-Aスイッチでエージェント転送を使用します。
ssh -A user@<bastion-public-IP-address>他のクライアントでSSHエージェント転送を使用する手順については、Securely Connect to Linux Instances Running in a Private Amazon VPCを参照してください。
GitLabをインストールしてカスタムAMIを作成する
後で起動設定に使用するため、設定済みのカスタムGitLab AMIが必要です。まず公式のGitLab AMIを使用してGitLabインスタンスを作成します。次に、PostgreSQL、Redis、Gitaly向けのカスタム設定を追加します。必要に応じて、公式のGitLab AMIを使用せず、独自に選択したEC2インスタンスを起動し、GitLabを手動でインストールすることもできます。
GitLabをインストールする
EC2ダッシュボードで、次の手順に従います。
- Find official GitLab-created AMI IDs on AWSというタイトルの以下のセクションを使用して、正しいAMIを見つけてLaunchを選択します。
- Name and tagsセクションで、Nameに
GitLabと指定します。 - Instance typeドロップダウンリストで、ワークロードに応じてインスタンスタイプを選択します。ハードウェア要件を参照し、ニーズに合ったタイプを選択します(少なくとも
c5.2xlarge。これは100人のユーザーに十分対応できます)。 - Key pairセクションで、Create new key pairを選択します。
- キーペアに名前(この例では
gitlab)を付け、後で使用するためにgitlab.pemファイルを保存します。
- キーペアに名前(この例では
- Network settingsセクション:
VPC: 先ほど作成した
gitlab-vpcを選択します。Subnet: 先ほど作成したサブネットの一覧から
gitlab-private-10.0.1.0を選択します。Auto-assign Public IP:
Disableを選択します。Firewall: Select existing security groupを選択し、ロードバランサーのアプローチに基づいて適切なセキュリティグループを選択します:
- NLB only:
gitlab-nlb-sec-groupとbastion-sec-group - Hybrid NLB->ALB:
gitlab-rails-sec-groupとbastion-sec-group
bastion-sec-groupは、SSH Agent Forwardingを使用して、管理および設定タスクのためにバスティオンホストからのSSHアクセスを許可します。- NLB only:
- ストレージについては、ルートボリュームはデフォルトで8 GiBに設定されています。ここにはデータを保存しないため、この容量で十分です。
- すべての設定を確認し、問題がなければ、Launch Instanceを選択します。
カスタム設定を追加する
SSHエージェント転送を使用し、踏み台ホストA経由でGitLabインスタンスに接続します。接続したら、次のカスタム設定を追加します。
Let’s Encryptを無効にする
ロードバランサーでSSL証明書を追加するため、GitLabに組み込まれているLet’s Encryptのサポートは必要ありません。httpsドメインを使用する場合、Let’s Encryptはデフォルトで有効になっているため、明示的に無効にする必要があります。
/etc/gitlab/gitlab.rbを開き、無効にします。letsencrypt['enable'] = falseファイルを保存し、変更を反映するために再設定します:
sudo gitlab-ctl reconfigure
PostgreSQLに必要な拡張機能をインストールする
gitlabユーザーがrds_superuserロールを持っている場合、GitLabは必要な拡張機能を自動的にインストールできます。その場合、以下の手動手順は必要ありません。
GitLabインスタンスからRDSインスタンスに接続してアクセスを検証し、required PostgreSQL extensionsをインストールします。
ホストまたはエンドポイントを見つけるには、Amazon RDS > Databasesに移動し、先ほど作成したデータベースを選択します。Connectivity & securityタブでエンドポイントを探します。
-hには、RDSエンドポイントのホスト名のみを使用し、末尾のコロンとポート番号は省略します:
sudo /opt/gitlab/embedded/bin/psql -U gitlab -h <rds-endpoint> -d gitlabhq_production次に、CREATE EXTENSIONを使用して各required extensionをインストールします:
CREATE EXTENSION IF NOT EXISTS btree_gist;
CREATE EXTENSION IF NOT EXISTS ...;\dxでインストールされた拡張機能を検証します。
PostgreSQLとRedisに接続するようにGitLabを設定する
/etc/gitlab/gitlab.rbを編集し、external_url 'http://<domain>'オプションを見つけて、使用しているhttpsドメインに変更します。GitLabデータベース設定を探して、必要に応じてコメントアウトを解除します。今回のケースでは、データベースアダプター、エンコード、ホスト、データベース名、ユーザー名、パスワードを指定します。
# Disable the built-in Postgres postgresql['enable'] = false # Fill in the connection details gitlab_rails['db_adapter'] = "postgresql" gitlab_rails['db_encoding'] = "unicode" gitlab_rails['db_database'] = "gitlabhq_production" gitlab_rails['db_username'] = "gitlab" gitlab_rails['db_password'] = "mypassword" gitlab_rails['db_host'] = "<rds-endpoint>"次に、Redisセクションを設定し、ホストを追加してポートのコメントアウトを解除する必要があります。
# Disable the built-in Redis redis['enable'] = false # Fill in the connection details gitlab_rails['redis_host'] = "<redis-endpoint>" gitlab_rails['redis_port'] = 6379 # Adjust based on your Redis setting gitlab_rails['redis_ssl'] = true最後に、変更を反映するためにGitLabを再設定します。
sudo gitlab-ctl reconfigureチェックとサービスステータスを実行して、すべてが正しく設定されていることを確認することもできます。
sudo gitlab-rake gitlab:check sudo gitlab-ctl status
Gitalyを設定する
このアーキテクチャでは、単一のGitalyサーバーが単一障害点になります。この制限を解消するには、Gitaly Cluster (Praefect)を使用します。
Gitalyは、Gitリポジトリへの高レベルのRPCアクセスを提供するサービスです。以前に設定したプライベートサブネットのいずれかに配置した個別のEC2インスタンス上で、Gitalyを有効にして設定する必要があります。
GitalyをインストールするEC2インスタンスを作成します。
- EC2ダッシュボードでLaunch instanceを選択します。
- Name and tagsセクションで、Nameに
Gitalyと指定します。 - AMIを選択します。この例では、最新のUbuntu Server LTS (HVM), SSD Volume Typeを選択します。サポート対象の最新のOSバージョンについては、GitLabドキュメントを確認してください。
- インスタンスタイプを選択します。
m5.xlargeを選択します。 - Key pairセクションで、Create new key pairを選択します。
- キーペアに名前(この例では
gitaly)を付け、後で使用するためにgitaly.pemファイルを保存します。
- キーペアに名前(この例では
- Network settingsセクション:
- VPCで、ドロップダウンリストから
gitlab-vpcを選択します。 - Subnetで、先ほど作成したプライベートサブネット(
gitlab-private-10.0.1.0)を選択します。 - Auto-assign Public IPで、Disableが選択されていることを確認します。
- Firewallで、Create security groupを選択し、Security group name(この例では
gitlab-gitaly-sec-group)を入力し、説明を追加します。- Custom TCPルールを作成し、ポート
8075をPort Rangeに追加します。ソースには、ロードバランサーのアプローチに基づいて適切なセキュリティグループを選択します:- NLB only:
gitlab-nlb-sec-group - Hybrid NLB->ALB:
gitlab-rails-sec-group
- NLB only:
- さらに、踏み台ホストからSSHエージェント転送を使用して接続できるように、
bastion-sec-groupからのSSH接続を許可するインバウンドルールを追加します。
- Custom TCPルールを作成し、ポート
- VPCで、ドロップダウンリストから
- Root volume sizeを
20 GiBに増やし、Volume TypeをProvisioned IOPS SSD (io1)に変更します。(ボリュームサイズには任意の値を設定できます。リポジトリストレージ要件を満たす十分な容量を確保してください。)- IOPSには
1000(20 GiB x 50 IOPS)を設定します。1 GiBあたり最大50 IOPSまでプロビジョニングできます。より大きなボリュームを選択する場合は、それに応じてIOPSを増やします。gitのように、多数の小さなファイルを直列的に書き込むワークロードでは、高性能ストレージが必要となるため、Provisioned IOPS SSD (io1)を選択します。
- IOPSには
- すべての設定を確認し、問題がなければ、Launch Instanceを選択します。
設定およびリポジトリストレージデータをルートボリュームに保存する代わりに、追加のEBSボリュームをリポジトリストレージとして追加することもできます。前述のガイダンスと同様の手順に従ってください。Amazon EBSの料金ページを参照してください。
EC2インスタンスの準備が整ったので、ドキュメントに従ってGitLabをインストールし、Gitalyを専用サーバー上にセットアップします。先ほど作成したGitLabインスタンスで、前述のドキュメントに記載されたクライアント側のセットアップ手順を実行します。
Elastic File System(EFS)
EFSはGitLabのパフォーマンスに悪影響を及ぼす可能性があるため、使用はお勧めしません。詳細については、クラウドベースのファイルシステムの回避に関するドキュメントを参照してください。
それでもEFSを使用する場合は、PosixUser属性を省略するか、Gitalyがインストールされているシステム上のgitユーザーのUIDとグループID(GID)を正しく指定してください。UIDとGIDは、次のコマンドで取得できます。
# UID
id -u git
# GID
id -g gitまた、複数のアクセスポイントを設定しないでください。特に、異なる認証情報を指定している場合は避ける必要があります。Gitaly以外のアプリケーションが、Gitalyストレージディレクトリに対する権限を操作し、Gitalyが正常に動作しなくなるおそれがあります。この問題の具体例については、omnibus-gitlabイシュー8893を参照してください。
プロキシ経由のSSLのサポートを追加する
ロードバランサーでSSLを終端しているため、/etc/gitlab/gitlab.rbでこの設定を行うには、プロキシ経由のSSLをサポートする手順に従います。
gitlab.rbファイルへの変更を保存した後、必ずsudo gitlab-ctl reconfigureを実行してください。
承認されたSSHキーの高速検索
GitLabへのアクセスを許可されたユーザーの公開SSHキーは、/var/opt/gitlab/.ssh/authorized_keysに保存されています。通常は共有ストレージを使用し、ユーザーがSSH経由でGitアクションを実行する際に、すべてのインスタンスがこのファイルにアクセスできるようにします。しかし、今回のセットアップでは共有ストレージを使用していないため、GitLabデータベース内のインデックス検索を使用してSSHユーザーを認証するように設定を更新します。
SSHキーの高速検索の設定手順に従って、authorized_keysファイルの使用からデータベースに切り替えてください。
高速検索を設定しない場合、SSH経由でGitアクションを実行すると次のエラーが返されます。
Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.ホストキーを設定する
通常は、プライマリアプリケーションサーバー上の/etc/ssh/の内容(プライマリキーと公開キー)を、すべてのセカンダリサーバー上の/etc/sshに手動でコピーします。これにより、ロードバランサーの背後にあるクラスター内のサーバーにアクセスする際に、誤った中間者攻撃のアラートが発生するのを防ぐことができます。
カスタムAMIの一部として静的ホストキーを作成することで、この手順を自動化します。また、これらのホストキーはEC2インスタンスが起動するたびにローテーションされるため、カスタムAMIに「ハードコード」することで、この問題を回避できます。
GitLabインスタンスで、次のコマンドを実行します。
sudo mkdir /etc/ssh_static
sudo cp -R /etc/ssh/* /etc/ssh_static/etc/ssh/sshd_configで、次の内容を更新します。
# HostKeys for protocol version 2
HostKey /etc/ssh_static/ssh_host_rsa_key
HostKey /etc/ssh_static/ssh_host_dsa_key
HostKey /etc/ssh_static/ssh_host_ecdsa_key
HostKey /etc/ssh_static/ssh_host_ed25519_keyAmazon S3オブジェクトストレージ
共有ストレージとしてNFSを使用していないため、バックアップ、アーティファクト、LFSオブジェクト、アップロード、マージリクエストの差分、コンテナレジストリのイメージなどを保存するためにAmazon S3バケットを使用します。GitLabのドキュメントには、これらの各データタイプに対してオブジェクトストレージを設定する方法や、GitLabでオブジェクトストレージを使用する際の詳細情報が記載されています。
以前に作成したAWS IAM profileを使用しているため、オブジェクトストレージを設定する際にAWSアクセスキーとシークレットアクセスキー/キー/バリューペアを省略するようにしてください。代わりに、先ほどリンクを紹介したオブジェクトストレージに関するドキュメントに記載されているとおり、設定で'use_iam_profile' => trueを使用します。
S3アクセスにIAMロールを使用する場合、GitLabはIMDSv1とIMDSv2の両方をサポートし、利用可能な場合は自動的にIMDSv2を使用します。
gitlab.rbファイルへの変更を保存した後、必ずsudo gitlab-ctl reconfigureを実行してください。
これで、GitLabインスタンスの設定変更は完了です。次に、このインスタンスを基にカスタムAMIを作成し、起動設定とオートスケールグループに使用します。
IP許可リスト
先ほど作成したgitlab-vpcのVPC IPアドレス範囲(CIDR)を、ヘルスチェックエンドポイントのIP許可リストに追加する必要があります。
/etc/gitlab/gitlab.rbを編集します。gitlab_rails['monitoring_whitelist'] = ['127.0.0.0/8', '10.0.0.0/16']GitLabを再設定します。
sudo gitlab-ctl reconfigure
プロキシプロトコル
先ほど作成したロードバランサーでプロキシプロトコルが有効になっている場合は、gitlab.rbファイルでもこれを有効にする必要があります。
/etc/gitlab/gitlab.rbを編集します。nginx['proxy_protocol'] = true nginx['real_ip_trusted_addresses'] = [ "127.0.0.0/8", "IP_OF_THE_PROXY/32"]GitLabを再設定します。
sudo gitlab-ctl reconfigure
初めてサインインする
ロードバランサーのDNSを設定したときに使用したドメイン名を使用すると、ブラウザでGitLabにアクセスできるようになります。
GitLabのインストール方法や、他の手段でパスワードを変更したかどうかに応じて、デフォルトのパスワードは次のいずれかになります。
- 公式のGitLab AMIを使用した場合は、インスタンスID。
/etc/gitlab/initial_root_passwordに24時間保存されるランダム生成パスワード。
デフォルトのパスワードを変更するには、rootユーザーとしてデフォルトのパスワードでサインインし、ユーザープロファイルで変更します。
オートスケールグループが新しいインスタンスを起動すると、ユーザー名rootと新しく作成されたパスワードでサインインできます。
カスタムAMIを作成する
EC2ダッシュボードで、次の手順に従います。
- 先ほど作成した
GitLabインスタンスを選択します。 - Actionsを選択し、Image and templatesまでスクロールダウンしてCreate imageを選択します。
- イメージの名前と説明を入力します(この例ではどちらにも
GitLab-Sourceを使用します)。 - それ以外の設定はすべてデフォルトのままにして、Create Imageを選択します。
これで、次のステップで起動設定を作成するために使用するカスタムAMIが作成されました。
オートスケールグループ内にGitLabをデプロイする
起動テンプレートを作成する
EC2ダッシュボードで、次の手順に従います。
左側のメニューからLaunch Templatesを選択し、create launch templateを選択します。
起動テンプレートの名前を入力します(この例では
gitlab-launch-template)。Launch template contentsを選択し、My AMIsタブを選択します。
Owned by meを選択し、先ほど作成したカスタムAMIである
GitLab-Sourceを選択します。ニーズに最適なインスタンスタイプを選択します(少なくとも
c5.2xlarge)。Key pairセクションで、Create new key pairを選択します。
- キーペアに名前(この例では
gitlab-launch-template)を付け、後で使用するためにgitlab-launch-template.pemファイルを保存します。
- キーペアに名前(この例では
ルートボリュームはデフォルトで8 GiBに設定されています。ここにはデータを保存しないため、この容量で十分です。Configure Security Groupを選択します。
Select existing security groupをチェックし、ロードバランサーのアプローチに基づいて適切なセキュリティグループを選択します:
- NLB only:
gitlab-nlb-sec-groupとbastion-sec-group - Hybrid NLB->ALB:
gitlab-rails-sec-groupとbastion-sec-group
bastion-sec-groupは、SSH Agent Forwardingを使用して、管理および設定タスクのためにバスティオンホストからのSSHアクセスを許可します。- NLB only:
Advanced detailsセクション:
- IAM instance profile: 先ほど作成した
GitLabS3Accessロールを選択します。
- IAM instance profile: 先ほど作成した
すべての設定を確認し、問題がなければCreate launch templateを選択します。
オートスケールグループを作成する
EC2ダッシュボードで、次の手順に従います。
左側のメニューからAuto scaling groupsを選択し、Create Auto Scaling groupを選択します。
Group nameを入力します(この例では
gitlab-auto-scaling-group)。Launch templateで、先ほど作成した起動テンプレートを選択します。Nextを選択します。
Network settingsセクション:
- VPCで、ドロップダウンリストから
gitlab-vpcを選択します。 - Availability Zones and subnetsで、先ほど作成したプライベートサブネット(
gitlab-private-10.0.1.0とgitlab-private-10.0.3.0)を選択します。 - Nextを選択します。
- VPCで、ドロップダウンリストから
Load Balancing settingsセクション:
- Attach to an existing load balancerを選択します。
- Existing load balancer target groupsドロップダウンリストで、ロードバランサーのアプローチに基づいて適切なターゲットグループを選択します:
- NLB only:
gitlab-nlb-ssh-targetとgitlab-nlb-http-targetを選択します - Hybrid NLB->ALB:
gitlab-nlb-ssh-targetとgitlab-alb-http-targetを選択します。オートスケールグループは、起動されたすべてのインスタンスをこれらのターゲットグループに自動的に登録します。
- NLB only:
- Health Check Typeで、Turn on Elastic Load Balancing health checksオプションをオンにします。Health Check Grace Periodは、デフォルトの
300秒のままにします。 - Nextを選択します。
Group sizeで、Desired capacityを
2に設定します。Scaling settingsセクションで、次の手順に従います。
- No scaling policiesを選択します。ポリシーは以降に設定されます。
- Min desired capacity:
2に設定します。 - Max desired capacity:
4に設定します。 - Nextを選択します。
最後に、必要に応じて通知とタグを設定し、変更内容を確認してから、オートスケールグループを作成します。
オートスケールグループを作成したら、CloudWatchでスケールアップおよびスケールダウンポリシーを作成し、それらを割り当てる必要があります。
- 先ほど作成したオートスケールグループのEC2インスタンスから取得したメトリクスに対して、
CPUUtilizationのアラームを作成します。 - 次の条件を使用してスケールアップポリシーを作成します。
CPUUtilizationが60%以上の場合は、キャパシティユニットを1追加します。- Scaling policy nameを
Scale Up Policyに設定します。
- 次の条件を使用してスケールダウンポリシーを作成します。
CPUUtilizationが45%以下の場合は、キャパシティユニットを1削除します。- Scaling policy nameを
Scale Down Policyに設定します。
- 先ほど作成したオートスケールグループに、新しい動的スケーリングポリシーを割り当てます。
- 先ほど作成したオートスケールグループのEC2インスタンスから取得したメトリクスに対して、
オートスケールグループが作成されると、EC2ダッシュボード上で新しいインスタンスが起動していることを確認できます。また、ロードバランサーに新しいインスタンスが追加されていることも確認できます。インスタンスがヘルスチェックに合格すると、ロードバランサーからトラフィックを受信する準備が整います。
インスタンスはオートスケールグループによって作成されるため、インスタンスに戻り、先ほど手動で作成したインスタンスを終了します。このインスタンスは、カスタムAMIを作成する目的にのみ使用しました。
Prometheusによるヘルスチェックとモニタリング
さまざまなサービスで有効化できるAmazon CloudWatchとは別に、GitLabはPrometheusに基づく独自の統合モニタリングソリューションを提供しています。設定方法の詳細については、GitLab Prometheusを参照してください。
GitLabにはさまざまなヘルスチェックエンドポイントが用意されており、pingしてレポートを取得できます。
GitLab Runner
GitLab CI/CDを活用するには、少なくとも1つのRunnerを設定する必要があります。
AWS上でオートスケール対応のGitLab Runnerを設定する方法については、リンク先を参照してください。
バックアップと復元
GitLabには、Gitデータ、データベース、添付ファイル、LFSオブジェクトなどをバックアップおよび復元するためのツールが用意されています。
知っておくべき重要な点:
- バックアップ/復元ツールは、シークレットなどの一部の設定ファイルを保存しません。これらは手動で設定する必要があります。
- デフォルトでは、バックアップファイルはローカルに保存されますが、S3を使用してGitLabをバックアップすることもできます。
- バックアップから特定のディレクトリを除外できます。
GitLabをバックアップする
GitLabをバックアップするには、次の手順に従います。
インスタンスにSSHで接続します。
バックアップを作成します。
sudo gitlab-backup create
バックアップからGitLabを復元する
GitLabを復元するには、まず復元に関するドキュメント、特に復元の前提条件を確認してください。次に、Linuxパッケージインストールセクションに記載された手順に従います。
GitLabを更新する
GitLabでは、毎月リリース日に新しいバージョンをリリースしています。新しいバージョンがリリースされたら、GitLabインスタンスを更新できます。
インスタンスにSSHで接続します。
バックアップを作成します。
sudo gitlab-backup createリポジトリを更新し、GitLabをインストールします。
sudo apt update sudo apt install gitlab-ee
数分後には、新しいバージョンが起動して稼働を開始します。
AWS上でGitLabが提供する公式AMI IDを見つける
GitLabがリリースしているAMIの使用方法については、リンク先をご覧ください。
まとめ
このガイドでは、主にスケーリングといくつかの冗長化オプションについて説明しましたが、必要な作業内容は環境によって異なります。
すべてのソリューションは、コストと複雑さ、そしてアップタイムの間でバランスを取る必要があります。必要とするアップタイムが長くなるほど、ソリューションは複雑になります。そしてソリューションが複雑になるほど、セットアップやメンテナンスに必要な作業も増えます。
以下のその他のリソースもぜひご覧ください。追加の資料をご希望の場合は、イシューを開いてリクエストしてください。
- GitLabのスケーリング: GitLabはさまざまなクラスタリングをサポートしています。
- Geoレプリケーション: Geoは、広範な地域に分散した開発チーム向けのソリューションです。
- Linuxパッケージ: GitLabインスタンスの管理について知っておくべきすべての情報が掲載されています。
- ライセンスの追加: ライセンスを適用すると、GitLab Enterprise Editionのすべての機能を有効にできます。
- 価格: 各プランの価格をご確認ください。
トラブルシューティング
インスタンスがヘルスチェックに失敗する
インスタンスがロードバランサーのヘルスチェックに失敗する場合は、以前に設定したヘルスチェックエンドポイントからステータス200が返されていることを確認してください。ステータス302などのリダイレクトを含む、その他のステータスが返されるとヘルスチェックは失敗します。
ヘルスチェックに合格するために、rootユーザーにパスワードを設定し、サインインエンドポイントでの自動リダイレクトを防ぐ必要がある場合があります。
メッセージ: The change you requested was rejected (422)
Webインターフェースでパスワードを設定しようとした際にこのページが表示される場合は、gitlab.rb内のexternal_urlがリクエスト元のドメインと一致していることを確認してください。ファイルに変更を加えた場合は、sudo gitlab-ctl reconfigureを実行します。
一部のジョブログがオブジェクトストレージにアップロードされない
GitLabデプロイを複数のノードにスケールアップすると、一部のジョブログがオブジェクトストレージに正常にアップロードされない場合があります。CIでオブジェクトストレージを使用するには、増分ログが必要です。
まだ有効にしていない場合は、増分ログを有効にします。







