Skip to content

Commit 441dae0

Browse files
nerda-codesRoRoJ
nerda-codes
authored and
RoRoJ
committed
docs(audit-trail): add new product integration & supported endpoints (#4670)
1 parent 3aafa0d commit 441dae0

7 files changed

+163
-9
lines changed

‎macros/audit-trail/iam-endpoints.mdx

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
macro: adt-iam-endpoints
3+
---
4+
5+
<Concept>
6+
## IAM
7+
8+
### IAM supported endpoints
9+
10+
The following IAM endpoints are supported and will be logged in Audit Trail:
11+
12+
- CreateSSHKey (`POST /iam/v1alpha1/ssh-keys`)
13+
- UpdateSSHKey (`PATCH /iam/v1alpha1/ssh-keys/{ssh_key_id}`)
14+
- DeleteSSHKey (`DELETE /iam/v1alpha1/ssh-keys/{ssh_key_id}`)
15+
- CreateGroup (`POST /iam/v1alpha1/groups`)
16+
- UpdateGroup (`PATCH /iam/v1alpha1/groups/{group_id}`)
17+
- DeleteGroup (`DELETE /iam/v1alpha1/groups/{group_id}`)
18+
- AddGroupMember (`POST /iam/v1alpha1/groups/{group_id}/add-member`)
19+
- AddGroupMembers (`POST /iam/v1alpha1/groups/{group_id}/add-members`)
20+
- SetGroupMembers (`PUT /iam/v1alpha1/groups/{group_id}/members`)
21+
- RemoveGroupMember (`POST /iam/v1alpha1/groups/{group_id}/remove-member`)
22+
- CreateAPIKey (`POST /iam/v1alpha1/api-keys`)
23+
- UpdateAPIKey (`PATCH /iam/v1alpha1/api-keys/{access_key}`)
24+
- DeleteAPIKey (`DELETE /iam/v1alpha1/api-keys/{access_key}`)
25+
- CreateUser (`POST /iam/v1alpha1/users`)
26+
- UpdateUser (`PATCH /iam/v1alpha1/users/{user_id}`)
27+
- DeleteUser (`DELETE /iam/v1alpha1/users/{user_id}`)
28+
- LockMember (`POST /iam/v1alpha1/users/{user_id}/lock`)
29+
- CreateMFAOTP (`POST /iam/v1alpha1/users/{user_id}/mfa-otp`)
30+
- DeleteMFAOTP (`DELETE /iam/v1alpha1/users/{user_id}/mfa-otp`)
31+
- UnlockMember (`POST /iam/v1alpha1/users/{user_id}/unlock`)
32+
- UpdateUserPassword (`POST /iam/v1alpha1/users/{user_id}/update-password`)
33+
- UpdateUserUsername (`POST /iam/v1alpha1/users/{user_id}/update-username`)
34+
- ValidateMFAOTP (`POST /iam/v1alpha1/users/{user_id}/validate-mfa-otp`)
35+
- CreateApplication (`POST /iam/v1alpha1/applications`)
36+
- UpdateApplication (`PATCH /iam/v1alpha1/applications/{application_id}`)
37+
- DeleteApplication (`DELETE /iam/v1alpha1/applications/{application_id}`)
38+
- CreatePolicy (`POST /iam/v1alpha1/policies`)
39+
- UpdatePolicy (`PATCH /iam/v1alpha1/policies/{policy_id}`)
40+
- DeletePolicy (`DELETE /iam/v1alpha1/policies/{policy_id}`)
41+
- ClonePolicy (`POST /iam/v1alpha1/policies/{policy_id}/clone`)
42+
- SetRules (`PUT /iam/v1alpha1/rules`)
43+
</Concept>

‎macros/audit-trail/key-manager-endpoints.mdx

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
macro: adt-key-manager-endpoints
3+
---
4+
5+
<Concept>
6+
## Key Manager
7+
8+
### Key Manager supported endpoints
9+
10+
The following Key Manager endpoints are supported and will be logged in Audit Trail:
11+
12+
- CreateKey (`POST /key-manager/v1alpha1/regions/{region}/keys`)
13+
- UpdateKey (`PATCH /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
14+
- DeleteKey (`DELETE /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
15+
- ProtectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/protect`)
16+
- UnprotectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/unprotect`)
17+
- RotateKey (Manual rotation) (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/rotate`)
18+
- DisableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/disable`)
19+
- EnableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/enable`)
20+
- ImportKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/import-key-material`)
21+
- DeleteKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/delete-key-material`)
22+
</Concept>

‎macros/audit-trail/kubernetes-endpoints.mdx

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
macro: adt-kubernetes-endpoints
3+
---
4+
5+
<Concept>
6+
## Kubernetes
7+
8+
### Kubernetes supported endpoints
9+
10+
The following Kubernetes endpoints are supported and will be logged in Audit Trail:
11+
12+
- Create a new cluster (`POST /k8s/v1/regions/{region}/clusters`)
13+
- Update a cluster (`PATCH /k8s/v1/regions/{region}/clusters/{cluster_id}`)
14+
- Delete a cluster (`DELETE /k8s/v1/regions/{region}/clusters/{cluster_id}`)
15+
- Migrate a cluster to SBS CSI (`POST /k8s/v1/regions/{region}/clusters/{cluster_id}/migrate-to-sbs-csi`)
16+
- Reset the admin token of a cluster (`POST /k8s/v1/regions/{region}/clusters/{cluster_id}/reset-admin-token`)
17+
- Change the cluster type (`POST /k8s/v1/regions/{region}/clusters/{cluster_id}/set-type`)
18+
- Upgrade a cluster (`POST /k8s/v1/regions/{region}/clusters/{cluster_id}/upgrade`)
19+
- Create a new pool in a cluster (`POST /k8s/v1/regions/{region}/clusters/{cluster_id}/pools`)
20+
- Update a pool in a cluster (`PATCH /k8s/v1/regions/{region}/pools/{pool_id}`)
21+
- Delete a pool in a cluster (`DELETE /k8s/v1/regions/{region}/pools/{pool_id}`)
22+
- Upgrade a pool in a cluster (`POST /k8s/v1/regions/{region}/pools/{pool_id}/upgrade`)
23+
- Delete a node in a cluster (`DELETE /k8s/v1/regions/{region}/nodes/{node_id}`)
24+
- Reboot a node in a cluster (`POST /k8s/v1/regions/{region}/nodes/{node_id}/reboot`)
25+
- Create a Kosmos node (`POST /k8s/v1/regions/{region}/pools/{pool_id}/external-nodes`)
26+
- Delete an existing ACL (`DELETE /k8s/v1/regions/{region}/acls/{acl_id}`)
27+
- Add new ACLs (`POST /k8s/v1/regions/{region}/clusters/{cluster_id}/acls`)
28+
- Set new ACLs (`PUT /k8s/v1/regions/{region}/clusters/{cluster_id}/acls`)
29+
30+
### Additional information
31+
32+
IP addresses are not logged in Audit Trail for Kubernetes events due to security considerations.
33+
</Concept>

‎macros/audit-trail/secret-manager-endpoints.mdx

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
macro: adt-secret-manager-endpoints
3+
---
4+
5+
<Concept>
6+
## Secret Manager
7+
8+
### Secret Manager supported endpoints
9+
10+
The following Secret Manager endpoints are supported and will be logged in Audit Trail:
11+
12+
- Create a secret (`POST /secret-manager/v1beta1/regions/{region}/secrets`)
13+
- Update metadata of a secret (`PATCH /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}`)
14+
- Delete a secret (`DELETE /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}`)
15+
- Allow a product to use the secret (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/add-owner`)
16+
- Enable secret protection (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/protect`)
17+
- Disable secret protection (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/unprotect`)
18+
- Create a version (`/secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions`)
19+
- Update metadata of a version (`PATCH /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}`)
20+
- Delete a version (`DELETE /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}`)
21+
- Disable a version (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}/disable`)
22+
- Enable a version (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}/disable`)
23+
</Concept>

