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.

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

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

Merged
merged 16 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions faq/audit-trail.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
meta:
title: Audit Trail FAQ
description: Get answers on using Scaleway's Audit Trail to monitor events, enhance security, and track activities across your resources
content:
h1: Audit Trail
hero: assets/iam.webp
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
dates:
validation: 2024-11-26
category: identity-and-access-management
---

## What is Audit Trail?

Audit Trail is a tool that holds a record of events and changes performed within a Scaleway Organization.

## Why do I need Audit Trail?

Audit Trail helps you ensure accountability and security by recording who did what and when within your Scaleway Organization. It tracks activity across all your resources (identity of the principal, date of activity, source IP address, API method used, and status of the request).

You can use Audit Trail for troubleshooting, compliance verification, and analysis in the event of a breach.

## How am I billed for using Audit Trail?

Audit Trail is free of charge during Beta.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
## Which Scaleway resources are integrated with Audit Trail?

During Beta, only Secret Manager and Kubernetes are integrated with Audit Trail. Refer to the [dedicated documentation](/identity-and-access-management/audit-trail/reference-content/product-integration-with-adt/) to find out more about product integration with Audit Trail.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
45 changes: 45 additions & 0 deletions identity-and-access-management/audit-trail/concepts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
meta:
title: Audit Trail - Concepts
description: Learn fundamental concepts of Scaleway's Audit Trail.
content:
h1: Concepts
paragraph: Learn fundamental concepts of Scaleway's Audit Trail.
tags: audit-trail log events access
dates:
validation: 2024-11-26
---

## Audit Trail

Audit Trail is a tool that holds a record of events and changes performed within a Scaleway Organization. Audit Trail allows you to keep track of all actions, whether successful, attempted, or failed, perfomed on your Scaleway resources.

With Audit Trail you can view [actions](/identity-and-access-management/audit-trail/concepts/#action) taken by any [principal](/identity-and-access-management/iam/concepts/#principal) in any Project and on any of your Scaleway resources. You can also see the API methods used, the outcome of the action performed (status), and the IP adress from which a principal performed an action.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

Audit Trail allows you to view the metadata of the API method used, allowing you to investigate incidents and troubleshoot issues.

## Event

An event is a log of user activity on your Scaleway resources.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

## Locacion
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

In the context of Audit Trail, location refers to the place where the Scaleway resources being monitored are located. They can be located in different Scaleway Projects, or Organizations.

nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
## Method

A method in the context of Audit Trail is the API call sent to the Audit Trail API whenever a principal takes an action (whether successful, attempted, or failed) on any Scaleway resource.

## Region

A region is the geographical area in which your resources are located. They are duplicated on all [Availability Zones](/compute/instances/concepts/#availability-zone) of the selected region (Paris, Amsterdam, or Warsaw).
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

Audit Trail allows you to select your resources by region. This allows you to better sort through your resources.

## Status
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

A status is the API response returned whenever an action was taken on a resource by a principal. There are two statuses:

- Successful: this means that the API request was executed.

- Failed: this means that the API request has failed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
meta:
title: How to configure the Audit Trail permission set
description: Learn how to configure IAM permissions for accessing Scaleway's Audit Trail, enabling event tracking across Organizations and Projects.
content:
h1: How to configure the Audit Trail permission set
paragraph: Learn how to configure IAM permissions for accessing Scaleway's Audit Trail, enabling event tracking across Organizations and Projects.
tags: audit-trail events tracking iam permissions
dates:
validation: 2024-11-26
posted: 2024-11-26
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
categories:
- identity-and-access-management
---

This page teaches you how to configure the necessary permission set to access [Audit Trail](/identity-and-access-management/audit-trail/concepts/#audit-trail).

## How to configure the Audit Trail permission set

To start using Audit Trail you need to configure the `AuditTrailReadOnly` permission set in [IAM](/identity-and-access-management/iam/concepts/#iam). The [scope](/identity-and-access-management/iam/concepts/#scope) of this permission set is at [Organization](/identity-and-access-management/iam/concepts/#organization) level.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

1. Click **Identity and Access Management (IAM)** from the top-right of your [**Organization Dashboard**](https://console.scaleway.com/organization) in the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays.
2. [Create an IAM policy](/identity-and-access-management/iam/how-to/create-policy/) and perform steps one to five.
3. Select the **Access to Organization features** scope and click **Validate** to move on to the next step.
<Message type="important">
The **Access to Organization features** scope allows you to give the [principal](/identity-and-access-management/iam/concepts/#principal) permissions to Organization-level features such as IAM, Audit Trail, billing, support and abuse tickets, and project management.
</Message>
4. Click the **Security and Identity** category in the **Products** section, then choose the **AuditTrailReadOnly** permission set.
5. Click **Validate**.
6. Click **Create policy**.

You now have access to Audit Trail.
8 changes: 8 additions & 0 deletions identity-and-access-management/audit-trail/how-to/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
meta:
title: Audit Trail - How Tos
description: Audit Trail How Tos
content:
h1: How Tos
paragraph: Audit Trail How Tos
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
meta:
title: How to use Audit Trail
description: Learn to view and filter events in Scaleway's Audit Trail by region, date, project, method, and status for effective resource tracking.
content:
h1: How to use Audit Trail
paragraph: Learn to view and filter events in Scaleway's Audit Trail by region, date, project, method, and status for effective resource tracking.
tags: audit-trail events track filter
dates:
validation: 2024-11-26
posted: 2024-11-26
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
categories:
- identity-and-access-management
---

This page shows you how to see and filter events for your Scaleway resources in Audit Trail.

## 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.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
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 **Successful** or **Failed**.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
7. Optionally, click **Reset** to reset the filter.

<Message type="tip">
If no events display after you use the filter, try switching the region from the **Region** drop-down, or adjusting your search.
</Message>
61 changes: 61 additions & 0 deletions identity-and-access-management/audit-trail/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
meta:
title: Audit Trail Documentation
description: Dive into Scaleway Audit Trail with our quickstart guides, how-tos, and more.
---

<ProductHeader
productName="Audit Trail"
productLogo="auditTrail"
description="Audit Trail allows you to keep track of the activity of your Scaleway resources."
url="/identity-and-access-management/audit-trail/quickstart/"
label="Audit Trail Quickstart"
/>

## Getting Started

<Grid>
<SummaryCard
title="Quickstart"
icon="rocket"
description="Learn how to track user activity, access events, and system changes in a few steps."
label="View Quickstart"
url="/identity-and-access-management/audit-trail/quickstart/"
/>
<SummaryCard
title="Concepts"
icon="info"
description="Core concepts that give you a better understanding of Audit Trail."
label="View Concepts"
url="/identity-and-access-management/audit-trail/concepts/"
/>
<SummaryCard
title="How-Tos"
icon="help-circle-outline"
description="Learn how to use Audit Trail via the Scaleway console."
label="View How-Tos"
url="/identity-and-access-management/audit-trail/how-to/"
/>
<SummaryCard
title="Additional Content"
icon="book-open-outline"
description="Check out in-depth information about Audit Trail."
label="View Additional Content"
url="/identity-and-access-management/audit-trail/reference-content/"
/>
</Grid>

<ClickableBanner
productLogo="cli"
title="Audit Trail API"
description="Manage Audit Trail using the Scaleway API."
url="https://www.scaleway.com/en/developers/api/audit-trail/"
label="Go to Audit Trail API"
/>

## Changelog

<ChangelogList
productName="audit-trail"
numberOfChanges={3}
/>
52 changes: 52 additions & 0 deletions identity-and-access-management/audit-trail/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
meta:
title: Audit Trail - Quickstart
description: Quickly set up and start using Scaleway’s Audit Trail. Follow steps to configure permissions and track events across regions and projects.
content:
h1: Audit Trail - Quickstart
paragraph: Quickly set up and start using Scaleway’s Audit Trail. Follow steps to configure permissions and track events across regions and projects.
dates:
validation: 2024-11-26
posted: 2024-11-26
---

In this quickstart, we show you how to start using [Audit Trail](/identity-and-access-management/audit-trail/concepts/#audit-trail).

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- Created resources integrated with Audit Trail
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

## How to configure the Audit Trail permission set

To start using Audit Trail you need to configure the `AuditTrailReadOnly` permission set in [IAM](/identity-and-access-management/iam/concepts/#iam). The [scope](/identity-and-access-management/iam/concepts/#scope) of this permission set is at [Organization](/identity-and-access-management/iam/concepts/#organization) level.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved

1. Click **Identity and Access Management (IAM)** from the top-right of your [**Organization Dashboard**](https://console.scaleway.com/organization) in the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays.
2. [Create an IAM policy](/identity-and-access-management/iam/how-to/create-policy/) and perform steps one to five.
3. Select the **Access to Organization features** scope and click **Validate** to move on to the next step.
<Message type="important">
The **Access to Organization features** scope allows you to give the [principal](/identity-and-access-management/iam/concepts/#principal) permissions to Organization-level features such as IAM, Audit Trail, billing, support & abuse tickets, and project management.
</Message>
4. Click the **Security and Identity** category in the **Products** section, then choose the **AuditTrailReadOnly** permission set.
5. Click **Validate**.
6. Click **Create policy**.

You now have access to Audit Trail.

## 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.
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
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 **Successful** or **Failed**.
7. Optionally, click **Reset** to reset the filter.

<Message type="tip">
If no events display after you use the filter, try switching the region from the **Region** drop-down, or adjusting your search.
</Message>
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved



Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
meta:
title: Audit Trail resource integration
description: Discover current and planned Scaleway resource integrations with Audit Trail for event tracking.
content:
h1: Audit Trail resource integration
paragraph: Discover current and planned Scaleway resource integrations with Audit Trail for event tracking.
tags: audit-trail product-integration scaleway-resources
dates:
validation: 2024-11-26
posted: 2024-11-26
categories:
- identity-and-access-management
---

The following table provides details about the Scaleway resources that are integrated with Audit Trail.

## Resource integration available

| **Product Name** | **Audit Trail Integration** |
|----------------------------|---------------------------------|
| Secret Manager | **Integrated** |
| Kubernetes | **Integrated** |

## Resource integration planned

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


| **Product Name** | **Audit Trail Integration** |
|----------------------------|---------------------------------|
| IAM | **Planned** |
| Object Storage | **Planned** |
| Billing | **Planned** |
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
| Account | **Not integrated yet** |
| Apple Silicon | **Not integrated yet** |
| Block Storage | **Not integrated yet** |
| Cockpit | **Not integrated yet** |
| Container Registry | **Not integrated yet** |
| Distributed Data Lab | **Not integrated yet** |
| Domains and DNS | **Not integrated yet** |
| Edge Services | **Not integrated yet** |
| Elastic Metal | **Not integrated yet** |
| Environmental Footprint | **Not integrated yet** |
| Generative APIs | **Not integrated yet** |
| GPU Instances | **Not integrated yet** |
| Instances | **Not integrated yet** |
| Instance Scaling Group | **Not integrated yet** |
| InterLink | **Not integrated yet** |
| IoT Hub | **Not integrated yet** |
| IPAM | **Not integrated yet** |
| Key Manager | **Not integrated yet** |
| Labs | **Not integrated yet** |
| Load Balancers | **Not integrated yet** |
| Managed Databases | **Not integrated yet** |
| Managed Inference | **Not integrated yet** |
| NATS | **Not integrated yet** |
| NFS | **Not integrated yet** |
| Organizations and Projects | **Not integrated yet** |
| Partners | **Not integrated yet** |
| Private Networks | **Not integrated yet** |
| Public Gateways | **Not integrated yet** |
| Queues | **Not integrated yet** |
| Serverless Containers | **Not integrated yet** |
| Serverless Functions | **Not integrated yet** |
| Serverless Jobs | **Not integrated yet** |
| Serverless SQL Databases | **Not integrated yet** |
| Service Catalog | **Not integrated yet** |
| Topics and Events | **Not integrated yet** |
| Transactional Email | **Not integrated yet** |
| VPC | **Not integrated yet** |
| Web Hosting | **Not integrated yet** |
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
meta:
title: I cannot see any events in Audit Trail
description: Troubleshoot missing events in Scaleway's Audit Trail. Ensure permissions, resource setup, and correct region to view your Audit Trail events.
h1: I cannot see any events in Audit Trail
paragraph: Troubleshoot missing events in Scaleway's Audit Trail. Ensure permissions, resource setup, and correct region to view your Audit Trail events.
tags: audit-trail events debug troubleshoot
dates:
validation: 2024-11-26
posted: 2024-11-26
nerda-codes marked this conversation as resolved.
Show resolved Hide resolved
categories:
- identity-and-access-management
---

This page provides information on what to do if you cannot find any events in Audit Trail.


## Problem

I cannot see any events in Audit Trail.

## Possible solutions

- Make sure that you have the [permision set necessary to access Audit Trail](/identity-and-access-management/audit-trail/how-to/configure-audit-trail-permissions). If you are not an IAM manager, contact your IAM manager to ask for Audit Trail access.

- Make sure you have created Scaleway resources to see events in Audit Trail.

- Make sure that the events you are looking for are from Scaleway resources that are integrated with Audit Trail.

- Make sure that you are looking for the desired events in the **right** region. Switch regions in the **Region** drop-down and look for the desired events again.
Loading
Loading