-
Notifications
You must be signed in to change notification settings - Fork 260
feat(instances): understanding qga #3896
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
bb419c8
feat(instances): understanding qga
bene2k1 8b71bd5
docs(fix): fixed typo and date
bene2k1 57a6bb5
fix(ins): fixed description
bene2k1 bb80f82
Apply suggestions from code review
bene2k1 0f23e03
feat(ins): network hot-autoconfig
bene2k1 ddaca0b
feat(ins): fix some typos
bene2k1 24fbd8f
Apply suggestions from code review
bene2k1 ad4948c
Apply suggestions from code review
bene2k1 681338a
Update compute/instances/reference-content/understanding-automatic-ne…
bene2k1 a755a55
Update compute/instances/reference-content/understanding-qemu-guest-a…
bene2k1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
...ances/reference-content/understanding-automatic-network-hot-reconfiguration.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - **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 | ||
| ``` | ||
112 changes: 112 additions & 0 deletions
112
compute/instances/reference-content/understanding-qemu-guest-agent.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| meta: | ||
| title: Understanding the QEMU Guest Agent in Scaleway Instances | ||
| description: Discover how the QEMU Guest Agent in Scaleway Instances works. | ||
| content: | ||
| h1: Understanding the QEMU Guest Agent in Scaleway Instances | ||
| paragraph: Discover how the QEMU Guest Agent in Scaleway Instances works. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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](). | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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 | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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"> | ||
| Deinstalling QGA is not strictly necessary to opt out. [Deactivating the service](#deactivation) is sufficient. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| </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 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.