外部Sidekiqインスタンスを設定する

GitLabパッケージにバンドルされているSidekiqを使用して、外部Sidekiqインスタンスを設定できます。Sidekiqは、Redis、PostgreSQL、およびGitalyインスタンスへの接続を必要とします。

GitLabインスタンス上のPostgreSQL、Gitaly、およびRedisのTCPアクセスを設定する

デフォルトでは、GitLabはUNIXソケットを使用しており、TCP経由での通信は設定されていません。これを変更するには:

1. Configure packaged PostgreSQL server to listen on TCP/IPし、SidekiqサーバーのIPアドレスをpostgresql['md5_auth_cidr_addresses']に追加します。

2. Make the bundled Redis reachable via TCP

3. GitLabインスタンス上の/etc/gitlab/gitlab.rbファイルを編集し、以下を追加します:

   ## Gitaly
   gitaly['configuration'] = {
      # ...
      #
      # Make Gitaly accept connections on all network interfaces
      listen_addr: '0.0.0.0:8075',
      auth: {
         ## Set up the Gitaly token as a form of authentication because you are accessing Gitaly over the network
         ## https://docs.gitlab.com/administration/gitaly/configure_gitaly/#about-the-gitaly-token
         token: 'abc123secret',
      },
   }
   
   gitlab_rails['gitaly_token'] = 'abc123secret'
   
   # Password to Authenticate Redis
   gitlab_rails['redis_password'] = 'redis-password-goes-here'

4. reconfigureを実行します。

   sudo gitlab-ctl reconfigure

5. PostgreSQLサーバーを再起動します:

   sudo gitlab-ctl restart postgresql

Sidekiqインスタンスを設定する

your reference architectureを見つけ、Sidekiqインスタンスの設定の詳細に従ってください。

共有ストレージを持つ複数のSidekiqノードを設定する

NFSなどの共有ファイルシステムを持つ複数のSidekiqノードを実行している場合、サーバー間でそれらが一致するようにUIDとGIDを指定する必要があります。UIDとGIDを指定することで、ファイルシステムにおける権限の問題を防ぎます。このアドバイスはadvice for Geo setupsと似ています。

複数のSidekiqノードを設定するには:

1. /etc/gitlab/gitlab.rbを編集します:

   user['uid'] = 9000
   user['gid'] = 9000
   web_server['uid'] = 9001
   web_server['gid'] = 9001
   registry['uid'] = 9002
   registry['gid'] = 9002

2. GitLabを再設定します:

   sudo gitlab-ctl reconfigure

外部Sidekiqを使用する際のコンテナレジストリを設定する

コンテナレジストリを使用しており、それがSidekiqとは異なるノードで実行されている場合は、以下の手順に従ってください。

1. /etc/gitlab/gitlab.rbを編集し、レジストリのURLを設定します:

   gitlab_rails['registry_api_url'] = "https://registry.example.com"

2. GitLabを再設定します:

   sudo gitlab-ctl reconfigure

3. コンテナレジストリがホストされているインスタンスで、registry.keyファイルをSidekiqノードにコピーします。

Sidekiqメトリクスサーバーを設定する

Sidekiqメトリクスを収集したい場合は、Sidekiqメトリクスサーバーを有効にします。localhost:8082/metricsからメトリクスを利用できるようにするには:

メトリクスサーバーを設定するには:

1. /etc/gitlab/gitlab.rbを編集します:

   sidekiq['metrics_enabled'] = true
   sidekiq['listen_address'] = "localhost"
   sidekiq['listen_port'] = 8082
   
   # Optionally log all the metrics server logs to log/sidekiq_exporter.log
   sidekiq['exporter_log_enabled'] = true

2. GitLabを再設定します:

   sudo gitlab-ctl reconfigure

HTTPSを有効にする

HTTPの代わりにHTTPS経由でメトリクスを提供するには、exporterの設定でTLSを有効にします:

