Skip to content

Commit c462a86

Browse files
committed
improve readme
On-behalf-of: @SAP [email protected]
1 parent 43a6fdf commit c462a86

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@
55
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kcp-dev/api-syncagent?sort=semver)](https://img.shields.io/github/v/release/kcp-dev/api-syncagent?sort=semver)
66
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkcp-dev%2Fapi-syncagent.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcp-dev%2Fapi-syncagent?ref=badge_shield)
77

8+
The kcp API Sync Agent is a Kubernetes controller capable of synchronizing objects from many kcp
9+
workspaces onto a single Kubernetes cluster (with kcp being the source of truth). In doing so it will
10+
move the desired state (usually the spec) of an object from kcp to the local cluster where the agent
11+
is running, and move the current object status back up into kcp. The agent can also sync so-called
12+
related objects, like a Secret belonging to a Certificate, in both directions.
13+
14+
The agent can be used to provide an API in kcp and then serving it from a remote Kubernetes cluster
15+
where the actual workload is then processed, usually by a 3rd-party operator. In many situations the
16+
synchronized objects are further processed using tools like Crossplane.
17+
18+
## Documentation
19+
20+
Please visit [https://docs.kcp.io/api-syncagent](https://docs.kcp.io/api-syncagent) for the latest
21+
documentation.
22+
823
## Troubleshooting
924

1025
If you encounter problems, please [file an issue][1].

0 commit comments

Comments
 (0)