https://github.com/cloudfoundry-community/gogobosh
Golang client library for applications wanting to talk to a BOSH/MicroBOSH or bosh-lite
https://github.com/cloudfoundry-community/gogobosh
Last synced: 9 months ago
JSON representation
Golang client library for applications wanting to talk to a BOSH/MicroBOSH or bosh-lite
- Host: GitHub
- URL: https://github.com/cloudfoundry-community/gogobosh
- Owner: cloudfoundry-community
- License: mit
- Created: 2014-01-23T15:50:26.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T22:48:34.000Z (over 1 year ago)
- Last Synced: 2025-10-21T17:43:01.086Z (9 months ago)
- Language: Go
- Homepage: http://bosh.cloudfoundry.org
- Size: 454 KB
- Stars: 23
- Watchers: 16
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Go BOSH - BOSH client API for golang applications
This project is a golang library for applications wanting to talk to a BOSH/MicroBOSH or bosh-lite.
[](https://godoc.org/github.com/cloudfoundry-community/gogobosh)
## API
The following client functions are available, as a subset of the full BOSH Director API.
* client.GetInfo()
* client.GetStemcells()
* client.GetReleases()
* client.GetDeployments()
* client.GetDeployment("cf")
* client.GetDeploymentVMs("cf")
* client.GetTasks()
* client.GetTask(123)
* client.GetTaskResult(123)
* client.Start("cf", "diego_cell", "b1a2e350-0405-41d8-89f0-e257c78b26ae")
* client.Stop("cf", "diego_cell", "b1a2e350-0405-41d8-89f0-e257c78b26ae")
* client.Restart("cf", "diego_cell", "b1a2e350-0405-41d8-89f0-e257c78b26ae")
## Install
```
go get github.com/cloudfoundry-community/gogobosh
````
## Documentation
The documentation is published to [https://godoc.org/github.com/cloudfoundry-community/gogobosh](https://godoc.org/github.com/cloudfoundry-community/gogobosh). Also, [view the documentation locally](http://localhost:6060/pkg/github.com/cloudfoundry-community/gogobosh/) with:
```shell
$ godoc
```
## Usage
As a short getting started guide:
``` golang
package main
import (
"github.com/cloudfoundry-community/gogobosh"
"fmt"
)
func main() {
c, _ := gogobosh.NewClient(gogobosh.DefaultConfig())
info, _ := c.GetInfo()
fmt.Println("Director")
fmt.Printf(" Name %s\n", info.Name)
fmt.Printf(" Version %s\n", info.Version)
fmt.Printf(" User %s\n", info.User)
fmt.Printf(" UUID %s\n", info.UUID)
fmt.Printf(" CPI %s\n", info.CPI)
}
```
##Development
Some test are unit tests and run completely in memory without bosh while the integration tests require a local
bosh-lite installation. Ideally you would run this before submitting a PR. All the unit and integration tests can be run using:
```shell
$ make test-all
```
Unit tests are fast in-memory tests and do not run against bosh-lite. All the unit tests can be run using:
```shell
$ make test
```
Integration tests in `integration_test.go` run against [bosh-lite](https://bosh.io/docs/bosh-lite/) and can be run using:
```shell
$ BOSH_CLIENT_SECRET='myadminsecret' make test-integration
```
Before submitting a PR make sure all the tests pass, the code is properly formatted and linted:
```shell
$ make
```
## Contributing
Contributions from the community are welcomed. 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)
- Push your changes to a topic branch in your fork of the repository
- Submit a pull request