README
¶
kcp-dev/multicluster-provider
This repository contains an experimental provider implementation for multicluster-runtime, a new controller-runtime "addon" that allows writing uniform multi-cluster-aware Kubernetes controllers.
Providers
This repository is expected to contain multiple Provider implementations depending on how your controllers are supposed to interact with kcp.
Currently available are:
- apiexport: for interacting with the
APIExportvirtual workspace (or virtual workspaces with the same semantics). - initializingworkspaces: for interacting with logical clusters that are currently being initialized and wait for an initializer created by a
WorkspaceTypeto be removed.
Examples
See examples for sample code. All providers in this repository come with an example.
Contributing
Thanks for taking the time to start contributing!
Before you start
- Please familiarize yourself with the Code of Conduct before contributing.
- See CONTRIBUTING.md for instructions on the developer certificate of origin that we require.
Pull requests
- We welcome pull requests. Feel free to dig through existing issues and jump in.
License
This project is licensed under Apache-2.0.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apiexport provides a sigs.k8s.io/multicluster-runtime provider implementation for interacting with APIExport virtual workspaces exposed by a [kcp] instance.
|
Package apiexport provides a sigs.k8s.io/multicluster-runtime provider implementation for interacting with APIExport virtual workspaces exposed by a [kcp] instance. |
|
Package envtest provides a test environment for testing code against a kcp control plane.
|
Package envtest provides a test environment for testing code against a kcp control plane. |
|
internal/flock
Package flock is copied from k8s.io/kubernetes/pkg/util/flock to avoid importing k8s.io/kubernetes as a dependency.
|
Package flock is copied from k8s.io/kubernetes/pkg/util/flock to avoid importing k8s.io/kubernetes as a dependency. |
|
examples
|
|
|
apiexport
command
|
|
|
initializingworkspaces
command
|
|
|
Package initializingworkspaces provides a sigs.k8s.io/multicluster-runtime provider implementation for interacting with initializing virtual workspace exposed by a [kcp] instance.
|
Package initializingworkspaces provides a sigs.k8s.io/multicluster-runtime provider implementation for interacting with initializing virtual workspace exposed by a [kcp] instance. |
|
internal
|
|
Click to show internal directories.
Click to hide internal directories.