Skip to content

fix(bring-your-own-{image,linux}): clarify config drive options and cloud-init expectation#9375

Merged
benchbzh merged 5 commits into
developfrom
PUBM-52977_byo_improvements
May 11, 2026
Merged

fix(bring-your-own-{image,linux}): clarify config drive options and cloud-init expectation#9375
benchbzh merged 5 commits into
developfrom
PUBM-52977_byo_improvements

Conversation

@sbraz
Copy link
Copy Markdown
Member

@sbraz sbraz commented May 7, 2026

What type of Pull Request is this?

  • Update of existing guide(s)
  • Fix

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=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

  • 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 the
    upstream 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:

  • Other tool (specify which tool was used): Claude Code (Opus 4.7)
  • This Pull Request can be merged as soon as possible.
  • This Pull Request content should be replicated for the US OVHcloud documentation: YES

Louis Sautier and others added 3 commits May 7, 2026 20:17
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>
@sbraz sbraz requested review from JayBeeDe and ashmonger May 7, 2026 19:14
@sbraz sbraz force-pushed the PUBM-52977_byo_improvements branch 6 times, most recently from dd422a9 to 78904dc Compare May 7, 2026 21:52
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>
@sbraz sbraz force-pushed the PUBM-52977_byo_improvements branch from 78904dc to 8a7bc86 Compare May 7, 2026 21:56
@benchbzh benchbzh merged commit eaade2b into develop May 11, 2026
1 check passed
@benchbzh benchbzh deleted the PUBM-52977_byo_improvements branch May 11, 2026 11:45
@benchbzh
Copy link
Copy Markdown
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>
@benchbzh benchbzh added Offer: Bare Metal The PR documents Bare Metal products: Dedicated Servers, VPS FIX The Pull Request contains fixes of code or content (typos) Minor update The Pull Request only contains minor updates of content labels May 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FIX The Pull Request contains fixes of code or content (typos) Minor update The Pull Request only contains minor updates of content Offer: Bare Metal The PR documents Bare Metal products: Dedicated Servers, VPS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants