From a360f63c9ce2076215213d13350ddce09c4ac521 Mon Sep 17 00:00:00 2001 From: Rowena Date: Thu, 9 Jan 2025 17:05:43 +0100 Subject: [PATCH 1/2] fix(iot): doc review --- managed-services/iot-hub/how-to/add-device.mdx | 2 +- managed-services/iot-hub/how-to/change-plan.mdx | 4 ++-- .../iot-hub/how-to/connect-default-mqtt-network.mdx | 2 +- .../iot-hub/how-to/connect-default-websocket-network.mdx | 4 ++-- managed-services/iot-hub/how-to/create-hub.mdx | 2 +- managed-services/iot-hub/how-to/create-route.mdx | 2 +- managed-services/iot-hub/how-to/delete-device.mdx | 2 +- managed-services/iot-hub/how-to/delete-hub.mdx | 2 +- managed-services/iot-hub/how-to/delete-route.mdx | 2 +- .../iot-hub/how-to/enable-auto-provisioning.mdx | 2 +- managed-services/iot-hub/how-to/enable-disable-hub.mdx | 2 +- .../iot-hub/how-to/provide-own-certificate-authority.mdx | 2 +- .../iot-hub/how-to/provide-own-device-certificate.mdx | 2 +- .../iot-hub/how-to/renew-device-certificate.mdx | 2 +- .../iot-hub/how-to/setup-use-rest-network.mdx | 2 +- .../iot-hub/how-to/setup-use-sigfox-network.mdx | 2 +- managed-services/iot-hub/how-to/simulate-event.mdx | 2 +- .../iot-hub/how-to/trigger-functions-from-messages.mdx | 4 ++-- .../iot-hub/how-to/understand-event-messages.mdx | 2 +- managed-services/iot-hub/how-to/use-mqtt-webclient.mdx | 2 +- managed-services/iot-hub/how-to/view-metrics.mdx | 2 +- managed-services/iot-hub/quickstart.mdx | 9 +++++---- network/vpc/reference-content/vpc-migration.mdx | 8 ++++---- 23 files changed, 33 insertions(+), 32 deletions(-) diff --git a/managed-services/iot-hub/how-to/add-device.mdx b/managed-services/iot-hub/how-to/add-device.mdx index 3f42981616..fc6fcc3eb5 100644 --- a/managed-services/iot-hub/how-to/add-device.mdx +++ b/managed-services/iot-hub/how-to/add-device.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to add a device to IoT Hub tags: iot iot-hub mqtt dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/change-plan.mdx b/managed-services/iot-hub/how-to/change-plan.mdx index 4b13a86a30..3355ebfe3e 100644 --- a/managed-services/iot-hub/how-to/change-plan.mdx +++ b/managed-services/iot-hub/how-to/change-plan.mdx @@ -7,13 +7,13 @@ content: paragraph: This page explains how to change the product plan for an IoT Hub tags: iot iot-hub plan dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services --- -If your project grows, you may require to upgrade your IoT Hub to a more powerful version to handle your applications load. You can upgrade your hub via the Scaleway console. +If your project grows, you may need to upgrade your IoT Hub to a more powerful version to handle your application load. You can upgrade your hub via the Scaleway console. diff --git a/managed-services/iot-hub/how-to/connect-default-mqtt-network.mdx b/managed-services/iot-hub/how-to/connect-default-mqtt-network.mdx index 1819587922..b99a0f4f42 100644 --- a/managed-services/iot-hub/how-to/connect-default-mqtt-network.mdx +++ b/managed-services/iot-hub/how-to/connect-default-mqtt-network.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to connect to the default MQTT network tags: iot iot-hub mqtt mqtt-network dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/connect-default-websocket-network.mdx b/managed-services/iot-hub/how-to/connect-default-websocket-network.mdx index 12c5adf32f..b448d11993 100644 --- a/managed-services/iot-hub/how-to/connect-default-websocket-network.mdx +++ b/managed-services/iot-hub/how-to/connect-default-websocket-network.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to connect to the default WebSocket network tags: websocket websocket-network iot iot-hub dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services @@ -28,7 +28,7 @@ Each Hub automatically creates a default WebSocket network, and, like the defaul - **Host**: The network endpoint. - **Port**: Use `80` for plaintext or `443` for TLS. - **MQTT Username**: The *Device ID* from the device you created earlier. - - If your client asks for a password, just pass in an empty string. + - If your client asks for a password, pass in an empty string. Mutual TLS authentication is not available on this network, which means that devices that connect over this network must `Allow Insecure` connections. diff --git a/managed-services/iot-hub/how-to/create-hub.mdx b/managed-services/iot-hub/how-to/create-hub.mdx index 09e86a2b7b..6be4d9ba18 100644 --- a/managed-services/iot-hub/how-to/create-hub.mdx +++ b/managed-services/iot-hub/how-to/create-hub.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to create an IoT Hub tags: iot iot-hub dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/create-route.mdx b/managed-services/iot-hub/how-to/create-route.mdx index 36456961ea..fc6e1bdd04 100644 --- a/managed-services/iot-hub/how-to/create-route.mdx +++ b/managed-services/iot-hub/how-to/create-route.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to create an IoT Hub route. tags: iot iot-hub iot-hub-route dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/delete-device.mdx b/managed-services/iot-hub/how-to/delete-device.mdx index 6452175c0f..01b75dfd85 100644 --- a/managed-services/iot-hub/how-to/delete-device.mdx +++ b/managed-services/iot-hub/how-to/delete-device.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to delete an IoT Hub device tags: iot iot-hub dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/delete-hub.mdx b/managed-services/iot-hub/how-to/delete-hub.mdx index 5a69ac9ae3..f360ce2d7a 100644 --- a/managed-services/iot-hub/how-to/delete-hub.mdx +++ b/managed-services/iot-hub/how-to/delete-hub.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to delete an IoT Hub tags: iot iot-hub dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/delete-route.mdx b/managed-services/iot-hub/how-to/delete-route.mdx index 1830b30d3f..c8bd4bbe33 100644 --- a/managed-services/iot-hub/how-to/delete-route.mdx +++ b/managed-services/iot-hub/how-to/delete-route.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to delete an IoT Hub route tags: iot iot-hub iot-hub-route dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/enable-auto-provisioning.mdx b/managed-services/iot-hub/how-to/enable-auto-provisioning.mdx index 7860439538..57a8a3160c 100644 --- a/managed-services/iot-hub/how-to/enable-auto-provisioning.mdx +++ b/managed-services/iot-hub/how-to/enable-auto-provisioning.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to enable device auto-provisioning tags: iot iot-hub auto-provisioning dates: - validation: 2024-11-13 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/enable-disable-hub.mdx b/managed-services/iot-hub/how-to/enable-disable-hub.mdx index 6f5ba9787e..62ba7df1ab 100644 --- a/managed-services/iot-hub/how-to/enable-disable-hub.mdx +++ b/managed-services/iot-hub/how-to/enable-disable-hub.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to enable or disable an IoT Hub tags: iot iot-hub dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/provide-own-certificate-authority.mdx b/managed-services/iot-hub/how-to/provide-own-certificate-authority.mdx index 3c5bcfb04e..d114ac235c 100644 --- a/managed-services/iot-hub/how-to/provide-own-certificate-authority.mdx +++ b/managed-services/iot-hub/how-to/provide-own-certificate-authority.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to provide your own Certificate Authority tags: iot-hub iot certificate authority certificate-authority dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/provide-own-device-certificate.mdx b/managed-services/iot-hub/how-to/provide-own-device-certificate.mdx index f12a1463c4..1910892ca4 100644 --- a/managed-services/iot-hub/how-to/provide-own-device-certificate.mdx +++ b/managed-services/iot-hub/how-to/provide-own-device-certificate.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to provide your own device certificate tags: iot iot-hub device-certificate dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2021-07-07 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/renew-device-certificate.mdx b/managed-services/iot-hub/how-to/renew-device-certificate.mdx index 6ab3ef2829..a988f570a1 100644 --- a/managed-services/iot-hub/how-to/renew-device-certificate.mdx +++ b/managed-services/iot-hub/how-to/renew-device-certificate.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to renew a Scaleway-generated certificate of a device. tags: iot iot-hub dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2021-07-09 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/setup-use-rest-network.mdx b/managed-services/iot-hub/how-to/setup-use-rest-network.mdx index 254dd01126..9e9db1fa4b 100644 --- a/managed-services/iot-hub/how-to/setup-use-rest-network.mdx +++ b/managed-services/iot-hub/how-to/setup-use-rest-network.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how set up and use a REST network tags: iot iot-hub rest-network dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/setup-use-sigfox-network.mdx b/managed-services/iot-hub/how-to/setup-use-sigfox-network.mdx index 32f8529594..8cde3b42fc 100644 --- a/managed-services/iot-hub/how-to/setup-use-sigfox-network.mdx +++ b/managed-services/iot-hub/how-to/setup-use-sigfox-network.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to set up and use a Sigfox network tags: iot iot-hub sigfox sigfox-network dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/simulate-event.mdx b/managed-services/iot-hub/how-to/simulate-event.mdx index fd2267c476..f026694441 100644 --- a/managed-services/iot-hub/how-to/simulate-event.mdx +++ b/managed-services/iot-hub/how-to/simulate-event.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to generate an error and receive an event tags: iot iot-hub error dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2021-06-05 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/trigger-functions-from-messages.mdx b/managed-services/iot-hub/how-to/trigger-functions-from-messages.mdx index d6cde19085..8658befa38 100644 --- a/managed-services/iot-hub/how-to/trigger-functions-from-messages.mdx +++ b/managed-services/iot-hub/how-to/trigger-functions-from-messages.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to configure your IoT Hub and a Serverless function to trigger the function when a message is published on the Hub. tags: IoT Hub iot-hub Serverless FaaS function dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2020-08-21 categories: - managed-services @@ -15,7 +15,7 @@ categories: Function as a Service allows developers to run code without the hassle of managing the server/Instance running it. -IoT Hub allows messages to be exchanged between devices and business-specific software. Some or all components of this software can be implemented using Serverless Functions, and IoT Hub can be configured to trigger these functions to process messages being exchanged on the hub. +IoT Hub allows messages to be exchanged between devices and business-specific software. Some or all components of this software can be implemented using Scaleway Serverless Functions, and IoT Hub can be configured to trigger these functions to process messages being exchanged on the hub. diff --git a/managed-services/iot-hub/how-to/understand-event-messages.mdx b/managed-services/iot-hub/how-to/understand-event-messages.mdx index 8aee54ccf3..a97ec45b6a 100644 --- a/managed-services/iot-hub/how-to/understand-event-messages.mdx +++ b/managed-services/iot-hub/how-to/understand-event-messages.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to understand event messages tags: iot iot-hub event-message dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2021-06-05 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/use-mqtt-webclient.mdx b/managed-services/iot-hub/how-to/use-mqtt-webclient.mdx index b4a9d750e2..eb891a37c4 100644 --- a/managed-services/iot-hub/how-to/use-mqtt-webclient.mdx +++ b/managed-services/iot-hub/how-to/use-mqtt-webclient.mdx @@ -8,7 +8,7 @@ content: totalTime: PT5M tags: iot iot-hub mqtt webclient dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2021-09-01 categories: - managed-services diff --git a/managed-services/iot-hub/how-to/view-metrics.mdx b/managed-services/iot-hub/how-to/view-metrics.mdx index 45dbe69e0d..72189bbcee 100644 --- a/managed-services/iot-hub/how-to/view-metrics.mdx +++ b/managed-services/iot-hub/how-to/view-metrics.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to view metrics tags: iot iot-hub metrics dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2019-10-01 categories: - managed-services diff --git a/managed-services/iot-hub/quickstart.mdx b/managed-services/iot-hub/quickstart.mdx index dbc767ad1b..0ed5ad2386 100644 --- a/managed-services/iot-hub/quickstart.mdx +++ b/managed-services/iot-hub/quickstart.mdx @@ -7,7 +7,7 @@ content: paragraph: This page shows you how to get started with Scaleway IoT Hub. tags: iot iot-hub dates: - validation: 2024-07-04 + validation: 2025-01-09 posted: 2021-05-26 categories: - managed-services @@ -33,7 +33,7 @@ In this Quickstart, we show you how to create your first IoT Hub to connect obje - **High Availability (HA) Plan:** Not only are resources dedicated to the hub, they are also replicated so that the broker is highly available. This setting is ideal for workloads that require greater robustness for their hub. 5. Click **Create hub** or **Create hub and add device**. - If you want to directly add a first device to the hub, click **Create a hub and add device** and continue with the documentation [IoT Hub - Devices](/managed-services/iot-hub/how-to/add-device/) + If you want to directly add a first device to the hub, click **Create hub and add device** and continue with the documentation [IoT Hub - Devices](/managed-services/iot-hub/how-to/add-device/) ## How to add a device @@ -72,7 +72,8 @@ To exchange messages between our two devices, we are going to open two web-based 1. Click the first device to see its status page. 2. Click **MQTT Webclient** to open the client. A pop-up displays. 3. Go back to the devices overview and repeat the steps above for the second device. -4. You now have two MQTT webclients open, one for the **publisher** and one for the **subscriber**. The client connects automatically to its associated device. Now that the 2 clients are connected, let's set up the subscription: + You now have two MQTT webclients open, one for the **publisher** and one for the **subscriber**. The client connects automatically to its associated device. Now that the 2 clients are connected, set up the subscription: +4. Follow these instructions to set up the subscription: * On the **publisher**: * Set the topic `my/first/topic` @@ -82,7 +83,7 @@ To exchange messages between our two devices, we are going to open two web-based * Click OK -5. Now that we have subscribed to the topic `my/first/topic`, we will post a message on the **publisher** device. Type the message in the form and click **Publish**: +5. Post a message on the **publisher** device. Type the message in the form and click **Publish**: You can see in the "Messages" box that the message published by **publisher** has been received by the **subscriber**. Congratulations, you have successfully configured your first IoT Hub. diff --git a/network/vpc/reference-content/vpc-migration.mdx b/network/vpc/reference-content/vpc-migration.mdx index 4070fd4718..469ae20266 100644 --- a/network/vpc/reference-content/vpc-migration.mdx +++ b/network/vpc/reference-content/vpc-migration.mdx @@ -7,7 +7,7 @@ content: paragraph: This page outlines the changes that arrived with the VPC product going into General Availability, and how existing configurations were migrated. tags: vpc regional zoned zonal private-networks public-gateway dhcp migration migrate subnet general-availability ga dates: - validation: 2024-07-03 + validation: 2025-01-09 posted: 2023-06-20 categories: - network @@ -41,7 +41,7 @@ There is also an impact on pre-existing Private Networks. There are three aspect - **Zoned > Regional**: All pre-existing zoned Private Networks have been automatically migrated by Scaleway, and are now regional Private Networks inside a VPC. - **DHCP activation**: Prior to VPC GA, DHCP was not itself present on any pre-existing Private Networks. It was instead a feature of the [Public Gateway](/network/public-gateways/concepts/#public-gateway) which could optionally be attached to a Private Network and (if DHCP was activated), automatically assign private IP addresses to attached resources. When VPC went into GA, DHCP functionality was moved from Public Gateways to Private Networks themselves. **Whether or not DHCP has been automatically activated on your pre-existing Private Network depends on the specificities of your configuration**. -- **Managed DNS**: All new Private Networks benefit from Managed DNS, to facilitate resource name resolution between different resources attached to the Private Network. **Private Networks attached to a Public Gateway continue to use the Gateway's DNS**. +- **Managed DNS**: All new Private Networks benefit from Managed DNS, to facilitate resource name resolution between different resources attached to the Private Network. **Private Networks attached to a legacy Public Gateway continue to use the Gateway's DNS**. Read on for more information about these three aspects. @@ -79,7 +79,7 @@ Whether or not the managed DHCP server has been automatically activated on your | Your configuration | Impact | |-------------------------------------------------------------------|-------------------------------------------------------------------------| | I have a Private Network, with no Public Gateway attached to it | DHCP has **not** been automatically activated on your Private Network, to avoid any conflicts with your existing IP addressing.

