Skip to content

Commit e7ca231

Browse files
committed
docs(add): encryption key step
1 parent 64fb80a commit e7ca231

File tree

2 files changed

+77
-65
lines changed

2 files changed

+77
-65
lines changed

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

Lines changed: 62 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ content:
77
paragraph: Discover how to efficiently create secrets using Scaleway's Secret Manager. Follow these step-by-step instructions whether you are setting up your first secret or adding more to your existing resources.
88
tags: secret sensitive-data storage-system secret-type
99
dates:
10-
validation: 2025-01-13
10+
validation: 2025-06-17
1111
posted: 2023-02-21
1212
categories:
1313
- identity-and-access-management
1414
---
1515

16-
The [secret](/secret-manager/concepts/#secret) creation process slightly differs depending on whether you are using Secret Manager for the first time or not. This page explains how to create a [secret](/secret-manager/concepts/#secret) for the first time using the [Scaleway console](https://console.scaleway.com) and how to create a secret if you have already created resources in Secret Manager.
16+
The [secret](/secret-manager/concepts/#secret) creation process slightly differs depending on whether you are using Secret Manager for the first time or not. Upon secret creation, you are prompted to choose a Scaleway-managed encryption key or specify an existing [Key Manager](/key-manager) key which will encrypt your data. This allows for secure and flexible encryption of your data, compliant with industry standards.
17+
18+
This page explains how to create a [secret](/secret-manager/concepts/#secret) for the first time using the [Scaleway console](https://console.scaleway.com) and how to create a secret if you have already created resources in Secret Manager.
1719

1820
<Macro id="requirements" />
1921

@@ -22,70 +24,75 @@ The [secret](/secret-manager/concepts/#secret) creation process slightly differs
2224

2325
<Tabs id="install">
2426
<TabsTab label="Create your first secret">
27+
1. Click **Secret Manager** in the **Security & Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
28+
2. In the **Region** drop-down, select the [region](/secret-manager/concepts/#region) in which you want to store your secret.
29+
<Message type="important">
30+
Secrets cannot be moved from one region to another after creation.
31+
</Message>
32+
3. Click **+ Create secret**.
33+
4. Add your secret:
34+
- Choose whether to add your secret manually or import it.
35+
<Message type="note">
36+
The maximum file size for your secret is 64 KiB.
37+
</Message>
38+
- Choose a [secret type](/secret-manager/concepts/#secret-types) and enter or upload your secret value.
39+
5. Choose a Key Manager encryption key:
40+
- Scaleway-managed encryption key: requires no configuration on your side.
2541

26-
27-
1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
28-
2. Click **+ Create secret**.
29-
3. Choose the [region](/secret-manager/concepts/#region) in which you want to create your secret.
42+
- Manually-managed encryption key: an existing [Key Manager](/key-manager) key you have previously created.
43+
6. Choose a [path](/secret-manager/concepts/#path) for your secret.
3044
<Message type="important">
31-
Secrets cannot be moved from one region to another after creation.
45+
A [path](/secret-manager/concepts/#path) is the directory structure to access your secrets and their [versions](/secret-manager/concepts/#version). Each path **must be prefixed** with a slash.
3246
</Message>
33-
4. Add your secret:
34-
- Choose whether to add your secret manually or import it from a file.
35-
<Message type="note">
36-
The maximum file size for your secret is 64 KiB.
37-
</Message>
38-
- Choose a [secret type](/secret-manager/concepts/#secret-types) and enter or upload your secret value.
39-
5. Create a [path](/secret-manager/concepts/#path) in which to store your secret. The path name **must be prefixed** with a slash.
40-
6. Enter a name for your secret and add optional tags.
41-
7. Optionally, click <Icon name="toggle" /> to enable [secret protection](/secret-manager/concepts/#secret-protection).
42-
8. Optionally, click <Icon name="toggle" /> next to **Single access** or **Time to Live** to apply an [ephemeral policy](/secret-manager/concepts/#ephemeral-policy) to your secret and its versions.
47+
7. Enter a name for your secret, a description, and optional tags.
48+
8. Optionally, click <Icon name="toggle" /> to enable [secret protection](/secret-manager/concepts/#secret-protection).
49+
9. Optionally, click <Icon name="toggle" /> next to **Enable single access** or **Enable Time to Live** to apply an [ephemeral policy](/secret-manager/concepts/#ephemeral-policy) to your secret and its versions.
4350
<Message type="important">
44-
- **Single access**: allows you to set your secret versions to **expire after one single access**.
45-
- **Time to Live**: allows you to set a time frame of up to one year, during which your secret versions are valid and accessible.
46-
- The ephemeral policy can only be applied to a secret at creation, and **cannot be removed** once applied.
47-
- Once applied to a secret, the ephemeral policy's settings will be applied to all the secret's versions, even those created subsequently.
51+
- **Single access**: allows you to set your secret versions to **expire after one single access**.
52+
- **Time to Live**: allows you to set a time frame of up to one year, during which your secret versions are valid and accessible.
53+
- The ephemeral policy can only be applied to a secret at creation, and **cannot be removed** once applied.
54+
- Once applied to a secret, the ephemeral policy's settings will be applied to all the secret's versions (even those created subsequently).
55+
</Message>
56+
10. Check the estimated cost and click **Create secret** to confirm. The **Overview** tab of your secret displays with information such as the region of your secret, its encryption key, the secret's ID, etc.
57+
<Message type="note">
58+
- The value of your secret is stored in its first version, which is enabled by default. At creation, your secret only has one version. Find out [how to add more versions](/secret-manager/how-to/create-version/) to your secret.
59+
- Your path and secret are created on the go.
4860
</Message>
49-
9. Click **Create secret**. The **Overview** tab of your secret displays.
50-
51-
<Message type="note">
52-
- The value of your secret is stored in its first version, which is enabled by default. At creation, your secret only has one version. Find out [how to add more versions](/secret-manager/how-to/create-version/) to your secret.
53-
- Your path and secret are created on the go.
54-
</Message>
55-
5661
</TabsTab>
5762
<TabsTab label="Create more secrets">
58-
1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
59-
2. Select your desired [region](/secret-manager/concepts/#region) in the **Region** drop-down.
60-
<Message type="important">
61-
Secrets cannot be moved from one region to another after creation.
62-
</Message>
63-
3. Click **+ Create secret**.
64-
4. Add your secret:
65-
- Choose whether to add your secret manually or import it from a file.
63+
1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
64+
2. Select your desired [region](/secret-manager/concepts/#region) in the **Region** drop-down.
65+
<Message type="important">
66+
Secrets cannot be moved from one region to another after creation.
67+
</Message>
68+
3. Click **+ Create secret**.
69+
4. Add your secret:
70+
- Choose whether to add your secret manually or import it from a file.
6671
<Message type="note">
6772
The maximum file size for your secret is 64 KiB.
6873
</Message>
69-
- Choose a [secret type](/secret-manager/concepts/#secret-types) and enter or upload your secret value.
70-
5. Choose a [path](/secret-manager/concepts/#path) for your secret:
71-
- Enter an existing [path](/secret-manager/concepts/#path).
72-
- Create a new path. The path name **must be prefixed** with a slash.
73-
6. Enter a name for your secret and add optional tags.
74-
7. Optionally, click <Icon name="toggle" /> to enable [secret protection](/secret-manager/concepts/#secret-protection).
75-
8. Optionally, click <Icon name="toggle" /> next to **Single access** or **Time to Live** to apply an [ephemeral policy](/secret-manager/concepts/#ephemeral-policy) to your secret and its versions.
74+
- Choose a [secret type](/secret-manager/concepts/#secret-types) and enter or upload your secret value.
75+
5. Choose a Key Manager encryption key:
76+
- Scaleway-managed encryption key: requires no configuration on your side.
77+
78+
- Manually-managed encryption key: an existing Key Manager key you have previously created.
79+
6. Choose a [path](/secret-manager/concepts/#path) for your secret:
80+
- Enter an existing [path](/secret-manager/concepts/#path).
81+
82+
- Create a new path. The path name **must be prefixed** with a slash.
83+
7. Enter a name for your secret, a description, and optional tags.
84+
8. Optionally, click <Icon name="toggle" /> to enable [secret protection](/secret-manager/concepts/#secret-protection).
85+
9. Optionally, click <Icon name="toggle" /> next to **Enable single access** or **Enable Time to Live** to apply an [ephemeral policy](/secret-manager/concepts/#ephemeral-policy) to your secret and its versions.
7686
<Message type="important">
77-
- **Single access**: allows you to set your secret versions to **expire after one single access**.
78-
- **Time to Live**: allows you to set a time frame of up to one year, during which your secret versions are valid and accessible.
79-
- The ephemeral policy can only be applied to a secret at creation, and **cannot be removed** once applied.
80-
- Once applied to a secret, the ephemeral policy's settings will be applied to all the secret's versions (even those created subsequently).
87+
- **Single access**: allows you to set your secret versions to **expire after one single access**.
88+
- **Time to Live**: allows you to set a time frame of up to one year, during which your secret versions are valid and accessible.
89+
- The ephemeral policy can only be applied to a secret at creation, and **cannot be removed** once applied.
90+
- Once applied to a secret, the ephemeral policy's settings will be applied to all the secret's versions (even those created subsequently).
91+
</Message>
92+
10. Click **Create secret**. The **Overview** tab of your secret displays with information such as the region of your secret, its encryption key, the secret's ID, etc.
93+
<Message type="note">
94+
- The value of your secret is stored in its first version, which is enabled by default. At creation, your secret only has one version. Find out [how to add more versions](/secret-manager/how-to/create-version/) to your secret.
95+
- If you have created a path that did not exist yet, your path and secret are created on the go.
8196
</Message>
82-
9. Click **Create secret**. The **Overview** tab of your secret displays.
83-
<Message type="note">
84-
- The value of your secret is stored in its first version, which is enabled by default. At creation, your secret only has one version. Find out [how to add more versions](/secret-manager/how-to/create-version/) to your secret.
85-
- If you have created a path that did not exist yet, your path and secret are created on the go.
86-
</Message>
87-
8897
</TabsTab>
8998
</Tabs>
90-
91-

pages/secret-manager/quickstart.mdx

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ content:
66
h1: Secret Manager - Quickstart
77
paragraph: Learn how to quickly set up and manage secrets with Scaleway's Secret Manager. Follow our step-by-step guide to create secrets, define paths, and add versions effortlessly.
88
dates:
9-
validation: 2025-06-13
9+
validation: 2025-06-17
1010
posted: 2023-02-21
1111
---
1212

13-
In this quickstart, we show you how to create a [secret](/secret-manager/concepts/#secret) within a [path](/secret-manager/concepts/#path), and how to add [versions](/secret-manager/concepts/#version) to your newly-created secret.
13+
Upon secret creation, you are prompted to choose a Scaleway-managed encryption key or specify an existing [Key Manager](/key-manager) key which will encrypt your data. This allows for secure and flexible encryption of your data, compliant with industry standards.
14+
15+
In this quickstart, we show you how to create a [secret](/secret-manager/concepts/#secret) within a [path](/secret-manager/concepts/#path), how to add an existing or a new [Key Manager](/key-manager) key. Then we show you how to add [versions](/secret-manager/concepts/#version) to your newly-created secret.
1416

1517
## Console overview
1618
Discover the Secret Manager interface on the Scaleway console.
@@ -24,31 +26,34 @@ Discover the Secret Manager interface on the Scaleway console.
2426
## How to create a secret
2527

2628
1. Click **Secret Manager** in the **Security & Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu.
27-
2. Click **+ Create secret**.
28-
3. Choose the [region](/secret-manager/concepts/#region) in which you want to store your secret.
29+
2. In the **Region** drop-down, select the [region](/secret-manager/concepts/#region) in which you want to store your secret.
2930
<Message type="important">
3031
Secrets cannot be moved from one region to another after creation.
3132
</Message>
33+
3. Click **+ Create secret**.
3234
4. Add your secret:
33-
- Choose whether to add your secret manually or import it from a file.
35+
- Choose whether to add your secret manually or import it.
3436
<Message type="note">
3537
The maximum file size for your secret is 64 KiB.
3638
</Message>
3739
- Choose a [secret type](/secret-manager/concepts/#secret-types) and enter or upload your secret value.
38-
5. Choose a [path](/secret-manager/concepts/#path) for your secret.
40+
5. Choose a Key Manager encryption key:
41+
- Scaleway-managed encryption key: requires no configuration on your side.
42+
- Manually-managed encryption key: an existing Key Manager key you have previously created.
43+
6. Choose a [path](/secret-manager/concepts/#path) for your secret.
3944
<Message type="important">
4045
A [path](/secret-manager/concepts/#path) is the directory structure to access your secrets and their [versions](/secret-manager/concepts/#version). Each path **must be prefixed** with a slash.
4146
</Message>
42-
6. Enter a name for your secret and add tags (optional).
43-
7. Optionally, click <Icon name="toggle" /> to enable [secret protection](/secret-manager/concepts/#secret-protection).
44-
8. Optionally, click <Icon name="toggle" /> next to **Enable single access** or **Enable Time to Live** to apply an [ephemeral policy](/secret-manager/concepts/#ephemeral-policy) to your secret and its versions.
47+
7. Enter a name for your secret and add tags (optional).
48+
8. Optionally, click <Icon name="toggle" /> to enable [secret protection](/secret-manager/concepts/#secret-protection).
49+
9. Optionally, click <Icon name="toggle" /> next to **Enable single access** or **Enable Time to Live** to apply an [ephemeral policy](/secret-manager/concepts/#ephemeral-policy) to your secret and its versions.
4550
<Message type="important">
4651
- **Single access**: allows you to set your secret versions to **expire after one single access**.
4752
- **Time to Live**: allows you to set a time frame of up to one year, during which your secret versions are valid and accessible.
4853
- The ephemeral policy can only be applied to a secret at creation, and **cannot be removed** once applied.
4954
- Once applied to a secret, the ephemeral policy's settings will be applied to all the secret's versions (even those created subsequently).
5055
</Message>
51-
9. Check the estimated cost and click **Create secret** to confirm. The **Overview** tab of your secret displays.
56+
10. Check the estimated cost and click **Create secret** to confirm. The **Overview** tab of your secret displays with information such as the region of your secret, its encryption key, the secret's ID, etc.
5257

5358
<Message type="note">
5459
- You have created a secret on the go. The value of your secret is stored in its first version, which is [enabled](/secret-manager/concepts/#enabling-a-version) by default. At creation, your secret only has one version. Keep reading our quickstart to find out how to add more versions to your secret.

0 commit comments

Comments
 (0)