Perubahan konfigurasi
Beberapa perkhidmatan merangkumi tetapan boleh dikonfigurasi yang boleh disesuaikan. Di bawah ialah nilai konfigurasi yang tersedia untuk setiap perkhidmatan.
Cara mengemas kini konfigurasi
Nilai konfigurasi boleh diubah dengan menetapkan nilai helm chart semasa menggunakan helm chart dengan --set configuration.<Configuration Key>=<Configuration value>.
Sebagai contoh, untuk menetapkan nilai ASPNETCORE_SHUTDOWNTIMEOUTSECONDS kepada 90 saat dan menetapkan nilai RATELIMITING__MaxMessageCount kepada 300 mesej, arahan helm adalah seperti di bawah -
helm upgrade --install cdrplatform-sync-api cdrplatform-sync-api \
--set configuration.ASPNETCORE_SHUTDOWNTIMEOUTSECONDS=90 \
--set configuration.RATELIMITING__MaxMessageCount=300
Akses API
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Menentukan tempoh masa untuk menunggu Web Host dimatikan. | Sebarang integer yang sah |
| AuthenticationScheme | Skim Pengesahan untuk API Access. | None, Bearer, Basic |
| Authentication__Schemes__Bearer__ValidAudiences__0 | Audience yang sah untuk API Access apabila AuthenticationScheme ditetapkan kepada Bearer | Sebarang rentetan yang sah ( cth. api://cdrplatform-api-access) |
| Authentication__Schemes__Bearer__ValidIssuer | Issuer yang sah apabila AuthenticationScheme ditetapkan kepada Bearer | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | Authority untuk API Access apabila AuthenticationScheme ditetapkan kepada Bearer | https://login.microsoftonline.com/\<tenant-id>/v2.0/ |
| CLIENTS__Policy__BaseAddress | URL asas yang dihantar oleh proksi kepada permintaan Policy Management API | http://policy-api:8080 |
| CLIENTS__License__BaseAddress | URL asas yang permintaan proxy License Management API dihantar ke | http://license-management.license-management.svc.cluster.local:8080 |
| CLIENTS__SyncApi__BaseAddress | URL asas yang permintaan proxy Sync API dihantar ke | http://api:8080 |
| CLIENTS__AsyncApi__BaseAddress | URL asas yang permintaan proxy Async API dihantar ke | http://async-api:8080 |
| CLIENTS__IcapProfile__BaseAddress | URL asas untuk menghantar permintaan proxy ICAP Profile Management ke | http://policy-api:8080 |
Sync API
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Menentukan tempoh masa untuk menunggu Web Host dimatikan. | Sebarang integer yang sah |
| RATELIMITING__MaxMessageCount | Bilangan maksimum mesej yang dibenarkan pada baris gilir permintaan sebelum pengehadan kadar bermula | Sebarang integer yang sah |
| ARCHIVE__MaxLevel | Lapisan maksimum arkib bersarang yang akan diproses maklumat lanjut | Integer positif |
| ARCHIVE__MaxFileCount | Bilangan fail maksimum yang dibenarkan dalam arkib sebelum kegagalan maklumat lanjut | Integer positif |
| ARCHIVE__MaxArchiveCount | Bilangan arkib bersarang maksimum yang dibenarkan dalam arkib sebelum kegagalan maklumat lanjut | Integer positif |
| ARCHIVE__MaxUnpackedSizeBytes | Saiz maksimum yang dibenarkan bagi fail yang dinyahpek daripada arkib sebelum kegagalan maklumat lanjut | Integer positif (dalam bait) |
Engine
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | Menentukan tempoh masa untuk menunggu Host dimatikan. | Sebarang integer yang sah |
| QUEUE__RetryLimit | Menentukan bilangan kali untuk mencuba semula permintaan Async | Sebarang integer yang sah |
| ReversingLabs__Endpoint | Titik akhir ReversingLabs File Reputation API. | https://data.reversinglabs.com/api/databrowser/malware_presence/query |
| ReversingLabs__Timeout | Tempoh tamat masa dalam saat yang digunakan apabila menghubungi ReversingLabs File Reputation API (lalai kepada 100 saat). | Sebarang integer yang sah |
Akses Portal
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| AuthenticationScheme | Skim Pengesahan untuk Portal Access API | Tiada, Bearer |
| Authentication__Schemes__Bearer__ValidAudiences__0 | Audience yang sah untuk Portal Access API. Tetapkan kepada ID Aplikasi (klien) bagi pendaftaran aplikasi cdrplatform-portal-access. | Sebarang rentetan yang sah |
| Authentication__Schemes__Bearer__ValidIssuer | Issuer yang sah untuk Portal Access API | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | Authority untuk Portal Access API | https://login.microsoftonline.com/\<tenant-id>/v2.0/ |
| REBUILD__RequireAuthenticatedUser | Menentukan sama ada pengguna mesti disahkan untuk melaksanakan permintaan bina semula. Lalai ialah false. | true/false |
Portal
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| BackendUrl | Domain bagi CDR Platform API | https://<domain-name> (A valid string) |
| OIDC.ProviderOptions.Authority | Authority untuk perkhidmatan Portal | https://login.microsoftonline.com/\<tenant-id>/v2.0 |
| OIDC.ProviderOptions.ClientId | ID Klien bagi pendaftaran Portal App (cdrplatform-portal-client) | Rentetan yang sah |
| OIDC.ProviderOptions.RedirectUri | URI ubah hala selepas Log Masuk SSO | https://\<domain-name>/authentication/login-callback |
| OIDC.ProviderOptions.PostLogoutRedirectUri | URI ubah hala selepas Log Keluar | https://\<domain-name>/authentication/logout-callback |
| REBUILD.RequireAuthenticatedUser | Menentukan sama ada pengguna mesti diautentikasi untuk mengakses halaman "Clean a file". Lalai ialah false. | true/false |
Pengurusan Lesen
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Menentukan tempoh masa untuk menunggu Web Host dimatikan. | Sebarang integer yang sah |
| DATABASE__Provider | Penyedia pangkalan data yang digunakan untuk tujuan cache | Mongo / Cosmos |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
Pembersihan
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | Menentukan tempoh masa untuk menunggu Host dimatikan. | Sebarang integer yang sah |
| CleanupAmount | Menentukan jumlah fail untuk dibersihkan bagi setiap kerja cron. Ini boleh ditetapkan melalui --set cron.CleanupAmount=5000 | Sebarang integer yang sah |
| maxAge | Menentukan umur maksimum fail untuk disimpan dalam storan. Ini boleh ditetapkan melalui --set cron.maxAge=01.00:00:00 | Sebarang Timespan yang sah |
| schedule | Menentukan jadual cron untuk kerja cron pembersihan dijalankan. Ini boleh ditetapkan melalui --set cron.schedule=0 */1 * * * | Sebarang ungkapan jadual cron yang sah |
ICAP
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Menentukan tempoh masa untuk menunggu Host dimatikan. | Sebarang integer yang sah |
| ICAP__ServiceHeader | Pengecam yang dimasukkan ke dalam pengepala ICAP. | Sebarang rentetan yang sah, lalai kepada 'Glasswall ICAP Server 1.0"' |
| ICAP__OptionsTTL | Jumlah masa dalam saat yang mana respons pilihan ICAP yang dihantar oleh pelayan adalah sah untuk klien icap. | Sebarang integer sah yang disokong oleh klien icap |
| ICAP__IdleTimeout | Lalai kepada infiniti. Menetapkan had masa yang menunjukkan berapa lama klien mesti mengambil masa sebelum pelayan akan menamatkan sambungan | Jangka masa yang sah contohnya 00:00:30 |
| CACHE__MaxSizeInMb | Jumlah data dalam megabait yang akan disimpan oleh pelayan ICAP di dalam cache untuk fail yang dibina semula | Lalai kepada 1Gb "1000" |
| DATABASE__Provider | Penyedia pangkalan data yang digunakan untuk tujuan cache | Mongo / Cosmos |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
| CERTIFICATE__VerificationFlags | Flag yang digunakan untuk menyesuaikan pengesahan rantaian sijil dalam pelayan ICAP. Sila lihat X509VerificationFlags untuk penjelasan tentang flag pengesahan. | Integer yang sah dalam julat enum |
| PROFILE__UseFallback | Flag Boolean yang menunjukkan sama ada hendak menggunakan profile sandaran atau tidak apabila Policy API tidak dapat dihubungi. | 'true' untuk mendayakan profile sandaran atau 'false' untuk menyahdayakannya. Secara lalai, ini ialah 'false' |
Async API
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Menentukan tempoh masa untuk menunggu Web Host dimatikan. | Sebarang integer yang sah |
| ARCHIVE__MaxLevel | Lapisan maksimum arkib bersarang yang akan diproses maklumat lanjut | Integer positif |
| ARCHIVE__MaxFileCount | Bilangan fail maksimum yang dibenarkan dalam arkib sebelum kegagalan maklumat lanjut | Integer positif |
| ARCHIVE__MaxArchiveCount | Bilangan arkib bersarang maksimum yang dibenarkan dalam arkib sebelum kegagalan maklumat lanjut | Integer positif |
| ARCHIVE__MaxUnpackedSizeBytes | Saiz maksimum yang dibenarkan bagi fail yang dinyahpek daripada arkib sebelum kegagalan maklumat lanjut | Integer positif (dalam bait) |
| DATABASE__Provider | Menentukan penyedia Database yang akan digunakan apabila menyimpan Async Requests | Mongo, Cosmos (Lalai kepada Mongo) |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
| QUEUE__MessageDelayInMs | Masa dalam milisaat sebelum hasil permintaan ASYNC dibersihkan. Ini hendaklah ditetapkan lebih rendah daripada tempoh maxAge bagi perkhidmatan Cleanup. | Sebarang integer positif yang sah. Nilai maksimum ialah (2^32)-1 milliseconds iaitu sedikit kurang daripada 50 hari. |
Pengumpul Tally
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| DATABASE__Provider | Menentukan penyedia Database yang akan digunakan apabila menyimpan Async Requests | Mongo, Cosmos (Lalai kepada Mongo) |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
Policy API
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| DATABASE__Provider | Menentukan penyedia Database yang akan digunakan apabila menyimpan Async Requests | Mongo, Cosmos (Lalai kepada Mongo) |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
Pengumpulan Metrik (Ditamatkan)
Mulai versi 2.6.2 Halo, perkhidmatan Metrics Collation tidak lagi diperlukan.
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| DATABASE__Provider | Menentukan penyedia Database yang akan digunakan apabila menyimpan Async Requests | Mongo, Cosmos (Lalai kepada Mongo) |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
Unjuran Metrik
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| DATABASE__Provider | Menentukan penyedia Database yang akan digunakan apabila menyimpan Async Requests | Mongo, Cosmos (Lalai kepada Mongo) |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
Pemantau Storan
| Kunci Konfigurasi | Penerangan | Nilai Sah |
|---|---|---|
| DATABASE__Provider | Menentukan penyedia Database yang akan digunakan apabila menyimpan data pemantauan | Mongo, Cosmos (Lalai kepada Mongo) |
| DATABASE__DatabaseName | Nama pangkalan data yang akan dicipta dalam Mongo / Cosmos | Rentetan yang sah bergantung pada provider |
| DATABASE__ConnectionString | Rentetan sambungan ke pangkalan data Mongo atau Cosmos | Rentetan sambungan yang sah untuk provider yang dikonfigurasikan |
| GRAPHAPI__ClientId | ID klien untuk pengesahan Microsoft Graph API | GUID yang sah |
| GRAPHAPI__ClientSecret | Rahsia klien untuk pengesahan Microsoft Graph API | Rentetan rahsia yang sah |
| GRAPHAPI__TenantId | ID tenant untuk pengesahan Microsoft Graph API | GUID yang sah |
| GRAPHAPI__MonitorValidationDelay | Kelewatan sebelum mengesahkan langganan monitor Graph API | Tempoh masa yang sah (Lalai kepada 00:00:30) |
| GRAPHAPI__SubscriptionDuration | Tempoh untuk langganan Graph API sebelum pembaharuan automatik | Tempoh masa yang sah (Lalai kepada 2.00:00:00) |
| GRAPHAPI__TenantName | Nama tenant Azure yang digunakan oleh Graph API | Nama tenant yang sah - cth. Glasswall |
| CLIENTS__SyncApi__Timeout | Had masa untuk panggilan ke Sync API | Tempoh masa yang sah (Lalai kepada 00:03:00) |
| ENABLE_OUTLOOK_BANNER | Mengaktifkan atau menyahaktifkan ciri banner Outlook | true, false (Lalai kepada false) |
| EXCHANGEONLINE__AppId | ID aplikasi untuk pengesahan Exchange Online | GUID yang sah - Diperlukan jika ENABLE_OUTLOOK_BANNER ditetapkan kepada true |
| EXCHANGEONLINE__Organization | Domain organisasi Exchange Online | Domain .onmicrosoft.com yang sah - Diperlukan jika ENABLE_OUTLOOK_BANNER ditetapkan kepada true |
| EXCHANGEONLINE__DistributionGroupName | Nama yang diberikan kepada kumpulan pengedaran yang dicipta dalam Exchange Online | Rentetan yang sah (Lalai kepada GWStorageMonitoringUsers) |
| EXCHANGEONLINE__TransportRuleName | Nama yang diberikan kepada peraturan aliran mel yang akan menggunakan banner kepada mereka dalam kumpulan pengedaran | Rentetan yang sah (Lalai kepada Glasswall Attachment Processing Notice) |
| EXCHANGEONLINE__DistributionListSyncHaloUri | URI asas untuk API Storage Monitor bagi mendapatkan monitor | URI yang sah (Lalai kepada http://localhost:8080 - port HTTP lalai Storage Monitor) |
| EXCHANGEONLINE__DistributionListSyncCronSchedule | Jadual untuk tugas penyegerakan Monitor/Banner dijalankan | Ungkapan cron yang sah (Lalai kepada 0 */3 * * * atau At the beginning of every 3rd hour) |
| MONITORING__BlockUnprocessedAttachments | Sama ada untuk menyekat lampiran Email dalam Outlook yang belum diproses | true, false (Lalai kepada true) |
| MONITORING__ProcessUnsupportedExtensions | Menentukan sama ada untuk menghantar fail dengan sambungan jenis fail yang tidak disokong ke Sync API untuk diproses | true, false |
| MONITORING__HealthcheckCronSchedule | Jadual cron untuk menjalankan semakan kesihatan | Ungkapan cron yang sah (Lalai kepada 0 */3 * * * atau At the beginning of every 3rd hour) |
| MONITORING__MaxDegreeOfParallelism | Bilangan maksimum operasi pemantauan selari | Integer positif (Lalai kepada 5) |
| MONITORING__MonitorLastSeenThreshold | Tempoh ambang selepas itu monitor dianggap tidak aktif | Jangka masa yang sah (Lalai kepada 03:00:00) |