d8dfun/virtual-kubelet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Files
513cebe7b7cf590cd53c02ea8da1a20b58dd8f18
virtual-kubelet/vendor/github.com/vmware/govmomi/toolbox/README.md
Loc Nguyen 513cebe7b7 VMware vSphere Integrated Containers provider (#206) 
* Add Virtual Kubelet provider for VIC

Initial virtual kubelet provider for VMware VIC.  This provider currently
handles creating and starting of a pod VM via the VIC portlayer and persona
server.  Image store handling via the VIC persona server.  This provider
currently requires the feature/wolfpack branch of VIC.

* Added pod stop and delete.  Also added node capacity.

Added the ability to stop and delete pod VMs via VIC.  Also retrieve
node capacity information from the VCH.

* Cleanup and readme file

Some file clean up and added a Readme.md markdown file for the VIC
provider.

* Cleaned up errors, added function comments, moved operation code

1. Cleaned up error handling.  Set standard for creating errors.
2. Added method prototype comments for all interface functions.
3. Moved PodCreator, PodStarter, PodStopper, and PodDeleter to a new folder.

* Add mocking code and unit tests for podcache, podcreator, and podstarter

Used the unit test framework used in VIC to handle assertions in the provider's
unit test.  Mocking code generated using OSS project mockery, which is compatible
with the testify assertion framework.

* Vendored packages for the VIC provider

Requires feature/wolfpack branch of VIC and a few specific commit sha of
projects used within VIC.

* Implementation of POD Stopper and Deleter unit tests (#4)

* Updated files for initial PR
2018-06-04 15:41:32 -07:00

159 lines
8.8 KiB
Markdown
Raw Blame History

# toolbox - VMware guest tools library for Go #
## Overview
The toolbox library is a lightweight, extensible framework for implementing VMware guest tools functionality.
The primary focus of the library is the implementation of VM guest RPC protocols, transport and dispatch.
These protocols are undocumented for the most part, but [open-vm-tools](https://github.com/vmware/open-vm-tools) serves
as a reference implementation. The toolbox provides default implementations of the supported RPCs, which can be
overridden and/or extended by consumers.
## Supported features
Feature list from the perspective of vSphere public API interaction. The properties, objects and methods listed are
relative to
the [VirtualMachine](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.VirtualMachine.html)
managed object type.
### guest.toolsVersionStatus property
The toolbox reports version as `guestToolsUnmanaged`.
See [ToolsVersionStatus](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.GuestInfo.ToolsVersionStatus.html)
### guest.toolsRunningStatus and guest.guestState properties
The VMX determines these values based on the toolbox's response to the `ping` RPC.
### guest.ipAddress property
The VMX requests this value via the `Set_Option broadcastIP` RPC.
The default value can be overridden by setting the `Service.PrimaryIP` function.
See [vim.vm.GuestInfo](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.GuestInfo.html)
### guest.net property
This data is pushed to the VMX using the `SendGuestInfo(INFO_IPADDRESS_V3)` RPC.
See [GuestNicInfo](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.GuestInfo.NicInfo.html).
### ShutdownGuest and RebootGuest methods
The [PowerCommandHandler](power.go) provides power hooks for customized guest shutdown and reboot.
### GuestAuthManager object
Not supported, but authentication can be customized.
See [vim.vm.guest.AuthManager](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.guest.AuthManager.html)
### GuestFileManager object
| Method | Supported | Client Examples |
|---------------------------------|-----------|-------------------------------------------------------------------------------------|
| ChangeFileAttributesInGuest | Yes | [chmod](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/chmod.go) |
| | | [chown](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/chown.go) |
| | | [touch](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/touch.go) |
| CreateTemporaryDirectoryInGuest | Yes | [mktemp](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/mktemp.go) |
| CreateTemporaryFileInGuest | Yes | [mktemp](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/mktemp.go) |
| DeleteDirectoryInGuest | Yes | [rmdir](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/rmdir.go) |
| DeleteFileInGuest | Yes | [rm](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/rm.go) |
| InitiateFileTransferFromGuest | Yes | [download](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/download.go) |
| InitiateFileTransferToGuest | Yes | [upload](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/upload.go) |
| ListFilesInGuest | Yes | [ls](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/ls.go) |
| MakeDirectoryInGuest | Yes | [mkdir](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/mkdir.go) |
| MoveDirectoryInGuest | Yes | [mv](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/mv.go) |
| MoveFileInGuest | Yes | [mv](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/mv.go) |
See [vim.vm.guest.FileManager](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.guest.FileManager.html)
### GuestProcessManager
Currently, the `ListProcessesInGuest` and `TerminateProcessInGuest` methods only apply those processes and goroutines
started by `StartProgramInGuest`.
| Method | Supported | Client Examples |
|--------------------------------|-----------|-------------------------------------------------------------------------------------|
| ListProcessesInGuest | Yes | [ps](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/ps.go) |
| ReadEnvironmentVariableInGuest | Yes | [getenv](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/getenv.go) |
| StartProgramInGuest | Yes | [start](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/start.go) |
| TerminateProcessInGuest | Yes | [kill](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/kill.go) |
See [vim.vm.guest.ProcessManager](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.guest.ProcessManager.html)
## Extensions
### Authentication
Guest operations can be authenticated using the `toolbox.CommandServer.Authenticate` hook.
### Go functions
The toolbox [ProcessManager](process.go) can manage both OS processes and Go functions running as go routines.
### File handlers
The `hgfs.FileHandler` interface can be used to customize file transfer.
### Process I/O
The toolbox provides support for I/O redirection without the use of disk files within the guest.
Access to *stdin*, *stdout* and *stderr* streams is implemented as an `hgfs.FileHandler` within the `ProcessManager`.
See [toolbox.Client](https://github.com/vmware/govmomi/blob/master/guest/toolbox/client.go) and
[govc guest.run](https://github.com/vmware/govmomi/blob/master/govc/vm/guest/run.go)
### http.RoundTripper
Building on top of the process I/O functionality, `toolbox.NewProcessRoundTrip` can be used to start a Go function to
implement the [http.RoundTripper](https://golang.org/pkg/net/http/#RoundTripper) interface over vmx guest RPC. This
makes it possible to use the Go [http.Client](https://golang.org/pkg/net/http/#Client) without network access to the VM
or to a port that is bound to the guest's loopback address. It is intended for use with bootstrap configuration for
example.
### Directory archives
The toolbox provides support for transferring directories to and from guests as gzip'd tar streams, without writing the
tar file itself to the guest file system. Archive supports is implemented as an `hgfs.FileHandler` within the `hgfs`
package. See [hgfs.NewArchiveHandler](https://github.com/vmware/govmomi/blob/master/toolbox/hgfs/archive.go)
### Linux /proc file access
With standard vmware-tools, the file size is reported as returned by `stat()` and hence a `Content-Length` header of
size `0`. The toolbox reports /proc file size as `hgfs.LargePacketMax` to enable transfer of these files. Note that if
the file data fits within in `hgfs.LargePacketMax`, the `Content-Length` header will be correct as it is sent after the
first read by the vmx. However, if the file data exceeds `hgfs.LargePacketMax`, the `Content-Length` will be
`hgfs.LargePacketMax`, and client side will truncate to that size.
## Testing
The Go tests cover most of the toolbox code and can be run on any Linux or MacOSX machine, virtual or otherwise.
To test the toolbox with vSphere API interaction, it must be run inside a VM managed by vSphere without the standard
vmtoolsd running.
The [toolbox-test.sh](toolbox-test.sh) can be used to run the full suite of toolbox tests with vSphere API interaction.
Use the `-s` flag to start the standalone version of the toolbox and leave it running, to test vSphere interaction
without running the test suite.
## Consumers of the toolbox library
* [Toolbox example main](https://github.com/vmware/govmomi/blob/master/toolbox/toolbox/main.go)
* [VIC tether toolbox extension](https://github.com/vmware/vic/blob/master/lib/tether/toolbox.go)
* [VIC container VM tether](https://github.com/vmware/vic/blob/main/cmd/tether/main_linux.go)
* [VIC container host tether](https://github.com/vmware/vic/blob/master/cmd/vic-init/main_linux.go)
## Supported guests
The toolbox guest RPC implementations tend to be simple and portable thanks to the Go standard library, but are only
supported on Linux currently. Support for other guests, such as Windows, has been kept in mind but not yet tested.
## Supported vSphere Versions
The toolbox is supported with vSphere 6.0 and 6.5, but may function with older versions.
Reference in New Issue View Git Blame Copy Permalink