docs(key-manager): dates & menu

nerda-codes · nerda-codes · commit d746a499e9a2 · 2025-01-02T15:17:18.000+01:00
diff --git a/identity-and-access-management/key-manager/api-cli/create-dek-api-cli.mdx b/identity-and-access-management/key-manager/api-cli/create-dek-api-cli.mdx
@@ -1,16 +1,16 @@
 ---
 meta:
-  title: Create a data encryption key using the Scaleway API and the Scaleway CLI
+  title: Creating a data encryption key using the Scaleway API and the Scaleway CLI
   description: Discover how to create a data encryption key using the Scaleway API and the Scaleway CLI.
 content:
-  h1: Create a data encryption key using the Scaleway API and the Scaleway CLI
+  h1: Creating a data encryption key using the Scaleway API and the Scaleway CLI
   paragraph: Discover how to create a data encryption key using the Scaleway API and the Scaleway CLI.
 tags: key-management dek data-encryption-key cli sdk api encryption
+dates:
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
-dates:
-  validation: 2024-12-09
-  posted: 2024-12-09
 ---
 
 <Macro id="requirements" />
diff --git a/identity-and-access-management/key-manager/api-cli/encrypt-decrypt-keys-with-streaming-aead-tink.mdx b/identity-and-access-management/key-manager/api-cli/encrypt-decrypt-keys-with-streaming-aead-tink.mdx
@@ -1,14 +1,14 @@
 ---
 meta:
-title: How to use Streaming AEAD with Tink and Key Manager
+title: Encrypting and decrypting data streams with Streaming AEAD, Tink and Key Manager
 description: Discover how to encrypt and decrypt large data streams with Streaming AEAD, Tink and Key Manager
 content:
-h1: How to use Streaming AEAD with Tink and Key Manager
+h1: Encrypting and decrypting data streams with Streaming AEAD, Tink and Key Manager
 paragraph: Discover how to encrypt and decrypt large data streams with Streaming AEAD, Tink and Key Manager
 tags: key sensitive-data tink aead streaming encryption decryption
 dates:
-validation: 2024-10-03
-posted: 2024-10-03
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
diff --git a/identity-and-access-management/key-manager/api-cli/manage-keys-with-tink.mdx b/identity-and-access-management/key-manager/api-cli/manage-keys-with-tink.mdx
@@ -1,13 +1,16 @@
 ---
 meta:
-  title: Using Tink with the Scaleway Key Manager
+  title: Managing your Key Manager keys using Tink
   description: Discover essential concepts of Scaleway Key Manager and how to use it effectively with the Tink Go library
 content:
-  h1: Using Tink with the Scaleway Key Manager
+  h1: Managing your Key Manager keys using Tink
   paragraph: Discover essential concepts of Scaleway Key Manager, including Key Encryption Keys and Data Encryption Keys
 tags: key-manager encryption kms key-management-service cryptographic
 dates:
-  validation: 2024-09-20
+  validation: 2025-01-06
+  posted: 2025-01-06
+categories:
+  - identity-and-access-management
 ---
 
 This documentation page provides information on Key Manager Key Encryption Keys (KEKs) and Data Encryption Keys (DEKs), and how to use them with the Tink Go library.
diff --git a/identity-and-access-management/key-manager/api-cli/rotate-keys-api-cli.mdx b/identity-and-access-management/key-manager/api-cli/rotate-keys-api-cli.mdx
@@ -7,8 +7,8 @@ h1: Perform key rotation using the Scaleway CLI and API
 paragraph: Find out how to rotate keys, and why you should adopt this practice.
 tags: key sensitive-data rotation
 dates:
-validation: 2024-10-07
-posted: 2024-10-07
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
diff --git a/identity-and-access-management/key-manager/concepts.mdx b/identity-and-access-management/key-manager/concepts.mdx
@@ -7,7 +7,7 @@ content:
   paragraph: Discover essential concepts of Scaleway Key Manager.
 tags: key-manager key encryption-key
 dates:
-  validation: 2024-12-09
+  validation: 2025-01-06
 ---
 
 ## Asymmetric encryption
diff --git a/identity-and-access-management/key-manager/how-to/create-km-key.mdx b/identity-and-access-management/key-manager/how-to/create-km-key.mdx
@@ -7,8 +7,8 @@ content:
   paragraph: Discover how to create a key from the Scaleway console to decrypt your data using Scaleway's Key Manager.
 tags: key-manager encryption data key
 dates:
-  validation: 2024-12-09
-  posted: 2024-12-09
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
diff --git a/identity-and-access-management/key-manager/how-to/delete-km-key.mdx b/identity-and-access-management/key-manager/how-to/delete-km-key.mdx
@@ -7,8 +7,8 @@ content:
   paragraph: Discover how to delete a Key Manager key from the Scaleway console.
 tags: key-manager delete key
 dates:
-  validation: 2024-12-09
-  posted: 2024-12-09
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
diff --git a/identity-and-access-management/key-manager/how-to/disable-km-key.mdx b/identity-and-access-management/key-manager/how-to/disable-km-key.mdx
@@ -7,8 +7,8 @@ content:
   paragraph: Discover how to disable a Key Manager key from the Scaleway console.
 tags: key-manager disable key
 dates:
-  validation: 2024-12-09
-  posted: 2024-12-09
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
diff --git a/identity-and-access-management/key-manager/how-to/manage-dek.mdx b/identity-and-access-management/key-manager/how-to/manage-dek.mdx
@@ -1,18 +1,17 @@
 ---
 meta:
-  title: Create a Key Manager data encryption key
+  title: Create and manage a Key Manager data encryption key
   description: Discover how to create a data encryption key from the Scaleway console to encrypt and decrypt your payloads using Scaleway's Key Manager.
 content:
-  h1: Create a Key Manager data encryption key
+  h1: Create and manage a Key Manager data encryption key
   paragraph: Discover how to create a data encryption key from the Scaleway console to encrypt and decrypt your payloads using Scaleway's Key Manager.
 tags: key-manager data-encryption-key data key payload encryption
 dates:
-  validation: 2024-12-11
-  posted: 2024-12-11
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
-
 Scaleway's key Manager allows you to create [data encryption keys (DEK)](/identity-and-access-management/key-manager/concepts/#data-encryption-key-dek) to encrypt and decrypt your [payload](/identity-and-access-management/key-manager/concepts/#payload).
 
 You can then use your Key Manager key to encrypt your DEK.
diff --git a/identity-and-access-management/key-manager/how-to/rotate-km-keys.mdx b/identity-and-access-management/key-manager/how-to/rotate-km-keys.mdx
@@ -3,12 +3,12 @@ meta:
   title: Perform key rotation using the Scaleway console
   description: Discover how to rotate a key from the Scaleway console to decrypt your data using Scaleway's Key Manager.
 content:
-  h1: Create a Key Manager key
+  h1: Perform key rotation using the Scaleway console
   paragraph: Discover how to rotate a key from the Scaleway console to decrypt your data using Scaleway's Key Manager.
 tags: key-manager encryption data key
 dates:
-  validation: 2024-12-09
-  posted: 2024-12-09
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
@@ -23,6 +23,8 @@ This reduces the risk of exposure if a key is compromised, thus enhancing the ov
 - [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](/identity-and-access-management/key-manager/how-to/create-km-key/) a Key Manager key
 
+## How to perform key rotation
+
 1. Click Key Manager in the **Security and Identity section** of the [Scaleway console](https://console.scaleway.com) side menu. Your keys display.
 2. Click the key to perform the rotation on. Your key's **Overview** tab displays.
 3. Scroll down to the **Key rotation** section, and click **Rotate key**. A tooltip displays to confirm the rotation was performed.
diff --git a/identity-and-access-management/key-manager/quickstart.mdx b/identity-and-access-management/key-manager/quickstart.mdx
@@ -6,8 +6,10 @@ content:
   h1: Quickstart
   paragraph: Learn how to quickly set up and manage keys with Scaleway's Key Manager. Follow our step-by-step guide to create keys.
 dates:
-  validation: 2024-12-09
-  posted: 2024-12-09
+  validation: 2025-01-06
+  posted: 2025-01-06
+categories:
+  - identity-and-access-management
 ---
 
 Scaleway's Key Manager allows you to create key encryption keys from the [Scaleway console](https://console.scaleway.com). Key encryption keys can then be used to encrypt and decrypt your encrypted data.
@@ -17,4 +19,40 @@ Scaleway's Key Manager allows you to create key encryption keys from the [Scalew
 - 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
 
+## How to create a Key Manager key
 
+1. Click Key Manager in the **Security and Identity section** of the [Scaleway console](https://console.scaleway.com) side menu.
+2. Click **+ Create key**.
+3. Choose the region in which you want to create your key.
+4. Enter a name, a description, and optional tags for your key.
+5. Select the [encryption method](/identity-and-access-management/key-manager/concepts/#encryption-method) for your key.
+
+    <Message type="important">
+     Key Manager currently only supports the `AES-256 GCM` [symmetric encryption](/identity-and-access-management/key-manager/concepts/#symmetric-encryption) algorithm.
+    </Message>
+6. Switch the <Icon name="toggle" /> icon to disable [key protection](/identity-and-access-management/key-manager/concepts/#key-protection) or leave it enabled.
+    <Message type="note">
+     Key protection allows you to protect your key from accidental deletion.
+    </Message>
+7. Click **Create key**. Your key's **Overview** page displays.
+
+## How to create and manage a data encryption key (DEK)
+
+
+
+1. Click Key Manager in the **Security and Identity section** of the [Scaleway console](https://console.scaleway.com) side menu. Your keys display.
+2. Click the key for which to create a data encryption key.
+3. Scroll down to the **Generate data encryption key** section.
+4. Click **Generate data encryption key**. A pop-up displays with the [ciphertext](/identity-and-access-management/key-manager/concepts/#ciphertext) of your DEK.
+5. Copy and store your DEK's ciphertext safely.
+    <Message type="important">
+     - We recommend that you **always store the ciphertext** of your data encryption key rather than its [plaintext](/identity-and-access-management/key-manager/concepts/#plaintext).
+     - While Scaleway Key Manager is responsible for generating, encrypting, and decrypting data encryption keys, it does not store, manage, or monitor them, nor does it engage in cryptographic operations with these keys. **You must use and manage data encryption keys outside of Key Manager**.
+     - Read our [documentation](/identity-and-access-management/key-manager/reference-content/understanding-key-manager/) to understand Key Manager.
+    </Message>
+6. Optionally, click **Display plaintext** to make sure that the plaintext does not contain any mistakes.
+7. Click **Close**.
+
+    <Message type="important">
+     You are responsible for storing your DEKS, as Key Manager does not store them for you.
+    </Message>
diff --git a/identity-and-access-management/key-manager/reference-content/differences-key-and-secret-manager.mdx b/identity-and-access-management/key-manager/reference-content/differences-key-and-secret-manager.mdx
@@ -1,13 +1,16 @@
 ---
 meta:
-  title: What is the difference between Key Manager and Secret Manager?
+  title: Understanding the difference between Key Manager and Secret Manager
   description: Learn the differences between Key Manager and Secret Manager and which one to use according to your needs
 content:
-  h1: What is the difference between Key Manager and Secret Manager?
+  h1: Understanding the difference between Key Manager and Secret Manager
   paragraph: Learn the differences between Key Manager and Secret Manager and which one to use according to your needs
 tags: key-manager secret-manager security
 dates:
-  validation: 2024-10-07
+  validation: 2025-01-06
+  posted: 2025-01-06
+categories:
+  - identity-and-access-management
 ---
 
 
@@ -50,13 +53,13 @@ the ciphertext to be decrypted. Your application is no longer responsible for ma
 Last, but not least, Key Manager provides another way of authorizing certain actions. You might want to authorize some principals only to encrypt data, and others
 only to decrypt data.
 
-Let's take the example of an application that receives sensitive health data that needs to be encrypted before being inserted into a database.The application would be able to ask Key Manager
+Let us take the example of an application that receives sensitive health data that needs to be encrypted before being inserted into a database.The application would be able to ask Key Manager
 to carry out encryption operations, but not decryption operations, so it cannot read the sensitive data already stored.
 
 This would not be possible to achieve with Secret Manager, since both writing and reading applications would need permissions to read the key from Secret Manager, which is sufficient to both encrypt and decrypt the data.
 
 
-## Conclusion
+## Additional note
 
 Cryptographic keys are secrets that need special care, and Key Manager is an effective tool to help you manage them securely. Key Manager allows your applications to offload all sensitive cryptographic
 operations and keep keys out-of-band for extra security.
diff --git a/identity-and-access-management/key-manager/reference-content/security-recommendations.mdx b/identity-and-access-management/key-manager/reference-content/security-recommendations.mdx
@@ -1,14 +1,14 @@
 ---
 meta:
-  title: Security measures to be aware of when using Key Manager
+  title: Understanding security measures when using Key Manager
   description: Discover how to enjoy Key Manager and data encryption and decryption securely.
 content:
-  h1: Security measures to be aware of when using Key Manager
+  h1: Understanding security measures when using Key Manager
   paragraph: Discover how to enjoy Key Manager and data encryption and decryption securely.
 tags: key-manager security-measures security encryption decryption
 dates:
-  validation: 2024-12-09
-  posted: 2024-12-09
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
diff --git a/identity-and-access-management/key-manager/reference-content/understanding-key-manager.mdx b/identity-and-access-management/key-manager/reference-content/understanding-key-manager.mdx
@@ -7,8 +7,8 @@ content:
   paragraph: Discover the robust encryption methods used by Secret Manager to safeguard sensitive data effectively. Learn about the Hierarchical Key Management System and its pivotal role in securing encryption keys and data integrity.
 tags: key-manager encryption data key
 dates:
-  validation: 2024-12-11
-  posted: 2024-12-11
+  validation: 2025-01-06
+  posted: 2025-01-06
 categories:
   - identity-and-access-management
 ---
diff --git a/menu/navigation.json b/menu/navigation.json
@@ -493,6 +493,98 @@
             "label": "Audit Trail",
             "slug": "audit-trail"
           },
+          {
+            "items": [
+              {
+                "label": "Overview",
+                "slug": "../key-manager"
+              },
+              {
+                "label": "Concepts",
+                "slug": "concepts"
+              },
+              {
+                "label": "Quickstart",
+                "slug": "quickstart"
+              },
+              {
+                "label": "FAQ",
+                "slug": "../../faq/key-manager"
+              },
+              {
+                "items": [
+                  {
+                    "label": "Create a Key Manager key",
+                    "slug": "create-km-key"
+                  },
+                  {
+                    "label": "Create and manage a Key Manager data encryption key",
+                    "slug": "manage-dek"
+                  },
+                  {
+                    "label": "Perform key rotation on Key Manager keys",
+                    "slug": "rotate-km-keys"
+                  },
+                  {
+                    "label": "Disable Key Manager keys",
+                    "slug": "disable-km-key"
+                  },
+                  {
+                    "label": "Delete Key Manager keys",
+                    "slug": "delete-km-key"
+                  }
+                ],
+                "label": "How to",
+                "slug": "how-to"
+              },
+              {
+                "items": [
+                  {
+                    "label": "Understanding security measures when using Key Manager",
+                    "slug": "security-recommendations"
+                  },
+                  {
+                    "label": "Understanding Key Manager",
+                    "slug": "understanding-key-manager"
+                  },
+                  {
+                    "label": "Understanding the difference between Key Manager and Secret Manager",
+                    "slug": "differences-key-and-secret-manager"
+                  }
+                ],
+                "label": "Additional Content",
+                "slug": "reference-content"
+              },
+              {
+                "items": [
+                  {
+                    "label": "Key Manager API Reference",
+                    "slug": "https://www.scaleway.com/en/developers/api/key-manager/"
+                  },
+                  {
+                    "label": "Creating a data encryption key using the Scaleway API and the Scaleway CLI",
+                    "slug": "create-dek-api-cli"
+                  },
+                  {
+                    "label": "Managing your Key Manager keys using Tink",
+                    "slug": "manage-keys-with-tink"
+                  },
+                  {
+                    "label": "Perform key rotation using the Scaleway CLI and API",
+                    "slug": "rotate-keys-api-cli"
+                  },
+                  {
+                    "label": "Encrypting and decrypting data streams with Streaming AEAD, Tink and Key Manager",
+                    "slug": "encrypt-decrypt-keys-with-streaming-aead-tink"
+                  }
+                ],
+                "label": "API/CLI",
+                "slug": "api-cli"
+              }
+            ],
+            "label": "Key Manager",
+            "slug": "key-manager"
+          },
           {
             "items": [
               {
