การเปลี่ยนแปลงการกำหนดค่า
หลายบริการมีการตั้งค่าที่กำหนดค่าได้และสามารถปรับแต่งได้ ด้านล่างนี้คือค่าการกำหนดค่าที่มีให้สำหรับแต่ละบริการ
วิธีอัปเดตการกำหนดค่า
สามารถเปลี่ยนค่าการกำหนดค่าได้โดยตั้งค่า helm chart values ระหว่างการ deploy helm chart โดยใช้ --set configuration.<Configuration Key>=<Configuration value>.
ตัวอย่างเช่น หากต้องการตั้งค่า 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 | None, Bearer, Basic |
| Authentication__Schemes__Bearer__ValidAudiences__0 | audience ที่ถูกต้องสำหรับการเข้าถึง API เมื่อ AuthenticationScheme ถูกตั้งค่าเป็น Bearer | สตริงที่ถูกต้องใดๆ (เช่น api://cdrplatform-api-access) |
| Authentication__Schemes__Bearer__ValidIssuer | Issuer ที่ถูกต้องเมื่อ AuthenticationScheme ถูกตั้งค่าเป็น Bearer | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | Authority สำหรับการเข้าถึง API เมื่อ AuthenticationScheme ถูกตั้งค่าเป็น Bearer | https://login.microsoftonline.com/\<tenant-id>/v2.0/ |
| CLIENTS__Policy__BaseAddress | URL พื้นฐานที่พร็อกซีใช้ส่งคำขอไปยัง Policy Management API | http://policy-api:8080 |
| CLIENTS__License__BaseAddress | URL พื้นฐานที่พร็อกซีใช้ส่งคำขอไปยัง License Management API | http://license-management.license-management.svc.cluster.local:8080 |
| CLIENTS__SyncApi__BaseAddress | URL พื้นฐานที่พร็อกซีใช้ส่งคำขอไปยัง Sync API | http://api:8080 |
| CLIENTS__AsyncApi__BaseAddress | URL พื้นฐานที่พร็อกซีใช้ส่งคำขอไปยัง Async API | http://async-api:8080 |
| CLIENTS__IcapProfile__BaseAddress | URL พื้นฐานสำหรับส่งพร็อกซีคำขอไปยังการจัดการ ICAP Profile | 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 | endpoint ของ ReversingLabs File Reputation API | https://data.reversinglabs.com/api/databrowser/malware_presence/query |
| ReversingLabs__Timeout | Timeout เป็นวินาทีที่ใช้เมื่อติดต่อกับ ReversingLabs File Reputation API (ค่าเริ่มต้นคือ 100 วินาที). | จำนวนเต็มที่ถูกต้องใดๆ |
การเข้าถึงพอร์ทัล
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| AuthenticationScheme | รูปแบบการยืนยันตัวตนสำหรับ Portal Access API | ไม่มี, Bearer |
| Authentication__Schemes__Bearer__ValidAudiences__0 | audience ที่ถูกต้องสำหรับ Portal Access API ตั้งค่าเป็น Application (client) ID ของการลงทะเบียนแอป cdrplatform-portal-access | สตริงที่ถูกต้องใดก็ได้ |
| Authentication__Schemes__Bearer__ValidIssuer | issuer ที่ถูกต้องสำหรับ Portal Access API | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | Authority สำหรับ Portal Access API | 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 | Authority สำหรับบริการ Portal | https://login.microsoftonline.com/\<tenant-id>/v2.0 |
| OIDC.ProviderOptions.ClientId | Client ID ของการลงทะเบียน Portal App (cdrplatform-portal-client) | สตริงที่ถูกต้อง |
| OIDC.ProviderOptions.RedirectUri | Redirect URI หลังจากการเข้าสู่ระบบ SSO | https://\<domain-name>/authentication/login-callback |
| OIDC.ProviderOptions.PostLogoutRedirectUri | Redirect URI หลังจาก Logout | 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 สำหรับการทำงานของ cleanup cron job โดยสามารถตั้งค่าได้ผ่าน --set cron.schedule=0 */1 * * * | นิพจน์ตารางเวลา cron ที่ถูกต้องใด ๆ |
ICAP
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | ระบุระยะเวลาที่จะรอให้ Host ปิดตัวลง | จำนวนเต็มที่ถูกต้องใดๆ |
| ICAP__ServiceHeader | ตัวระบุที่จะถูกแทรกลงในส่วนหัว ICAP | สตริงที่ถูกต้องใดๆ โดยค่าเริ่มต้นคือ 'Glasswall ICAP Server 1.0"' |
| ICAP__OptionsTTL | ระยะเวลาเป็นวินาทีที่การตอบกลับ options ของ ICAP ที่ส่งโดยเซิร์ฟเวอร์จะยังคงใช้ได้สำหรับ icap client | จำนวนเต็มที่ถูกต้องใดๆ ที่ icap client รองรับ |
| ICAP__IdleTimeout | ค่าเริ่มต้นคือไม่สิ้นสุด กำหนดเส้นตายว่าฝั่งไคลเอนต์ต้องใช้เวลานานเท่าใดก่อนที่เซิร์ฟเวอร์จะยุติการเชื่อมต่อ | ช่วงเวลาที่ถูกต้อง เช่น 00:00:30 |
| CACHE__MaxSizeInMb | ปริมาณข้อมูลเป็นเมกะไบต์ที่เซิร์ฟเวอร์ ICAP จะจัดเก็บไว้ในแคชสำหรับไฟล์ที่สร้างใหม่ | ค่าเริ่มต้นคือ 1Gb "1000" |
| DATABASE__Provider | ผู้ให้บริการฐานข้อมูลที่ใช้สำหรับการแคช | Mongo / Cosmos |
| DATABASE__DatabaseName | ชื่อของฐานข้อมูลที่จะถูกสร้างใน Mongo / Cosmos | สตริงที่ถูกต้องตามผู้ให้บริการ |
| DATABASE__ConnectionString | สตริงการเชื่อมต่อไปยังฐานข้อมูล Mongo หรือ Cosmos | สตริงการเชื่อมต่อที่ถูกต้องสำหรับผู้ให้บริการที่กำหนดค่าไว้ |
| CERTIFICATE__VerificationFlags | แฟล็กที่ใช้เพื่อปรับแต่งการตรวจสอบ certificate chain ในเซิร์ฟเวอร์ ICAP โปรดดู X509VerificationFlags สำหรับคำอธิบายเกี่ยวกับ verification flags | จำนวนเต็มที่ถูกต้องภายในช่วงของ enum |
| PROFILE__UseFallback | แฟล็กบูลีนที่ระบุว่าจะใช้ profile สำรองหรือไม่เมื่อไม่สามารถติดต่อ Policy API ได้ | 'true' เพื่อเปิดใช้ profile สำรอง หรือ 'false' เพื่อปิดใช้งาน โดยค่าเริ่มต้นคือนี่คือ 'false' |
Async API
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | ระบุระยะเวลาที่ต้องรอให้ Web Host ปิดการทำงาน | จำนวนเต็มที่ถูกต้องใดๆ |
| ARCHIVE__MaxLevel | จำนวนชั้นสูงสุดของไฟล์เก็บถาวรแบบซ้อนกันที่จะถูกประมวลผล ข้อมูลเพิ่มเติม | จำนวนเต็มบวก |
| ARCHIVE__MaxFileCount | จำนวนไฟล์สูงสุดที่อนุญาตในไฟล์เก็บถาวรก่อนที่จะล้มเหลว ข้อมูลเพิ่มเติม | จำนวนเต็มบวก |
| ARCHIVE__MaxArchiveCount | จำนวนไฟล์เก็บถาวรแบบซ้อนสูงสุดที่อนุญาตในไฟล์เก็บถาวรก่อนที่จะล้มเหลว ข้อมูลเพิ่มเติม | จำนวนเต็มบวก |
| ARCHIVE__MaxUnpackedSizeBytes | ขนาดสูงสุดที่อนุญาตของไฟล์ที่แตกออกจากไฟล์เก็บถาวรก่อนที่จะล้มเหลว ข้อมูลเพิ่มเติม | จำนวนเต็มบวก (เป็นไบต์) |
| DATABASE__Provider | ระบุว่าจะใช้ผู้ให้บริการ Database ใดเมื่อจัดเก็บ Async Requests | Mongo, Cosmos (ค่าเริ่มต้นคือ Mongo) |
| DATABASE__DatabaseName | ชื่อของฐานข้อมูลที่จะถูกสร้างใน Mongo / Cosmos | สตริงที่ถูกต้องตามผู้ให้บริการ |
| DATABASE__ConnectionString | สตริงการเชื่อมต่อไปยังฐานข้อมูล Mongo หรือ Cosmos | สตริงการเชื่อมต่อที่ถูกต้องสำหรับผู้ให้บริการที่กำหนดค่าไว้ |
| QUEUE__MessageDelayInMs | เวลาเป็นมิลลิวินาทีก่อนที่ผลลัพธ์ของคำขอ ASYNC จะถูกล้างออก ควรกำหนดค่านี้ให้ต่ำกว่า Timespan ของ maxAge สูงสุดของบริการ Cleanup | จำนวนเต็มบวกที่ถูกต้องใดก็ได้ ค่าสูงสุดคือ (2^32)-1 milliseconds ซึ่งน้อยกว่า 50 วันเล็กน้อย |
Tally Accumulator
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| DATABASE__Provider | ระบุว่าจะใช้ผู้ให้บริการ Database ใดเมื่อจัดเก็บ Async Requests | Mongo, Cosmos (ค่าเริ่มต้นคือ Mongo) |
| DATABASE__DatabaseName | ชื่อของฐานข้อมูลที่จะถูกสร้างใน Mongo / Cosmos | สตริงที่ถูกต้องตามผู้ให้บริการ |
| DATABASE__ConnectionString | สตริงการเชื่อมต่อไปยังฐานข้อมูล Mongo หรือ Cosmos | สตริงการเชื่อมต่อที่ถูกต้องสำหรับผู้ให้บริการที่กำหนดค่าไว้ |
Policy API
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| DATABASE__Provider | ระบุว่าจะใช้ผู้ให้บริการ Database ใดเมื่อจัดเก็บ Async Requests | Mongo, Cosmos (ค่าเริ่มต้นคือ Mongo) |
| DATABASE__DatabaseName | ชื่อของฐานข้อมูลที่จะถูกสร้างใน Mongo / Cosmos | สตริงที่ถูกต้องตามผู้ให้บริการ |
| DATABASE__ConnectionString | สตริงการเชื่อมต่อไปยังฐานข้อมูล Mongo หรือ Cosmos | สตริงการเชื่อมต่อที่ถูกต้องสำหรับผู้ให้บริการที่กำหนดค่าไว้ |
Metrics Collation (เลิกใช้แล้ว)
ตั้งแต่ Halo เวอร์ชัน 2.6.2 เป็นต้นไป ไม่จำเป็นต้องใช้บริการ Metrics Collation อีกต่อไป
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| DATABASE__Provider | ระบุว่าจะใช้ผู้ให้บริการ Database ใดเมื่อจัดเก็บ Async Requests | Mongo, Cosmos (ค่าเริ่มต้นคือ Mongo) |
| DATABASE__DatabaseName | ชื่อของฐานข้อมูลที่จะถูกสร้างใน Mongo / Cosmos | สตริงที่ถูกต้องตามผู้ให้บริการ |
| DATABASE__ConnectionString | สตริงการเชื่อมต่อไปยังฐานข้อมูล Mongo หรือ Cosmos | สตริงการเชื่อมต่อที่ถูกต้องสำหรับผู้ให้บริการที่กำหนดค่าไว้ |
Metrics Projection
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| DATABASE__Provider | ระบุว่าจะใช้ผู้ให้บริการ Database ใดเมื่อจัดเก็บ Async Requests | Mongo, Cosmos (ค่าเริ่มต้นคือ Mongo) |
| DATABASE__DatabaseName | ชื่อของฐานข้อมูลที่จะถูกสร้างใน Mongo / Cosmos | สตริงที่ถูกต้องตามผู้ให้บริการ |
| DATABASE__ConnectionString | สตริงการเชื่อมต่อไปยังฐานข้อมูล Mongo หรือ Cosmos | สตริงการเชื่อมต่อที่ถูกต้องสำหรับผู้ให้บริการที่กำหนดค่าไว้ |
Storage Monitor
| คีย์การกำหนดค่า | คำอธิบาย | ค่าที่ใช้ได้ |
|---|---|---|
| DATABASE__Provider | ระบุว่าจะใช้ผู้ให้บริการ Database ใดเมื่อจัดเก็บข้อมูลการตรวจสอบ | Mongo, Cosmos (ค่าเริ่มต้นคือ Mongo) |
| DATABASE__DatabaseName | ชื่อของฐานข้อมูลที่จะถูกสร้างใน Mongo / Cosmos | สตริงที่ถูกต้องตามผู้ให้บริการ |
| DATABASE__ConnectionString | สตริงการเชื่อมต่อไปยังฐานข้อมูล Mongo หรือ Cosmos | สตริงการเชื่อมต่อที่ถูกต้องสำหรับผู้ให้บริการที่กำหนดค่าไว้ |
| GRAPHAPI__ClientId | Client ID สำหรับการยืนยันตัวตนของ Microsoft Graph API | GUID ที่ถูกต้อง |
| GRAPHAPI__ClientSecret | Client secret สำหรับการยืนยันตัวตนของ Microsoft Graph API | สตริง secret ที่ถูกต้อง |
| GRAPHAPI__TenantId | Tenant ID สำหรับการยืนยันตัวตนของ Microsoft Graph API | GUID ที่ถูกต้อง |
| GRAPHAPI__MonitorValidationDelay | ระยะเวลาก่อนตรวจสอบการสมัครรับข้อมูล monitor ของ Graph API | ช่วงเวลาที่ถูกต้อง (ค่าเริ่มต้นคือ 00:00:30) |
| GRAPHAPI__SubscriptionDuration | ระยะเวลาสำหรับการสมัครรับข้อมูล Graph API ก่อนต่ออายุอัตโนมัติ | ช่วงเวลาที่ถูกต้อง (ค่าเริ่มต้นคือ 2.00:00:00) |
| GRAPHAPI__TenantName | ชื่อของ Azure tenant ที่ใช้โดย Graph API | ชื่อ tenant ที่ถูกต้อง - เช่น Glasswall |
| CLIENTS__SyncApi__Timeout | หมดเวลาสำหรับการเรียกไปยัง Sync API | ช่วงเวลาที่ถูกต้อง (ค่าเริ่มต้นคือ 00:03:00) |
| ENABLE_OUTLOOK_BANNER | เปิดหรือปิดใช้งานฟีเจอร์แบนเนอร์ Outlook | true, false (ค่าเริ่มต้นคือ false) |
| EXCHANGEONLINE__AppId | Application ID สำหรับการยืนยันตัวตนของ Exchange Online | GUID ที่ถูกต้อง - จำเป็นหากตั้งค่า ENABLE_OUTLOOK_BANNER เป็น true |
| EXCHANGEONLINE__Organization | โดเมนองค์กรของ Exchange Online | โดเมน .onmicrosoft.com ที่ถูกต้อง - จำเป็นหากตั้งค่า ENABLE_OUTLOOK_BANNER เป็น true |
| EXCHANGEONLINE__DistributionGroupName | ชื่อที่กำหนดให้กับ distribution group ที่สร้างใน Exchange Online | สตริงที่ถูกต้อง (ค่าเริ่มต้นคือ GWStorageMonitoringUsers) |
| EXCHANGEONLINE__TransportRuleName | ชื่อที่กำหนดให้กับกฎ mail flow ซึ่งจะใช้แบนเนอร์กับผู้ที่อยู่ใน distribution group | สตริงที่ถูกต้อง (ค่าเริ่มต้นคือ Glasswall Attachment Processing Notice) |
| EXCHANGEONLINE__DistributionListSyncHaloUri | Base URI สำหรับ API ของ Storage Monitor สำหรับการดึง monitors | URI ที่ถูกต้อง (ค่าเริ่มต้นคือ http://localhost:8080 - พอร์ต HTTP เริ่มต้นของ Storage Monitor) |
| 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 | ระยะเวลาเกณฑ์หลังจากนั้นที่ monitor จะถูกพิจารณาว่าไม่ทำงาน | ช่วงเวลาที่ถูกต้อง (ค่าเริ่มต้นเป็น 03:00:00) |