Toolbox

Toolboxポッドは、GitLabアプリケーション内で定期的なハウスキーピングタスクを実行するために使用されます。これらのタスクには、バックアップ、Sidekiqのメンテナンス、Rakeタスクが含まれます。

設定

以下の設定は、Toolboxチャートによって提供されるデフォルトの設定です:

gitlab:
  ## doc/charts/gitlab/toolbox
  toolbox:
    enabled: true
    replicas: 1
    backups:
      cron:
        enabled: false
        concurrencyPolicy: Replace
        failedJobsHistoryLimit: 1
        schedule: "0 1 * * *"
        successfulJobsHistoryLimit: 3
        suspend: false
        backoffLimit: 6
        safeToEvict: false
        restartPolicy: "OnFailure"
        resources:
          requests:
            cpu: 50m
            memory: 350M
        persistence:
          enabled: false
          accessMode: ReadWriteOnce
          useGenericEphemeralVolume: false
          size: 10Gi
      objectStorage:
        backend: s3
        config: {}
    persistence:
      enabled: false
      accessMode: 'ReadWriteOnce'
      size: '10Gi'
    resources:
      requests:
        cpu: '50m'
        memory: '350M'
    securityContext:
      fsGroup: '1000'
      runAsUser: '1000'
      runAsGroup: '1000'
    containerSecurityContext:
      runAsUser: '1000'
    affinity: {}

バックアップの設定

バックアップと復元のドキュメントでのバックアップの設定に関する情報。バックアップの実行方法の技術的な実装に関する追加情報は、バックアップと復元のアーキテクチャドキュメントにあります。

永続設定

バックアップと復元用の永続ストアは個別に設定されます。GitLabをバックアップおよび復元操作用に設定する場合は、次の考慮事項を確認してください。

バックアップはbackups.cron.persistence.*プロパティを使用し、復元はpersistence.*プロパティを使用します。永続ストアの設定に関する詳細な説明では、最後のプロパティキー（例: .enabledまたは.size）のみを使用し、適切なプレフィックスを追加する必要があります。

永続ストアはデフォルトで無効になっているため、適切なサイズのバックアップまたは復元を行うには、.enabledをtrueに設定する必要があります。さらに、KubernetesによってPersistentVolumeを作成するには.storageClassを指定するか、PersistentVolumeを手動で作成する必要があります。.storageClassが「-」として指定されている場合、PersistentVolumeは、Kubernetesクラスタで指定されているデフォルトのStorageClassを使用して作成されます。

PersistentVolumeを手動で作成する場合、ボリュームは.volumeNameプロパティを使用するか、セレクター.matchLables / .matchExpressionsプロパティを使用して指定できます。

ほとんどの場合、.accessModeのデフォルト値は、ToolboxのみがPersistentVolumeにアクセスするための適切な制御を提供します。設定が正しいことを確認するには、KubernetesクラスタにインストールされているCSIドライバーのドキュメントを参照してください。

バックアップの考慮事項

バックアップ操作では、バックアップオブジェクトストアに書き込まれる前に、バックアップされる個々のコンポーネントを保持するためのディスク容量が必要です。ディスク容量は、次の要因によって異なります:

• プロジェクトの数と各プロジェクトに保存されているデータの量
• PostgresSQLデータベースのサイズ（イシュー、MRなど）
• 各オブジェクトストアバックエンドのサイズ

おおよそのサイズが決定されると、backups.cron.persistence.sizeプロパティを設定して、バックアップを開始できます。

リストアの考慮事項

バックアップの復元中、実行中のインスタンスでファイルを置き換える前に、バックアップをディスクに抽出する必要があります。この復元ディスク領域のサイズは、persistence.sizeプロパティによって制御されます。GitLabインストールのサイズが大きくなるにつれて、復元ディスク領域のサイズもそれに応じて大きくする必要があることに注意してください。ほとんどの場合、復元ディスク領域のサイズは、バックアップディスク領域と同じサイズである必要があります。

Toolboxに含まれるツール

Toolboxコンテナには、Railsコンソール、Rakeタスクなど、役立つGitLabツールが含まれています。これらのコマンドを使用すると、データベース移行のステータスを確認したり、管理タスクのRakeタスクを実行したり、Railsコンソールと対話したりできます:

# locate the Toolbox pod
kubectl get pods -lapp=toolbox

# Launch a shell inside the pod
kubectl exec -it <Toolbox pod name> -- bash

# open Rails console
gitlab-rails console -e production

# execute a Rake task
gitlab-rake gitlab:env:info

affinity

詳細については、affinityを参照してください。