Skip to content

Commit ff1c788

Browse files
committed
extend FAQ
On-behalf-of: @SAP [email protected]
1 parent fc2b82c commit ff1c788

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/content/faq.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ Only if you have distinct API groups (and therefore also distinct `PublishedReso
1717
You cannot currently publish the same API group onto multiple kcp setups. See issue #13 for more
1818
information.
1919

20-
## What happens when CRDs are updated?
21-
22-
At the moment, nothing. `APIResourceSchemas` in kcp are immutable and the Sync Agent currently does
23-
not attempt to update existing schemas in an `APIExport`. If you add a _new_ CRD that you want to
24-
publish, that's fine, it will be added to the `APIExport`. But changes to existing CRDs require
25-
manual work.
26-
27-
To trigger an update:
28-
29-
* remove the `APIResourceSchema` from the `latestResourceSchemas`,
30-
* delete the `APIResourceSchema` object in kcp,
31-
* restart the api-syncagent
20+
## Can I have additional resources in APIExports, unmanaged by the Sync Agent?
21+
22+
Yes, you can. The agent will only ever change those resourceSchemas that match group/resource of
23+
the configured `PublishedResources`. So if you configure the agent to publish
24+
`cert-manager.io/Certificate`, this would "claim" all resource schemas ending in
25+
`.certificates.cert-manager.io`. When updating the `APIExport`, the agent will only touch schemas
26+
with this suffix and leave all others alone.
27+
28+
This is also used when a `PublishedResource` is deleted: Since the `APIResourceSchema` remains in kcp,
29+
but is no longer configured in the agent, the agent will simply ignore the schema in the `APIExport`.
30+
This allows for async cleanup processes to happen before an admin ultimately removes the old
31+
schema from the `APIExport`.
3232

3333
## Does the Sync Agent handle permission claims?
3434

0 commit comments

Comments
 (0)