Skip to content

Commit ec9d4d1

Browse files
committed
fix(mnq): continue split
1 parent 5228b91 commit ec9d4d1

File tree

6 files changed

+99
-125
lines changed

6 files changed

+99
-125
lines changed
Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
11
---
22
meta:
3-
title: Connecting Messaging and Queuing SQS or SNS to the AWS-CLI
4-
description: This page explains how to connect Scaleway Messaging and Queuing SQS or SNS to the AWS-CLI
3+
title: Connecting Queues or Topics and Events to the AWS-CLI
4+
description: This page explains how to connect Scaleway Queues and/or Topics and Events to the AWS-CLI
55
content:
6-
h1: Connecting Messaging and Queuing SQS or SNS to the AWS-CLI
7-
paragraph: This page explains how to connect Scaleway Messaging and Queuing SQS or SNS to the AWS-CLI
6+
h1: Connecting Queues or Topics and Events to the AWS-CLI
7+
paragraph: This page explains how to connect Scaleway Queues and/or Topics and Events to the AWS-CLI
88
tags: messaging sns sqs aws-cli cli aws sdk python boto
99
categories:
1010
- messaging
1111
dates:
12-
validation: 2024-04-09
12+
validation: 2024-10-18
1313
posted: 2023-01-04
1414
---
1515

16-
The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. With minimal configuration, you can start using the AWS-CLI with Scaleway Messaging and Queuing SQS and/or SNS. This allows you to create, list and manage your queues and topics, send messages and much more, all from your command line.
16+
The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. With minimal configuration, you can start using the AWS-CLI with Scaleway Queues or Scaleway Topics and Events. This allows you to create, list and manage your queues and topics, send messages and much more, all from your command line.
1717

18-
This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Messaging and Queuing SQS or SNS.
18+
This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Queues or Scaleway Topics and Events.
1919

2020
<Macro id="requirements" />
2121