‎menu/navigation.json

+4
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,10 @@
514514
{
515515
"label": "Audit Trail product integration",
516516
"slug": "resource-integration-with-adt"
517+
},
518+
{
519+
"label": "Supported endpoints for Audit Trail",
520+
"slug": "adt-supported-endpoints"
517521
}
518522
],
519523
"label": "Additional Content",

‎pages/audit-trail/reference-content/adt-supported-endpoints.mdx

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
meta:
3+
title: Supported endpoints for Audit Trail
4+
description: Discover current Scaleway product integrations and endpoints supported in Audit Trail for event tracking.
5+
content:
6+
h1: Supported endpoints for Audit Trail
7+
paragraph: Discover current Scaleway product integrations and endpoints supported in Audit Trail for event tracking.
8+
tags: audit-trail product-integration products endpoints
9+
dates:
10+
validation: 2025-03-27
11+
posted: 2025-03-27
12+
categories:
13+
- identity-and-access-management
14+
---
15+
16+
This page provides information on the specific endpoints logged in [Audit Trail](/audit-trail/) for Scaleway products. Refer to the [dedicated documentation](/audit-trail/reference-content/resource-integration-with-adt/) for a list of Scaleway products integrated with Audit Trail.
17+
18+
19+
<Macro id="adt-iam-endpoints" />
20+
21+
22+
<Macro id="adt-key-manager-endpoints" />
23+
24+
25+
<Macro id="adt-kubernetes-endpoints" />
26+
27+
28+
<Macro id="adt-secret-manager-endpoints" />

