設定変更
複数のサービスには、カスタマイズ可能な設定が含まれています。以下に、各サービスで利用可能な構成値を示します。
構成を更新する方法
構成値は、helm chartのデプロイ時に --set configuration.<Configuration Key>=<Configuration value> を使用してhelm chartの値を設定することで変更できます。
たとえば、ASPNETCORE_SHUTDOWNTIMEOUTSECONDS の値を90秒に設定し、RATELIMITING__MaxMessageCount の値を300メッセージに設定する場合、helmコマンドは次のようになります -
helm upgrade --install cdrplatform-sync-api cdrplatform-sync-api \
--set configuration.ASPNETCORE_SHUTDOWNTIMEOUTSECONDS=90 \
--set configuration.RATELIMITING__MaxMessageCount=300
APIアクセス
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Web Host がシャットダウンするまで待機する時間を指定します。 | 任意の有効な整数 |
| AuthenticationScheme | API Access の認証スキーム。 | None、Bearer、Basic |
| Authentication__Schemes__Bearer__ValidAudiences__0 | AuthenticationScheme が Bearer に設定されている場合の API Access の有効な audience | 任意の有効な文字列（例: api://cdrplatform-api-access） |
| Authentication__Schemes__Bearer__ValidIssuer | AuthenticationScheme が Bearer に設定されている場合の有効な Issuer | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | AuthenticationScheme が Bearer に設定されている場合の API Access の Authority | https://login.microsoftonline.com/\<tenant-id>/v2.0/ |
| CLIENTS__Policy__BaseAddress | プロキシが policy Management API リクエストを送信する先のベース URL | http://policy-api:8080 |
| CLIENTS__License__BaseAddress | プロキシが License Management API リクエストを送信する先のベース URL | http://license-management.license-management.svc.cluster.local:8080 |
| CLIENTS__SyncApi__BaseAddress | プロキシが Sync API リクエストを送信する先のベース URL | http://api:8080 |
| CLIENTS__AsyncApi__BaseAddress | プロキシが Async API リクエストを送信する先のベース URL | http://async-api:8080 |
| CLIENTS__IcapProfile__BaseAddress | ICAP Profile Management リクエストをプロキシする先のベース URL | http://policy-api:8080 |
Sync API
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Web Host がシャットダウンするまで待機する時間を指定します。 | 任意の有効な整数 |
| RATELIMITING__MaxMessageCount | レート制限が有効になる前にリクエストキューで許可されるメッセージの最大数 | 任意の有効な整数 |
| ARCHIVE__MaxLevel | 処理されるネストされたアーカイブの最大階層数 詳細情報 | 正の整数 |
| ARCHIVE__MaxFileCount | 失敗する前にアーカイブ内で許可される最大ファイル数 詳細情報 | 正の整数 |
| ARCHIVE__MaxArchiveCount | 失敗する前にアーカイブ内で許可される最大ネストアーカイブ数 詳細情報 | 正の整数 |
| ARCHIVE__MaxUnpackedSizeBytes | 失敗する前にアーカイブから展開されたファイルに許可される最大サイズ 詳細情報 | 正の整数（バイト単位） |
Engine
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | Host がシャットダウンするまで待機する時間を指定します。 | 任意の有効な整数 |
| QUEUE__RetryLimit | Async リクエストを再試行する回数を指定します | 任意の有効な整数 |
| ReversingLabs__Endpoint | ReversingLabs File Reputation API のエンドポイント。 | https://data.reversinglabs.com/api/databrowser/malware_presence/query |
| ReversingLabs__Timeout | ReversingLabs File Reputation API への接続時に使用される秒単位のタイムアウト （デフォルトは100秒）。 | 任意の有効な整数 |
ポータルアクセス
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| AuthenticationScheme | Portal Access API の認証スキーム | なし、Bearer |
| Authentication__Schemes__Bearer__ValidAudiences__0 | Portal Access API の有効な audience。cdrplatform-portal-access アプリ登録の Application (client) ID に設定します。 | 任意の有効な文字列 |
| Authentication__Schemes__Bearer__ValidIssuer | Portal Access API の有効な issuer | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | Portal Access API の Authority | https://login.microsoftonline.com/\<tenant-id>/v2.0/ |
| REBUILD__RequireAuthenticatedUser | ユーザーが再構築リクエストを実行するために認証されている必要があるかどうかを決定します。デフォルトは false です。 | true/false |
Portal
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| BackendUrl | CDR Platform API のドメイン | https://<domain-name> (A valid string) |
| OIDC.ProviderOptions.Authority | Portal サービスの Authority | https://login.microsoftonline.com/\<tenant-id>/v2.0 |
| OIDC.ProviderOptions.ClientId | Portal App registration (cdrplatform-portal-client) の Client ID | 有効な文字列 |
| OIDC.ProviderOptions.RedirectUri | SSO ログイン後のリダイレクト URI | https://\<domain-name>/authentication/login-callback |
| OIDC.ProviderOptions.PostLogoutRedirectUri | ログアウト後のリダイレクト URI | https://\<domain-name>/authentication/logout-callback |
| REBUILD.RequireAuthenticatedUser | ユーザーが "Clean a file" ページにアクセスするために認証が必要かどうかを決定します。デフォルトは false です。 | true/false |
ライセンス管理
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Web Host がシャットダウンするまで待機する時間を指定します。 | 任意の有効な整数 |
| DATABASE__Provider | キャッシュ用途で使用されるデータベースプロバイダー | Mongo / Cosmos |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
クリーンアップ
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | Host がシャットダウンするまで待機する時間を指定します。 | 任意の有効な整数 |
| CleanupAmount | cron ジョブごとにクリーンアップするファイル数を指定します。これは --set cron.CleanupAmount=5000 で設定できます | 任意の有効な整数 |
| maxAge | ストレージ内に保持するファイルの最大保持期間を指定します。これは --set cron.maxAge=01.00:00:00 で設定できます | 有効な任意の Timespan |
| schedule | クリーンアップ cron ジョブを実行する cron スケジュールを指定します。これは --set cron.schedule=0 */1 * * * で設定できます | 有効な任意の cron スケジュール式 |
ICAP
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Host がシャットダウンするまで待機する時間を指定します。 | 任意の有効な整数 |
| ICAP__ServiceHeader | ICAP ヘッダーに挿入される識別子。 | 任意の有効な文字列。デフォルトは 'Glasswall ICAP Server 1.0"' |
| ICAP__OptionsTTL | サーバーから送信される ICAP options 応答が icap client に対して有効である秒単位の時間。 | icap client がサポートする任意の有効な整数 |
| ICAP__IdleTimeout | デフォルトは無制限です。サーバーが接続を終了するまでに、クライアントがどれくらいの時間内に処理を完了しなければならないかを示す期限を設定します | 有効な timespan（例: 00:00:30） |
| CACHE__MaxSizeInMb | ICAP server が再構築されたファイルのために cache 内に保存するデータ量（メガバイト単位） | デフォルトは 1Gb "1000" |
| DATABASE__Provider | キャッシュ用途で使用されるデータベースプロバイダー | Mongo / Cosmos |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
| CERTIFICATE__VerificationFlags | ICAP server における証明書チェーン検証をカスタマイズするために使用されるフラグです。検証フラグの説明については、X509VerificationFlags を参照してください。 | enum 範囲内の有効な整数 |
| PROFILE__UseFallback | Policy API に接続できない場合に fallback profile を使用するかどうかを示すブールフラグです。 | fallback profile を有効にするには 'true'、無効にするには 'false' を指定します。デフォルトでは 'false' です |
Async API
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Web Host がシャットダウンするまで待機する時間を指定します。 | 任意の有効な整数 |
| ARCHIVE__MaxLevel | 処理されるネストされたアーカイブの最大階層数 詳細情報 | 正の整数 |
| ARCHIVE__MaxFileCount | 失敗する前にアーカイブ内で許可される最大ファイル数 詳細情報 | 正の整数 |
| ARCHIVE__MaxArchiveCount | 失敗する前にアーカイブ内で許可される最大ネストアーカイブ数 詳細情報 | 正の整数 |
| ARCHIVE__MaxUnpackedSizeBytes | 失敗する前にアーカイブから展開されたファイルに許可される最大サイズ 詳細情報 | 正の整数（バイト単位） |
| DATABASE__Provider | Async Requests を保存する際に使用する Database provider を指定します | Mongo、Cosmos（デフォルトは Mongo） |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
| QUEUE__MessageDelayInMs | ASYNC リクエストの結果がクリーンアップされるまでの時間（ミリ秒）です。これは Cleanup service の maxAge Timespan より短く設定する必要があります。 | 任意の有効な正の整数。最大値は (2^32)-1 milliseconds で、50日弱です。 |
Tally Accumulator
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| DATABASE__Provider | Async Requests を保存する際に使用する Database provider を指定します | Mongo、Cosmos（デフォルトは Mongo） |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
Policy API
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| DATABASE__Provider | Async Requests を保存する際に使用する Database provider を指定します | Mongo、Cosmos（デフォルトは Mongo） |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
Metrics Collation（非推奨）
Halo バージョン 2.6.2 以降、Metrics Collation service は不要になりました。
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| DATABASE__Provider | Async Requests を保存する際に使用する Database provider を指定します | Mongo、Cosmos（デフォルトは Mongo） |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
Metrics Projection
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| DATABASE__Provider | Async Requests を保存する際に使用する Database provider を指定します | Mongo、Cosmos（デフォルトは Mongo） |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
Storage Monitor
| 構成キー | 説明 | 有効な値 |
|---|---|---|
| DATABASE__Provider | monitor data を保存する際に使用する Database provider を指定します | Mongo、Cosmos（デフォルトは Mongo） |
| DATABASE__DatabaseName | Mongo / Cosmos で作成されるデータベースの名前 | プロバイダーに応じた有効な文字列 |
| DATABASE__ConnectionString | Mongo または Cosmos データベースへの接続文字列 | 設定されたプロバイダー用の有効な接続文字列 |
| GRAPHAPI__ClientId | Microsoft Graph API 認証用の Client ID | 有効な GUID |
| GRAPHAPI__ClientSecret | Microsoft Graph API 認証用のクライアント シークレット | 有効なシークレット文字列 |
| GRAPHAPI__TenantId | Microsoft Graph API 認証用のテナント ID | 有効な GUID |
| GRAPHAPI__MonitorValidationDelay | Graph API モニター サブスクリプションを検証する前の遅延 | 有効な timespan（既定値: 00:00:30） |
| GRAPHAPI__SubscriptionDuration | 自動更新前の Graph API サブスクリプションの期間 | 有効な timespan（既定値: 2.00:00:00） |
| GRAPHAPI__TenantName | Graph API で使用される Azure テナントの名前 | 有効なテナント名（例: Glasswall） |
| CLIENTS__SyncApi__Timeout | Sync API の呼び出しのタイムアウト | 有効な期間（デフォルトは 00:03:00） |
| ENABLE_OUTLOOK_BANNER | Outlook バナー機能を有効または無効にします | true、false（デフォルトは false） |
| EXCHANGEONLINE__AppId | Exchange Online 認証用のアプリケーション ID | 有効な GUID - ENABLE_OUTLOOK_BANNER が true に設定されている場合は必須 |
| EXCHANGEONLINE__Organization | Exchange Online 組織ドメイン | 有効な .onmicrosoft.com ドメイン - ENABLE_OUTLOOK_BANNER が true に設定されている場合は必須 |
| EXCHANGEONLINE__DistributionGroupName | Exchange Online で作成される配布グループに付けられる名前 | 有効な文字列（デフォルトは GWStorageMonitoringUsers） |
| EXCHANGEONLINE__TransportRuleName | 配布グループ内のユーザーにバナーを適用するメール フロー ルールに付けられる名前 | 有効な文字列（デフォルトは Glasswall Attachment Processing Notice） |
| EXCHANGEONLINE__DistributionListSyncHaloUri | モニターを取得するための Storage Monitor の API のベース URI | 有効な URI（デフォルトは http://localhost:8080 - Storage Monitor のデフォルト HTTP ポート） |
| EXCHANGEONLINE__DistributionListSyncCronSchedule | Monitor/Banner 同期ジョブを実行するスケジュール | 有効な cron 式（デフォルトは 0 */3 * * * または At the beginning of every 3rd hour） |
| MONITORING__BlockUnprocessedAttachments | 未処理の Outlook 内のメール添付ファイルをブロックするかどうか | true、false（デフォルトは true） |
| MONITORING__ProcessUnsupportedExtensions | サポートされていないファイル拡張子を持つファイルを処理のために Sync API に送信するかどうかを指定します | true、false |
| MONITORING__HealthcheckCronSchedule | ヘルスチェックを実行するための cron スケジュール | 有効な cron 式（デフォルトは 0 */3 * * * または At the beginning of every 3rd hour） |
| MONITORING__MaxDegreeOfParallelism | 並列モニタリング操作の最大数 | 正の整数（デフォルトは 5） |
| MONITORING__MonitorLastSeenThreshold | モニターが非アクティブと見なされるまでのしきい値期間 | 有効な時間範囲（デフォルトは 03:00:00） |