github.com/ovirt/go-ovirt-client (go): Package ovirtclient provides a human-friendly Go client for the oVirt Engine. It provides an abstraction layer for the oVirt API, as well as a mocking facility for testing purposes.  This documentation contains two parts. This introduction explains setting up the client with the credentials. The API doc contains the individual API calls.  When reading the API doc, start with the Client interface: it contains all components of the API. The individual API's, their documentation and examples are located in subinterfaces, such as DiskClient.  There are several ways to create a client instance. The most basic way is to use the New() function as follows:  The mock client simulates the oVirt engine behavior in-memory without needing an actual running engine. This is a good way to provide a testing facility.  It can be created using the NewMock method:  That's it! However, to make it really useful, you will need the test helper which can set up test fixtures.  The test helper can work in two ways:  Either it sets up test fixtures in the mock client, or it sets up a live connection and identifies a usable storage domain, cluster, etc. for testing purposes.  The ovirtclient.NewMockTestHelper() function can be used to create a test helper with a mock client in the backend:  The easiest way to set up the test helper for a live connection is by using environment variables. To do that, you can use the ovirtclient.NewLiveTestHelperFromEnv() function:  This function will inspect environment variables to determine if a connection to a live oVirt engine can be established. The following environment variables are supported:  URL of the oVirt engine API. Mandatory.  The username for the oVirt engine. Mandatory.  The password for the oVirt engine. Mandatory.  A file containing the CA certificate in PEM format.  Provide the CA certificate in PEM format directly.  Disable certificate verification if set. Not recommended.  The cluster to use for testing. Will be automatically chosen if not provided.  ID of the blank template. Will be automatically chosen if not provided.  Storage domain to use for testing. Will be automatically chosen if not provided.  VNIC profile to use for testing. Will be automatically chosen if not provided.  You can also create the test helper manually:  This library provides extensive logging. Each API interaction is logged on the debug level, and other messages are added on other levels. In order to provide logging this library uses the go-ovirt-client-log (https://github.com/oVirt/go-ovirt-client-log) interface definition.  As long as your logger implements this interface, you will be able to receive log messages. The logging library also provides a few built-in loggers. For example, you can log via the default Go log interface:  Or, you can also log in tests:  You can also disable logging:  Finally, we also provide an adapter library for klog here: https://github.com/oVirt/go-ovirt-client-log-klog  Modern-day oVirt engines run secured with TLS. This means that the client needs a way to verify the certificate the server is presenting. This is controlled by the tls parameter of the New() function. You can implement your own source by implementing the TLSProvider interface, but the package also includes a ready-to-use provider.  Create the provider using the TLS() function:  This provider has several functions. The easiest to set up is using the system trust root for certificates. However, this won't work own Windows:  Now you need to add your oVirt engine certificate to your system trust root.  If you don't want to, or can't add the certificate to the system trust root, you can also directly provide it to the client.  Finally, you can also disable certificate verification. Do we need to say that this is a very, very bad idea?  The configured tls variable can then be passed to the New() function to create an oVirt client.  This library attempts to retry API calls that can be retried if possible. Each function has a sensible retry policy. However, you may want to customize the retries by passing one or more retry flags. The following retry flags are supported:  This strategy will stop retries when the context parameter is canceled.  This strategy adds a wait time after each time, which is increased by the given factor on each try. The default is a backoff with a factor of 2.  This strategy will cancel retries if the error in question is a permanent error. This is enabled by default.  This strategy will abort retries if a maximum number of tries is reached. On complex calls the retries are counted per underlying API call.  This strategy will abort retries if a certain time has been elapsed for the higher level call.  This strategy will abort retries if a certain underlying API call takes longer than the specified duration.
Keywords: api|golang|ovirt|ovirt-engine