https://github.com/kubernetes-retired/go-open-service-broker-client
A golang client for service brokers implementing the Open Service Broker API
https://github.com/kubernetes-retired/go-open-service-broker-client
k8s-sig-service-catalog
Last synced: about 2 months ago
JSON representation
A golang client for service brokers implementing the Open Service Broker API
- Host: GitHub
- URL: https://github.com/kubernetes-retired/go-open-service-broker-client
- Owner: kubernetes-retired
- License: apache-2.0
- Archived: true
- Created: 2017-05-07T18:28:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-28T08:24:44.000Z (over 3 years ago)
- Last Synced: 2024-11-12T00:36:18.890Z (8 months ago)
- Topics: k8s-sig-service-catalog
- Language: Go
- Size: 327 KB
- Stars: 62
- Watchers: 10
- Forks: 51
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Security: SECURITY_CONTACTS
Awesome Lists containing this project
README
# `go-open-service-broker-client`
[](https://travis-ci.org/kubernetes-sigs/go-open-service-broker-client)
[](https://coveralls.io/github/kubernetes-sigs/go-open-service-broker-client)
[](https://goreportcard.com/report/github.com/kubernetes-sigs/go-open-service-broker-client)
[](https://godoc.org/github.com/kubernetes-sigs/go-open-service-broker-client)
A golang client for communicating with service brokers implementing the
[Open Service Broker API](https://github.com/openservicebrokerapi/servicebroker).
## Who should use this library?
This library is most interesting if you are implementing an integration
between an application platform and the Open Service Broker API.
## Example
```go
import (
osb "sigs.k8s.io/go-open-service-broker-client/v2"
)
func GetBrokerCatalog(URL string) (*osb.CatalogResponse, error) {
config := osb.DefaultClientConfiguration()
config.URL = URL
client, err := osb.NewClient(config)
if err != nil {
return nil, err
}
return client.GetCatalog()
}
```
## Documentation
This client library supports the following versions of the
[Open Service Broker API](https://github.com/openservicebrokerapi/servicebroker):
- [v2.14](https://github.com/openservicebrokerapi/servicebroker/tree/v2.14)
- [v2.13](https://github.com/openservicebrokerapi/servicebroker/tree/v2.13)
- [v2.12](https://github.com/openservicebrokerapi/servicebroker/tree/v2.12)
- [v2.11](https://github.com/openservicebrokerapi/servicebroker/tree/v2.11)
Only fields supported by the version configured for a client are
sent/returned.
Check out the
[API specification](https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md).
Check out the detailed docs for the [v2 client here](docs/).
## Current status
This repository is used in:
* The [Kubernetes `service-catalog`](https://github.com/kubernetes-sigs/service-catalog)
incubator repo
* The [`osb-broker-lib`](https://github.com/pmorie/osb-broker-lib) library for
creating service brokers
* The [OSB Starter Pack](https://github.com/pmorie/osb-starter-pack) broker quickstart
## Goals
Overall, to make an excellent golang client for the Open Service Broker API.
Specifically:
- Provide useful insights to newcomers to the API
- Support moving between major and minor versions of the OSB API easily
- Support new auth modes in a backward-compatible manner
- Support alpha features in the Open Service Broker API in a clear manner
- Allow advanced configuration of TLS configuration to a broker
- Provide a fake client suitable for unit-type testing
Goals for the content of the project are:
- Provide high-quality godoc comments
- High degree of unit test coverage
- Code should pass vet and lint checks
## Non-goals
This project does not aim to provide:
- A v1 client
- A fake _service broker_; you may be interested in the [OSB starter
pack](https://github.com/pmorie/osb-starter-pack)
- A conformance suite for service brokers; see
[`osb-checker`](https://github.com/openservicebrokerapi/osb-checker) for that
- Any 'custom' API features that are not either in a released version of the
Open Service Broker API spec or accepted into the spec but not yet released
## Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
You can reach the maintainers of this project at:
- [Slack channel](https://kubernetes.slack.com/messages/sig-service-catalog)
- [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-service-catalog)
### Code of conduct
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).