README
¶
service-catalog
Service Catalog lets you provision cloud services directly from the comfort of native Kubernetes tooling. This project is in incubation to bring integration with service brokers to the Kubernetes ecosystem via the Open Service Broker API.
Documentation
Our goal is to have extensive use-case and functional documentation.
See the Service Catalog documentation on the main Kubernetes site, and svc-cat.io.
For details on broker servers that are compatible with this software, see the Open Service Broker API project's Getting Started guide.
Video links
Project Status
We are currently working toward a beta-quality release to be used in conjunction with Kubernetes 1.9. See the milestones list for information about the issues and PRs in current and future milestones.
The project roadmap contains information about our high-level goals for future milestones.
We are currently making weekly releases; see the release process for more information.
Terminology
This project's problem domain contains a few inconvenient but unavoidable overloads with other Kubernetes terms. Check out our terminology page for definitions of terms as they are used in this project.
Contributing
Interested in contributing? Check out the contribution guidelines.
Also see the developer's guide for information on how to build and test the code.
We have a mailing list available here.
We have weekly meetings - see our SIG Readme for details. For meeting agendas and notes, see Kubernetes SIG Service Catalog Agenda.
Previous meeting notes are also available: 2016-08-29 through 2017-09-17.
Kubernetes Incubator
This is a Kubernetes Incubator project. The project was established 2016-Sept-12. The incubator team for the project is:
- Sponsor: Brian Grant (@bgrant0607)
- Champion: Paul Morie (@pmorie)
- SIG: sig-service-catalog
- See our "working" SIG Charter, which should be ratified by the Kubernetes Steering Committee soon.
For more information about sig-service-catalog, such as meeting times and agenda, check out the community site.
Code of Conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
controller-manager/app
Package app implements a server that runs the service catalog controllers.
|
Package app implements a server that runs the service catalog controllers. |
|
healthcheck
command
|
|
|
service-catalog
command
A binary that can morph into all of the other kubernetes service-catalog binaries.
|
A binary that can morph into all of the other kubernetes service-catalog binaries. |
|
svcat
command
|
|
|
svcat/plugin
Package plugin helps apply kubectl plugin-specific cli configuration.
|
Package plugin helps apply kubectl plugin-specific cli configuration. |
|
contrib
|
|
|
cmd/user-broker
command
|
|
|
examples/consumer
command
|
|
|
pkg/brokerapi
Package brokerapi contains types that are used exclusively to talk to a backing open service broker API compatible API
|
Package brokerapi contains types that are used exclusively to talk to a backing open service broker API compatible API |
|
pkg/brokerapi/fake
Package fake contains fake implementations of each of the CF broker APIs.
|
Package fake contains fake implementations of each of the CF broker APIs. |
|
internal
|
|
|
apis/servicecatalog
Package servicecatalog contains all of the sources needed to make servicebrokers and their related service objects.
|
Package servicecatalog contains all of the sources needed to make servicebrokers and their related service objects. |
|
apis/servicecatalog/install
Package install registers the service-catalog API group
|
Package install registers the service-catalog API group |
|
apis/servicecatalog/testapi
Package testapi provides a helper for retrieving the KUBE_TEST_API environment variable.
|
Package testapi provides a helper for retrieving the KUBE_TEST_API environment variable. |
|
apis/servicecatalog/v1beta1
Package v1beta1 defines all of the versioned (v1beta1) definitions of the service catalog model.
|
Package v1beta1 defines all of the versioned (v1beta1) definitions of the service catalog model. |
|
apis/settings
Package settings implements PodPreset CRUD APIs +groupName=settings.servicecatalog.k8s.io
|
Package settings implements PodPreset CRUD APIs +groupName=settings.servicecatalog.k8s.io |
|
apis/settings/install
Package install installs the settings API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the settings API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/settings/v1alpha1
Package v1alpha1 defines all of the versioned (v1alpha1) definitions of the settings group.
|
Package v1alpha1 defines all of the versioned (v1alpha1) definitions of the settings group. |
|
client/clientset_generated/clientset
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset_generated/clientset/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset_generated/clientset/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset_generated/clientset/typed/servicecatalog/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/clientset/typed/servicecatalog/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset_generated/clientset/typed/settings/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/clientset/typed/settings/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset_generated/internalclientset
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset_generated/internalclientset/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset_generated/internalclientset/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset_generated/internalclientset/typed/servicecatalog/internalversion
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/internalclientset/typed/servicecatalog/internalversion/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset_generated/internalclientset/typed/settings/internalversion
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/internalclientset/typed/settings/internalversion/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
metrics
Package metrics creates and registers metrics objects with Prometheus and sets the Prometheus HTTP handler for /metrics
|
Package metrics creates and registers metrics objects with Prometheus and sets the Prometheus HTTP handler for /metrics |
|
metrics/osbclientproxy
Package osbclientproxy proxies the OSB Client Library enabling metrics instrumentation
|
Package osbclientproxy proxies the OSB Client Library enabling metrics instrumentation |
|
openapi
Package openapi exists to hold generated openapi code
|
Package openapi exists to hold generated openapi code |
|
svcat/service-catalog/service-catalogfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
plugin
|
|
|
test
|
|
|
tools
|
|
|
changelog
command
|
|
|
gotest2junit
command
|
|
|
import-verifier
command
|