Các thay đổi cấu hình
Một số dịch vụ bao gồm các cài đặt có thể cấu hình và tùy chỉnh. Dưới đây là các giá trị cấu hình khả dụng cho từng dịch vụ.
Cách cập nhật cấu hình
Các giá trị cấu hình có thể được thay đổi bằng cách đặt các giá trị helm chart trong khi triển khai helm chart bằng --set configuration.<Configuration Key>=<Configuration value>.
Ví dụ: để đặt giá trị ASPNETCORE_SHUTDOWNTIMEOUTSECONDS thành 90 giây và đặt giá trị RATELIMITING__MaxMessageCount thành 300 thông điệp, lệnh helm sẽ như bên dưới -
helm upgrade --install cdrplatform-sync-api cdrplatform-sync-api \
--set configuration.ASPNETCORE_SHUTDOWNTIMEOUTSECONDS=90 \
--set configuration.RATELIMITING__MaxMessageCount=300
Quyền truy cập API
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Chỉ định khoảng thời gian chờ Web Host tắt. | Bất kỳ số nguyên hợp lệ nào |
| AuthenticationScheme | Lược đồ xác thực cho API Access. | None, Bearer, Basic |
| Authentication__Schemes__Bearer__ValidAudiences__0 | Đối tượng người nhận hợp lệ cho API Access khi AuthenticationScheme được đặt thành Bearer | Bất kỳ chuỗi hợp lệ nào (ví dụ: api://cdrplatform-api-access) |
| Authentication__Schemes__Bearer__ValidIssuer | Issuer hợp lệ khi AuthenticationScheme được đặt thành Bearer | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | Authority cho API Access khi AuthenticationScheme được đặt thành Bearer | https://login.microsoftonline.com/\<tenant-id>/v2.0/ |
| CLIENTS__Policy__BaseAddress | URL cơ sở mà proxy gửi yêu cầu tới Policy Management API | http://policy-api:8080 |
| CLIENTS__License__BaseAddress | URL cơ sở mà proxy gửi yêu cầu tới License Management API | http://license-management.license-management.svc.cluster.local:8080 |
| CLIENTS__SyncApi__BaseAddress | URL cơ sở mà proxy gửi yêu cầu tới Sync API | http://api:8080 |
| CLIENTS__AsyncApi__BaseAddress | URL cơ sở mà proxy gửi yêu cầu tới Async API | http://async-api:8080 |
| CLIENTS__IcapProfile__BaseAddress | URL cơ sở để proxy chuyển tiếp các yêu cầu quản lý ICAP Profile tới | http://policy-api:8080 |
Sync API
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Chỉ định khoảng thời gian chờ Web Host tắt. | Bất kỳ số nguyên hợp lệ nào |
| RATELIMITING__MaxMessageCount | Số lượng tối đa các thông điệp được phép trên hàng đợi yêu cầu trước khi giới hạn tốc độ bắt đầu có hiệu lực | Bất kỳ số nguyên hợp lệ nào |
| ARCHIVE__MaxLevel | Số lớp tối đa của các tệp lưu trữ lồng nhau sẽ được xử lý thông tin thêm | Số nguyên dương |
| ARCHIVE__MaxFileCount | Số lượng tệp tối đa được phép trong một kho lưu trữ trước khi xảy ra lỗi thông tin thêm | Số nguyên dương |
| ARCHIVE__MaxArchiveCount | Số lượng kho lưu trữ lồng nhau tối đa được phép trong một kho lưu trữ trước khi xảy ra lỗi thông tin thêm | Số nguyên dương |
| ARCHIVE__MaxUnpackedSizeBytes | Kích thước tối đa được phép của các tệp đã giải nén từ một kho lưu trữ trước khi xảy ra lỗi thông tin thêm | Số nguyên dương (tính bằng byte) |
Engine
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | Chỉ định khoảng thời gian chờ Host tắt. | Bất kỳ số nguyên hợp lệ nào |
| QUEUE__RetryLimit | Chỉ định số lần thử lại các yêu cầu Async | Bất kỳ số nguyên hợp lệ nào |
| ReversingLabs__Endpoint | Điểm cuối ReversingLabs File Reputation API. | https://data.reversinglabs.com/api/databrowser/malware_presence/query |
| ReversingLabs__Timeout | Thời gian chờ tính bằng giây được sử dụng khi liên hệ với ReversingLabs File Reputation API (mặc định là 100 giây). | Bất kỳ số nguyên hợp lệ nào |
Truy cập Cổng
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| AuthenticationScheme | Lược đồ xác thực cho Portal Access API | Không có, Bearer |
| Authentication__Schemes__Bearer__ValidAudiences__0 | Đối tượng người nhận hợp lệ cho Portal Access API. Đặt thành ID Ứng dụng (máy khách) của đăng ký ứng dụng cdrplatform-portal-access. | Bất kỳ chuỗi hợp lệ nào |
| Authentication__Schemes__Bearer__ValidIssuer | Issuer hợp lệ cho Portal Access API | https://sts.windows.net/\<tenant-id>/ |
| Authentication__Schemes__Bearer__Authority | Authority cho Portal Access API | https://login.microsoftonline.com/\<tenant-id>/v2.0/ |
| REBUILD__RequireAuthenticatedUser | Xác định liệu người dùng có phải được xác thực để thực hiện các yêu cầu rebuild hay không. Mặc định là false. | true/false |
Portal
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| BackendUrl | Miền của CDR Platform API | https://<domain-name> (A valid string) |
| OIDC.ProviderOptions.Authority | Authority cho dịch vụ Portal | https://login.microsoftonline.com/\<tenant-id>/v2.0 |
| OIDC.ProviderOptions.ClientId | Client ID của đăng ký Portal App (cdrplatform-portal-client) | Một chuỗi hợp lệ |
| OIDC.ProviderOptions.RedirectUri | URI chuyển hướng sau khi đăng nhập SSO | https://\<domain-name>/authentication/login-callback |
| OIDC.ProviderOptions.PostLogoutRedirectUri | URI chuyển hướng sau khi đăng xuất | https://\<domain-name>/authentication/logout-callback |
| REBUILD.RequireAuthenticatedUser | Xác định liệu người dùng có phải được xác thực để truy cập trang "Clean a file" hay không. Mặc định là false. | true/false |
Quản lý giấy phép
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Chỉ định khoảng thời gian chờ Web Host tắt. | Bất kỳ số nguyên hợp lệ nào |
| DATABASE__Provider | Nhà cung cấp cơ sở dữ liệu được sử dụng cho mục đích lưu đệm | Mongo / Cosmos |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
Dọn dẹp
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| DOTNET_SHUTDOWNTIMEOUTSECONDS | Chỉ định khoảng thời gian chờ Host tắt. | Bất kỳ số nguyên hợp lệ nào |
| CleanupAmount | Chỉ định số lượng tệp cần dọn dẹp trong mỗi cron job. Có thể thiết lập giá trị này qua --set cron.CleanupAmount=5000 | Bất kỳ số nguyên hợp lệ nào |
| maxAge | Chỉ định tuổi tối đa của các tệp được giữ trong bộ nhớ lưu trữ. Có thể thiết lập giá trị này qua --set cron.maxAge=01.00:00:00 | Bất kỳ Timespan hợp lệ nào |
| schedule | Chỉ định lịch cron để cron job dọn dẹp chạy theo. Có thể thiết lập giá trị này qua --set cron.schedule=0 */1 * * * | Bất kỳ biểu thức lịch cron hợp lệ nào |
ICAP
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Chỉ định khoảng thời gian chờ Host tắt. | Bất kỳ số nguyên hợp lệ nào |
| ICAP__ServiceHeader | Một định danh được chèn vào các header ICAP. | Bất kỳ chuỗi hợp lệ nào, mặc định là 'Glasswall ICAP Server 1.0"' |
| ICAP__OptionsTTL | Khoảng thời gian tính bằng giây mà phản hồi tùy chọn ICAP do máy chủ gửi có hiệu lực đối với icap client. | Bất kỳ số nguyên hợp lệ nào mà icap client hỗ trợ |
| ICAP__IdleTimeout | Mặc định là vô hạn. Đặt thời hạn cho biết client phải hoàn thành trong bao lâu trước khi máy chủ kết thúc kết nối | Khoảng thời gian hợp lệ, ví dụ 00:00:30 |
| CACHE__MaxSizeInMb | Lượng dữ liệu tính bằng megabyte mà máy chủ ICAP sẽ lưu trong bộ nhớ đệm của nó cho các tệp đã được dựng lại | Mặc định là 1Gb "1000" |
| DATABASE__Provider | Nhà cung cấp cơ sở dữ liệu được sử dụng cho mục đích lưu đệm | Mongo / Cosmos |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
| CERTIFICATE__VerificationFlags | Các cờ được dùng để tùy chỉnh việc xác minh chuỗi chứng chỉ trong máy chủ ICAP. Vui lòng xem X509VerificationFlags để biết giải thích về các cờ xác minh. | Một số nguyên hợp lệ trong phạm vi enum |
| PROFILE__UseFallback | Cờ Boolean cho biết có sử dụng profile dự phòng hay không khi không thể liên hệ với Policy API. | 'true' để bật profile dự phòng hoặc 'false' để tắt. Mặc định là 'false' |
Async API
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| ASPNETCORE_SHUTDOWNTIMEOUTSECONDS | Chỉ định khoảng thời gian chờ Web Host tắt. | Bất kỳ số nguyên hợp lệ nào |
| ARCHIVE__MaxLevel | Số lớp tối đa của các tệp lưu trữ lồng nhau sẽ được xử lý thông tin thêm | Số nguyên dương |
| ARCHIVE__MaxFileCount | Số lượng tệp tối đa được phép trong một kho lưu trữ trước khi xảy ra lỗi thông tin thêm | Số nguyên dương |
| ARCHIVE__MaxArchiveCount | Số lượng kho lưu trữ lồng nhau tối đa được phép trong một kho lưu trữ trước khi xảy ra lỗi thông tin thêm | Số nguyên dương |
| ARCHIVE__MaxUnpackedSizeBytes | Kích thước tối đa được phép của các tệp đã giải nén từ một kho lưu trữ trước khi xảy ra lỗi thông tin thêm | Số nguyên dương (tính bằng byte) |
| DATABASE__Provider | Chỉ định nhà cung cấp Database sẽ sử dụng khi lưu trữ Async Requests | Mongo, Cosmos (Mặc định là Mongo) |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
| QUEUE__MessageDelayInMs | Thời gian tính bằng mili giây trước khi kết quả của một yêu cầu ASYNC được dọn dẹp. Giá trị này nên được đặt thấp hơn khoảng thời gian maxAge của dịch vụ Cleanup. | Bất kỳ số nguyên dương hợp lệ nào. Giá trị tối đa là (2^32)-1 milliseconds, tương đương gần 50 ngày. |
Tally Accumulator
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| DATABASE__Provider | Chỉ định nhà cung cấp Database sẽ sử dụng khi lưu trữ Async Requests | Mongo, Cosmos (Mặc định là Mongo) |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
Policy API
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| DATABASE__Provider | Chỉ định nhà cung cấp Database sẽ sử dụng khi lưu trữ Async Requests | Mongo, Cosmos (Mặc định là Mongo) |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
Tổng hợp Metrics (Không còn được dùng)
Kể từ phiên bản 2.6.2 của Halo, dịch vụ Metrics Collation không còn cần thiết nữa.
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| DATABASE__Provider | Chỉ định nhà cung cấp Database sẽ sử dụng khi lưu trữ Async Requests | Mongo, Cosmos (Mặc định là Mongo) |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
Metrics Projection
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| DATABASE__Provider | Chỉ định nhà cung cấp Database sẽ sử dụng khi lưu trữ Async Requests | Mongo, Cosmos (Mặc định là Mongo) |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
Storage Monitor
| Khóa cấu hình | Mô tả | Giá trị hợp lệ |
|---|---|---|
| DATABASE__Provider | Chỉ định nhà cung cấp Database sẽ sử dụng khi lưu trữ dữ liệu giám sát | Mongo, Cosmos (Mặc định là Mongo) |
| DATABASE__DatabaseName | Tên của cơ sở dữ liệu sẽ được tạo trong Mongo / Cosmos | Một chuỗi hợp lệ tùy thuộc vào nhà cung cấp |
| DATABASE__ConnectionString | Chuỗi kết nối tới cơ sở dữ liệu Mongo hoặc Cosmos | Một chuỗi kết nối hợp lệ cho nhà cung cấp đã được cấu hình |
| GRAPHAPI__ClientId | Client ID dùng để xác thực Microsoft Graph API | GUID hợp lệ |
| GRAPHAPI__ClientSecret | Client secret để xác thực Microsoft Graph API | Một chuỗi secret hợp lệ |
| GRAPHAPI__TenantId | Tenant ID để xác thực Microsoft Graph API | GUID hợp lệ |
| GRAPHAPI__MonitorValidationDelay | Độ trễ trước khi xác thực các đăng ký monitor của Graph API | Một khoảng thời gian hợp lệ (Mặc định là 00:00:30) |
| GRAPHAPI__SubscriptionDuration | Thời lượng cho các đăng ký Graph API trước khi tự động gia hạn | Một khoảng thời gian hợp lệ (Mặc định là 2.00:00:00) |
| GRAPHAPI__TenantName | Tên của Azure tenant được Graph API sử dụng | Một tên tenant hợp lệ - ví dụ: Glasswall |
| CLIENTS__SyncApi__Timeout | Thời gian chờ cho các lệnh gọi tới Sync API | Khoảng thời gian hợp lệ (Mặc định là 00:03:00) |
| ENABLE_OUTLOOK_BANNER | Bật hoặc tắt tính năng banner Outlook | true, false (Mặc định là false) |
| EXCHANGEONLINE__AppId | ID ứng dụng để xác thực Exchange Online | GUID hợp lệ - Bắt buộc nếu ENABLE_OUTLOOK_BANNER được đặt thành true |
| EXCHANGEONLINE__Organization | Miền tổ chức Exchange Online | Miền .onmicrosoft.com hợp lệ - Bắt buộc nếu ENABLE_OUTLOOK_BANNER được đặt thành true |
| EXCHANGEONLINE__DistributionGroupName | Tên được đặt cho nhóm phân phối được tạo trong Exchange Online | Chuỗi hợp lệ (Mặc định là GWStorageMonitoringUsers) |
| EXCHANGEONLINE__TransportRuleName | Tên được đặt cho quy tắc luồng thư sẽ áp dụng banner cho những người trong nhóm phân phối | Chuỗi hợp lệ (Mặc định là Glasswall Attachment Processing Notice) |
| EXCHANGEONLINE__DistributionListSyncHaloUri | URI cơ sở cho API của Storage Monitor để truy xuất các monitor | Một URI hợp lệ (Mặc định là http://localhost:8080 - cổng HTTP mặc định của Storage Monitor) |
| EXCHANGEONLINE__DistributionListSyncCronSchedule | Lịch để tác vụ đồng bộ Monitor/Banner chạy vào | Biểu thức cron hợp lệ (Mặc định là 0 */3 * * * hoặc At the beginning of every 3rd hour) |
| MONITORING__BlockUnprocessedAttachments | Có chặn các tệp đính kèm Email trong Outlook chưa được xử lý hay không | true, false (Mặc định là true) |
| MONITORING__ProcessUnsupportedExtensions | Chỉ định có gửi các tệp có phần mở rộng loại tệp không được hỗ trợ tới Sync API để xử lý hay không | true, false |
| MONITORING__HealthcheckCronSchedule | Lịch cron để chạy kiểm tra tình trạng | Biểu thức cron hợp lệ (Mặc định là 0 */3 * * * hoặc At the beginning of every 3rd hour) |
| MONITORING__MaxDegreeOfParallelism | Số lượng tối đa các thao tác giám sát song song | Một số nguyên dương (Mặc định là 5) |
| MONITORING__MonitorLastSeenThreshold | Khoảng thời gian ngưỡng sau đó một monitor được coi là không hoạt động | Khoảng thời gian hợp lệ (Mặc định là 03:00:00) |