GitLabサイレントモード

サイレントモードでは、GitLabからの送信通信（メールなど）を停止できます。サイレントモードは、使用中の環境での使用を目的としていません。

サイレントモードの使用場面

サイレントモードは特定のテストおよび検証シナリオ向けに設計されており、本番環境向けの汎用機能として使用しないでください。

サイレントモードは、以下のシナリオ向けに設計されています:

• Geoサイトのプロモートのテスト: Geoサイトのセカンダリサイトをプロモートしてディザスターリカバリー手順を検証する際に、プライマリサイトがアクティブなままである場合。
  • たとえば、ディザスターリカバリーソリューションの一部として、セカンダリGeoサイトがあるとします。ディザスターリカバリー計画が実際に機能することを保証するためのベストプラクティスとして、それをプロモートしてプライマリGeoサイトにすることを定期的にテストしたいとします。ただし、プライマリサイトが、ユーザーへのレイテンシーが最も低い地域にあるため、フェイルオーバー全体を実際には実行したくありません。また、定期的なテストのたびにダウンタイムを発生させたくありません。そのため、プライマリサイトを起動したまま、セカンダリサイトをプロモートします。プロモートされたサイトのスモークテストを開始します。しかし、プロモートされたサイトがユーザーにメールを送信し始め、プッシュミラーが外部のGitリポジトリへの変更をプッシュするなどが発生します。ここでサイレントモードが登場します。サイトのプロモートの一部として有効にすることで、この問題を回避できます。
• GitLabのバックアップの検証: バックアップが機能していることを確認するために、別のテストインスタンスでバックアップの復元をテストする場合。サイレントモードを使用すると、無効なメールをユーザーに送信することを回避できます。
• ステージング環境のテスト: ユーザーまたは外部システムに影響を与える可能性のある送信通信をトリガーせずに、GitLabの機能をテストする必要がある場合。特に、本番データを使用してステージング環境をシードした場合。

サイレントモードは、以下のような目的には設計されていません:

• 本番環境: サイレントモードは意図的に多くのGitLab機能を中断します。サイレントモードは、予期しないエラーを引き起こす可能性があり、特に新機能で発生しやすくなります。サイレントモードでは、デフォルトで新しい通信をブロックすることで、安全側に倒す必要があります。

サイレントモードをオンにする

前提要件:

• 管理者アクセス権が必要です。

サイレントモードをオンにする方法は複数あります:

• WEB UI

  1. 左側のサイドバーの下部で、管理者を選択します。
  2. 左側のサイドバーで、設定 > 一般を選択します。
  3. Silent Mode（サイレントモード）を展開し、Enable Silent Mode（サイレントモードを有効にする）切替をオンにします。
  4. 変更はすぐに保存されます。

• API:

  curl --request PUT --header "PRIVATE-TOKEN:$ADMIN_TOKEN" "<gitlab-url>/api/v4/application/settings?silent_mode_enabled=true"

• Rails console（Railsコンソール）:

  ::Gitlab::CurrentSettings.update!(silent_mode_enabled: true)

有効になるまでに最大1分かかる場合があります。イシュー405433は、この遅延を削除することを提案しています。

サイレントモードをオフにする

前提要件:

• 管理者アクセス権が必要です。

サイレントモードを無効にする方法は複数あります:

• WEB UI

  1. 左側のサイドバーの下部で、管理者を選択します。
  2. 左側のサイドバーで、設定 > 一般を選択します。
  3. Silent Mode（サイレントモード）を展開し、Enable Silent Mode（サイレントモードを有効にする）切替をオフにします。
  4. 変更はすぐに保存されます。

• API:

  curl --request PUT --header "PRIVATE-TOKEN:$ADMIN_TOKEN" "<gitlab-url>/api/v4/application/settings?silent_mode_enabled=false"

• Rails console（Railsコンソール）:

  ::Gitlab::CurrentSettings.update!(silent_mode_enabled: false)

有効になるまでに最大1分かかる場合があります。イシュー405433は、この遅延を削除することを提案しています。

サイレントモードでのGitLab機能の動作

このセクションでは、サイレントモードが有効になっている場合のGitLabの現在の動作について説明します。サイレントモードの最初のイテレーションの作業は、エピック9826で追跡されます。

サイレントモードが有効になっている場合、設定が有効になっていること、およびAll outbound communications are blocked（すべての送信通信がブロックされている）ことを示すバナーが、すべてのユーザーに対してページの上部に表示されます。

停止される送信通信

次の機能からの送信通信は、サイレントモードによって停止されます。

停止されない送信通信

次の機能からの送信通信は、サイレントモードによって停止されません。