Utiliser la fonctionnalité Bring Your Own Image
Apprenez à déployer vos images grâce à Bring Your Own Image
Dernière mise à jour le 25/11/2022
Objectif
Grâce à la technologie Bring Your Own Image, il vous est désormais possible de déployer des images cloudready directement sur vos serveurs dédiés. Vous pouvez donc utiliser le produit bare metal comme ressource pour vos déploiements.
Que signifie cloudready ?
En une phrase, être agnostique de l'infrastructure sur laquelle l'image démarre.
Outre les prérequis et limitations citées plus bas, il faut s'assurer que l'image (récupérée, générée) répond à la bonne définition des attentes techniques d'une image cloudready. L'image doit être capable de booter correctement quelle que soit la typologie de serveur sur laquelle elle démarre, elle doit également embarquer le service Cloud Init dans le cas de l'utilisation d'un Config Drive. Enfin, les configurations systèmes doivent permettre de pouvoir pleinement laisser l'OS s'initier, en particulier celles relatives au réseau.
Découvrez comment configurer BringYourOwnImage depuis l'APIv6 OVHcloud
Prérequis
- Posséder un serveur dédié OVHcloud.
- Être connecté à votre espace client OVHcloud pour la partie « Déploiement via espace client » de ce guide.
- Être connecté aux API OVHcloud pour la partie « Déploiement via API » de ce guide.
- Avoir généré les credentials pour utiliser l'APIv6 pour la partie « Déploiement via API » de ce guide.
- La taille de votre image doit être inférieure à la quantité de la mémoire vive de votre serveur moins 3GiB.
Une nouvelle installation par BringYourOwnImage effacera l'intégralité des données présentes sur le serveur.
En pratique
Limitations techniques
Il existe aujourd'hui encore quelques limitations techniques liées à l'usage de produits physiques comme les serveurs dédiés. Veuillez prendre en compte les impératifs listés ci-dessous lors de votre préparation de déploiement. Cette liste n'est pas exhaustive.
- Le type de boot : uefi ou legacy
- Le type de partition : MBR ou GPT
- Le format d'image : qcow2 ou raw
Si votre serveur dispose d'un boot uefi, il vous faudra impérativement prévoir dans votre image une partition EFI si vous souhaitez que votre serveur puisse booter.
Méthodes de déploiement
- Déploiement via espace client : vous permettra de deployer rapidement et facilement votre image directement depuis votre espace client OVHcloud.
- Déploiement via API : vous pouvez utiliser les API OVHcloud pour les intégrer à vos propres scripts afin d'automatiser le déploiement.
Déployer votre image depuis l'espace client OVHcloud
Depuis votre espace client OVHcloud, dans la section Bare Metal Cloud, puis Serveurs Dédiés, sélectionnez votre serveur.
Dans le cadre Informations générales, cliquez sur le bouton ... devant Informations générales. Cliquez enfin sur Installer.
Dans la fenêtre qui apparaît, sélectionnez Installer à partir d'une image personnalisée, puis cliquez sur Installer.
Vous serez redirigé vers la page de configuration. Assurez-vous que l'URL de votre image est au format approprié. Complétez le reste des champs requis sur cette page. Lorsque vous avez confirmé que les informations sont correctes, cliquez sur Installer le système.
Retrouvez le détail des options dans la partie « Tableaux des options » de ce guide.
Concernant l'activation de ConfigDrive, retrouver la documentation sur cette page.
Déployer votre image depuis les API
Connectez-vous sur https://api.ovh.com/ puis rendez-vous dans la section dedicated/server. Le champ Filter vous permettra de rechercher « BringYourOwnImage ».
Vous disposez de trois appels API liés à la fonctionnalité BringYourOwnImage.
Pour créer et déployer votre image, utilisez l'appel suivant et complétez les champs requis :
Tableaux des options
| Champ | Description |
|---|---|
| serviceName | Le nom de votre serveur. |
| URL | L'URL où récupérer votre image. |
| checkSum | Le checksum de votre image. |
| checkSumType | Le checksum de l'image à déployer (md5, sha1, sha256, sha512). |
| enable (ConfigDrive)* | Activer la création de la partition ConfigDrive (cloud-init) |
| hostname (ConfigDrive)* | Le hostname de votre serveur. |
| sshKey (ConfigDrive)* | Votre clé SSH publique. |
| userData (ConfigDrive)* | Votre script de post-installation. |
| userMetadatas (ConfigDrive)* | Meta datas utilisés par CloudInit au moment du boot. |
| description | Le nom de votre image. |
| diskGroupId | L'id du disque qui doit être utilisé. |
| httpHeader | Uniquement si nécessaire pour télécharger l'image. |
| type | Le type/format de votre image (qcow2, raw, ova). |
* Le ConfigDrive est une partition utilisée par cloud-init au premier boot de votre serveur afin d'établir la configuration souhaitée. Vous pouvez choisir d'activer ou non cette option.
Une fois les champs complétés, lancez le déploiement en cliquant sur Execute.
Vérifier le déploiement
Vous pouvez suivre le déploiement de votre image via l'appel API ci-dessous ou par le biais du KVM / IPMI.
Dans cet exemple, le déploiement est en cours de démarrage.
Le déploiement peut durer une dizaine de minutes. Une fois l'opération terminée, le statut de votre déploiement passera en « done » et votre serveur aura redémarré sur disque.
Exemples de retour
Voici quelques exemples de retour :
| Message | Signification |
|---|---|
| Can't write qcow2 on disk. | Impossible d'écrire l'image qcow2 sur le disque. |
| Could not download, qcow2 image is too big to download in memory. | Il n'y a pas assez d'espace en RAM pour télécharger l'image. |
Could not download image located : http://path/of/your/image. |
Impossible de télécharger l'image située : http://chemin/de/votre/image. |
| Bad format image, expected : qcow2, raw. | Le format de l'image est incorrect. |
| Bad checkSumType, expected : sha1, sha256, md5. | Le type de checksum est incorrect. |
| Bad $checkSumType for downloaded file, got : 1234 while expecting 5678. | Le checksum est incorrect. |
| Can not move backup GPT data structures to the end of disk. | Le format disque est incorrect. |
| Could not create configdrive on disk. | Impossible de créer la partition configdrive sur le disk. |
Supprimer le déploiement
Vous pouvez choisir de supprimer votre déploiement grâce à l'appel suivant :
Cela aura pour effet d'effacer l'état du déploiement et de placer votre serveur en mode rescue.
Aller plus loin
Échangez avec notre communauté d'utilisateurs sur https://community.ovh.com/.
Cette documentation vous a-t-elle été utile ?
N’hésitez pas à nous proposer des suggestions d’amélioration afin de faire évoluer cette documentation.
Images, contenu, structure… N’hésitez pas à nous dire pourquoi afin de la faire évoluer ensemble !
Vos demandes d’assistance ne seront pas traitées par ce formulaire. Pour cela, utilisez le formulaire "Créer un ticket" .
Merci beaucoup pour votre aide ! Vos retours seront étudiés au plus vite par nos équipes..