You should see a button in the Scaleway console inviting you to activate DHCP if/when you are ready. Note that activating DHCP is permanent, and there is no way to undo the activation, so proceed with caution. | -| I have a Private Network, attached to a Public Gateway, but DHCP is disabled on the gateway. | DHCP has **not** be automatically activated on your Private Network, to avoid any conflicts with your existing IP addressing.

You should see a button in the Scaleway console inviting you to activate DHCP if/when you are ready. Note that activating DHCP is permanent, and there is no way to undo the activation, so proceed with caution. | +| I have a Private Network, attached to a Public Gateway, but DHCP is disabled on the gateway. | DHCP has **not** been automatically activated on your Private Network, to avoid any conflicts with your existing IP addressing.

You should see a button in the Scaleway console inviting you to activate DHCP if/when you are ready. Note that activating DHCP is permanent, and there is no way to undo the activation, so proceed with caution. | | I have a Private Network, attached to a Public Gateway, and DHCP is enabled on the gateway. | DHCP **has** been automatically activated on your Private Network, and cannot be deactivated. We take care of IP management of your resources within your Private Network (see details above).

All the Public Gateway's leases are synchronized with the managed DHCP, so there is no impact for you and no action is necessary. | | I have a Private Network with my own DHCP server running on it | We assume that your network is therefore not attached to a Public Gateway with DHCP enabled (which would cause conflicts with your own DHCP server). DHCP has **not** been automatically activated on your Private Network, to avoid any conflicts with your existing IP addressing.

