Kyvernon documentation

Kyvernon runs virtual machines. A controller manages the inventory, hosts run the virtual machines with Kyvernon VMM, and you work with it through the web console, the kyvernon command-line client, the native API and the vSphere API endpoints. These pages are written for administrators, users, tenants of a provider and developers.

Start here

1. Install from an offline depot: a controller and a first host on servers without internet access.
2. First sign-in: the new password, two-step verification and the language of the web console.
3. First virtual machine: upload a cloud image, create a virtual machine and open its console.

Find what you need

Use the search field at the top of every page, or open the list of all pages. The error codes page leads from a message id to its cause and remedy. The reference pages for the REST API, the gRPC API, the CLI and the vSphere API methods are in English in every language.

• Getting startedLessons from an offline depot to a first virtual machine, a first CLI session and a first connection of vSphere tools.
• Virtual machinesCreate, power, change, snapshot, clone, move and import virtual machines, and open their console.
• StorageDatastores, iSCSI, files on a datastore, disks of virtual machines and content libraries.
• NetworkingHost-bridge networks, public IP pools, the addresses of servers, reverse DNS and traffic.
• Users and accessLocal and federated users, roles and permissions, sign-in security, API tokens, sessions and the audit log.
• Tasks, events and monitoringFollow tasks, read events, define alarms, chart performance, deliver webhooks and report usage.
• OperationsHosts, clusters, capacity, backup and restore, licence, offline depot, upgrade and configuration of a Kyvernon installation.
• Self-serviceTenants, plans, the catalogue and servers of a multi-tenant Kyvernon cloud, and the integration of a portal.
• Migration from vSphereMove virtual machines from vSphere to Kyvernon: methods, guest preparation, OVA, OVF and VMDK import, checks afterwards and terms.
• Compatibility with vSphere toolingThe vSphere-compatible endpoints of Kyvernon and the tools verified against them: PowerCLI, govc, Terraform, Ansible and monitoring.
• ReferenceFacts to look up: error codes, the API, the CLI, privileges and roles.
• Release notesWhat changed in each version of Kyvernon, newest first.