Skip to content

Commit

Permalink
fix(MNQ): content revision (#2450)
Browse files Browse the repository at this point in the history
* fix(MNQ): content revision

* Update serverless/messaging/concepts.mdx
  • Loading branch information
jcirinosclwy authored Nov 27, 2023
1 parent 2358098 commit e8d84c0
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
14 changes: 7 additions & 7 deletions serverless/messaging/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ A **D**ead **L**etter **Q**ueue (DLQ), or **undelivered-message queue**, receive

## Fanout

Fanout is a type of messaging pattern. A fanout exchange broadcasts messages to all queues/consumers it is aware of. This allows the same published message to be consumed by different consumers, who will process it in different ways. Each message is processed in the order in which it arrives
Fanout is a type of messaging pattern. A fanout exchange broadcasts messages to all queues/consumers it is aware of. This allows the same published message to be consumed by different consumers, who will process it in different ways. Each message is processed in the order in which it arrives.

</Concept>

Expand Down Expand Up @@ -105,7 +105,7 @@ The message retention period is a setting that can be configured for an SQS queu

## Messaging and Queuing

Scaleway's Messaging and Queuing product is a [message broker](#message-broker) tool that allows you to transfer messages between different microservices and platforms. This enables them to "talk" to each other effectively even if they are not otherwise compatible. Messaging and Queuing enables and simplifies microservices application development and allows you to build highly scalable, reliable, distributed applications.
Scaleway's Messaging and Queuing product is a [message broker](#message-broker) tool that allows you to transfer messages between different microservices and platforms. This enables them to "talk" to each other effectively even if they are not otherwise compatible. Messaging and Queuing enables and simplifies microservices application development and allows you to build highly scalable, reliable, distributed applications.

</Concept>

Expand Down Expand Up @@ -147,7 +147,7 @@ A NATS account sets a scope for any NATS credentials, messages, queues and strea

Scaleway offers three protocols to use with Messaging and Queuing: [NATS](#nats), [SQS](#sqs), and [SNS](#sns).

To create a message broker configured for the NATS protocol, you must create a [NATS account](#nats-account) and then create credentials for that account. The account gives you an endpoint/URL for your NATS message broker.
To create a message broker configured for the NATS protocol, you must create a [NATS account](#nats-account) and then create credentials for that account. The account gives you an endpoint/URL for your NATS message broker.

For a message broker configured for the SQS or SNS protocols, you must activate the required protocol, and then create credentials for the protocol. Once activated, you get an endpoint/URL for your SQS or SNS message broker. You can activate both protocols: in this case, you must create separate credentials for each one, and they will each have a separate endpoint/URL.

Expand All @@ -157,7 +157,7 @@ For a message broker configured for the SQS or SNS protocols, you must activate

## Publish/Subscribe

Also known as "pub/sub", the publish/subscribe model provides a pattern or framework for the exchange of messages between publishers and subscribers. It contrasts with the [queuing](#queuing) model. The key feature of publish/subscribe is that messages are not sent to defined recipients. Instead, subscribers define the types of message they are interested in, and only receive messages matching their criteria. The publisher sends the message without knowing exactly who will receive it. The process of selecting which messages to receive is called [filtering](#filtering), which can be [topic-based](#topic-based) or [content-based](#content-based). The publish/subscribe model relies on a [message broker](#message-broker) to relay messages between publishers and subscribers.
Also known as "pub/sub", the publish/subscribe model provides a pattern or framework for the exchange of messages between publishers and subscribers. It contrasts with the [queuing](#queuing) model. The key feature of publish/subscribe is that messages are not sent to defined recipients. Instead, subscribers define the types of message they are interested in, and only receive messages matching their criteria. The publisher sends the message without knowing exactly who will receive it. The process of selecting which messages to receive is called [filtering](#filtering), which can be [topic-based](#topic-based) or [content-based](#content-based). The publish/subscribe model relies on a [message broker](#message-broker) to relay messages between publishers and subscribers.

</Concept>

Expand All @@ -181,7 +181,7 @@ When creating queues with Scaleway Messaging and Queuing SQS or SNS, two queue t

## Queuing

The message queuing model provides a pattern or framework for sending messages, which contrasts with the [publish/subscribe](#publishsubscribe) model. Queuing is a form of asynchronous service-to-service communication. Whereas with the publish/subscribe model multiple subscribers can receive each message, with the queuing model, messages have just one destination. Messages are stored in the queue until they are processed and delivered, and they are deleted once consumed. This model is used in serverless and microservices architectures.
The message queuing model provides a pattern or framework for sending messages, which contrasts with the [publish/subscribe](#publishsubscribe) model. Queuing is a form of asynchronous service-to-service communication. Whereas with the publish/subscribe model multiple subscribers can receive each message, with the queuing model, messages have just one destination. Messages are stored in the queue until they are processed and delivered, and they are deleted once consumed. This model is used in serverless and microservices architectures.

</Concept>

Expand Down Expand Up @@ -214,8 +214,8 @@ The **S**imple **N**otification **S**ervice, or SNS, is a [publish/subscribe](#p

## SQS

The **S**imple **Q**ueue **S**ervice, or SQS, is a distributed message [queuing](#queuing) service that supports programmatic sending of messages via web service applications. The SQS protocol offers two types of message queues:
- **Standard** queues offer maximum throughput, best-effort ordering, and at-least-once delivery.
The **S**imple **Q**ueue **S**ervice, or SQS, is a distributed message [queuing](#queuing) service that supports programmatic sending of messages via web service applications. The SQS protocol offers two types of message queues:
- **Standard** queues offer maximum throughput, best-effort ordering, and at-least-once delivery.
- **FIFO** queues are designed to guarantee that messages are processed exactly once, in the exact order that they are sent.

</Concept>
Expand Down
10 changes: 5 additions & 5 deletions serverless/messaging/how-to/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Both procedures are described in full below.
<Macro id="iam-requirements" />

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com).
</Message>

## How to create a NATS account
Expand All @@ -44,8 +44,8 @@ To start using a NATS message broker, you must first create a NATS account. This

- Choose a **region**, which is the geographical location in which your NATS account will be created. Currently, only the `PARIS` region is available.
- Enter a **name** for your NATS account, or use the auto-generated name suggested for you.
- Optional: Use the *Estimated cost** calculator to simulate how messages sent and stored with NATS streams will be billed. Note that simply creating a NATS account does not in itself incur any billing. For more information about NATS billing, see the [FAQ](/faq/messaging-and-queuing/#how-is-messaging-and-queuing-billed).
- Click **Create NATS account** to finish
- Optional: Use the *Estimated cost** calculator to simulate how messages sent and stored with NATS streams will be billed. Note that simply creating a NATS account does not in itself incur any billing. For more information about NATS billing, see the [FAQ](/faq/messaging-and-queuing/#how-is-messaging-and-queuing-billed).
- Click **Create NATS account** to finish.

You are directed to the listing of your NATS accounts, where your newly-created NATS account now appears.

Expand All @@ -66,9 +66,9 @@ SQS and SNS are handled as two separate protocols. Each one needs to be activate

A message displays prompting you to click a button to activate the protocol. It also reminds you that activating the protocol does not trigger any billing, and that you can deactivate at any time.

3. Click **Actvate SQS** (or SNS).
3. Click **Activate SQS** (or SNS).

The protocol is activated and you are invited to [generate credentials](/serverless/messaging/how-to/create-credentials/).
The protocol is activated, and you are invited to [generate credentials](/serverless/messaging/how-to/create-credentials/).

<Navigation title="See Also">
<NextButton to="/serverless/messaging/how-to/create-credentials/">How to create credentials</NextButton>
Expand Down
2 changes: 1 addition & 1 deletion serverless/messaging/how-to/manage-credentials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This page shows how to manage [credentials](/serverless/messaging/concepts/#cred

1. Click **Messaging** in the **Serverless** section of the Scaleway console side menu. The list of Messaging and Queuing protocols displays.

2. Click SQS or SNS depending on which service you want to update credentials for.
2. Click SQS or SNS, depending on which service you want to update credentials for.

3. In the **Credentials** tab, click the <Icon name="more" /> button next to the credentials you want to update, and select **Update credentials**. A pop-up displays, such as the one below for SQS:

Expand Down
2 changes: 1 addition & 1 deletion serverless/messaging/how-to/migrate-to-new-mnq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ SNS namespaces and credentials created with Scaleway Messaging and Queuing befor
<Message type="important">
You **must** update the endpoint in any code or applications using these endpoints. After 30 days, the old endpoints will no longer be supported.<br/>
<br/>
If you use the API to manage your resources, you should use the new `v1beta1` version of the Messaging and Queuing SQS API going forward. This is available on the [Scaleway developers website](https://www.scaleway.com/en/developers/api/). Note that your previous resources (SNS namespaces, credentials etc) still exist on the old `v1alpha1` version of the API, which you can also access, but after 30 days these resources will be deleted.
If you use the API to manage your resources, you should use the new `v1beta1` version of the Messaging and Queuing SQS API going forward. This is available on the [Scaleway developers website](https://www.scaleway.com/en/developers/api/). Note that your previous resources (SNS namespaces, credentials etc.) still exist on the old `v1alpha1` version of the API, which you can also access, but after 30 days these resources will be deleted.
</Message>

<Message type="tip">
Expand Down
8 changes: 4 additions & 4 deletions serverless/messaging/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This quickstart guide is divided into two sections, depending on the protocol yo
<Macro id="iam-requirements" />

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com).
</Message>

## Quickstart for SQS or SNS
Expand All @@ -39,9 +39,9 @@ SQS and SNS are handled as two separate protocols. Each one needs to be activate

A message displays prompting you to click a button to activate the protocol. It also reminds you that activating the protocol does not trigger any billing, and that you can deactivate at any time.

3. Click **Actvate SQS** (or SNS).
3. Click **Activate SQS** (or SNS).

The protocol is activated and you are invited to generate credentials.
The protocol is activated, and you are invited to generate credentials.

### How to create credentials for SQS or SNS

Expand All @@ -56,7 +56,7 @@ Credentials for SQS or SNS are granular: you can define the level of access that

4. Enter a name for these credentials.

5. Select the required permissions for the credentials. You must choose at least one of **Write**, **Read** and **Manage**. You are free to select any combination of these permissions.
5. Select the required permissions for the credentials. You must choose at least one of **Write**, **Read** and **Manage**. You are free to select any combination of these permissions.

6. Click **Generate credentials**.

Expand Down
2 changes: 1 addition & 1 deletion serverless/messaging/reference-content/migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Note the following important information about the migration/crossover period, w
- The `v1beta1` API also becomes available. You should recreate your resources in this API.
- The console now uses the `v1beta1` API. **You are no longer able to see or manage your old resources from the `v1alpha1` API via the console**. Any resources now created via the console exist in the `v1beta1` API.

**30 days afterwards**
**30 days afterward**
- The `v1alpha1` API will be decommissioned. Any resources still existing on this API will be deleted.

**The URL/endpoints for your Messaging and Queuing SNS service and for your topics are not the same in the two versions**. Make sure that when you recreate your resources with the new version, you remember to update the endpoint in any code, scripts, applications and architectures that were using the old endpoint. If you do not do so, they will continue to access the "old" resources rather than the new ones you have created for the new version.
Expand Down

0 comments on commit e8d84c0

Please sign in to comment.