Bring Your Own Image (BYOI)

Objectif

La fonctionnalité Bring Your Own Image (BYOI) vous permet de déployer des images cloudready directement sur votre serveur dédié. Vous pouvez ainsi utiliser le service bare metal comme ressource pour vos déploiements.

Que signifie cloudready ?

La norme cloudready signifie généralement être agnostique de l’infrastructure sur laquelle l’image est déployée. En plus des prérequis et limitations mentionnés ci-dessous, vous devez vous assurer que l'image (téléchargée ou générée) répond correctement à la définition des attentes techniques d'une image cloudready.

Ce guide vous explique comment utiliser Bring Your Own Image (BYOI) sur votre serveur dédié OVHcloud.

Prérequis

• Un serveur dédié dans votre compte OVHcloud
• Avoir accès à l'API OVHcloud (pour la méthode de déploiement via l'API de ce guide)
• Votre image doit être inférieure à la RAM du serveur moins 3 Gio

Accès à l'espace client OVHcloud

• Lien direct : Serveurs dédiés
• Pour accéder à vos services : Bare Metal Cloud > Serveurs dédiés > Sélectionnez votre serveur

En pratique

Limites techniques :

Certaines limites techniques sont liées à l’utilisation de produits physiques comme les serveurs dédiés. Voici une liste non exhaustive à garder à l'esprit lors de la préparation de votre déploiement :

• Type de démarrage : uefi ou legacy
• Type de partition : MBR ou GPT
• Format de l'image : qcow2 ou raw

Méthodes de déploiement :

• Déploiement via l'espace client : vous permet de déployer simplement votre image depuis l'espace client OVHcloud.
• Déploiement via API : vous pouvez utiliser l’API OVHcloud pour intégrer des images dans vos propres scripts afin d’automatiser les déploiements.

Déploiement de votre image via l’espace client

Dans l'onglet Informations générales, cliquez sur le bouton ... à côté de « Système (OS) » puis cliquez sur Installer.

À l'étape suivante, sélectionnez Personnalisé dans le menu puis Bring Your Own Image - byoi et cliquez sur Suivant.

Vous allez être redirigé vers la page de configuration. Assurez-vous que l'URL de votre image est au bon format. Remplissez le reste des champs obligatoires de cette page. Une fois que vous avez confirmé que les informations sont correctes, cliquez sur Confirmer.

Vous trouverez plus de détails sur les options dans la section « options de déploiement » ci-dessous.

Déploiement de votre image via l'API

Connectez-vous sur https://api.ovh.com/ puis rendez-vous dans la section /dedicated/server.

Le contenu de la requête API de Bring Your Own Image (BYOI) doit être similaire au fichier JSON suivant :

