513cebe7b7
* 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
102 lines
2.9 KiB
Markdown
102 lines
2.9 KiB
Markdown
# Contributing to govmomi
|
|
|
|
## Getting started
|
|
|
|
First, fork the repository on GitHub to your personal account.
|
|
|
|
Note that _GOPATH_ can be any directory, the example below uses _$HOME/govmomi_.
|
|
Change _$USER_ below to your github username if they are not the same.
|
|
|
|
``` shell
|
|
export GOPATH=$HOME/govmomi
|
|
go get github.com/vmware/govmomi
|
|
cd $GOPATH/src/github.com/vmware/govmomi
|
|
git config push.default nothing # anything to avoid pushing to vmware/govmomi by default
|
|
git remote rename origin vmware
|
|
git remote add $USER git@github.com:$USER/govmomi.git
|
|
git fetch $USER
|
|
```
|
|
|
|
## Installing from source
|
|
|
|
Compile the govmomi libraries and install govc using:
|
|
|
|
``` shell
|
|
go install -v github.com/vmware/govmomi/govc
|
|
```
|
|
|
|
Note that **govc/build.sh** is only used for building release binaries.
|
|
|
|
## Contribution flow
|
|
|
|
This is a rough outline of what a contributor's workflow looks like:
|
|
|
|
- Create a topic branch from where you want to base your work.
|
|
- Make commits of logical units.
|
|
- Make sure your commit messages are in the proper format (see below).
|
|
- Update CHANGELOG.md and/or govc/CHANGELOG.md when appropriate.
|
|
- Push your changes to a topic branch in your fork of the repository.
|
|
- Submit a pull request to vmware/govmomi.
|
|
|
|
Example:
|
|
|
|
``` shell
|
|
git checkout -b my-new-feature vmware/master
|
|
git commit -a
|
|
git push $USER my-new-feature
|
|
```
|
|
|
|
### Stay in sync with upstream
|
|
|
|
When your branch gets out of sync with the vmware/master branch, use the following to update:
|
|
|
|
``` shell
|
|
git checkout my-new-feature
|
|
git fetch -a
|
|
git rebase vmware/master
|
|
git push --force-with-lease $USER my-new-feature
|
|
```
|
|
|
|
### Updating pull requests
|
|
|
|
If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
|
|
existing commits.
|
|
|
|
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
|
|
amend the commit.
|
|
|
|
``` shell
|
|
git add .
|
|
git commit --amend
|
|
git push --force-with-lease $USER my-new-feature
|
|
```
|
|
|
|
If you need to squash changes into an earlier commit, you can use:
|
|
|
|
``` shell
|
|
git add .
|
|
git commit --fixup <commit>
|
|
git rebase -i --autosquash vmware/master
|
|
git push --force-with-lease $USER my-new-feature
|
|
```
|
|
|
|
Be sure to add a comment to the PR indicating your new changes are ready to review, as github does not generate a
|
|
notification when you git push.
|
|
|
|
### Code style
|
|
|
|
The coding style suggested by the Golang community is used in govmomi. See the
|
|
[style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details.
|
|
|
|
Try to limit column width to 120 characters for both code and markdown documents such as this one.
|
|
|
|
### Format of the Commit Message
|
|
|
|
We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
|
|
|
|
Be sure to include any related GitHub issue references in the commit message.
|
|
|
|
## Reporting Bugs and Creating Issues
|
|
|
|
When opening a new issue, try to roughly follow the commit message format conventions above.
|