README
¶
kcp API Sync Agent
The kcp API Sync Agent is a Kubernetes controller capable of synchronizing objects from many kcp workspaces onto a single Kubernetes cluster (with kcp being the source of truth). In doing so it will move the desired state (usually the spec) of an object from kcp to the local cluster where the agent is running, and move the current object status back up into kcp. The agent can also sync so-called related objects, like a Secret belonging to a Certificate, in both directions.
The agent can be used to provide an API in kcp and then serving it from a remote Kubernetes cluster where the actual workload is then processed, usually by a 3rd-party operator. In many situations the synchronized objects are further processed using tools like Crossplane.
Documentation
Please visit https://docs.kcp.io/api-syncagent for the latest documentation.
Troubleshooting
If you encounter problems, please file an issue.
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 the issues and jump in.
Changelog
See the list of releases to find out about feature changes.
License
Apache 2.0
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
api-syncagent
command
|
|
|
pubres-toolkit
command
|
|
|
internal
|
|
|
controller/apiexport
Package apiexport contains a controller that watches for PublishedResources and then maintains a singular APIExport for all found PR's.
|
Package apiexport contains a controller that watches for PublishedResources and then maintains a singular APIExport for all found PR's. |
|
controller/apiresourceschema
Package apiresourceschema contains a controller that watches for PublishedResources and CRDs and creates a matching APIResourceSchema (ARS) in kcp.
|
Package apiresourceschema contains a controller that watches for PublishedResources and CRDs and creates a matching APIResourceSchema (ARS) in kcp. |
|
controller/sync
Package sync contains a controller that watches the APIExport we manage in kcp.
|
Package sync contains a controller that watches the APIExport we manage in kcp. |
|
controller/syncmanager
Package syncmanager contains a controller that watches the APIExport we manage in kcp.
|
Package syncmanager contains a controller that watches the APIExport we manage in kcp. |
|
sync/apis/dummy/v1alpha1
+groupName=dummy.example.com +versionName=v1alpha1 +kubebuilder:object:generate=true
|
+groupName=dummy.example.com +versionName=v1alpha1 +kubebuilder:object:generate=true |
|
sdk
module
|
|
|
test
|
|