435c0d9fc8
This PR switches the Nomad repository from using govendor to Go modules for managing dependencies. Aspects of the Nomad workflow remain pretty much the same. The usual Makefile targets should continue to work as they always did. The API submodule simply defers to the parent Nomad version on the repository, keeping the semantics of API versioning that currently exists.
87 lines
2.9 KiB
Markdown
87 lines
2.9 KiB
Markdown
[](https://travis-ci.org/vmware/govmomi)
|
|
[](https://goreportcard.com/report/github.com/vmware/govmomi)
|
|
|
|
# govmomi
|
|
|
|
A Go library for interacting with VMware vSphere APIs (ESXi and/or vCenter).
|
|
|
|
In addition to the vSphere API client, this repository includes:
|
|
|
|
* [govc](./govc) - vSphere CLI
|
|
|
|
* [vcsim](./vcsim) - vSphere API mock framework
|
|
|
|
* [toolbox](./toolbox) - VM guest tools framework
|
|
|
|
## Compatibility
|
|
|
|
This library is built for and tested against ESXi and vCenter 6.0, 6.5 and 6.7.
|
|
|
|
It may work with versions 5.5 and 5.1, but neither are officially supported.
|
|
|
|
## Documentation
|
|
|
|
The APIs exposed by this library very closely follow the API described in the [VMware vSphere API Reference Documentation][apiref].
|
|
Refer to this document to become familiar with the upstream API.
|
|
|
|
The code in the `govmomi` package is a wrapper for the code that is generated from the vSphere API description.
|
|
It primarily provides convenience functions for working with the vSphere API.
|
|
See [godoc.org][godoc] for documentation.
|
|
|
|
[apiref]:http://pubs.vmware.com/vsphere-6-5/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html
|
|
[godoc]:http://godoc.org/github.com/vmware/govmomi
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
go get -u github.com/vmware/govmomi
|
|
```
|
|
|
|
## Discussion
|
|
|
|
Contributors and users are encouraged to collaborate using GitHub issues and/or
|
|
[Slack](https://vmwarecode.slack.com/messages/govmomi).
|
|
Access to Slack requires a [VMware {code} membership](https://code.vmware.com/join/).
|
|
|
|
## Status
|
|
|
|
Changes to the API are subject to [semantic versioning](http://semver.org).
|
|
|
|
Refer to the [CHANGELOG](CHANGELOG.md) for version to version changes.
|
|
|
|
## Projects using govmomi
|
|
|
|
* [Docker Machine](https://github.com/docker/machine/tree/master/drivers/vmwarevsphere)
|
|
|
|
* [Docker InfraKit](https://github.com/docker/infrakit/tree/master/pkg/provider/vsphere)
|
|
|
|
* [Docker LinuxKit](https://github.com/linuxkit/linuxkit/tree/master/src/cmd/linuxkit)
|
|
|
|
* [Kubernetes](https://github.com/kubernetes/kubernetes/tree/master/pkg/cloudprovider/providers/vsphere)
|
|
|
|
* [Kubernetes kops](https://github.com/kubernetes/kops/tree/master/upup/pkg/fi/cloudup/vsphere)
|
|
|
|
* [Terraform](https://github.com/terraform-providers/terraform-provider-vsphere)
|
|
|
|
* [Packer](https://github.com/jetbrains-infra/packer-builder-vsphere)
|
|
|
|
* [VMware VIC Engine](https://github.com/vmware/vic)
|
|
|
|
* [Travis CI](https://github.com/travis-ci/jupiter-brain)
|
|
|
|
* [collectd-vsphere](https://github.com/travis-ci/collectd-vsphere)
|
|
|
|
* [Gru](https://github.com/dnaeon/gru)
|
|
|
|
* [Libretto](https://github.com/apcera/libretto/tree/master/virtualmachine/vsphere)
|
|
|
|
## Related projects
|
|
|
|
* [rbvmomi](https://github.com/vmware/rbvmomi)
|
|
|
|
* [pyvmomi](https://github.com/vmware/pyvmomi)
|
|
|
|
## License
|
|
|
|
govmomi is available under the [Apache 2 license](LICENSE).
|