1. /etc/gitlab/gitlab.rbを編集し、以下の行を追加（または見つけてコメントを解除）します:

   sidekiq['exporter_tls_enabled'] = true
   sidekiq['exporter_tls_cert_path'] = "/path/to/certificate.pem"
   sidekiq['exporter_tls_key_path'] = "/path/to/private-key.pem"

2. ファイルを保存して、GitLabを再設定し、変更を有効にします。

TLSが有効になっている場合、以前に説明したのと同じportとaddressが使用されます。メトリクスサーバーは、HTTPとHTTPSの両方を同時に提供することはできません。

ヘルスチェックを設定する

Sidekiqを監視するためにヘルスチェックプローブを使用する場合、Sidekiqヘルスチェックサーバーを有効にします。localhost:8092からヘルスチェックを利用できるようにするには:

1. /etc/gitlab/gitlab.rbを編集します:

   sidekiq['health_checks_enabled'] = true
   sidekiq['health_checks_listen_address'] = "localhost"
   sidekiq['health_checks_listen_port'] = 8092

2. GitLabを再設定します:

   sudo gitlab-ctl reconfigure

ヘルスチェックの詳細については、Sidekiq health check pageを参照してください。

LDAPおよびユーザーまたはグループの同期を設定する

ユーザーおよびグループ管理にLDAPを使用している場合、LDAPの設定とLDAP同期ワーカーをSidekiqノードに追加する必要があります。LDAPの設定とLDAP同期ワーカーがSidekiqノードに適用されていない場合、ユーザーとグループは自動的に同期されません。

GitLabのLDAPを設定する方法の詳細については、以下を参照してください:

• GitLab LDAP configuration documentation
• LDAP synchronization documentation

Sidekiqで同期ワーカーと共にLDAPを有効にするには:

1. /etc/gitlab/gitlab.rbを編集します:

   gitlab_rails['ldap_enabled'] = true
   gitlab_rails['prevent_ldap_sign_in'] = false
   gitlab_rails['ldap_servers'] = {
   'main' => {
   'label' => 'LDAP',
   'host' => 'ldap.mydomain.com',
   'port' => 389,
   'uid' => 'sAMAccountName',
   'encryption' => 'simple_tls',
   'verify_certificates' => true,
   'bind_dn' => '_the_full_dn_of_the_user_you_will_bind_with',
   'password' => '_the_password_of_the_bind_user',
   'tls_options' => {
      'ca_file' => '',
      'ssl_version' => '',
      'ciphers' => '',
      'cert' => '',
      'key' => ''
   },
   'timeout' => 10,
   'active_directory' => true,
   'allow_username_or_email_login' => false,
   'block_auto_created_users' => false,
   'base' => 'dc=example,dc=com',
   'user_filter' => '',
   'attributes' => {
      'username' => ['uid', 'userid', 'sAMAccountName'],
      'email' => ['mail', 'email', 'userPrincipalName'],
      'name' => 'cn',
      'first_name' => 'givenName',
      'last_name' => 'sn'
   },
   'lowercase_usernames' => false,
   
   # Enterprise Edition only
   # https://docs.gitlab.com/administration/auth/ldap/ldap_synchronization/
   'group_base' => '',
   'admin_group' => '',
   'external_groups' => [],
   'sync_ssh_keys' => false
   }
   }
   gitlab_rails['ldap_sync_worker_cron'] = "0 */12 * * *"

2. GitLabを再設定します:

   sudo gitlab-ctl reconfigure

SAMLグループ同期のためにSAMLグループを設定する

SAML Group Syncを使用する場合、すべてのSidekiqノードでSAML Groupsを設定する必要があります。

関連トピック

• Extra Sidekiq processes
• 特定のジョブクラスの処理
• Sidekiq health checks
• Using the GitLab-Sidekiq chart

トラブルシューティング

弊社のadministrator guide to troubleshooting Sidekiqを参照してください。