From 33403bff163a156e3a2673ea441c596cab77574f Mon Sep 17 00:00:00 2001 From: Artem Navoiev Date: Mon, 7 Oct 2024 01:38:00 -0700 Subject: [PATCH] docs: add audit logs page for Cloud (#7193) ### Describe Your Changes Please provide a brief description of the changes you made. Be as specific as possible to help others understand the purpose and impact of your modifications. ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: Artem Navoiev (cherry picked from commit 18dd4105be2b019da53ac5feb30cf0eb8649a4ed) --- docs/victoriametrics-cloud/api.md | 14 ++++----- docs/victoriametrics-cloud/audit-logs.md | 36 ++++++++++++++++++++++++ docs/victoriametrics-cloud/support.md | 4 +-- 3 files changed, 45 insertions(+), 9 deletions(-) create mode 100644 docs/victoriametrics-cloud/audit-logs.md diff --git a/docs/victoriametrics-cloud/api.md b/docs/victoriametrics-cloud/api.md index 095cf178b4..14f3443c45 100644 --- a/docs/victoriametrics-cloud/api.md +++ b/docs/victoriametrics-cloud/api.md @@ -15,7 +15,7 @@ VictoriaMetrics Cloud provides programmatic access for managing cloud resources **Note: Access Tokens** are used for reading and writing data to deployments. They are separate from API Keys and should not be confused. API Keys are specifically for managing resources via the API, while Access Tokens handle data access for deployments. -## API Swagger/OpenAPI Reference: [https://cloud.victoriametrics.com/api-docs](https://cloud.victoriametrics.com/api-docs) +## API Swagger/OpenAPI Reference: [https://console.victoriametrics.cloud/api-docs](https://console.victoriametrics.cloud/api-docs) ## API Key Properties: @@ -23,23 +23,23 @@ VictoriaMetrics Cloud provides programmatic access for managing cloud resources * **Lifetime**: Key expiration date (no expiration is an option). * **Permissions**: Read-only or Read/Write access. * **Deployment Access**: Limit access to single, multiple, or all deployments. ***Note**: selecting all deployments in the list and the “All” option are not the same thing, the “All" option will also apply to future deployments that are created.* -* **Key Value**: Programmatically generated identifier. It's sensitive data used for Authentication. Any operation with API keys (including viewing/revealing Key Value), will be recorded in the Audit Log. +* **Key** or **Key Value**: Programmatically generated identifier. It's sensitive data used for Authentication. Any operation with API keys (including viewing/revealing Key Value), will be recorded in the [Audit Log](https://docs.victoriametrics.com/victoriametrics-cloud/audit-logs/). ![Create API Key](api-1.webp) ## Authentication: -* **API Key Creation**: Required for using the VictoriaMetrics Cloud API. You need to issue the key manually [here](https://cloud.victoriametrics.com/api_keys). +* **API Key Creation**: Required for using the VictoriaMetrics Cloud API. You need to issue the key manually [here](https://console.victoriametrics.cloud/api_keys). * **HTTP Header**: * **Header Name**: `X-VM-Cloud-Access` * **Header Value**: `` ## Alerting & Recording Rules API: -* **List Files**: [API reference](https://cloud.victoriametrics.com/api-docs) -* **View File**: [API reference](https://cloud.victoriametrics.com/api-docs) -* **Upload File**: [API reference](https://cloud.victoriametrics.com/api-docs) -* **Delete File**: [API reference](https://cloud.victoriametrics.com/api-docs) +* **List Files**: [API reference](https://console.victoriametrics.cloud/api-docs) +* **View File**: [API reference](https://console.victoriametrics.cloud/api-docs) +* **Upload File**: [API reference](https://console.victoriametrics.cloud/api-docs) +* **Delete File**: [API reference](https://console.victoriametrics.cloud/api-docs) For detailed setup instructions, check the [VictoriaMetrics Cloud - AlertManager Setup Guide](https://docs.victoriametrics.com/victoriametrics-cloud/alertmanager-setup-for-deployment/). diff --git a/docs/victoriametrics-cloud/audit-logs.md b/docs/victoriametrics-cloud/audit-logs.md new file mode 100644 index 0000000000..a73ddc0bbd --- /dev/null +++ b/docs/victoriametrics-cloud/audit-logs.md @@ -0,0 +1,36 @@ +--- +weight: 9 +title: VictoriaMetrics Cloud Audit Logs +menu: + docs: + parent: "cloud" + weight: 8 + name: Audit Logs +--- +An [**audit log**](https://console.victoriametrics.cloud/audit) is a record of user and system activities within an organization. It captures details of who performed an action, what was done, and when it occurred. Audit logs are essential for security, compliance, and troubleshooting processes. + +## Cloud Audit Log Scopes + +VictoriaMetrics Cloud provides two scopes for audit logs: + +1. **Organization-Level Audit Logs** + These logs record all activities at the organization level, such as user logins, token reveals, updates to payment information, and deployments being created or destroyed. +2. **Deployment-Level Audit Logs** + These logs record activities related to a specific deployment only, such as changes to deployment parameters, creating or deleting access tokens, and modifying alerting or recording rules. + +## Example Log Entry + +* **Time**: 2024-10-0515:40 UTC +* **Email**: cloud-admin@victoriametrics.com +* **Action**: cluster updated: production-platform, changed properties: vmstorage settings changed: disk size changed from 50.0TB to 80.0TB, + +## Filtering + +The audit log page offers filtering options, allowing you to filter logs by time range, actor, or perform a full-text search by action. + +## Export to CSV + +The Export to CSV button on the audit log page allows you to export the entire audit log as a CSV file. + +Filtering does not affect the export; you will always receive the entire audit log in the exported file. + diff --git a/docs/victoriametrics-cloud/support.md b/docs/victoriametrics-cloud/support.md index 0abc6868f8..a184a520fd 100644 --- a/docs/victoriametrics-cloud/support.md +++ b/docs/victoriametrics-cloud/support.md @@ -10,10 +10,10 @@ menu: ## Basic Support All offerings include basic support, where we maintain the health of your deployments, perform system upgrades, and proactively contact customers if issues arise. -All changes are logged and visible in the [Audit log](https://cloud.victoriametrics.com/audit). +All changes are logged and visible in the [Audit log](https://console.victoriametrics.cloud/audit ). For more details, check the [documentation](https://docs.victoriametrics.com/victoriametrics-cloud/audit-logs/) ## How to Reach Support -To contact support, use the [Contact Support](https://cloud.victoriametrics.com/contact_support) button in the Cloud UI. +To contact support, use the [Contact Support](https://console.victoriametrics.cloud/contact_support) button in the Cloud UI. We categorize support requests into three types: - Issues