Skip to content

Commit 736a5a8

Browse files
committed
update docs
On-behalf-of: @SAP [email protected]
1 parent b3c56e8 commit 736a5a8

File tree

1 file changed

+6
-8
lines changed
  • internal/controller/apiresourceschema

1 file changed

+6
-8
lines changed

internal/controller/apiresourceschema/doc.go

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,13 @@ limitations under the License.
1515
*/
1616

1717
/*
18-
Package apiresourceschema contains a controller that watches for PublishedResources
19-
and creates a matching APIResourceSchema (ARS) in kcp. The name of the generated
20-
ARS is stored in the PublishedResource's status, so that the apiexport controller
21-
can find and include it in the generated APIExport.
18+
Package apiresourceschema contains a controller that watches for PublishedResources and CRDs
19+
and creates a matching APIResourceSchema (ARS) and, optionally, an APIConversion in kcp.
20+
The name of the generated ARS is stored in the PublishedResource's status, so that the
21+
apiexport controller can find and include it in the generated APIExport.
2222
23-
The ARS name contains a hash over the GVK that the PublishedResource is pointing
24-
to. This is to ensure that if an PublishedResource is created, then deleted, modified
25-
with an editor and re-applied, it won't turn into the same ARS, as we cannot simply
26-
turn an ARS for a Pod into an ARS for a StorageClass.
23+
The ARS name contains a hash over the Group, Kind and spec of the projected CRD. This way any
24+
changes to the original CRD or projection rules will result in a new ARS.
2725
2826
There is no extra cleanup procedure in either of the clusters when a PublishedResource
2927
is deleted. This is to prevent accidental data loss in kcp in case a service owner

0 commit comments

Comments
 (0)