Skip to content

Commit 1a4bafb

Browse files
authored
docs(sem): add secret deletion (#4851)
1 parent ac9c043 commit 1a4bafb

File tree

7 files changed

+125
-22
lines changed

7 files changed

+125
-22
lines changed

menu/navigation.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -576,12 +576,20 @@
576576
"slug": "manage-version"
577577
},
578578
{
579-
"label": "Delete a secret",
579+
"label": "Schedule a secret deletion",
580580
"slug": "delete-secret"
581581
},
582582
{
583-
"label": "Delete a version",
583+
"label": "Schedule a version deletion",
584584
"slug": "delete-version"
585+
},
586+
{
587+
"label": "Recover secrets scheduled for deletion",
588+
"slug": "recover-secrets"
589+
},
590+
{
591+
"label": "Recover a version scheduled for deletion",
592+
"slug": "recover-version"
585593
}
586594
],
587595
"label": "How to",

pages/secret-manager/concepts.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Discover essential concepts of Scaleway Secret Manager, including secret versioning, ephemeral policies, and path management.
88
tags: secret-manager secret version
99
dates:
10-
validation: 2025-01-13
10+
validation: 2025-04-15
1111
---
1212

1313
## Disabling a version
@@ -109,12 +109,18 @@ Secret types refer to the different kinds of sensitive data you can store with S
109109

110110
Upon secret creation, you must choose a secret type that will also be applied to the secret version. All the secret's subsequent versions must be of the same type.
111111

112+
## Scheduled deletion
113+
114+
Scheduled deletion lets you mark a secret and its versions for deletion ahead of time. Instead of immediate deletion, the secret enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-secrets/).
115+
116+
During this time, you can read secret versions but cannot edit, access, or delete them. After the retention period, the secret and all its versions are permanently deleted. You can also schedule a secret version for deletion without impacting the secret associated with the version.
117+
118+
Recovering deleted secrets is billed €0.01 per version associated with the secret.
119+
112120
## Tag
113121

114122
Tags allow you to organize your secrets. This gives you the possibility of sorting and filtering your secrets in any organizational pattern of your choice, which in turn helps you arrange, control, and monitor your secrets.
115123

116124
## Version
117125

