• 要件
• デザインの選択
• 設定
• インストールコマンドラインオプション
• チャート構成例
  • エクストラエンバイロメント
  • エクストラボリューム
  • エクストラボリュームマウント
  • 画像.pullSecrets
  • こうわん
  • コンメンタール
• このChartのコミュニティ版を使って
• 外部サービス
  • Redis
  • PostgreSQL
  • Gitaly
• メトリクス
• チャート全体の既定値
• ポッドごとの設定
  • キュー
  • ネゲートキュー
  • クラスター
  • pod 記入例
• を設定します。networkpolicy
  • ネットワークポリシー例

GitLab-Sidekiqチャートの使い方

sidekiq サブチャートは、Sidekiq ワーカーのコンフィギュレーション可能なデプロイを提供し、個々のスケーラビリティとコンフィギュレーションで複数のDeploymentにまたがるキューの分離を提供するように明示的に設計されています。

このChartはデフォルトのpods: 宣言を提供しますが、空の定義を提供した場合、ワーカーは存在しません。

要件

このチャートは、完全なGitLabチャートの一部として、あるいはこのチャートがデプロイされているKubernetesクラスターから到達可能な外部サービスとして提供されている、Redis、PostgreSQL、Gitalyサービスへのアクセスに依存しています。

デザインの選択

このChartでは、複数のDeploymentsと関連するConfigMapsが ConfigMap作成されますConfigMap。 ConfigMapコマンドの長さに関する懸念を避けるために、environment属性やコンテナ用のcommand への追加引数を使用する代わりに、ビヘイビアをConfigMap使用する方が明確 ConfigMapであると判断されました。この選択により、ConfigMapsの数は多くなりますが、各ポッドが何をすべきかの定義は非常に明確になります。

設定

sidekiq チャートは、チャート全体の外部サービス、チャート全体のデフォルト、ポッドごとの定義の3つの部分で構成されます。

インストールコマンドラインオプション

以下の表は、--set フラグを使用して、helm install コマンドに供給できるすべての可能なチャート設定です：

チャート構成例

エクストラエンバイロメント

extraEnv を使うと、 dependencies コンテナで追加の環境変数を公開することができます。

以下はextraEnvの使用例です：

extraEnv:
  SOME_KEY: some_value
  SOME_OTHER_KEY: some_other_value

コンテナが起動したら、環境変数が公開されていることを確認できます：

env | grep SOME
SOME_KEY=some_value
SOME_OTHER_KEY=some_other_value

エクストラボリューム

extraVolumes により、Chart 全体で追加ボリュームを設定できます。

以下はextraVolumesの使用例です：

extraVolumes: |
  - name: example-volume
    persistentVolumeClaim:
      claimName: example-pvc

エクストラボリュームマウント

extraVolumeMounts を使用すると、Chart 全体ですべてのコンテナに追加の VolumeMount を設定できます。

以下はextraVolumeMountsの使用例です：

extraVolumeMounts: |
  - name: example-volume-mount
    mountPath: /etc/example

画像.pullSecrets

pullSecrets を使うと、非公開レジストリで認証してポッドのイメージを取り出せるようになります。

非公開レジストリとその認証方法についての詳細は、Kubernetesのドキュメントに記載されています。

以下はpullSecretsの使用例です：

image:
  repository: my.sidekiq.repository
  pullPolicy: Always
  pullSecrets:
  - name: my-secret-name
  - name: my-secondary-secret-name

こうわん

tolerations 汚染されたワーカーノードでポッドのスケジューリングが可能

以下はtolerationsの使用例です：

tolerations:
- key: "node_label"
  operator: "Equal"
  value: "true"
  effect: "NoSchedule"
- key: "node_label"
  operator: "Equal"
  value: "true"
  effect: "NoExecute"

コンメンタール

annotations を使用すると、Sidekiqポッドに注釈を追加できます。

以下はannotationsの使用例です：

annotations:
  kubernetes.io/example-annotation: annotation-value

このChartのコミュニティ版を使って

デフォルトでは、HelmチャートはGitLabのEnterprise Editionを使用します。 必要であれば、代わりにCommunity Editionを使用することもできます。両者の違いについてはこちらをご覧ください。

コミュニティ版を使用するには、image.repository をregistry.gitlab.com/gitlab-org/build/cng/gitlab-sidekiq-ceに設定します。

外部サービス

このチャートは、Webserviceチャートと同じRedis、PostgreSQL、Gitalyインスタンスにアタッチする必要があります。 外部サービスの値は、すべてのSidekiqポッドで共有されるConfigMap。

Redis

redis:
  host: rank-racoon-redis
  port: 6379
  sentinels:
    - host: sentinel1.example.com
      port: 26379
  password:
    secret: gitlab-redis
    key: redis-password

_注意:_現在のRedis Sentinelサポートは、GitLabチャートとは別にデプロイされたSentinelのみをサポートしています。 そのため、GitLabチャートを介したRedisのデプロイは、redis.install=false。 Redisのパスワードを含むシークレットは、GitLabチャートをデプロイする前に手動で作成する必要があります。

PostgreSQL

psql:
  host: rank-racoon-psql
  serviceName: pgbouncer
  port: 5432
  database: gitlabhq_production
  username: gitlab
  preparedStatements: false
  password:
    secret: gitlab-postgres
    key: psql-password

