feat(instances): understanding qga (#3896)

compute/instances/reference-content/add-instance-specific-ssh-keys-using-tags.mdx

@@ -10,7 +10,7 @@ categories:
 dates:
   validation: 2024-10-08
   posted: 2024-10-08
-tags: Instance ssh-key ssh tag
+tags: instance ssh-key ssh tag
 ---
 
 In cloud environments, managing SSH keys across multiple Instances is key to keeping your infrastructure secure and easy to access.

compute/instances/reference-content/understanding-automatic-network-hot-reconfiguration.mdx

@@ -0,0 +1,82 @@
+---
+meta:
+  title: Understanding automatic network hot-reconfiguration for Scaleway Instances
+  description: Find out how to configure automatic network hot-reconfiguration for Scaleway Instances.
+content:
+  h1: Understanding automatic network hot-reconfiguration for Scaleway Instances
+  paragraph: Find out how to configure automatic network hot-reconfiguration for Scaleway Instances.
+categories:
+  - compute
+dates:
+  validation: 2024-10-29
+  posted: 2024-10-29
+tags: instance network hot-reconfiguration
+---
+
+The Scaleway Instances product includes a feature called **automatic network hot-reconfiguration**.
+
+This mechanism automatically configures or deconfigures a [flexible IP address](/compute/instances/concepts/#flexible-ip) in the guest operating system when it is attached to or detached from an Instance.
+
+This guide explains how to enable or disable the automatic network hot-reconfiguration mechanism on your Instance.
+
+<Message type="note">
+  This documentation page does not apply to Instances running the Microsoft Windows operating system.
+</Message>
+
+## Supported configurations
+
+Before proceeding, ensure that your operating system supports the target network configuration: refer to Scaleway’s compatibility guidelines on [OS images and flexible IP type combinations](/compute/instances/reference-content/comaptibility-scw-os-images-flexible-ip/).
+
+Starting from **October 10th, 2024**, all GNU/Linux-based operating systems and InstantApp images for Scaleway Instances have automatic network hot-reconfiguration enabled by default.
+
+To verify that the feature is active on your Instance, use the following command:
+
+```bash
+# systemctl is-active scw-net-reconfig.path
+```
+
+If the output is `active`, the feature is enabled and ready to use. If the output is `inactive`, you have to enable it first.
+
+
+### Enabling network hot-reconfiguration
+
+Follow these steps to enable automatic network hot-reconfiguration on a Scaleway Instance where the feature is currently inactive.
+
+1. Enable the QEMU Guest Agent. Refer to Scaleway’s documentation on [enabling the QEMU Guest Agent (GQA)](/compute/instances/reference-content/understanding-qemu-guest-agent/#opting-in) for further details.
+
+2. Install the latest Scaleway ecosystem package.
+
+   - **Fedora / AlmaLinux / RockyLinux / CentOS**
+     ```bash
+     # yum -y --best install scaleway-ecosystem
+     ```
+
+   - **Debian / Ubuntu**
+     ```bash
+     # apt-get update
+     # apt-get -y install scaleway-ecosystem
+     ```
+
+     <Message type="note">
+       Ensure you install version `0.0.7-1` or higher of the `scaleway-ecosystem` package.
+     </Message>
+
+3. Enable the automatic network reconfiguration mechanism.
+
+   On Debian and Ubuntu systems, the mechanism typically activates automatically after installing or upgrading the `scaleway-ecosystem` package. However, RedHat-based distributions may require a manual start:
+
+   ```bash
+   # systemctl enable --now scw-net-reconfig.path
+   ```
+
+   <Message type="note">
+     Rebooting your Instance will also activate network hot-reconfiguration.
+   </Message>
+
+### Disabling network hot-reconfiguration
+
+If you prefer to prevent automatic network reconfiguration when a flexible IP is attached or detached, run the following command:
+
+   ```bash
+   # systemctl disable --now scw-net-reconfig.path
+   ```

compute/instances/reference-content/understanding-qemu-guest-agent.mdx

@@ -0,0 +1,112 @@
+---
+meta:
+  title: Understanding the QEMU Guest Agent in Scaleway Instances
+  description: Discover how the QEMU Guest Agent works with Scaleway Instances.
+content:
+  h1: Understanding the QEMU Guest Agent in Scaleway Instances
+  paragraph: Discover how the QEMU Guest Agent works with Scaleway Instances.
+tags: instance qga guemu guest agent
+dates:
+  validation: 2024-10-28
+categories:
+  - compute
+---
+
+Some features of the Instances product require Scaleway's infrastructure to query or exchange information with your Instance. To enable this communication, a software component must run on the guest operating system: the QEMU Guest Agent (QGA).
+
+This page provides essential insights into this mechanism.
+
+<Message type="note">
+  This documentation page does not apply to Instances running the Microsoft Windows operating system.
+</Message>
+
+## What are the features provided by QGA?
+
+Running the QEMU Guest Agent (QGA) on your Instance currently enables the following feature:
+
+- **Automatic network reconfiguration** upon flexible IP attachment or detachment [Learn how to enable/disable this feature](/compute/instances/reference-content/understanding-automatic-network-hot-reconfiguration/).
+
+Additional features may be added in the future.
+
+## Checking QGA's status
+
+Since March 1st, 2024, all Scaleway-provided GNU/Linux and InstantApp images for Instances come with QGA pre-installed and enabled by default.
+
+To verify that QGA is running on your Instance, use the following command:
+
+```bash
+# systemctl is-active qemu-guest-agent.service
+```
+
+If the output is `active`, QGA is running, and you are ready to benefit from the associated features. If the output is `inactive`, you may need to install and/or activate QGA.
+
+## Opting in
+
+Follow these steps to enable QGA on an Instance where it is currently inactive.
+
+### Installation
+
+Instances created from images older than March 1st, 2024 may require manual installation of the `qemu-guest-agent` package:
+
+- **Fedora / AlmaLinux / RockyLinux / CentOS**
+
+  ```bash
+  # yum -y --best install qemu-guest-agent
+  ```
+
+- **Debian / Ubuntu**
+
+  ```bash
+  # apt-get update
+  # apt-get -y install qemu-guest-agent
+  ```
+
+### Activation
+
+After installing the package, start the `qemu-guest-agent.service` by either:
+
+- Rebooting your Instance, or
+- Running the following command:
+
+  ```bash
+  # systemctl start qemu-guest-agent.service
+  ```
+
+## Opting Out
+
+Follow these steps to disable QGA and the associated Scaleway features.
+
+### Deactivation
+
+<Message type="important">
+  Disabling QGA is not recommended, as doing so also disables all the [Scaleway features](#what-are-the-features-provided-by-qga) it provides.
+</Message>
+
+To stop and disable QGA, run:
+
+```bash
+# systemctl stop qemu-guest-agent.service
+# systemctl mask qemu-guest-agent.service
+```
+
+This stops the service and prevents it from starting on subsequent reboots.
+
+### Deinstallation (Optional)
+
+<Message type="note">
+  You do not necessarily need to deinstall QGA to opt out. [Deactivating the service](#deactivation) is sufficient.
+</Message>
+
+If you prefer to completely remove QGA, ensure the service is stopped first, then run:
+
+- **Fedora / AlmaLinux / RockyLinux / CentOS**
+
+  ```bash
+  # yum -y remove qemu-guest-agent
+  ```
+
+- **Debian / Ubuntu**
+
+  ```bash
+  # apt-get -y purge qemu-guest-agent
+  ```

menu/navigation.json

@@ -1357,6 +1357,14 @@
                     "label": "Understanding the differences between ARM and x86 Instances",
                     "slug": "understanding-differences-x86-arm"
                   },
+                  {
+                    "label": "Understanding QEMU Guest Agent",
+                    "slug": "understanding-qemu-guest-agent"
+                  },
+                  {
+                    "label": "Understanding automatic network hot-reconfiguration",
+                    "slug": "understanding-automatic-network-hot-reconfiguration"
+                  },
                   {
                     "label": "Understanding Instance pricing",
                     "slug": "understanding-instance-pricing"