‎pages/audit-trail/reference-content/resource-integration-with-adt.mdx

+10-9
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Discover current and planned Scaleway product integrations with Audit Trail for event tracking.
88
tags: audit-trail product-integration scaleway-resources
99
dates:
10-
validation: 2024-11-28
10+
validation: 2025-03-27
1111
posted: 2024-11-28
1212
categories:
1313
- identity-and-access-management
@@ -17,19 +17,21 @@ The following table provides details about the Scaleway products that are integr
1717

1818
## Product integration available
1919

20-
| **Product Name** | **Audit Trail Integration** |
21-
|----------------------------|---------------------------------|
22-
| Secret Manager | **Integrated** |
20+
| **Product name** | **Audit Trail integration** | **Supported endpoints** |
21+
|----------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
22+
| IAM | **Integrated** | Refer to the [dedicated documentation](/audit-trail/reference-content/adt-supported-endpoints/#iam) to find out which IAM endpoints are supported.|
23+
| Key Manager | **Integrated** | Refer to the [dedicated documentation](/audit-trail/reference-content/adt-supported-endpoints/#key-manager) to find out which Key Manager endpoints are supported.|
24+
| Kubernetes | **Integrated** | Refer to the [dedicated documentation](/audit-trail/reference-content/adt-supported-endpoints/#kubernetes) to find out which Kubernetes endpoints are supported.|
25+
| Secret Manager | **Integrated** | Refer to the [dedicated documentation](/audit-trail/reference-content/adt-supported-endpoints/#secret-manager) to find out which Secret Manager endpoints are supported.|
26+
2327

24-
## Planned product integration
28+
## Planned product integration
2529

2630
The following table provides details about the Scaleway products that will be integrated with Audit Trail.
2731

2832

29-
| **Product Name** | **Audit Trail Integration** |
33+
| **Product name** | **Audit Trail integration** |
3034
|----------------------------|---------------------------------|
31-
| Kubernetes | **Not integrated yet** |
32-
| IAM | **Not integrated yet** |
3335
| Object Storage | **Not integrated yet** |
3436
| Billing | **Not integrated yet** |
3537
| Account | **Not integrated yet** |
@@ -49,7 +51,6 @@ The following table provides details about the Scaleway products that will be in
4951
| InterLink | **Not integrated yet** |
5052
| IoT Hub | **Not integrated yet** |
5153
| IPAM | **Not integrated yet** |
52-
| Key Manager | **Not integrated yet** |
5354
| Labs | **Not integrated yet** |
5455
| Load Balancers | **Not integrated yet** |
5556
| Managed Databases | **Not integrated yet** |

0 commit comments

Comments
 (0)