Vue d'ensemble de la compatibilité

Kyvernon sert l'API SOAP de vSphere (vim25), l'API REST d'automatisation, l'accès aux fichiers des datastores et le point de terminaison de transfert OVF, à côté de son API native. Le contrôleur les sert sur le même écouteur et avec le même certificat que l'API native, si bien qu'un outil se connecte à l'adresse du contrôleur (port 8443 dans les exemples). Les points de terminaison sont désactivés tant que [facades] enabled = true n'est pas défini dans controller.toml ; voir Paramètres des points de terminaison de compatibilité.

Points de terminaison

Sessions et comptes

Un client se connecte avec le nom d'utilisateur et le mot de passe d'un compte Kyvernon. Les autorisations du compte déterminent ce que le client voit et peut faire : les privilèges utilisent les identifiants vSphere et s'appliquent aux mêmes objets que dans la console. Un objet que le compte n'a pas le droit de lire n'est pas signalé, et le PropertyCollector ne le traverse pas. Les écritures vérifient le privilège de l'opération sur sa cible et répondent par une erreur NoPermission quand il manque.

La connexion par les points de terminaison de compatibilité suit la stratégie de connexion du contrôleur : le verrouillage et les enregistrements d'audit s'appliquent. La connexion vim25 n'a pas d'invite interactive pour la validation en deux étapes. Un compte qui doit changer son mot de passe est refusé tant qu'il ne l'a pas fait. Une session se termine après 30 minutes sans requête (session_timeout), et quand le compte ou ses sessions sont révoqués par n'importe quelle API.

Références d'objets et tâches

Les références aux objets gérés utilisent les identifiants de l'API native sous les formes de vSphere, comme vm-42, host-7, datastore-3, network-5, domain-c1 et resgroup-1. Les opérations dont le nom se termine par _Task renvoient une référence de tâche que les outils attendent avec le PropertyCollector. Ce sont les mêmes tâches que dans la console et dans l'API native. Les chemins de propriétés comme config.hardware.device se résolvent sur les objets gérés que les points de terminaison servent.

Méthodes non prises en charge

L'API vim25 compte 972 méthodes. Kyvernon en sert 196 : celles que les outils vérifiés utilisent, regroupées par objet géré dans la référence méthodes de l'API vSphere prises en charge. Une méthode qui fait partie de l'API sans être servie renvoie une erreur NotSupported, si bien qu'un outil qui l'appelle échoue de façon visible. Un nom extérieur à l'API renvoie MethodNotFound. ShutdownGuest, RebootGuest, les méthodes de LicenseManager et CreateDVS_Task sont des exemples de méthodes non servies. Pour ces fonctions, utilisez l'API native, par exemple kyvernon vm shutdown <id>.

Identification du produit

Les informations du service (about) nomment Kyvernon comme produit. Certains outils vérifient le nom du produit avant d'activer une fonction ; le paramètre product_name de [facades] change le nom que les points de terminaison signalent. Voir Paramètres des points de terminaison de compatibilité pour savoir quel outil en a besoin.

Images cloud

Les images cloud Linux qui incluent cloud-init sont personnalisées avec les clés extraConfig que lit la source de données VMware de cloud-init : guestinfo.userdata, guestinfo.metadata et guestinfo.vendordata, chacune avec un .encoding facultatif valant base64 ou gzip+base64. Kyvernon transmet les données à l'invité sous la forme d'un disque NoCloud en lecture seule. Les clés que définissent l'argument Terraform extra_config, govc vm.change -e ou les paramètres avancés de PowerCLI fonctionnent sans modification. Des données invalides font échouer la tâche qui les définit, avec la clé nommée.

Tâches liées

• PowerCLI, govc, Terraform, Ansible
• Paramètres des points de terminaison de compatibilité
• Terminologie pour les utilisateurs de vSphere