Skip to content

Commit 8196ac6

Browse files
bene2k1tgenaitay
bene2k1
authored and
tgenaitay
committed
feat(instances): understanding qga (#3896)
1 parent 1e81d59 commit 8196ac6

File tree

4 files changed

+203
-1
lines changed

4 files changed

+203
-1
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ categories:
1010
dates:
1111
validation: 2024-10-08
1212
posted: 2024-10-08
13-
tags: Instance ssh-key ssh tag
13+
tags: instance ssh-key ssh tag
1414
---
1515

1616
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‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
meta:
3+
title: Understanding automatic network hot-reconfiguration for Scaleway Instances
4+
description: Find out how to configure automatic network hot-reconfiguration for Scaleway Instances.
5+
content:
6+
h1: Understanding automatic network hot-reconfiguration for Scaleway Instances
7+
paragraph: Find out how to configure automatic network hot-reconfiguration for Scaleway Instances.
8+
categories:
9+
- compute
10+
dates:
11+
validation: 2024-10-29
12+
posted: 2024-10-29
13+
tags: instance network hot-reconfiguration
14+
---
15+
16+
The Scaleway Instances product includes a feature called **automatic network hot-reconfiguration**.
17+
18+
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.
19+
20+
This guide explains how to enable or disable the automatic network hot-reconfiguration mechanism on your Instance.
21+
22+
<Message type="note">
23+
This documentation page does not apply to Instances running the Microsoft Windows operating system.
24+
</Message>
25+
26+
## Supported configurations
27+
28+
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/).
29+
30+
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.
31+
32+
To verify that the feature is active on your Instance, use the following command:
33+
34+
```bash
35+
# systemctl is-active scw-net-reconfig.path
36+
```
37+
38+
If the output is `active`, the feature is enabled and ready to use. If the output is `inactive`, you have to enable it first.
39+
40+
41+
### Enabling network hot-reconfiguration
42+
43+
Follow these steps to enable automatic network hot-reconfiguration on a Scaleway Instance where the feature is currently inactive.
44+
45+
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.
46+
47+
2. Install the latest Scaleway ecosystem package.
48+
49+
- **Fedora / AlmaLinux / RockyLinux / CentOS**
50+
```bash
51+
# yum -y --best install scaleway-ecosystem
52+
```
53+
54+
- **Debian / Ubuntu**
55+
```bash
56+
# apt-get update
57+
# apt-get -y install scaleway-ecosystem
58+
```
59+
60+
<Message type="note">
61+
Ensure you install version `0.0.7-1` or higher of the `scaleway-ecosystem` package.
62+
</Message>
63+
64+
3. Enable the automatic network reconfiguration mechanism.
65+
66+
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:
67+
68+
```bash
69+
# systemctl enable --now scw-net-reconfig.path
70+
```
71+
72+
<Message type="note">
73+
Rebooting your Instance will also activate network hot-reconfiguration.
74+
</Message>
75+
76+
### Disabling network hot-reconfiguration
77+
78+
If you prefer to prevent automatic network reconfiguration when a flexible IP is attached or detached, run the following command:
79+
80+
```bash
81+
# systemctl disable --now scw-net-reconfig.path
82+
```

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

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
meta:
3+
title: Understanding the QEMU Guest Agent in Scaleway Instances
4+
description: Discover how the QEMU Guest Agent works with Scaleway Instances.
5+
content:
6+
h1: Understanding the QEMU Guest Agent in Scaleway Instances
7+
paragraph: Discover how the QEMU Guest Agent works with Scaleway Instances.
8+
tags: instance qga guemu guest agent
9+
dates:
10+
validation: 2024-10-28
11+
categories:
12+
- compute
13+
---
14+
15+
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).
16+
17+
This page provides essential insights into this mechanism.
18+
19+
<Message type="note">
20+
This documentation page does not apply to Instances running the Microsoft Windows operating system.
21+
</Message>
22+
23+
## What are the features provided by QGA?
24+
25+
Running the QEMU Guest Agent (QGA) on your Instance currently enables the following feature:
26+
27+
- **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/).
28+
29+
Additional features may be added in the future.
30+
31+
## Checking QGA's status
32+
33+
Since March 1st, 2024, all Scaleway-provided GNU/Linux and InstantApp images for Instances come with QGA pre-installed and enabled by default.
34+
35+
To verify that QGA is running on your Instance, use the following command:
36+
37+
```bash
38+
# systemctl is-active qemu-guest-agent.service
39+
```
40+
41+
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.
42+
43+
## Opting in
44+
45+
Follow these steps to enable QGA on an Instance where it is currently inactive.
46+
47+
### Installation
48+
49+
Instances created from images older than March 1st, 2024 may require manual installation of the `qemu-guest-agent` package:
50+
51+
- **Fedora / AlmaLinux / RockyLinux / CentOS**
52+
53+
```bash
54+
# yum -y --best install qemu-guest-agent
55+
```
56+
57+
- **Debian / Ubuntu**
58+
59+
```bash
60+
# apt-get update
61+
# apt-get -y install qemu-guest-agent
62+
```
63+
64+
### Activation
65+
66+
After installing the package, start the `qemu-guest-agent.service` by either:
67+
68+
- Rebooting your Instance, or
69+
- Running the following command:
70+
71+
```bash
72+
# systemctl start qemu-guest-agent.service
73+
```
74+
75+
## Opting Out
76+
77+
Follow these steps to disable QGA and the associated Scaleway features.
78+
79+
### Deactivation
80+
81+
<Message type="important">
82+
Disabling QGA is not recommended, as doing so also disables all the [Scaleway features](#what-are-the-features-provided-by-qga) it provides.
83+
</Message>
84+
85+
To stop and disable QGA, run:
86+
87+
```bash
88+
# systemctl stop qemu-guest-agent.service
89+
# systemctl mask qemu-guest-agent.service
90+
```
91+
92+
This stops the service and prevents it from starting on subsequent reboots.
93+
94+
### Deinstallation (Optional)
95+
96+
<Message type="note">
97+
You do not necessarily need to deinstall QGA to opt out. [Deactivating the service](#deactivation) is sufficient.
98+
</Message>
99+
100+
If you prefer to completely remove QGA, ensure the service is stopped first, then run:
101+
102+
- **Fedora / AlmaLinux / RockyLinux / CentOS**
103+
104+
```bash
105+
# yum -y remove qemu-guest-agent
106+
```
107+
108+
- **Debian / Ubuntu**
109+
110+
```bash
111+
# apt-get -y purge qemu-guest-agent
112+
```

‎menu/navigation.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1357,6 +1357,14 @@
13571357
"label": "Understanding the differences between ARM and x86 Instances",
13581358
"slug": "understanding-differences-x86-arm"
13591359
},
1360+
{
1361+
"label": "Understanding QEMU Guest Agent",
1362+
"slug": "understanding-qemu-guest-agent"
1363+
},
1364+
{
1365+
"label": "Understanding automatic network hot-reconfiguration",
1366+
"slug": "understanding-automatic-network-hot-reconfiguration"
1367+
},
13601368
{
13611369
"label": "Understanding Instance pricing",
13621370
"slug": "understanding-instance-pricing"

0 commit comments

Comments
 (0)