2222
- A Scaleway account logged into the [console](https://console.scaleway.com)
2323
- [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
24-
- [Activated SQS and/or SNS](/serverless/messaging/how-to/get-started/#how-to-activate-sqs-or-sns)
25-
- Valid [credentials](/serverless/messaging/how-to/create-credentials/) for SQS/SNS
24+
- Valid [credentials](/serverless/messaging/how-to/create-credentials/) for Queues and/or Topics and Events
2625

2726
<Message type="note">
28-
This page assumes you will use the AWS-CLI v1. For v2, see the [relevant AWS-CLI documentation page](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html).
27+
This page assumes you will use the AWS-CLI v1.
2928
</Message>
3029

3130
## How to install the AWS-CLI
3231

33-
To interact with Scaleway Messaging and Queuing, both `aws-cli` and `awscli-plugin-endpoint` need to be installed. The `awscli-plugin-endpoint` is a useful plugin to help people more easily access third-party providers such as Scaleway.
32+
To interact with Scaleway Queues and Scaleway Topics and Events, both `aws-cli` and `awscli-plugin-endpoint` need to be installed. The `awscli-plugin-endpoint` is a useful plugin to help people more easily access third-party providers such as Scaleway.
3433

3534
Install both `aws-cli` and `awscli-plugin` using `pip`.
3635

@@ -41,7 +40,7 @@ pip3 install awscli-plugin-endpoint
4140

4241
## How to configure the AWS-CLI
4342

44-
Now you have installed the AWS-CLI, you need to configure it for use with Scaleway Messaging and Queuing.
43+
Now you have installed the AWS-CLI, you need to configure it for use with Scaleway Queues / Topics and Events.
4544

4645
1. Create a file named `~/.aws/config` by running the following command:
4746
```
@@ -52,32 +51,32 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
5251
With the most recent versions of awscli (1.29.0 or 2.13.0), the use of a plugin is not necessary. If you are using one of those versions and wish to skip this step, you can do so. Note that this will also affect your configuration file in the next step.
5352
</Message>
5453

55-
2. Open the `~/.aws/config` file you just created in a text editor and edit it as follows (the SNS or SQS endpoint URL can be found in the console on the **Settings** page for the relevant protocol)
54+
2. Open the `~/.aws/config` file you just created in a text editor and edit it as follows (the Queues or Topics and Events endpoint URL can be found in the console on the **Settings** page for the relevant product)
5655
```
5756
[plugins]
5857
endpoint = awscli_plugin_endpoint
59-
[profile sns]
58+
[profile topics_events]
6059
region = fr-par
61-
sns =
60+
topics_events =
6261
endpoint_url = https://sns.mnq.fr-par.scaleway.com
63-
[profile sqs]
62+
[profile queues]
6463
region = fr-par
65-
sqs =
64+
queues =
6665
endpoint_url = https://sqs.mnq.fr-par.scaleway.com
6766
```
6867

69-
Optionally, you can also configure additional profiles by adding new blocks under `[sqs]` and `[sns]`. For example, you can add a third profile, `[profile aws]`, to connect to the AWS SQS/SNS service if you want:
68+
Optionally, you can also configure additional profiles by adding new blocks under `[queues]` and `[topics_events]`. For example, you can add a third profile, `[profile aws]`, to connect to the AWS SQS/SNS service if you want:
7069

7170
```
7271
[plugins]
7372
endpoint = awscli_plugin_endpoint
74-
[profile sns]
73+
[profile topics_events]
7574
region = fr-par
76-
sns =
75+
topics_events =
7776
endpoint_url = https://sns.mnq.fr-par.scaleway.com
78-
[profile sqs]
77+
[profile queues]
7978
region = fr-par
80-
sqs =
79+
queues =
8180
endpoint_url = https://sqs.mnq.fr-par.scaleway.com
8281
[profile aws]
8382
region=eu-west-3
@@ -91,10 +90,10 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
9190
<Message type="tip">
9291
If you are using aws 1.29.0 or 2.13.0 without the plugin, your configuration file should be as follows:
9392
```
94-
[profile sns]
93+
[profile topics_events]
9594
region = fr-par
9695
endpoint_url = https://sns.mnq.fr-par.scaleway.com
97-
[profile sqs]
96+
[profile queues]
9897
region = fr-par
9998
endpoint_url = https://sqs.mnq.fr-par.scaleway.com
10099
```
@@ -105,14 +104,14 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
105104
```
106105
aws configure
107106
```
108-
109-
4. Open the `~/.aws/credentials` file you just created, and for each protocol you want to use, add the access key and secret key you saved when you generated your [SQS or SNS credentials](/serverless/messaging/how-to/create-credentials/):
107+
**
108+
4. Open the `~/.aws/credentials` file you just created, and for each product (out of **Queues** and **Topics and Events**) you want to use, add the access key and secret key you saved when you generated your [credentials](/serverless/messaging/how-to/create-credentials/):
110109
```
111-
[sns]
110+
[topics_events]
112111
aws_access_key_id=<ACCESS_KEY_FOR_SNS>
113112
aws_secret_access_key=<SECRET_KEY_FOR_SNS>
114113
115-
[sqs]
114+
[queues]
116115
aws_access_key_id=<ACCESS_KEY_FOR_SQS>
117116
aws_secret_access_key=<SECRET_KEY_FOR_SQS>
118117
```
@@ -126,13 +125,13 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
126125

127126
6. Test that everything is set up correctly with the following command:
128127
```
129-
aws sqs list-queues
128+
aws queues list-queues
130129
```
131130

132131
Use the `--profile` option if you want to test it using a different profile.
133132

134133
<Message type="tip">
135134
Check out our dedicated documentation to find more common commands for getting started with the AWS CLI:
136-
- The [SQS guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sqs) walks you through creating and listing queues, sending messages to queues, and more.
137-
- The [SNS guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sns) shows you how to create and list topics and subscriptions, send messages to topics, and more.
135+
- The [Queues guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sqs) walks you through creating and listing queues, sending messages to queues, and more.
136+
- The [Topics and Events guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sns) shows you how to create and list topics and subscriptions, send messages to topics, and more.
138137
</Message>
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
meta:
3-
title: Messaging and Queuing - API/CLI Documentation
4-
description: Messaging and Queuing API/CLI Documentation
3+
title: NATS, Queues, and Topics and Events - API/CLI Documentation
4+
description: NATS, Queues, and Topics and Events API/CLI Documentation
55
content:
6-
h1: Messaging and Queuing - API/CLI Documentation
7-
paragraph: Messaging and Queuing API/CLI Documentation
6+
h1: NATS, Queues, and Topics and Events - API/CLI Documentation
7+
paragraph: NATS, Queues, and Topics and Events API/CLI Documentation
88
---

serverless/messaging/api-cli/nats-cli.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
meta:
33
title: Using the NATS CLI
4-
description: This page explains how to use the NATS CLI with Scaleway Messaging and Queuing
4+
description: This page explains how to use the NATS CLI with Scaleway NATS
55
content:
66
h1: Using the NATS CLI
7-
paragraph: This page explains how to use the NATS CLI with Scaleway Messaging and Queuing
7+
paragraph: This page explains how to use the NATS CLI with Scaleway NATS
88
tags: messaging nats cli
99
categories:
1010
- messaging
1111
dates:
12-
validation: 2024-04-09
12+
validation: 2024-10_18
1313
posted: 2023-01-20
1414
---
1515

@@ -18,7 +18,7 @@ The NATS CLI (`nats`) is the official NATS tool for managing your NATS resources
1818
Check out the official [NATS CLI documentation](https://docs.nats.io/using-nats/nats-tools/nats_cli/) for installation instructions, examples and more.
1919

2020
<Message type="tip">
21-
You can also configure Messaging and Queuing with the Terraform NATS Jetstream provider using our [dedicated tutorial](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/guides/mnq_with_nats_terraform_provider).
21+
You can also configure Scaleway NATS with the Terraform NATS Jetstream provider using our [dedicated tutorial](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/guides/mnq_with_nats_terraform_provider).
2222
</Message>
2323

2424
This page shows you how to get started with some basic actions via the NATS CLI.
@@ -27,7 +27,7 @@ This page shows you how to get started with some basic actions via the NATS CLI.
2727

2828
- A Scaleway account logged into the [console](https://console.scaleway.com)
2929
- [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
30-
- A [NATS account](/serverless/messaging/how-to/get-started/#how-to-create-a-nats-account)
30+
- A Scaleway [NATS account](/serverless/messaging/how-to/get-started/#how-to-create-a-nats-account)
3131
- NATS [credentials](/serverless/messaging/how-to/create-credentials/) downloaded to your machine
3232

3333
## Installing the NATS CLI
@@ -36,7 +36,7 @@ Follow instructions from the [official NATS documentation](https://docs.nats.io/
3636

3737
## Define a context
3838

39-
To simplify your interactions with NATS hosted on Scaleway Messaging and Queuing, we recommend that you use [contexts](https://docs.nats.io/using-nats/nats-tools/nats_cli#nats-contexts). A context is a named configuration that stores the settings (such as credentials, URLs and certificates) required to connect to NATS. By creating a context, you won't need to specify your server and credentials with each new request.
39+
To simplify your interactions with NATS hosted on Scaleway, we recommend that you use [contexts](https://docs.nats.io/using-nats/nats-tools/nats_cli#nats-contexts). A context is a named configuration that stores the settings (such as credentials, URLs and certificates) required to connect to NATS. By creating a context, you won't need to specify your server and credentials with each new request.
4040

4141
### Create a context
4242

@@ -62,7 +62,7 @@ To create a [stream](/serverless/messaging/concepts/#stream), use the command `n
6262

6363
<Message type="important">
6464
Bear in mind that:
65-
- Scaleway Messaging and Queuing does not support in-memory streams: choose `File` as storage backend.
65+
- Scaleway NATS does not support in-memory streams: choose `File` as storage backend.
6666
- Some [system limits](/serverless/messaging/reference-content/limitations/) may apply by default.
6767
- If you choose a `Retention Policy` other than `Work Queue` you will be billed for the messages stored and retained.
6868
- Choosing three replicas has an impact on:

0 commit comments

Comments
 (0)