--- title: "Débuter avec l’API OpenStack" description: "Découvrez comment gérer vos instances à l'aide du client Python OpenStack" url: https://docs.ovhcloud.com/fr/guides/public-cloud/compute/starting-with-nova lang: fr lastUpdated: 2022-10-13 --- # Débuter avec l’API OpenStack ## Objectif Afin d'automatiser vos opérations sur le Public Cloud, vous pouvez utiliser les API OpenStack afin de générer différents scripts. :::info Le client Nova était précédemment utilisé pour gérer vos instances ainsi que leurs disques. Ce client est maintenant déprécié et les commandes ont été intégrées au sein du client Python OpenStack. ::: Vous pourrez par exemple lancer la création d'instances supplémentaires lorsque vos outils de monitoring détectent un pic de charge, afin d'éviter une saturation sur votre infrastructure. Il est aussi possible de programmer la création de snapshots de manière régulière. Ce guide vous aidera à prendre en main les API OpenStack afin de gérer vos instances à l'aide du client Python OpenStack. ## Prérequis - [Préparer l'environnement pour utiliser l'API OpenStack](/fr/guides/public-cloud/cross-functional/compute-prepare-openstack-api-environment.md) - [Charger les variables d'environnement OpenStack](/fr/guides/public-cloud/cross-functional/compute-set-openstack-environment-variables.md) ## En pratique Vous pouvez obtenir la liste des commandes possible en lisant la documentation du client : ```bash admin@serveur-1:~$ openstack command list ``` Vous pouvez filtrer les commandes affichées en indiquant le groupe : ```bash admin@serveur-1:~$ openstack command list --group compute ``` Il est aussi possible d'avoir des informations concernant une commande en ajoutant `help` devant celle ci : ```bash admin@serveur-1:~$ openstack help flavor list usage: openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ``] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--public | --private | --all] [--min-disk ``] [--min-ram ``] [--long] [--marker ``] [--limit ``] List flavors ... ``` :::tip Consultez la documentation du client directement sur le [site OpenStack](https://docs.openstack.org/python-openstackclient/latest/cli/index.html) ::: ### Opérations basiques #### Ajout d'une clé SSH publique Dans un premier temps, il est nécessaire d'ajouter une clé SSH publique qui permettra de se connecter sur les instances. - Lister les commandes liées aux clés SSH : ```bash admin@serveur-1:~$ openstack help | grep keypair keypair create Create new public or private key for server ssh access keypair delete Delete public or private key(s) keypair list List key fingerprints keypair show Display key details ``` - Ajouter la clé SSH publique : ```bash admin@serveur-1:~$ openstack keypair create --public-key ~/.ssh/id_rsa.pub SSHKEY ``` - Lister les clés SSH disponibles : ```bash admin@serveur-1:~$ openstack keypair list +---------------+-------------------------------------------------+------+ | Name | Fingerprint | Type | +---------------+-------------------------------------------------+------+ | SSHKEY | 5c:fd:9d:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:3a | ssh | +---------------+-------------------------------------------------+------+ ``` #### Lister les modèles d'instances Il faudra ensuite récupérer l'ID du modèle que l'on souhaite utiliser : ```bash admin@serveur-1:~$ openstack flavor list +--------------------------------------+-----------------+--------+------+-----------+-------+-----------+ | ID | Name | RAM | Disk | Ephemeral | VCPUs | Is Public | +--------------------------------------+-----------------+--------+------+-----------+-------+-----------+ | 0062dad0-f93c-4d7d-bde7-6add4ad6baaa | win-b2-15-flex | 15000 | 50 | 0 | 4 | True | | 022f8ac5-b6a7-4365-9db8-c69775d67a2d | t2-180 | 180000 | 50 | 0 | 60 | True | | 07124b62-dd6d-4bf2-80d7-d9ea3c923cf3 | i1-180 | 180000 | 50 | 0 | 32 | True | | 0cb50da2-cd4d-4a14-8a22-bbc59d94c814 | c2-120-flex | 120000 | 50 | 0 | 32 | True | | 0d338e52-cfba-4e32-914e-c2ea19d2a9df | d2-4 | 4000 | 50 | 0 | 2 | True | | 0dbcff05-2da0-40a6-87dc-96a1e98d9ffc | b2-30 | 30000 | 200 | 0 | 8 | True | | 11530c24-bc02-48c3-b272-802791795176 | i1-45 | 45000 | 50 | 0 | 8 | True | | 11fc4ed3-5198-4043-b093-063787a144e1 | c2-7 | 7000 | 50 | 0 | 2 | True | | 13d9146d-f519-4f8b-b87c-245d76bd21b0 | b2-120-flex | 120000 | 50 | 0 | 32 | True | | ... | ... | ... | .. | ... | | ... | +--------------------------------------+-----------------+--------+------+-----------+-------+-----------+ ``` #### Lister les images disponibles Pour finir, il suffit de récupérer l'ID de l'image qui sera utilisée pour l'instance : ```bash admin@serveur-1:~$ openstack image list +--------------------------------------+-----------------------------------------------+--------+ | ID | Name | Status | +--------------------------------------+-----------------------------------------------+--------+ | 8990fbbb-bd7e-4c57-8b19-a162e12c5195 | AlmaLinux 8 | active | | f1d2e56e-faec-4fd4-8493-dcf4c4201b40 | AlmaLinux 8 - UEFI | active | | a243240a-ca1f-4a53-a3bd-30c4f96b241f | AlmaLinux 8 - cPanel | active | | 1be04371-252f-48be-81fb-1cb89ea55778 | AlmaLinux 9 | active | | df89529f-8b4f-4534-9ddc-0092e30bcc97 | AlmaLinux 9 - UEFI | active | | 81c5ebbc-04fd-40f8-83aa-9b2bae8769f2 | Centos 7 | active | | b753f820-37cd-437a-b301-3423caf27637 | Centos 7 - Analytics - Ambari pre-warmed | active | | 81ddd059-41b0-493e-a1e2-a278139b7bbb | Centos 7 - Analytics - Base image | active | | ... | ... | ... | +--------------------------------------+-----------------------------------------------+--------+ ``` #### Creation d'une instance Avec les éléments récupérés précédemment, vous pouvez créer une instance : ```bash admin@serveur-1:~$ openstack server create --key-name SSHKEY --flavor d2-2 --image "Ubuntu 22.04" InstanceTest +-----------------------------+-----------------------------------------------------+ | Field | Value | +-----------------------------+-----------------------------------------------------+ | OS-DCF:diskConfig | MANUAL | | OS-EXT-AZ:availability_zone | | | OS-EXT-STS:power_state | NOSTATE | | OS-EXT-STS:task_state | scheduling | | OS-EXT-STS:vm_state | building | | OS-SRV-USG:launched_at | None | | OS-SRV-USG:terminated_at | None | | accessIPv4 | | | accessIPv6 | | | addresses | | | adminPass | xxxxxxxxxxxx | | config_drive | | | created | 2022-10-13T19:05:54Z | | flavor | d2-2 (14c5fa3f-fdad-45c4-9cd1-14dd99c341ee) | | hostId | | | id | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | | image | Ubuntu 22.04 (0ea24976-fb6c-46ef-acb5-0cb88b0493aa) | | key_name | SSHKEY | | name | InstanceTest | | progress | 0 | | project_id | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | properties | | | security_groups | name='default' | | status | BUILD | | updated | 2022-10-13T19:05:55Z | | user_id | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | volumes_attached | | +-----------------------------+-----------------------------------------------------+ ``` Après quelques instants, on peut vérifier la liste des instances existantes afin de retrouver l'instance nouvellement créée : ```bash admin@serveur-1:~$ openstack server list +--------------------------------------+--------------+--------+-------------------------------------+--------------+--------+ | ID | Name | Status | Networks | Image | Flavor | +--------------------------------------+--------------+--------+-------------------------------------+--------------+--------+ | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | InstanceTest | ACTIVE | Ext-Net=xxxx:xxxx::xxxx, 51.xx.xx.x | Ubuntu 22.04 | d2-2 | +--------------------------------------+--------------+--------+-------------------------------------+--------------+--------+ ``` #### Suppression d'une instance Vous pouvez supprimer une instance grâce à la commande suivante : ```bash admin@serveur-1:~$ openstack server delete InstanceTest ``` ## Aller plus loin Échangez avec notre [communauté d’utilisateurs](https://community.ovhcloud.com/).