CI/CD変数

CI/CD変数を使用して、Auto DevOpsドメインをセットアップし、カスタムHelmチャートを提供するか、アプリケーションをスケールします。

ビルドおよびデプロイの変数

これらの変数を使用して、ビルドをカスタマイズおよびデプロイします。

データベース変数

これらの変数を使用して、CI/CDをPostgreSQLデータベースと統合します。

ジョブスキップ変数

これらの変数を使用して、特定のタイプのCI/CDジョブをスキップします。スキップすると、CI/CDジョブは作成または実行されません。

アプリケーションシークレット変数を設定する

一部のデプロイされたアプリケーションでは、シークレット変数へのアクセスが必要です。Auto DevOpsはK8S_SECRET_で始まるCI/CD変数を検出し、環境変数としてデプロイされたアプリケーションで利用できるようにします。

前提要件:

• 変数の値は1行である必要があります。

シークレット変数を設定するには、次のようにします:

1. 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
2. 設定 > CI/CDを選択します。
3. 変数を展開します。
4. プレフィックスK8S_SECRET_を持つCI/CD変数を作成します。たとえば、K8S_SECRET_RAILS_MASTER_KEYという変数を作成できます。
5. 新しいパイプラインを手動で作成するか、コード変更をGitLabにプッシュして、Auto DevOpsパイプラインを実行します。

Kubernetesシークレット

Auto DevOpsパイプラインは、アプリケーションのシークレット変数を使用して、Kubernetesシークレットに入力された状態にします。このシークレットは環境ごとに一意です。アプリケーションのデプロイ時、シークレットは、アプリケーションを実行しているコンテナ内の環境変数として読み込まれます。例えば、K8S_SECRET_RAILS_MASTER_KEYという名前のシークレットを作成した場合、Kubernetesのシークレットは次のようになります:

$ kubectl get secret production-secret -n minimal-ruby-app-54 -o yaml

apiVersion: v1
data:
  RAILS_MASTER_KEY: MTIzNC10ZXN0
kind: Secret
metadata:
  creationTimestamp: 2018-12-20T01:48:26Z
  name: production-secret
  namespace: minimal-ruby-app-54
  resourceVersion: "429422"
  selfLink: /api/v1/namespaces/minimal-ruby-app-54/secrets/production-secret
  uid: 57ac2bfd-03f9-11e9-b812-42010a9400e4
type: Opaque

アプリケーションシークレットの更新

環境変数は通常、Kubernetesのポッド内でイミュータブルです。アプリケーションシークレットを更新し、手動で新しいパイプラインを作成した場合、実行中のアプリケーションは更新されたシークレットを受け取りません。

アプリケーションシークレットを更新するには、次のいずれかの方法を実行します:

• GitLabにプッシュしてコードを更新し、Kubernetesのデプロイにポッドを再作成させます。
• シークレットが更新された新しいポッドをKubernetesに作成させるために、実行中のポッドを手動で削除します。

複数行の値を持つ変数は、Auto DevOpsのスクリプト環境の制限によりサポートされていません。

レプリカ変数の設定

デプロイをスケールする場合は、レプリカ変数を追加します:

1. プロジェクトCI/CD変数としてレプリカ変数を追加します。

2. アプリケーションをスケールするには、再デプロイします。

   Kubernetesを直接使用してアプリケーションをスケールしないでください。Helmが変更を検出せず、後続のAuto DevOpsでのデプロイで変更が元に戻る可能性があります。

カスタムレプリカ変数

<TRACK>_<ENV>_REPLICASの形式で、カスタムレプリカ変数を作成できます:

• <TRACK>は、Helmチャートアプリケーション定義で設定されたtrack Kubernetesラベルの大文字の値です。trackが設定されていない場合は、カスタム変数から<TRACK>を省略してください。
• <ENV>は、.gitlab-ci.ymlで設定されたデプロイジョブのすべて大文字の環境名です。

たとえば、環境がqaで、トラックがfooの場合、FOO_QA_REPLICASという環境変数を作成します:

QA testing:
  stage: deploy
  environment:
    name: qa
  script:
    - deploy foo

トラックfooは、アプリケーションのHelmチャートで定義されている必要があります。次に例を示します:

replicaCount: 1
image:
  repository: gitlab.example.com/group/project
  tag: stable
  pullPolicy: Always
  secrets:
    - name: gitlab-registry
application:
  track: foo
  tier: web
service:
  enabled: true
  name: web
  type: ClusterIP
  url: http://my.host.com/
  externalPort: 5000
  internalPort: 5000

ステージング環境と本番環境のデプロイポリシー

Auto DevOpsは通常、継続的デプロイを使用し、デフォルトブランチで新しいパイプラインが実行されるたびに、production本番環境に自動的にプッシュします。本番環境に手動でデプロイするには、STAGING_ENABLEDCI/CD変数を使用できます。

STAGING_ENABLEDを設定すると、GitLabはアプリケーションをstagingステージング環境に自動的にデプロイします。本番環境にデプロイする準備ができたら、GitLabはproduction_manualジョブを作成します。

プロジェクト設定で手動デプロイを有効にすることもできます。

カナリア環境のデプロイポリシー

本番環境に変更をデプロイする前に、カナリア環境を使用できます。

CANARY_ENABLEDを設定すると、GitLabは2つの手動ジョブを作成します:

• canary - アプリケーションをカナリア環境にデプロイします。
• production_manual - アプリケーションを本番環境にデプロイします。

本番環境への段階的ロールアウト

段階的ロールアウトを使用して、少数のポッドから始めて、アプリケーションを継続的にデプロイします。ポッドの数は手動で増やすことができます。

プロジェクト設定で手動デプロイを有効にするか、INCREMENTAL_ROLLOUT_MODEをmanualに設定します。

INCREMENTAL_ROLLOUT_MODEをmanualに設定すると、GitLabは4つの手動ジョブを作成します:

1. rollout 10%
2. rollout 25%
3. rollout 50%
4. rollout 100%

パーセンテージはREPLICASCI/CD変数に基づいており、デプロイに使用されるポッドの数を定義します。たとえば、値が10で、10%ロールアウトジョブを実行すると、アプリケーションは1つのポッドにのみデプロイされます。

ロールアウトジョブは任意の順序で実行できます。スケールダウンするには、より低いパーセンテージのジョブを再実行します。

rollout 100%ジョブを実行した後、スケールダウンできず、デプロイをロールバックする必要があります。

段階的ロールアウト構成の例

INCREMENTAL_ROLLOUT_MODEなし、STAGING_ENABLEDなし:

INCREMENTAL_ROLLOUT_MODEなし、STAGING_ENABLEDあり:

INCREMENTAL_ROLLOUT_MODEをmanualに設定し、STAGING_ENABLEDがない場合:

INCREMENTAL_ROLLOUT_MODEをmanualに設定し、STAGING_ENABLEDがある場合:

本番環境への時間指定段階的ロールアウト

時間指定段階的ロールアウトを使用して、少数のポッドから始めて、アプリケーションを継続的にデプロイします。

プロジェクト設定で時間指定段階的デプロイを有効にするか、INCREMENTAL_ROLLOUT_MODECI/CD変数をtimedに設定します。

INCREMENTAL_ROLLOUT_MODEをtimedに設定すると、GitLabは4つのジョブを作成します:

1. timed rollout 10%
2. timed rollout 25%
3. timed rollout 50%
4. timed rollout 100%

ジョブの間には5分間の遅延があります。