Gitaly

gitaly:
  internal:
    names:
      - default
      - default2
  external:
    - name: node1
      hostname: node1.example.com
      port: 8079
  authToken:
    secret: gitaly-secret
    key: token

メトリクス

デフォルトでは、Prometheusメトリクスエクスポーターがポッドごとに有効になっています。 メトリクスは、管理エリアでGitLab Prometheusメトリクスが有効になっている場合にのみ利用可能です。 エクスポーターは、ポート3807の/metrics エンドポイントを公開します。 メトリクスが有効になっている場合、Prometheusサーバーが公開されたメトリクスを検出してスクレイピングできるように、各ポッドにアノテーションが追加されます。

チャート全体の既定値

以下の値は、ポッド単位で表示されないイベントにおいて、チャート全体で使用されます。

ポッドごとの設定

pods 宣言は、ワーカーポッドのすべての属性の宣言を提供します。これらは、Deployments にテンプレート化され、Sidekiq インスタンスには個別のConfigMaps があります。

キュー

queues の値は、処理されるキューのコンマ区切りのリストを含む文字列です。 デフォルトでは、これは設定されておらず、すべてのキューが処理されることを意味します。

文字列にはスペースを含んではいけません。merge,post_receive,process_commit は機能しますが、merge, post_receive, process_commit は機能しません。

ジョブが追加されたものの、少なくとも一つのポッドアイテムの一部として表現されていないキューは処理されません。 すべてのキューの完全なリストについては、GitLabソースのこれらのファイルを参照してください：

1. app/workers/all_queues.yml
2. ee/app/workers/all_queues.yml

ネゲートキュー

negateQueues はqueuesと同じ形式ですが、処理されるのではなく、無視されるキューを表します。

文字列にはスペースを含んではいけません。merge,post_receive,process_commit は機能しますが、merge, post_receive, process_commit は機能しません。

これは、重要なキューを処理するポッドと、それ以外のキューを処理する別のポッドがある場合に便利です。これらのポッドは、同じキューのリストを使用し、一方をqueues に、もう一方をnegateQueuesに置くことができます。

クラスター

cluster は、Sidekiqプロセスを開始するためにSidekiq Clusterを使用することを示します。 ブーリアン以外が指定された場合、その値は無視されます。

現在のデフォルトはtrueです。

Sidekiq Clusterを使用する場合、queues (またはnegateQueues)は文字列でなければなりません。Sidekiq Clusterを使用しない場合、文字列の配列でなければなりません。後者のオプションはGitLab 14.0からはサポートされません。

pod 記入例

pods:
  - name: immediate
    concurrency: 10
    minReplicas: 2  # defaults to inherited value
    maxReplicas: 10 # defaults to inherited value
    maxUnavailable: 5 # defaults to inherited value
    queues:
    - [post_receive, 5]
    - [merge, 5]
    - [update_merge_requests, 3]
    - [process_commit, 3]
    - [new_note, 2]
    - [new_issue, 2]
    extraVolumeMounts: |
      - name: example-volume-mount
        mountPath: /etc/example
    extraVolumes: |
      - name: example-volume
        persistentVolumeClaim:
          claimName: example-pvc
    resources:
      limits:
        cpu: 800m
        memory: 2Gi
    hpa:
      targetAverageValue: 350m

を設定します。networkpolicy

このセクションはNetworkPolicyを制御します。 この設定はオプションで、ポッドの Egress および Ingress を特定のエンドポイントに制限するために使用します。

ネットワークポリシー例

Sidekiqサービスは、有効な場合はPrometheus exporterのみにIngress接続を必要とし、通常は様々な場所にEgress接続を必要とします。 この例では、以下のネットワークポリシーを追加します：

• TCP10.0.0.0/8 ポート 3807 のネットワークからのすべての Ingress 要求は、メトリクスのエクスポー トで許可されます。
• UDP10.0.0.0/8 ポート53のネットワークへのすべてのEgressリクエストは、DNSのために許可されています。
• TCP10.0.0.0/8 ポート 5432 のネットワークへのすべての Egress リクエストは PostgreSQL に対して許可されます。
• TCP10.0.0.0/8 ポート 6379 のネットワークへのすべての Egress リクエストは、Redis に対して許可されています。
• 10.0.0.0/8 、内部ネットワークへのその他のEgressリクエストは制限されています。
• 10.0.0.0/8 、内部からの退出要求が許可されます。

例題はあくまで一例であり、完全なものではありません。

Sidekiqサービスでは、外部オブジェクトストレージ上の画像を公開インターネットに接続する必要があります。

networkpolicy:
  enabled: true
  ingress:
    enabled: true
    rules:
      - from:
        - ipBlock:
            cidr: 10.0.0.0/8
        ports:
        - port: 3807
  egress:
    enabled: true
    rules:
      - to:
        - ipBlock:
            cidr: 10.0.0.0/8
        ports:
        - port: 53
          protocol: UDP
      - to:
        - ipBlock:
            cidr: 10.0.0.0/8
        ports:
        - port: 5432
          protocol: TCP
      - to:
        - ipBlock:
            cidr: 10.0.0.0/8
        ports:
        - port: 6379
          protocol: TCP
      - to:
        - ipBlock:
            cidr: 0.0.0.0/0
            except:
            - 10.0.0.0/8