कॉन्फ़िगरेशन परिवर्तन
कई सेवाओं में कॉन्फ़िगर किए जा सकने वाले settings शामिल हैं जिन्हें अनुकूलित किया जा सकता है। नीचे प्रत्येक सेवा के लिए उपलब्ध configuration values दिए गए हैं।
कॉन्फ़िगरेशन को कैसे अपडेट करें
helm chart को deploy करते समय --set configuration.<Configuration Key>=<Configuration value> का उपयोग करके helm chart values सेट कर configuration values बदले जा सकते हैं।
उदाहरण के लिए, ASPNETCORE_SHUTDOWNTIMEOUTSECONDS का मान 90 seconds और RATELIMITING__MaxMessageCount का मान 300 messages सेट करने के लिए, helm command नीचे जैसा होगा -
helm upgrade --install cdrplatform-sync-api cdrplatform-sync-api \
--set configuration.ASPNETCORE_SHUTDOWNTIMEOUTSECONDS=90 \
--set configuration.RATELIMITING__MaxMessageCount=300
API एक्सेस
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | यह निर्दिष्ट करता है कि Web Host के बंद होने की प्रतीक्षा कितनी देर तक की जाए। | कोई भी मान्य पूर्णांक |
| AuthenticationScheme | API Access के लिए Authentication Scheme। | None, Bearer, Basic |
| Authentication__Schemes__Bearer__ValidAudiences__0 | जब AuthenticationScheme को Bearer पर सेट किया गया हो, तब API Access के लिए मान्य audience | कोई भी मान्य string ( e.g. 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 | वह base URL जिस पर proxy Policy Management API अनुरोध भेजता है | http://policy-api:8080 |
| CLIENTS__License__BaseAddress | वह बेस URL जिस पर proxy License Management API अनुरोध भेजता है | http://license-management.license-management.svc.cluster.local:8080 |
| CLIENTS__SyncApi__BaseAddress | वह बेस URL जिस पर proxy Sync API अनुरोध भेजता है | http://api:8080 |
| CLIENTS__AsyncApi__BaseAddress | वह बेस URL जिस पर proxy Async API अनुरोध भेजता है | http://async-api:8080 |
| CLIENTS__IcapProfile__BaseAddress | वह बेस URL जिस पर proxy ICAP Profile Management अनुरोध भेजता है | http://policy-api:8080 |
Sync API
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | यह निर्दिष्ट करता है कि Web Host के बंद होने की प्रतीक्षा कितनी देर तक की जाए। | कोई भी मान्य पूर्णांक |
| RATELIMITING__MaxMessageCount | rate limiting लागू होने से पहले request queue पर अनुमत संदेशों की अधिकतम संख्या | कोई भी मान्य पूर्णांक |
| ARCHIVE__MaxLevel | nested archives की अधिकतम परतें जिन्हें प्रोसेस किया जाएगा अधिक जानकारी | धनात्मक पूर्णांक |
| ARCHIVE__MaxFileCount | विफलता से पहले किसी archive में अनुमत अधिकतम फ़ाइल संख्या अधिक जानकारी | धनात्मक पूर्णांक |
| ARCHIVE__MaxArchiveCount | विफलता से पहले किसी archive में अनुमत अधिकतम nested archive संख्या अधिक जानकारी | धनात्मक पूर्णांक |
| ARCHIVE__MaxUnpackedSizeBytes | विफलता से पहले किसी archive से unpack की गई फ़ाइलों का अनुमत अधिकतम आकार अधिक जानकारी | धनात्मक पूर्णांक (bytes में) |
Engine
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | यह Host के बंद होने की प्रतीक्षा करने के समय की मात्रा निर्दिष्ट करता है। | कोई भी मान्य पूर्णांक |
| QUEUE__RetryLimit | यह Async requests को पुनः प्रयास करने की संख्या निर्दिष्ट करता है | कोई भी मान्य पूर्णांक |
| ReversingLabs__Endpoint | ReversingLabs File Reputation API endpoint. | https://data.reversinglabs.com/api/databrowser/malware_presence/query |
| ReversingLabs__Timeout | ReversingLabs File Reputation API से संपर्क करते समय उपयोग किया जाने वाला timeout, सेकंड में (default 100 seconds है)। | कोई भी मान्य पूर्णांक |
पोर्टल एक्सेस
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| AuthenticationScheme | Portal Access API के लिए प्रमाणीकरण स्कीम | कोई नहीं, Bearer |
| Authentication__Schemes__Bearer__ValidAudiences__0 | Portal Access API के लिए मान्य audience. इसे cdrplatform-portal-access app registration के 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 requests करने के लिए उपयोगकर्ताओं का authenticated होना आवश्यक है या नहीं। डिफ़ॉल्ट रूप से false होता है। | true/false |
Portal
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| 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 का Client ID (cdrplatform-portal-client) | एक मान्य string |
| OIDC.ProviderOptions.RedirectUri | SSO Login के बाद Redirect URI | https://\<domain-name>/authentication/login-callback |
| OIDC.ProviderOptions.PostLogoutRedirectUri | Logout के बाद Redirect URI | https://\<domain-name>/authentication/logout-callback |
| REBUILD.RequireAuthenticatedUser | यह निर्धारित करता है कि "Clean a file" पेज तक पहुंचने के लिए उपयोगकर्ताओं का authenticated होना आवश्यक है या नहीं। डिफ़ॉल्ट रूप से false है। | true/false |
लाइसेंस प्रबंधन
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | यह निर्दिष्ट करता है कि Web Host के बंद होने की प्रतीक्षा कितनी देर तक की जाए। | कोई भी मान्य पूर्णांक |
| DATABASE__Provider | caching उद्देश्यों के लिए उपयोग किया जाने वाला database provider | Mongo / Cosmos |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
Cleanup
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | यह Host के बंद होने की प्रतीक्षा करने के समय की मात्रा निर्दिष्ट करता है। | कोई भी मान्य पूर्णांक |
| CleanupAmount | प्रति cron job साफ़ की जाने वाली files की संख्या निर्दिष्ट करता है। इसे --set cron.CleanupAmount=5000 के माध्यम से सेट किया जा सकता है | कोई भी मान्य पूर्णांक |
| maxAge | storage में रखी जाने वाली files की अधिकतम आयु निर्दिष्ट करता है। इसे --set cron.maxAge=01.00:00:00 के माध्यम से सेट किया जा सकता है | कोई भी मान्य Timespan |
| schedule | cleanup cron job के चलने के लिए cron schedule निर्दिष्ट करता है। इसे --set cron.schedule=0 */1 * * * के माध्यम से सेट किया जा सकता है | कोई भी मान्य cron schedule expression |
ICAP
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | यह Host के बंद होने की प्रतीक्षा करने के समय की मात्रा निर्दिष्ट करता है। | कोई भी मान्य पूर्णांक |
| ICAP__ServiceHeader | एक Identifier जो ICAP headers में डाला जाता है। | कोई भी मान्य स्ट्रिंग, डिफ़ॉल्ट रूप से 'Glasswall ICAP Server 1.0"' |
| ICAP__OptionsTTL | सेकंड में वह समयावधि जिसके लिए सर्वर द्वारा भेजा गया ICAP options response icap client के लिए मान्य रहता है। | कोई भी मान्य पूर्णांक जिसे icap client समर्थन करता हो |
| ICAP__IdleTimeout | डिफ़ॉल्ट रूप से अनंत। एक समय-सीमा सेट करता है जो दर्शाती है कि सर्वर कनेक्शन समाप्त करने से पहले क्लाइंट को कितना समय लेना चाहिए | एक मान्य समयावधि, उदाहरण के लिए 00:00:30 |
| CACHE__MaxSizeInMb | मेगाबाइट में डेटा की वह मात्रा जिसे ICAP server rebuilt files के लिए अपने cache में संग्रहीत करेगा | डिफ़ॉल्ट रूप से 1Gb "1000" |
| DATABASE__Provider | caching उद्देश्यों के लिए उपयोग किया जाने वाला database provider | Mongo / Cosmos |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
| CERTIFICATE__VerificationFlags | ICAP server में certificate chain verification को अनुकूलित करने के लिए उपयोग किए जाने वाले flags। verification flags की व्याख्या के लिए कृपया X509VerificationFlags देखें। | enum range के भीतर एक मान्य पूर्णांक |
| PROFILE__UseFallback | Boolean flag जो यह दर्शाता है कि जब Policy API से संपर्क नहीं हो पाता, तब fallback profile का उपयोग करना है या नहीं। | 'true' fallback profile सक्षम करने के लिए या 'false' इसे अक्षम करने के लिए। डिफ़ॉल्ट रूप से, यह 'false' है |
Async API
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | यह निर्दिष्ट करता है कि Web Host के बंद होने की प्रतीक्षा कितनी देर तक की जाए। | कोई भी मान्य पूर्णांक |
| ARCHIVE__MaxLevel | nested archives की अधिकतम परतें जिन्हें प्रोसेस किया जाएगा अधिक जानकारी | धनात्मक पूर्णांक |
| ARCHIVE__MaxFileCount | विफलता से पहले किसी archive में अनुमत अधिकतम फ़ाइल संख्या अधिक जानकारी | धनात्मक पूर्णांक |
| ARCHIVE__MaxArchiveCount | विफलता से पहले किसी archive में अनुमत अधिकतम nested archive संख्या अधिक जानकारी | धनात्मक पूर्णांक |
| ARCHIVE__MaxUnpackedSizeBytes | विफलता से पहले किसी archive से unpack की गई फ़ाइलों का अनुमत अधिकतम आकार अधिक जानकारी | धनात्मक पूर्णांक (bytes में) |
| DATABASE__Provider | यह निर्दिष्ट करता है कि Async Requests को संग्रहीत करते समय किस Database provider का उपयोग करना है | Mongo, Cosmos (डिफ़ॉल्ट Mongo है) |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
| QUEUE__MessageDelayInMs | मिलीसेकंड में वह समय जिसके बाद ASYNC request के परिणाम को साफ़ किया जाता है। इसे Cleanup service के maxAge Timespan से कम पर सेट किया जाना चाहिए। | कोई भी मान्य धनात्मक पूर्णांक। अधिकतम मान (2^32)-1 milliseconds है, जो 50 दिनों से थोड़ा कम है। |
Tally Accumulator
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| DATABASE__Provider | यह निर्दिष्ट करता है कि Async Requests को संग्रहीत करते समय किस Database provider का उपयोग करना है | Mongo, Cosmos (डिफ़ॉल्ट Mongo है) |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
Policy API
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| DATABASE__Provider | यह निर्दिष्ट करता है कि Async Requests को संग्रहीत करते समय किस Database provider का उपयोग करना है | Mongo, Cosmos (डिफ़ॉल्ट Mongo है) |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
Metrics Collation (अप्रचलित)
Halo के version 2.6.2 से, Metrics Collation service अब आवश्यक नहीं है।
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| DATABASE__Provider | यह निर्दिष्ट करता है कि Async Requests को संग्रहीत करते समय किस Database provider का उपयोग करना है | Mongo, Cosmos (डिफ़ॉल्ट Mongo है) |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
Metrics Projection
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| DATABASE__Provider | यह निर्दिष्ट करता है कि Async Requests को संग्रहीत करते समय किस Database provider का उपयोग करना है | Mongo, Cosmos (डिफ़ॉल्ट Mongo है) |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
Storage Monitor
| Configuration Key | विवरण | मान्य मान |
|---|---|---|
| DATABASE__Provider | यह निर्दिष्ट करता है कि monitor data को संग्रहीत करते समय किस Database provider का उपयोग करना है | Mongo, Cosmos (डिफ़ॉल्ट Mongo है) |
| DATABASE__DatabaseName | उस database का नाम जो Mongo / Cosmos में बनाया जाएगा | provider पर निर्भर एक मान्य string |
| DATABASE__ConnectionString | Mongo या Cosmos database के लिए connection string | configured provider के लिए एक मान्य connection string |
| GRAPHAPI__ClientId | Microsoft Graph API authentication के लिए Client ID | एक मान्य GUID |
| GRAPHAPI__ClientSecret | Microsoft Graph API प्रमाणीकरण के लिए Client secret | एक मान्य secret string |
| GRAPHAPI__TenantId | Microsoft Graph API प्रमाणीकरण के लिए Tenant ID | एक मान्य GUID |
| GRAPHAPI__MonitorValidationDelay | Graph API monitor subscriptions को मान्य करने से पहले की देरी | एक मान्य timespan (डिफ़ॉल्ट 00:00:30 है) |
| GRAPHAPI__SubscriptionDuration | auto-renewal से पहले Graph API subscriptions की अवधि | एक मान्य timespan (डिफ़ॉल्ट 2.00:00:00 है) |
| GRAPHAPI__TenantName | Graph API द्वारा उपयोग किए जाने वाले Azure tenant का नाम | एक मान्य tenant name - उदाहरण के लिए Glasswall |
| CLIENTS__SyncApi__Timeout | Sync API को किए जाने वाले calls के लिए timeout | एक मान्य समयावधि (डिफ़ॉल्ट 00:03:00) |
| ENABLE_OUTLOOK_BANNER | Outlook बैनर सुविधा को सक्षम या अक्षम करता है | true, false (डिफ़ॉल्ट false) |
| EXCHANGEONLINE__AppId | Exchange Online प्रमाणीकरण के लिए Application ID | एक मान्य GUID - यदि ENABLE_OUTLOOK_BANNER को true पर सेट किया गया है, तो आवश्यक |
| EXCHANGEONLINE__Organization | Exchange Online संगठन डोमेन | एक मान्य .onmicrosoft.com डोमेन - यदि ENABLE_OUTLOOK_BANNER को true पर सेट किया गया है, तो आवश्यक |
| EXCHANGEONLINE__DistributionGroupName | Exchange Online में बनाए गए distribution group को दिया गया नाम | एक मान्य स्ट्रिंग (डिफ़ॉल्ट GWStorageMonitoringUsers) |
| EXCHANGEONLINE__TransportRuleName | उस mail flow rule को दिया गया नाम जो distribution group में शामिल लोगों पर बैनर लागू करेगा | एक मान्य स्ट्रिंग (डिफ़ॉल्ट Glasswall Attachment Processing Notice) |
| EXCHANGEONLINE__DistributionListSyncHaloUri | मॉनिटर्स प्राप्त करने के लिए Storage Monitor के API का बेस URI | एक वैध URI (डिफ़ॉल्ट http://localhost:8080 - Storage Monitor का डिफ़ॉल्ट HTTP पोर्ट) |
| EXCHANGEONLINE__DistributionListSyncCronSchedule | Monitor/Banner sync job के चलने का शेड्यूल | एक मान्य cron expression (डिफ़ॉल्ट 0 */3 * * * या At the beginning of every 3rd hour है) |
| MONITORING__BlockUnprocessedAttachments | क्या Outlook में उन Email attachments को ब्लॉक करना है जिन्हें प्रोसेस नहीं किया गया है | true, false (डिफ़ॉल्ट true) |
| MONITORING__ProcessUnsupportedExtensions | यह निर्दिष्ट करता है कि असमर्थित file type extensions वाली फ़ाइलों को प्रोसेसिंग के लिए Sync API पर भेजना है या नहीं | true, false |
| MONITORING__HealthcheckCronSchedule | health checks चलाने के लिए Cron शेड्यूल | एक मान्य cron expression (डिफ़ॉल्ट 0 */3 * * * या At the beginning of every 3rd hour है) |
| MONITORING__MaxDegreeOfParallelism | समानांतर monitoring operations की अधिकतम संख्या | एक धनात्मक पूर्णांक (डिफ़ॉल्ट 5) |
| MONITORING__MonitorLastSeenThreshold | वह थ्रेशोल्ड अवधि जिसके बाद किसी monitor को निष्क्रिय माना जाता है | एक मान्य समयावधि (डिफ़ॉल्ट 03:00:00 है) |