Skip to content

Commit 6faf67a

Browse files
addetzbenradstone
andcommitted
docs: refactor audit logs page DOC-2535 (#9519)
* docs: refactor audit logs page DOC-2535 * docs: fix vale * docs: add stream description * Apply suggestions from code review Co-authored-by: Ben Radstone <[email protected]> * ci: auto-formatting prettier issues * docs: rename cloudwatch --------- Co-authored-by: Ben Radstone <[email protected]> (cherry picked from commit 2708c83)
1 parent a80edae commit 6faf67a

File tree

1 file changed

+45
-49
lines changed

1 file changed

+45
-49
lines changed

docs/docs-content/audit-logs/audit-logs.md

Lines changed: 45 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -15,56 +15,47 @@ The audit log contains information about the resource and the user who performed
1515
action on the resource is classified as _Create_, _Update_, and _Delete_. Every resource is categorized as a type that
1616
helps the user to scope down the audit logs.
1717

18-
Audit logs are retained for the last one year.
19-
20-
## Accessing Audit Logs
18+
## View Audit Logs
2119

2220
Audits can be accessed for the tenant scope and the project scope. The tenant scope audits show all the activity logs
2321
across all projects and tenant actions. The project scope audits show the activity logs for the specific project.
2422

25-
- The tenant scope audit logs can be accessed in the Spectro Cloud console under the **Admin > Audit Logs**. The user
26-
should have the _Tenant Admin_ role or at least the `audit.get` and `audit.list` permissions at the tenant scope to
27-
access the audit logs.
28-
- The project scope audit logs can be accessed under the **Project** _selection_ > **Audit Logs**. The user should have
29-
at least the _Project Viewer_ role with `audit.get` and `audit.list` permissions for the selected project to access
30-
the audit logs.
31-
- Tenant admins (or users with appropriate permissions) can download the audit logs as a \*.csv file.
32-
33-
## Filtering Audit Logs
23+
1. Log in to [Palette](https://console.spectrocloud.com).
3424

35-
The audit logs can be filtered based on user and resource attributes. The following attributes can be used to filter the
36-
audit logs:
25+
2. Select a project to view project scope audit logs or select **Tenant Admin** to view tenant scope audit logs.
3726

38-
- Type - The action type on the resource.
39-
- Resource Type - The resource type. (The resources are grouped based on the type).
40-
- Start Date and End Date - Period range for the audit logs.
27+
- Users must have the **Project Viewer** role with `audit.get` and `audit.list` permissions for the selected project
28+
to access the audit logs.
29+
- Users must have the **Tenant Admin** role or the `audit.get` and `audit.list` permissions at the tenant scope to
30+
access the audit logs.
4131

42-
## Adding Update Note
32+
3. Navigate to the left main menu and select **Audit Logs**.
4333

44-
For certain resources like the Cluster Profile, users can associate a custom update note in addition to the generic
45-
audit event log. On a successful save of the Cluster Profile, the user will be prompted to provide an update note about
46-
the changes made on the profile. This message will be shown when the user selects an audit log from the list.
34+
4. You can filter audit logs based on user and resource attributes. The following attributes can be used to filter the
35+
audit logs.
4736

48-
## Pushing the Audit Log to the AWS Cloud Trail
37+
- **Project**
38+
- **Log Type**
39+
- **User**
40+
- **Resource Type**
4941

50-
Spectro Cloud users can now push the compliance, management, operational, and risk audit logs to the AWS CloudTrail.
51-
This enables continuous monitoring, security analysis, resource tracking, and troubleshooting of the workload cluster
52-
using the event history.
42+
5. You can also download audit logs as CSV files.
5343

54-
<br />
44+
## Add Update Note
5545

56-
:::warning
46+
For certain resources, like cluster profiles, you can associate a custom update note in addition to the generic audit
47+
event log. On a successful save of a cluster profile, you will be prompted to provide an update note about the changes
48+
made to the profile. This message will be shown when you select an audit log from the list.
5749

58-
An AWS account with cloud trail created is the prerequisite.
50+
## Push Audit Trails to Amazon CloudWatch
5951

60-
The permissions listed need to be enabled for CloudWatch.
52+
You can push the compliance, management, operational, and risk audit logs to
53+
[Amazon CloudWatch](https://aws.amazon.com/cloudwatch/). This enables continuous monitoring, security analysis, resource
54+
tracking, and troubleshooting of the workload cluster using the event history.
6155

62-
:::
56+
### Prerequisites
6357

64-
### Permission List
65-
66-
Ensure that the IAM user or the ROOT user role created should have the following IAM policy included for Amazon
67-
CloudWatch:
58+
Ensure that the IAM user or the ROOT user role created has the following IAM policy included for Amazon CloudWatch.
6859

6960
```json
7061
{
@@ -86,27 +77,32 @@ CloudWatch:
8677
}
8778
```
8879

89-
### Instructions to Push Cluster Audit Logs to AWS Trails
80+
### Enablement
81+
82+
1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin.
9083

91-
- Go to Admin Settings and select Audit Trails.
92-
- Select the wizard ‘Add new Audit Trail’ and fill in the following details:
84+
2. Navigate to the left main menu and select **Tenant Settings**. Then, select **Audit Trails** from the
85+
**Infrastructure** section.
9386

94-
- Audit Name: Custom name to identify the logs
95-
- Type: Choice of monitoring service (currently set to AWS Cloud Watch)
96-
- Group: The log group name obtained from cloud watch logs of AWS cloud trail creation
97-
- Region: The region of the AWS account
98-
- Method of verification: _ Credentials: Use the AWS Access Key and Secret Access Key to validate the AWS account for
99-
pushing the Audit log trails from Spectro Cloud console. _ STS: Use Amazon’s unique resource identifier- ARN, to
100-
validate the AWS account for pushing the Audit log trails from Spectro Cloud console.
87+
3. Select **Add new Audit Trail**. The **Add audit trail** window appears.
10188

102-
- Stream Optional.
103-
- Confirm the information to complete the audit trail creation wizard.
104-
- The audit trail could be edited and deleted using the **three-dot Menu**.
89+
4. Fill in the following details.
90+
91+
- **Audit Name**: Custom name to identify the logs.
92+
- **Type**: Choice of monitoring service. Currently, CloudWatch is available.
93+
- **Group**: The log group name obtained from CloudWatch logs for audit trail creation.
94+
- **Region**: The region of the AWS account.
95+
- **Credentials** : Use an **Access Key** and **Secret Access Key** to validate the AWS account for pushing the audit
96+
trails from Palette.
97+
- **STS**: Use Amazon's unique resource identifier, ARN, to validate the AWS account for pushing the audit trails
98+
from Palette.
99+
- **Stream (Optional)**: CloudWatch log stream for audit trail creation.
100+
101+
5. Select **Confirm** to complete the audit trail configuration. Audit trails can be edited and deleted using the
102+
**three-dot Menu**.
105103

106104
## Resources
107105

108106
- [Kubernetes API parameters](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/)
109107

110108
- [Kubernetes Auditing Documentation](https://kubernetes.io/docs/tasks/debug/debug-cluster/audit/)
111-
112-
<br />

0 commit comments

Comments
 (0)