README
¶
Kubebuilder: apiserver-runtime
Note: This project is Alpha with no commitments from its maintainers to provide any sort of support. If you intend to use this project in production, we recommend you become involved in maintaining it.
Experimental / Work in Progress
This project exists to explore the creation of new libraries for building Kubernetes API extension servers.
This project is experimental and may change drastically or be cancelled with little or no public notice.
If deletion of this repo would negatively impact you, then make sure this is documented:
- Comment on this issue
And make sure you will get any public notifications about this project.
- Join the kubebuilder@googlegroups.com mailing list
Documenting your dependence on this project does not guarantee that it will not be cancelled if there was insufficient interest on the part of the maintainers to continue maintaining it.
Goals
apiserver-runtime provides libraries for building on top of the Kubernetes apiserver and apimachinery modules.
If you are simply looking to create new Kubernetes extension resource types backed by etcd storage, then you should use CRDs instead of this library. This library is only for the cases where you want to expose Kubernetes endpoints which are not backed by etcd storage.
apiserver-runtime is developed under the kubebuilder subproject.
See the docs: https://pkg.go.dev/sigs.k8s.io/apiserver-runtime/pkg/builder
See the example: sample/cmd/apiserver/main.go
Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this project at:
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
example
Package example provides an example for an apiserver TODO: merge this with the sample at the root
|
Package example provides an example for an apiserver TODO: merge this with the sample at the root |
|
sample-apiserver/pkg/apis/wardle
Package api is the internal version of the API.
|
Package api is the internal version of the API. |
|
sample-apiserver/pkg/apis/wardle/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
|
sample-apiserver/pkg/apis/wardle/v1beta1
Package v1beta1 is the v1beta1 version of the API.
|
Package v1beta1 is the v1beta1 version of the API. |
|
sample-apiserver/pkg/generated/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
sample-apiserver/pkg/generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
sample-apiserver/pkg/generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
sample-apiserver/pkg/generated/clientset/versioned/typed/wardle/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
sample-apiserver/pkg/generated/clientset/versioned/typed/wardle/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
sample-apiserver/pkg/generated/clientset/versioned/typed/wardle/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
sample-apiserver/pkg/generated/clientset/versioned/typed/wardle/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
Package pkg contains the apiserver-runtime libraries.
|
Package pkg contains the apiserver-runtime libraries. |
|
builder
Package builder contains a builder for creating a new Kubernetes apiserver.
|
Package builder contains a builder for creating a new Kubernetes apiserver. |
|
builder/resource
Package resource defines interfaces that may be implemented by types -- e.g.
|
Package resource defines interfaces that may be implemented by types -- e.g. |
|
builder/resource/resourcerest
Package resourcerest defines interfaces for resource REST implementations.
|
Package resourcerest defines interfaces for resource REST implementations. |
|
builder/resource/resourcestrategy
Package resourcestrategy defines interfaces for customizing how resources are converted and stored.
|
Package resourcestrategy defines interfaces for customizing how resources are converted and stored. |
|
builder/resource/util
Package util contains a set of utility functions that help plumbing new kubernetes resources into an aggregated apiserver.
|
Package util contains a set of utility functions that help plumbing new kubernetes resources into an aggregated apiserver. |
|
builder/rest
Package rest contains libraries for implementing resource request handlers.
|
Package rest contains libraries for implementing resource request handlers. |
|
experimental/storage/filepath
Package filepath provides filepath storage related utilities.
|
Package filepath provides filepath storage related utilities. |
|
experimental/storage/mysql
Package mysql provides mysql storage related utilities.
|
Package mysql provides mysql storage related utilities. |
|
features
Package features defines feature-gates.
|
Package features defines feature-gates. |
|
util/context
Package context is a set of utilities for managing contexts.
|
Package context is a set of utilities for managing contexts. |
|
util/loopback
Package loopback is a set of utilities for apiserver loopback connections.
|
Package loopback is a set of utilities for apiserver loopback connections. |
|
sample
|
|
|
pkg/apis/sample
Package sample provides the internal version of all APIs in the sample.k8s.com API group.
|
Package sample provides the internal version of all APIs in the sample.k8s.com API group. |
|
pkg/apis/sample/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
|
pkg/generated/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
pkg/generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
pkg/generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
pkg/generated/clientset/versioned/typed/sample/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
pkg/generated/clientset/versioned/typed/sample/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
pkg/generated/openapi
Package openapi contains the OpenAPI definitions for resources in the sample.k8s.com group.
|
Package openapi contains the OpenAPI definitions for resources in the sample.k8s.com group. |
|
tools
|
|