Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(audit-trail): add audit trail documentation #3970

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat(audit-trail): add audit trail documentation #3970

wants to merge 9 commits into from

Conversation

nerda-codes
Copy link
Contributor

Index page
Concepts
How-Tos
FAQ
Reference content (Product integration with Audit Trail)
Troubleshooting
Menu

The product icon in the menu is missing, will update here again when it is available. (need to update in menu and FAQ)

@nerda-codes nerda-codes added type: new content New pages or categories do not merge PR that shouldn't be merged before a specific date (eg release) status: tech review Waiting for technical review labels Nov 13, 2024
@nerda-codes nerda-codes self-assigned this Nov 13, 2024
crlptl
crlptl reviewed Nov 14, 2024
View reviewed changes
faq/audit-trail.mdx Outdated Show resolved Hide resolved
crlptl
crlptl reviewed Nov 14, 2024
View reviewed changes
faq/audit-trail.mdx Outdated Show resolved Hide resolved
crlptl
crlptl reviewed Nov 14, 2024
View reviewed changes
Copy link
Contributor

@crlptl crlptl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for all the work!
I've let some comments but overall I'm happy with the doc.

nerda-codes
nerda-codes commented Nov 14, 2024
View reviewed changes
identity-and-access-management/audit-trail/how-to/configure-audit-trail-permissions.mdx
5. Click **Validate**.
6. Click **Create policy**.

## Configure Audit Trail access via the IAM Administrator group
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Configure Audit Trail access via the IAM Administrator group
## Configure Audit Trail access via the IAM Administrators group

nerda-codes
nerda-codes commented Nov 14, 2024
View reviewed changes
identity-and-access-management/audit-trail/concepts.mdx

## Event

An event is a record of any activity related to your Scaleway resources, encompassing actions by users, applications, or Scaleway itself.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
An event is a record of any activity related to your Scaleway resources, encompassing actions by users, applications, or Scaleway itself.
An event is a record of any activity related to your Scaleway resources, encompassing actions by users, applications, or Scaleway.

ojroques
ojroques approved these changes Nov 19, 2024
View reviewed changes
identity-and-access-management/audit-trail/concepts.mdx

An event is a record of any activity related to your Scaleway resources, encompassing actions by users, applications, or Scaleway itself.

## Location
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that the official term for Projects and Organizations ? Otherwise I would suggest Scope because Location may be confused with a geographical location.

luxifer
luxifer reviewed Nov 19, 2024
View reviewed changes
identity-and-access-management/audit-trail/concepts.mdx
Comment on lines +43 to +45
- `200`: this means that the API request was executed.

- `500`: this means that the API request has failed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add the 403 status for permission denied

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we want to document 500 because these are for internal server error, where the error occurs on the Scaleway servers due to a bug or an incident.

identity-and-access-management/audit-trail/how-to/use-audit-trail.mdx
## How to use Audit Trail

1. Click **Audit Trail** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
2. Click the **Region** dop-down and select a region in which you have created resources integrated with Audit Trail. Your Audit Trail events should display.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Click the **Region** dop-down and select a region in which you have created resources integrated with Audit Trail. Your Audit Trail events should display.
2. Click the **Region** drop-down and select a region in which you have created resources integrated with Audit Trail. Your Audit Trail events should display.

identity-and-access-management/audit-trail/how-to/use-audit-trail.mdx
3. Click the **Date range** field and select a date range to track events for.
4. Click the **Project** drop-down and select the Scaleway Project containing the resources you want to track.
5. Click the **Method** drop-down and select the API method you want to track events for.
6. Click the **Status** drop-down and select either **200** or **500** to view successful or failed requests.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
6. Click the **Status** drop-down and select either **200** or **500** to view successful or failed requests.
6. Click the **Status** drop-down and select either **200** or **403** to view successful or failed requests.

identity-and-access-management/audit-trail/quickstart.mdx
3. Click the **Date range** field and select a date range to track events for.
4. Click the **Project** drop-down and select the Scaleway Project containing the resources you want to track.
5. Click the **Method** drop-down and select the API method you want to track events for.
6. Click the **Status** drop-down and select either **200** or **500** to view successful or failed requests.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
6. Click the **Status** drop-down and select either **200** or **500** to view successful or failed requests.
6. Click the **Status** drop-down and select either **200** or **403** to view successful or failed requests.

identity-and-access-management/audit-trail/reference-content/resource-integration-with-adt.mdx
@@ -0,0 +1,72 @@
---
meta:
title: Audit Trail resource integration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe product instead of resource?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crlptl crlptl crlptl left review comments

@luxifer luxifer luxifer left review comments

@ojroques ojroques ojroques approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees

@nerda-codes nerda-codes

Labels
do not merge PR that shouldn't be merged before a specific date (eg release) status: tech review Waiting for technical review type: new content New pages or categories
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nerda-codes @luxifer @ojroques @crlptl