구성 변경
여러 서비스에는 사용자 지정이 가능한 구성 설정이 포함되어 있습니다. 아래에는 각 서비스에 대해 사용할 수 있는 구성 값이 나와 있습니다.
구성을 업데이트하는 방법
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에 대한 유효한 대상입니다. | 유효한 모든 문자열 (예: api://cdrplatform-api-access) |
| Authentication__Schemes__Bearer__ValidIssuer | AuthenticationScheme이 Bearer로 설정된 경우의 유효한 발급자입니다. | 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 | 사용자가 rebuild 요청을 수행하기 위해 인증되어야 하는지 여부를 결정합니다. 기본값은 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 등록의 Client ID (cdrplatform-portal-client) | 유효한 문자열 |
| 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 job당 정리할 파일 수를 지정합니다. 이는 --set cron.CleanupAmount=5000을 통해 설정할 수 있습니다. | 유효한 모든 정수 |
| maxAge | 스토리지에 유지할 파일의 최대 보관 기간을 지정합니다. 이는 --set cron.maxAge=01.00:00:00을 통해 설정할 수 있습니다. | 유효한 모든 Timespan |
| schedule | 정리 cron job이 실행될 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 | 기본값은 무한대입니다. 서버가 연결을 종료하기 전에 클라이언트가 응답해야 하는 제한 시간을 설정합니다. | 유효한 시간 범위(예: 00:00:30) |
| CACHE__MaxSizeInMb | ICAP 서버가 재구성된 파일을 위해 캐시에 저장할 데이터의 양(MB)입니다. | 기본값은 1Gb "1000"입니다. |
| DATABASE__Provider | 캐싱 목적으로 사용되는 데이터베이스 공급자 | Mongo / Cosmos |
| DATABASE__DatabaseName | Mongo / Cosmos에서 생성될 데이터베이스의 이름 | 공급자에 따라 달라지는 유효한 문자열 |
| DATABASE__ConnectionString | Mongo 또는 Cosmos 데이터베이스에 대한 연결 문자열 | 구성된 공급자에 대한 유효한 연결 문자열 |
| CERTIFICATE__VerificationFlags | ICAP 서버에서 인증서 체인 검증을 사용자 지정하는 데 사용되는 플래그입니다. 검증 플래그에 대한 설명은 X509VerificationFlags를 참조하세요. | enum 범위 내의 유효한 정수 값 |
| PROFILE__UseFallback | Policy API에 연결할 수 없을 때 대체 profile을 사용할지 여부를 나타내는 부울 플래그입니다. | 대체 profile을 활성화하려면 'true', 비활성화하려면 'false'입니다. 기본값은 'false'입니다. |
비동기 API
| 구성 키 | 설명 | 유효한 값 |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Web Host가 종료될 때까지 대기하는 시간을 지정합니다. | 유효한 모든 정수 |
| ARCHIVE__MaxLevel | 처리될 중첩 아카이브의 최대 계층 수 자세히 보기 | 양의 정수 |
| ARCHIVE__MaxFileCount | 실패하기 전에 아카이브에서 허용되는 최대 파일 수 자세한 정보 | 양의 정수 |
| ARCHIVE__MaxArchiveCount | 실패하기 전에 아카이브에서 허용되는 최대 중첩 아카이브 수 자세한 정보 | 양의 정수 |
| ARCHIVE__MaxUnpackedSizeBytes | 실패하기 전에 아카이브에서 압축 해제된 파일에 허용되는 최대 크기 자세한 정보 | 양의 정수(바이트 단위) |
| DATABASE__Provider | 비동기 요청을 저장할 때 사용할 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 | 비동기 요청을 저장할 때 사용할 Database provider를 지정합니다 | Mongo, Cosmos (기본값은 Mongo) |
| DATABASE__DatabaseName | Mongo / Cosmos에서 생성될 데이터베이스의 이름 | 공급자에 따라 달라지는 유효한 문자열 |
| DATABASE__ConnectionString | Mongo 또는 Cosmos 데이터베이스에 대한 연결 문자열 | 구성된 공급자에 대한 유효한 연결 문자열 |
policy API
| 구성 키 | 설명 | 유효한 값 |
|---|---|---|
| DATABASE__Provider | 비동기 요청을 저장할 때 사용할 Database provider를 지정합니다 | Mongo, Cosmos (기본값은 Mongo) |
| DATABASE__DatabaseName | Mongo / Cosmos에서 생성될 데이터베이스의 이름 | 공급자에 따라 달라지는 유효한 문자열 |
| DATABASE__ConnectionString | Mongo 또는 Cosmos 데이터베이스에 대한 연결 문자열 | 구성된 공급자에 대한 유효한 연결 문자열 |
메트릭 집계(사용 중단됨)
Halo 버전 2.6.2부터는 Metrics Collation service가 더 이상 필요하지 않습니다. 2.6.2
| 구성 키 | 설명 | 유효한 값 |
|---|---|---|
| DATABASE__Provider | 비동기 요청을 저장할 때 사용할 Database provider를 지정합니다 | Mongo, Cosmos (기본값은 Mongo) |
| DATABASE__DatabaseName | Mongo / Cosmos에서 생성될 데이터베이스의 이름 | 공급자에 따라 달라지는 유효한 문자열 |
| DATABASE__ConnectionString | Mongo 또는 Cosmos 데이터베이스에 대한 연결 문자열 | 구성된 공급자에 대한 유효한 연결 문자열 |
메트릭 프로젝션
| 구성 키 | 설명 | 유효한 값 |
|---|---|---|
| DATABASE__Provider | 비동기 요청을 저장할 때 사용할 Database provider를 지정합니다 | Mongo, Cosmos (기본값은 Mongo) |
| DATABASE__DatabaseName | Mongo / Cosmos에서 생성될 데이터베이스의 이름 | 공급자에 따라 달라지는 유효한 문자열 |
| DATABASE__ConnectionString | Mongo 또는 Cosmos 데이터베이스에 대한 연결 문자열 | 구성된 공급자에 대한 유효한 연결 문자열 |
스토리지 모니터
| 구성 키 | 설명 | 유효한 값 |
|---|---|---|
| DATABASE__Provider | 모니터 데이터를 저장할 때 사용할 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 모니터 구독을 검증하기 전 지연 시간 | 유효한 시간 범위(기본값: 00:00:30) |
| GRAPHAPI__SubscriptionDuration | 자동 갱신 전 Graph API 구독의 지속 시간 | 유효한 시간 범위(기본값: 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) |