{
  "operatingSystem": "byoi_64",
  "customizations": {
    "hostname": "mon-tux",
    "imageURL": "https://cdimage.debian.org/cdimage/cloud/bullseye/20230124-1270/debian-11-generic-amd64-20230124-1270.raw",
    "imageType": "raw",
    "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9xPpdqP3sx2H+gcBm65tJEaUbuifQ1uGkgrWtNY0PRKNNPdy+3yoVOtxk6Vjo4YZ0EU/JhmQfnrK7X7Q5vhqYxmozi0LiTRt0BxgqHJ+4hWTWMIOgr+C2jLx7ZsCReRk+fy5AHr6h0PHQEuXVLXeUy/TDyuY2JPtUZ5jcqvLYgQ== my-nuclear-power-plant",
    "efiBootloaderPath": "\\efi\\debian\\grubx64.efi",
    "imageCheckSum": "2cbd3dd5606ef95a5cfa47943b3ad453fcc43522915be7f559a296a71395f82f88e621e558df7aa5f3d2e62c20043f9430ad18c900e565a1c070066e8d008aaa",
    "httpHeaders": {
      "Authorization": "Basic bG9naW46cGFzc3dvcmQ="
    },
    "imageCheckSumType": "sha512",
    "configDriveUserData": "I2Nsb3VkLWNvbmZpZwpzc2hfYXV0aG9yaXplZF9rZXlzOgogIC0gc3NoLXJzYSBBQUFBQjhkallpdz09IG15c2VsZkBteWRvbWFpbi5uZXQKCnVzZXJzOgogIC0gbmFtZTogcGF0aWVudDAKICAgIHN1ZG86IEFMTD0oQUxMKSBOT1BBU1NXRDpBTEwKICAgIGdyb3VwczogdXNlcnMsIHN1ZG8KICAgIHNoZWxsOiAvYmluL2Jhc2gKICAgIGxvY2tfcGFzc3dkOiBmYWxzZQogICAgc3NoX2F1dGhvcml6ZWRfa2V5czoKICAgICAgLSBzc2gtcnNhIEFBQUFCOGRqWWl3PT0gbXlzZWxmQG15ZG9tYWluLm5ldApkaXNhYmxlX3Jvb3Q6IGZhbHNlCnBhY2thZ2VzOgogIC0gdmltCiAgLSB0cmVlCmZpbmFsX21lc3NhZ2U6IFRoZSBzeXN0ZW0gaXMgZmluYWxseSB1cCwgYWZ0ZXIgJFVQVElNRSBzZWNvbmRzCg=="
  }
}

Même si configDriveUserData peut être envoyé à l'API directement en clair en échappant les bons caractères, il est recommandé d'envoyer à l'API le script encodé en base64 en utilisant par exemple la commande UNIX/Linux suivante :

cat my-data.yaml | base64 -w0

Voici la version en clair de configDriveUserData de l'exemple ci-dessus :

#cloud-config
ssh_authorized_keys:
  - ssh-rsa AAAAB8djYiw== myself@mydomain.net

users:
  - name: patient0
    sudo: ALL=(ALL) NOPASSWD:ALL
    groups: users, sudo
    shell: /bin/bash
    lock_passwd: false
    ssh_authorized_keys:
      - ssh-rsa AAAAB8djYiw== myself@mydomain.net
disable_root: false
packages:
  - vim
  - tree
final_message: The system is finally up, after $UPTIME seconds

Une fois les champs complétés, démarrez le déploiement en cliquant sur Execute.

Options de déploiement

¹ Données utilisateur cloud-init standard — généralement un document #cloud-config ou un script (voir les exemples officiels de cloud-init). Équivalent à server create --user-data <fichier> chez OpenStack. Sa représentation JSON doit être sur une seule ligne avec \n pour les retours à la ligne, car les chaînes JSON ne peuvent pas contenir de retours à la ligne littéraux.
² À utiliser uniquement si vous avez besoin d'en-têtes HTTP, tels que Basic Auth
³ Le chemin du bootloader EFI est utilisé par iPXE pour démarrer votre système d'exploitation. Pour plus d'informations, consultez notre guide « Comprendre le processus de démarrage des serveurs dédiés ». Exemples :

⁴ Objet JSON de couples clé/valeur arbitraires, équivalent à server create --property clé=valeur chez OpenStack. Les couples sont écrits dans le meta_data.json du config drive sous la clé meta, où cloud-init peut les lire. Exemple : "configDriveMetadata": {"role": "webserver", "env": "prod"} devient "meta": {"role": "webserver", "env": "prod"} dans meta_data.json. Voir la documentation du service de métadonnées OpenStack pour le schéma complet.

Les erreurs clients fréquentes

Le tableau suivant donne un aperçu des erreurs clients les plus connues et de la manière de les corriger.

Aller plus loin

API OVHcloud et installation d'un OS

Bring Your Own Linux (BYOLinux)

Comparaison entre Bring Your Own Image (BYOI) et Bring Your Own Linux (BYOLinux)

Comprendre le processus de démarrage des serveurs dédiés

Échangez avec notre communauté d'utilisateurs.