118-
Versions store the data contained in your secret (API keys, passwords, or certificates). Versions can be [**enabled**](#enabling-a-version) or [**disabled**](#disabling-a-version) depending on your usage. Versions must be of the same type as the secret they belong to.
119-
120-
126+
Versions store the data contained in your secret (API keys, passwords, or certificates). Versions can be [**enabled**](#enabling-a-version) or [**disabled**](#disabling-a-version) depending on your usage. Versions must be of the same type as the secret they belong to.

pages/secret-manager/faq.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ meta:
55
content:
66
h1: Secret Manager FAQ
77
dates:
8-
validation: 2025-04-01
8+
validation: 2025-04-15
99
category: identity-and-access-management
1010
productIcon: SecretManagerProductIcon
1111
---
@@ -40,3 +40,5 @@ To understand the secrets encryption process, refer to our [related documentatio
4040
At the end of the month, you are billed for the number of secret versions stored and API requests made on the service.
4141
A secret version is billed if it is in an enabled or disabled state.
4242
If, for example, you have used a secret version for five days, you will only be billed for the five days and not for the whole month. Find out more about pricing on our [dedicated page](https://www.scaleway.com/en/pricing/?tags=available).
43+
44+
Recovering secrets [scheduled for deletion](/secret-manager/concepts/#scheduled-deletion) is billed €0.01 per version associated with the secret.

pages/secret-manager/how-to/delete-secret.mdx

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,17 @@ meta:
55
content:
66
h1: How to delete a secret
77
paragraph: Discover how to securely delete secrets using Scaleway's intuitive console. Follow these steps to manage your sensitive data effectively.
8-
tags: secret sensitive-data storage-system
8+
tags: secret sensitive-data storage-system schedule-deletion
99
dates:
10-
validation: 2025-03-14
10+
validation: 2025-04-15
1111
posted: 2023-02-21
1212
categories:
1313
- identity-and-access-management
1414
---
1515

16-
This page explains how to delete a [secret](/secret-manager/concepts/#secret) using the [Scaleway console](https://console.scaleway.com). You **cannot delete protected secrets**, i.e. secrets to which you have applied [secret protection](/secret-manager/concepts/#secret-protection).
16+
This page explains how to [schedule a secret deletion](/secret-manager/concepts/#scheduled-deletion) using the [Scaleway console](https://console.scaleway.com). You **cannot delete protected secrets**, i.e. secrets to which you have applied [secret protection](/secret-manager/concepts/#secret-protection).
17+
18+
Once you schedule a secret for deletion, it enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-secrets/). After this retention period, the secret and all its versions are permanently deleted.
1719

1820
<Macro id="requirements" />
1921

@@ -25,13 +27,10 @@ This page explains how to delete a [secret](/secret-manager/concepts/#secret) us
2527

2628
1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
2729
2. Select the [region](/secret-manager/concepts/#region) in which to delete the secret, in the **Region** drop-down.
28-
3. Access the secret you wish to delete. The secret's **Overview** tab displays.
29-
4. Scroll down and click **Delete secret**. A pop-up displays.
30-
5. Type **DELETE** and click **Delete secret**.
30+
3. Click <Icon name="more" /> next to the secret you want to delete and click **Delete**. A pop-up displays informing you that the action schedules the deletion of your secret and its version.
31+
4. Type **DELETE** and click **Delete secret** to confirm. Your secret displays in the **Scheduled for deletion** tab for a period of 7 days before being permanently deleted.
3132

3233
<Message type="important">
33-
- Although you cannot delete a [protected secret](/secret-manager/concepts/#secret-protection), you can delete its versions
34-
- Deleting a secret is a permanent action. It erases every version you have created for your secret
34+
- Although you cannot delete a [protected secret](/secret-manager/concepts/#secret-protection), you can delete its versions.
35+
- Deleting a secret is a permanent action. It erases every version you have created for your secret if you do not [recover it](/secret-manager/how-to/recover-secrets/) before the end of the retention period.
3536
</Message>
36-
37-

pages/secret-manager/how-to/delete-version.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ content:
77
paragraph: Learn how to securely delete versions of secrets using the Scaleway console. Follow these steps to effectively manage your sensitive data.
88
tags: sensitive-data storage-system api-key
99
dates:
10-
validation: 2025-03-14
10+
validation: 2025-04-15
1111
posted: 2023-02-21
1212
categories:
1313
- identity-and-access-management
1414
---
1515

16-
This page explains how to delete a secret [version](/secret-manager/concepts/#version) using the [Scaleway console](https://console.scaleway.com).
16+
This page explains how to [schedule](/secret-manager/concepts/#scheduled-deletion) a [version](/secret-manager/concepts/#version) deletion using the [Scaleway console](https://console.scaleway.com).
17+
18+
Once you schedule a version for deletion, it enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-version/). After this retention period, the version is permanently deleted.
1719

1820
<Macro id="requirements" />
1921

@@ -27,11 +29,11 @@ This page explains how to delete a secret [version](/secret-manager/concepts/#ve
2729
3. Access the secret for which you want to delete the version. Your secret's **Overview** tab displays.
2830
4. Click the **Versions** tab.
2931
5. Click <Icon name="more" /> next to the version you want to delete.
30-
6. Click **Delete**. A pop-up displays.
31-
7. Type **DELETE** and click **Delete version**.
32+
6. Click **Delete**. A pop-up displays informating you that the action schedules the deletion of your version.
33+
7. Type **DELETE** and click **Delete version**. Your version enters the **Scheduled for deletion** status for a period of 7 days before being permanently deleted.
3234

3335
<Message type="important">
34-
Deleting a version is permanent. You will not be able to use the version again.
36+
Deleting a version is permanent. You will not be able to use the version again if you do not [recover it](/secret-manager/how-to/recover-version/) before the end of the retention period.
3537
</Message>
3638

3739

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
meta:
3+
title: How to recover secrets scheduled for deletion
4+
description: Recover secrets scheduled for deletion in the Scaleway console before they are permanently removed.
5+
content:
6+
h1: How to recover secrets scheduled for deletion
7+
paragraph: Recover secrets scheduled for deletion in the Scaleway console before they are permanently removed.
8+
tags: secret sensitive-data scheduled-deletion recover-secret
9+
dates:
10+
validation: 2025-04-15
11+
posted: 2025-04-15
12+
categories:
13+
- identity-and-access-management
14+
---
15+
16+
This page shows you how to recover secrets scheduled for deletion using the Scaleway [console](https://console.scaleway.com). Once you schedule a secret for deletion, it enters a 7-day pending deletion period, during which you can still recover it.
17+
After this retention period, the secret and all its versions are permanently deleted.
18+
19+
<Message type="important">
20+
Scheduled deletion deletes ephemeral secrets and their versions immediately.
21+
</Message>
22+
23+
<Macro id="requirements" />
24+
25+
- A Scaleway account logged into the [console](https://console.scaleway.com)
26+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
27+
- Created a [secret](/secret-manager/how-to/create-secret/)
28+
- Scheduled secrets for deletion
29+
30+
## How to recover one secret
31+
32+
1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
33+
2. Select the [region](/secret-manager/concepts/#region) in which to recover the secret, in the **Region** drop-down.
34+
3. Click the **Scheduled for deletion** tab. Your secrets display.
35+
4. Click <Icon name="more" /> next to the secret you want to recover and click **Recover**. A pop-up displays the estimated cost of recovering the secret.
36+
<Message type="note">
37+
Recovering a secret is billed €0.01 per version associated with the secret.
38+
</Message>
39+
5. Click **Recover secret** to confirm. Your secret displays in the **Secrets** tab.
40+
41+
## How to recover several secrets
42+
43+
1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
44+
2. Select the [region](/secret-manager/concepts/#region) in which to recover the secret, in the **Region** drop-down.
45+
3. Click the **Scheduled for deletion** tab. Your secrets display.
46+
4. Tick the checkbox next to **Name** to select all the secrets you want to recover.
47+
5. Click the circular arrow to recover the selected secrets.
48+
6. Check the estimated cost and click **Recover secrets** to confirm.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
meta:
3+
title: How to recover a version scheduled for deletion
4+
description: Recover a version scheduled for deletion in the Scaleway console before it is permanently removed.
5+
content:
6+
h1: How to recover a version scheduled for deletion
7+
paragraph: Recover a version scheduled for deletion in the Scaleway console before it is permanently removed.
8+
tags: secret sensitive-data scheduled-deletion recover-version
9+
dates:
10+
validation: 2025-04-15
11+
posted: 2025-04-15
12+
categories:
13+
- identity-and-access-management
14+
---
15+
16+
This page shows you how to recover a version scheduled for deletion using the Scaleway [console](https://console.scaleway.com). Once you schedule a version for deletion, it enters a 7-day pending deletion period, during which you can still recover it.
17+
After this retention period, the version is permanently deleted.
18+
19+
<Message type="important">
20+
Scheduled deletion deletes ephemeral secrets and their versions immediately.
21+
</Message>
22+
23+
<Macro id="requirements" />
24+
25+
- A Scaleway account logged into the [console](https://console.scaleway.com)
26+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
27+
- Created a [version](/secret-manager/how-to/create-version/)
28+
- Scheduled a version for deletion
29+
30+
1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
31+
2. Select the [region](/secret-manager/concepts/#region) in which to recover the version, in the **Region** drop-down.
32+
3. Access the secret for which you want to recover the version. Your secret's **Overview** tab displays.
33+
4. Click the **Versions** tab.
34+
5. Click <Icon name="more" /> next to the version you want to recover, and click **Recover**. A pop-up displays the estimated cost of recovering the version.
35+
<Message type="note">
36+
Recovering a version is billed €0.01.
37+
</Message>
38+
6. Click **Recover version** to confirm. You version displays in the **Versions** tab with the same status as before the scheduled deletion.

0 commit comments

Comments
 (0)