Skip to content

Commit 0471ca7

Browse files
committed
Add section about creating initial APIBinding to Getting Started guide
On-behalf-of: SAP <[email protected]> Signed-off-by: Marvin Beckers <[email protected]>
1 parent d651fca commit 0471ca7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/content/getting-started.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,32 @@ $ kubectl create --filename apiexport.yaml
3939
apiexport/test.example.com created
4040
```
4141

42+
### Optional: Create Initial APIBinding
43+
44+
To save resources, kcp doesn't start API endpoints for `APIExports` that are not in use (i.e. that don't
45+
have an active `APIBinding`). To avoid cryptic errors in the Sync Agent logs about resources not being found,
46+
you can create an initial `APIBinding` in the same (or another) workspace as your `APIExport`.
47+
48+
It could look like this:
49+
50+
```yaml
51+
apiVersion: apis.kcp.io/v1alpha1
52+
kind: APIBinding
53+
metadata:
54+
name: test.example.com
55+
spec:
56+
reference:
57+
export:
58+
name: test.example.com
59+
```
60+
61+
While still being in your `:workspace:you:want:to:create:it` workspace, you could create the `APIBinding` like this:
62+
63+
```sh
64+
$ kubectl create --filename apibinding.yaml
65+
apibinding/test.example.com created
66+
```
67+
4268
## Sync Agent Installation
4369

4470
The Sync Agent can be installed into any namespace, but in our example we are going with `kcp-system`.

0 commit comments

Comments
 (0)