You should see a button in the Scaleway console inviting you to activate DHCP if/when you are ready. Note that activating DHCP is permanent, and there is no way to undo the activation, so proceed with caution. | @@ -114,7 +114,7 @@ You may have observed the following behavior when during the period directly fol **Public Gateways created via the [Scaleway console](https://console.scaleway.com/) after October 17 2023 are IPAM-mode gateways, and the temporary behavior described above no longer applies.** These gateways are fully compatible with Scaleway's [IPAM](/network/vpc/concepts/#ipam) and no longer need to auto-create their own VPC for attached Private Networks to ensure IPAM compatibility. **Public Gateways created before October 17 2023 are legacy gateways, and their attached Private Networks must stay in the gateway's auto-created VPC to ensure IPAM compatibility.** - +in 2023 You can tell whether your Public Gateway is in legacy mode or IPAM mode, by referring to the "mode" badge in the [listing of your Public Gateway in the Scaleway console](https://console.scaleway.com/public-gateway/public-gateways). From 6b5f489fe9520ba4c0259e81aeceb37e3c5eb62b Mon Sep 17 00:00:00 2001 From: Rowena Date: Thu, 9 Jan 2025 17:06:51 +0100 Subject: [PATCH 2/2] fix(typo) --- network/vpc/reference-content/vpc-migration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/network/vpc/reference-content/vpc-migration.mdx b/network/vpc/reference-content/vpc-migration.mdx index 469ae20266..5129283974 100644 --- a/network/vpc/reference-content/vpc-migration.mdx +++ b/network/vpc/reference-content/vpc-migration.mdx @@ -114,7 +114,7 @@ You may have observed the following behavior when during the period directly fol **Public Gateways created via the [Scaleway console](https://console.scaleway.com/) after October 17 2023 are IPAM-mode gateways, and the temporary behavior described above no longer applies.** These gateways are fully compatible with Scaleway's [IPAM](/network/vpc/concepts/#ipam) and no longer need to auto-create their own VPC for attached Private Networks to ensure IPAM compatibility. **Public Gateways created before October 17 2023 are legacy gateways, and their attached Private Networks must stay in the gateway's auto-created VPC to ensure IPAM compatibility.** -in 2023 + You can tell whether your Public Gateway is in legacy mode or IPAM mode, by referring to the "mode" badge in the [listing of your Public Gateway in the Scaleway console](https://console.scaleway.com/public-gateway/public-gateways).