fix(bring-your-own-{image,linux}): clarify config drive options and cloud-init expectation#9375
Merged
Merged
Conversation
The previous "Custom Cloud-Init metadata" wording did not say where the values land or how to use them. Clarify that configDriveMetadata is the equivalent of OpenStack's `server create --property k=v` and that the pairs appear in the config drive's meta_data.json under the `meta` key, with a concrete example and a link to the OpenStack metadata service schema. Ref: PUBM-52977 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The previous "Your configDrive file content" wording was unclear about what the field actually is. Rename it to "cloud-init user-data" and extend the footnote to say it's standard cloud-init user-data (the equivalent of OpenStack's `server create --user-data <file>`), with a link to the upstream cloud-init format documentation. Ref: PUBM-52977 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…ons table
Only 4 of 9 customizations rows used "Your"/"votre" — the rest were already
phrased as bare noun labels ("Hostname", "EFI bootloader path",
"HTTP Headers key", etc). Drop the outliers to align: "Your image URL" →
"Image URL", "L'URL de votre image" → "L'URL de l'image", and so on.
Also drops a stray trailing period in BYOI fr-fr's imageCheckSumType row.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
dd422a9 to
78904dc
Compare
Rewrite the misleading "default vs custom" [!primary] callout near
the deployment-options table (configDriveUserData is purely
additive, not a toggle between two pre-built config drives) into a
factual paragraph on what OVHcloud creates during install and how
configDriveUserData fits in. BYOL: config drive is always added;
BYOI: only added when at least one customization on the page is
set, otherwise no config drive is created.
Add a separate brief prerequisite [!primary] in Requirements
stating that to apply OVHcloud customizations at first boot, the
image must include cloud-init or a compatible alternative (such as
FreeBSD's nuageinit).
Normalize prose to cloud-init upstream conventions ("ConfigDrive"
-> "config drive", "Cloud-Init" -> "cloud-init"; API field names
like configDriveUserData are unchanged), update an outdated 22.1_a
documentation URL, and fold the cloud-init examples link into
footnote 1 where configDriveUserData is defined.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
78904dc to
8a7bc86
Compare
JayBeeDe
approved these changes
May 11, 2026
Collaborator
|
Thank you for your contribution @sbraz! |
sbraz
pushed a commit
to ovh/bringyourownlinux
that referenced
this pull request
May 11, 2026
Mirror the doc improvements that landed in ovh/docs#9375: - Requirements blockquote: image needs cloud-init or a compatible alternative (such as FreeBSD's nuageinit) to apply OVHcloud customizations at first boot. - New "key elements" bullet for configDriveUserData (standard cloud-init user-data, link to upstream format docs and examples). - Link cloud-init on its first mention in the "What is it?" features bullet ("Customizing the image at first boot via cloud-init"). - Drop the outdated 22.1_a "Cloud-Init's ConfigDrive" sentence in the Control Panel walkthrough. - Add the OpenStack config-drive datasource link in the "Create config-drive" section description. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of Pull Request is this?
Description
fix(bring-your-own-{image,linux}): clarify configDriveMetadata field
The previous "Custom Cloud-Init metadata" wording did not say where the
values land or how to use them. Clarify that configDriveMetadata is the
equivalent of OpenStack's
server create --property k=vand that the pairsappear in the config drive's meta_data.json under the
metakey, with aconcrete example and a link to the OpenStack metadata service schema.
Ref: PUBM-52977
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
fix(bring-your-own-{image,linux}): clarify configDriveUserData field
The previous "Your configDrive file content" wording was unclear about what
the field actually is. Rename it to "cloud-init user-data" and extend the
footnote to say it's standard cloud-init user-data (the equivalent of
OpenStack's
server create --user-data <file>), with a link to theupstream cloud-init format documentation.
Ref: PUBM-52977
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
fix(bring-your-own-{image,linux}): drop possessive in deployment-options table
Only 4 of 9 customizations rows used "Your"/"votre" — the rest were already
phrased as bare noun labels ("Hostname", "EFI bootloader path",
"HTTP Headers key", etc). Drop the outliers to align: "Your image URL" →
"Image URL", "L'URL de votre image" → "L'URL de l'image", and so on.
Also drops a stray trailing period in BYOI fr-fr's imageCheckSumType row.
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
fix(bring-your-own-{image,linux}): clarify config drive documentation
Rewrite the misleading "default vs custom" [!primary] callout near
the deployment-options table (configDriveUserData is purely
additive, not a toggle between two pre-built config drives) into a
factual paragraph on what OVHcloud creates during install and how
configDriveUserData fits in. BYOL: config drive is always added;
BYOI: only added when at least one customization on the page is
set, otherwise no config drive is created.
Add a separate brief prerequisite [!primary] in Requirements
stating that to apply OVHcloud customizations at first boot, the
image must include cloud-init or a compatible alternative (such as
FreeBSD's nuageinit).
Normalize prose to cloud-init upstream conventions ("ConfigDrive"
-> "config drive", "Cloud-Init" -> "cloud-init"; API field names
like configDriveUserData are unchanged), update an outdated 22.1_a
documentation URL, and fold the cloud-init examples link into
footnote 1 where configDriveUserData is defined.
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
Mandatory information
The translations in this Pull Request have been done using: