Skip to content

Commit 966db40

Browse files
committed
docs(km): add scheduled deletion docs
1 parent 43fd448 commit 966db40

File tree

5 files changed

+69
-8
lines changed

5 files changed

+69
-8
lines changed

menu/navigation.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,8 +501,12 @@
501501
"slug": "disable-km-keys"
502502
},
503503
{
504-
"label": "Delete Key Manager keys",
504+
"label": "Schedule Key Manager keys for deletion",
505505
"slug": "delete-km-keys"
506+
},
507+
{
508+
"label": "Recover keys scheduled for deletion",
509+
"slug": "recover-deleted-keys"
506510
}
507511
],
508512
"label": "How to",

pages/key-manager/concepts.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Key Manager - Concepts
33
description: Explore essential cryptographic concepts, including symmetric and asymmetric encryption, data encryption keys (DEKs), key encryption keys (KEKs), and Scaleway Key Manager's robust features for secure key management and encryption operations.
44
tags: key-manager key encryption-key
55
dates:
6-
validation: 2025-02-06
6+
validation: 2025-07-24
77
---
88

99
## Asymmetric encryption
@@ -141,6 +141,12 @@ A region refers to the **geographical location** in which your key will be creat
141141

142142
A root encryption key (REK) is another type of key that has the single purpose of encrypting and decrypting KEKs in order to store them in hard storage. Scaleway's Key Manager has one REK per region, which is securely stored in our facilities.
143143

144+
## Scheduled deletion
145+
146+
When you delete a key, it is scheduled for deletion. This lets you mark a key and its version for deletion ahead of time. Instead of immediate deletion, the key enters a 7-day pending deletion period, during which you can still recover it.
147+
148+
During this time, you can read your key version but cannot edit, access, or delete it. After the retention period, the key and its version are permanently deleted.
149+
144150
## Symmetric encryption
145151

146152
Symmetric encryption is a fundamental type of cryptographic method where the same key is used to both encrypt and decrypt data. This means that the sender and receiver must have access to the same secret key, which they use to secure their communication.

pages/key-manager/faq.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Key Manager FAQ
33
description: Explore Scaleway Key Manager with our comprehensive FAQ covering security, key types, and more.
44
dates:
5-
validation: 2025-02-06
5+
validation: 2025-07-24
66
productIcon: KmsProductIcon
77
---
88

@@ -35,3 +35,11 @@ Key Manager supports the three following cryptographic operations:
3535
Keys with a [key usage](/key-manager/concepts/#key-usage) set to `symmetric_encryption` are **used to encrypt and decrypt data**.
3636

3737
Refer to our [dedicated documentation](/key-manager/reference-content/understanding-key-manager/) to find out more about Key Manager.
38+
39+
## What happens when I delete a key?
40+
41+
When you delete a key, it is scheduled for deletion. This lets you mark a key and its version for deletion ahead of time. Instead of immediate deletion, the key enters a 7-day pending deletion period, during which you can still recover it.
42+
43+
During this time, you can read your key version but cannot edit, access, or delete it. After the retention period, the key and its version are permanently deleted.
44+
45+
Recovering keys [scheduled for deletion](/key-manager/concepts/#scheduled-deletion) is billed €0.01 per key.
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
2-
title: Delete a Key Manager key
2+
title: Schedule a Key Manager key deletion
33
description: Discover how to delete a Key Manager key from the Scaleway console.
44
tags: key-manager delete key
55
dates:
6-
validation: 2025-02-06
6+
validation: 2025-07-24
77
posted: 2025-02-06
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
1010

1111

12-
This page shows you how to delete a Key Manager key.
12+
This page explains how to [schedule a key deletion](/key-manager/concepts/#scheduled-deletion) using the Scaleway console. You cannot delete protected keys, i.e. keys to which you have applied [key protection](/key-manager/concepts/#key-protection).
13+
14+
Once you schedule a key for deletion, it enters a 7-day pending deletion period, during which you can still recover it. After this retention period, the key and its version are permanently deleted.
1315

1416
<Requirements />
1517

@@ -20,11 +22,12 @@ This page shows you how to delete a Key Manager key.
2022

2123
## How to delete a key
2224

23-
1. Click Key Manager in the **Security and Identity section** of the [Scaleway console](https://console.scaleway.com) side menu. Your keys display.
25+
1. Click Key Manager in the **Security & Identity section** of the [Scaleway console](https://console.scaleway.com) side menu. Your keys display.
2426
2. Click the key you want to delete.
2527
3. Scroll down to the **Delete key** section, and click **Delete key**.
26-
4. Type **DELETE** to confirm and click **Delete key**.
28+
4. Type **DELETE** and click **Delete key** to confirm. Your key displays in the **Scheduled for deletion** tab for a period of 7 days before being permanently deleted.
2729

2830
<Message type="important">
2931
All data encrypted using this key, including data encryption keys, will become unusable.
32+
Deleting a key is a permanent action. All data encrypted using this key, including data encryption keys, will become unusable, if you do not [recover it](/key-manager/how-to/recover-deleted-keys/) before the end of the retention period.
3033
</Message>
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: How to recover keys scheduled for deletion
3+
description: Recover keys scheduled for deletion in the Scaleway console before they are permanently removed.
4+
tags: key encrypted-data scheduled-deletion recover-keys
5+
dates:
6+
validation: 2025-07-24
7+
posted: 2025-07-24
8+
---
9+
import Requirements from '@macros/iam/requirements.mdx'
10+
11+
12+
This page shows you how to recover keys scheduled for deletion using the Scaleway [console](https://console.scaleway.com). Once you schedule a key for deletion, it enters a 7-day pending deletion period, during which you can still recover it.
13+
After this retention period, the key and its version are permanently deleted.
14+
15+
<Requirements />
16+
17+
- A Scaleway account logged into the [console](https://console.scaleway.com)
18+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
19+
- Created a [key](/key-manager/how-to/create-key/)
20+
- Scheduled keys for deletion
21+
22+
## How to recover one key
23+
24+
1. Click **Key Manager** in the **Security & Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
25+
2. Select the [region](/key-manager/concepts/#region) in which to recover the key, in the **Region** drop-down.
26+
3. Click the **Scheduled for deletion** tab. Your keys display.
27+
4. Click <Icon name="more" /> next to the key you want to recover and click **Recover**. A pop-up displays the estimated cost of recovering the key.
28+
<Message type="note">
29+
Recovering a key is billed €0.01 per key.
30+
</Message>
31+
5. Click **Recover key** to confirm. Your key displays in the **Keys** tab.
32+
33+
## How to recover several keys
34+
35+
1. Click **Key Manager** in the **Security & Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
36+
2. Select the [region](/key-manager/concepts/#region) in which to recover the key, in the **Region** drop-down.
37+
3. Click the **Scheduled for deletion** tab. Your keys display.
38+
4. Tick the checkbox next to **Name** to select all the keys you want to recover.
39+
5. Click the circular arrow to recover the selected keys.
40+
6. Check the estimated cost and click **Recover keys** to confirm.

0 commit comments

Comments
 (0)