You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: serverless/messaging/how-to/create-credentials.mdx
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ dates:
15
15
16
16
This page shows how to create [credentials](/serverless/messaging/concepts/#credentials) for Scaleway **NATS**, **Queues** and **Topics and Events** (previously grouped together as the **Messaging and Queuing** product). Credentials give their bearer (e.g. services and platforms) access to your service.
17
17
18
-
You can create multiple sets of credentials for each of your NATS accounts, Queues and Topics and Events services.
18
+
You can create multiple sets of credentials for each of your NATS accounts, and for your Queues and Topics and Events services.
19
19
20
20
<Macroid="requirements" />
21
21
@@ -28,17 +28,19 @@ Credentials for NATS accounts are not granular: they necessarily give full read
28
28
29
29
1. Click **NATS** in the **Serverless** section of the Scaleway console side menu.
30
30
31
-
2. Use the drop-down menu to select the [region](/serverless/messaging/concepts/#region) of the NATS account for which you want to create credentials.
31
+
2. Use the drop-down menu to select the [region](/serverless/messaging/concepts/#region) of the NATS account for which you want to create credentials. The list of your NATS accounts in the pre-selected region displays.
32
32
33
-
3. Click **NATS**. The list of your NATS accounts in the pre-selected region displays.
33
+
3. Click the NATS account you want to generate credentials for. The account's **Overview** page displays.
34
34
35
-
4. Click the NATS account you want to generate credentials for. The account's **Overview** page displays.
35
+
<Lightboxsrc="scaleway-nats-overview.webp"alt="In the Scaleway console, the Overview tab of a NATS account is displayed. Three panels are visible: account information (URL and region), Credentials, adn Delete NATS account." />
36
36
37
-
5. In the **Credentials** panel, click **Generate credentials**. A pop-up displays.
37
+
4. In the **Credentials** panel, click **Generate credentials**. A pop-up displays.
38
38
39
39
6. Enter a name for these credentials, and click **Generate credentials**.
40
40
41
-
The credentials are created and a button displays prompting you to download them in a `.creds` file.
41
+
The credentials are created and a button displays prompting you to download them in a `.creds` file.
42
+
43
+
<Lightboxsrc="scaleway_nats_creds.webp"alt="In the Scaleway console, a screen shows that a .creds key file has been generated, which the user is prompted to download." />
42
44
43
45
<Messagetype="important">
44
46
The generated credentials are displayed only once. Make sure to download and safely store them before closing the window.
@@ -50,14 +52,16 @@ Credentials for NATS accounts are not granular: they necessarily give full read
50
52
51
53
## How to create credentials for Queues
52
54
53
-
Credentials for Queues are granular: you can define the level of access that they should give.
55
+
Credentials for Queues are granular: you can define the level of access that they should give. Credentials give the specified level of access to all queues that you create in the region they are scoped to.
54
56
55
-
1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. The **Queues** dashboard displays.
57
+
1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. A list of your queues displays.
56
58
57
-
2. Click the **Credentials** tab.
59
+
2. Click the **Credentials** tab.
58
60
59
61
3. Click **Generate credentials**. A pop-up displays:
60
62
63
+
<Lightboxsrc="scaleway-queues-gen-creds.webp"alt="In the Scaleway console, the Generate credentials screen displays. It prompts the user to choose a region for their credentials, a name, and permissions (write, read and/or manage)" />
64
+
61
65
4. Choose a region that these credentials should be scoped to.
62
66
63
67
5. Enter a name for these credentials.
@@ -78,15 +82,15 @@ Credentials for Queues are granular: you can define the level of access that the
78
82
79
83
## How to create credentials for Topics and Events
80
84
81
-
Credentials for Topics and Events are granular: you can define the level of access that they should give.
85
+
Credentials for Topics and Events are granular: you can define the level of access that they should give. Credentials give the specified level of access to all topics that you create in the region they are scoped to.
82
86
83
87
1. Click **Topics and Events** in the **Serverless** section of the Scaleway console side menu. The **Topics and Events** dashboard displays.
84
88
85
89
2. Click the **Credentials** tab.
86
90
87
91
3. Click **Generate credentials**. A pop-up displays:
88
92
89
-
TODO screenshot for Topics and Events
93
+
<Lightboxsrc="scaleway-topics-gen-creds.webp"alt="In the Scaleway console, the Generate credentials screen displays. It prompts the user to choose a region for their credentials, a name, and permissions (write, read and/or manage)" />
90
94
91
95
4. Choose a region that these credentials should be scoped to.
Copy file name to clipboardExpand all lines: serverless/messaging/how-to/create-manage-queues.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ This page shows how to create and manage your Scaleway [Queues](/serverless/mess
25
25
1. Click **Queues** in the **Serverless** section of the Scaleway console side menu.
26
26
27
27
2. Click **Create queue**. The Qqeue creation wizard displays.
28
-
TODO SCREENSHOT
28
+
<Lightboxsrc="scaleway-queues-create-queue.webp"alt="In the Scaleway console, the Create a Queue screen displays. The different sections of the screen are described in the steps below." />
29
29
30
30
3. Select the [region](/serverless/messaging/concepts/#region) in which you want to create the queue.
31
31
@@ -39,7 +39,7 @@ This page shows how to create and manage your Scaleway [Queues](/serverless/mess
39
39
-**Visibility timeout**: The length of time (in seconds) during which, after a message is received, it is hidden and cannot be received again by the same or other consumers. This is useful as the queue itself does not automatically delete messages once they are received, and so prevents consumers from receiving the same message many times before they have finished processing it. Therefore, the value set here should be informed by the expected length of time it will take consumers to process messages. The default value is 30 seconds. The value must be between 1 second and 43 200 seconds (12 hours).
40
40
-**Message retention period**: The length of time (in seconds) that messages are kept in the queue before being deleted. Setting a longer message retention period allows for a longer interval between a message being sent and it being received. The default value is 60 seconds. The value must be between 60 seconds and 1 290 600 seconds (14 days).
41
41
-**Maximum message size**: The maximum size (in kilobytes) of a message that can be sent to the queue. Messages greater than the defined size will be rejected. The default value is 256 KB. The value must be between 1 KB and 256 KB.
42
-
-**Content Based Deduplication**: This setting is only available for FIFO Queues. Enable content-based deduplication if the message body is guaranteed to be unique for each message. A unique hash value is generated from the body of each message, which is used as its deduplication ID. This avoids the need to set a deduplication ID when sending messages.
42
+
-**Content Based Deduplication**: This setting is only available for FIFO queues. Enable content-based deduplication if the message body is guaranteed to be unique for each message. A unique hash value is generated from the body of each message, which is used as its deduplication ID. This avoids the need to set a deduplication ID when sending messages.
43
43
44
44
7. Click **Create queue** to finish.
45
45
@@ -48,22 +48,22 @@ You are returned to the **Queues** tab, where your newly-created queue now displ
48
48
Go further by clicking on the queue's name to access its **Settings** page and see additional information such as its ARN (Amazon Resource Name) and configuration parameters.
49
49
50
50
<Messagetype="tip">
51
-
Remember that you need to [create credentials](/serverless/messaging/how-to/create-credentials/) in order to access your Queues from an API or CLI. Sending messages to Queues requires that credentials have the `can_publish` permission, while receiving messages from Queues requires the `can_receive` permission. You can create separate credentials if you need to isolate these two roles in your application.
51
+
Remember that you need to [create credentials](/serverless/messaging/how-to/create-credentials/) in order to access your queues from an API or CLI. Sending messages to queues requires that credentials have the `can_publish` permission, while receiving messages from queues requires the `can_receive` permission. You can create separate credentials if you need to isolate these two roles in your application.
52
52
</Message>
53
53
54
54
## How to modify a queue's configuration
55
55
56
-
You can modify the visibility timeout, message retention period and maximum message size of a queue after creation. You can also modify the content based deduplication settings for FIFO Queues. However, you cannot change a queue's name or type after creation.
56
+
You can modify the visibility timeout, message retention period and maximum message size of a queue after creation. You can also modify the content based deduplication settings for FIFO queues. However, you cannot change a queue's name or type after creation.
57
57
58
58
1. Click **Queues** in the **Serverless** section of the Scaleway console side menu.
59
59
60
-
2. Use the drop-down menu to select the [region](/serverless/messaging/concepts/#region) of the queue you want to configure.
60
+
2. Use the drop-down menu to select the [region](/serverless/messaging/concepts/#region) of the queue you want to modify.
61
61
62
62
3. Click the queue you wish to modify. The queue's **Settings** page displays:
63
63
64
-
TODO SCREENSHOT
64
+
<Lightboxsrc="scaleway-queues-queue-settings.webp"alt="In the Scaleway console, the queue's settings displays includes a Queue information panel (showing its type, number of messages, region, creation date, URL and ARN), a Queue information panel (with visibility timeout, message retention period, max message size and content based deduplication settings), and a Delete queue panel (with a button to delete the queue)." />
65
65
66
-
4. Modify the visibility timeout, message retention period, maximum message size, and (for FIFO Queues) content-based deduplication values as you wish.
66
+
4. Modify the visibility timeout, message retention period, maximum message size, and (for FIFO queues) content-based deduplication values as you wish.
67
67
68
68
5. Click **Save**.
69
69
@@ -81,7 +81,7 @@ You can use the **Purge** feature to delete all messages from a queue.
81
81
82
82
A pop-up asks you to confirm that you understand this action will delete all your queued messages.
0 commit comments