Merge pull request #60 from kcp-dev/sdk-module

Introduce standalone SDK

Author: kcp-ci-bot

Makefile

@@ -62,16 +62,18 @@ $(GIMPS):
 	  gimps \
 	  ${GIMPS_VERSION}
 
+# wwhrd is installed as a Go module rather than from the provided
+# binaries because there is no arm64 binary available from the author.
+
 WWHRD = _tools/wwhrd
-WWHRD_VERSION = 0.4.0
+WWHRD_VERSION = 06b99400ca6db678386ba5dc39bbbdcdadb664ff
 
 .PHONY: $(WWHRD)
 $(WWHRD):
-	@hack/download-tool.sh \
-	  https://github.com/frapposelli/wwhrd/releases/download/v${WWHRD_VERSION}/wwhrd_${WWHRD_VERSION}_${GOOS}_${GOARCH}.tar.gz \
+	@GO_MODULE=true hack/download-tool.sh \
+	  github.com/frapposelli/wwhrd \
 	  wwhrd \
-	  ${WWHRD_VERSION} \
-	  wwhrd
+	  ${WWHRD_VERSION}
 
 BOILERPLATE = _tools/boilerplate
 BOILERPLATE_VERSION = 0.3.0

README.md

@@ -5,6 +5,21 @@
 [![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)
 [![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)
 
+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](https://docs.kcp.io/api-syncagent) for the latest
+documentation.
+
 ## Troubleshooting
 
 If you encounter problems, please [file an issue][1].