Consistent categories for kyma CRDs

[a-thaler]

Created on 2024-06-04} by Andreas Thaler(@a-thaler)

Decision log

Name	Description
Title	Consistent CRD categories
Due date	2024-06-30
Status	Proposed on 202-06-04
Decision type	Binary
Affected decisions	-

Context

It is hard to get an overview across the modules and the kyma status as all entities are modeled in individual CRDs, so you need to know what to query for.

It should be possible to list and get relevant Kyma resources with simple commands using kubectl. A typical approach is to leverage CRD categories. Having that simple 'kubectl get ' will return all resources belonging to the category.

Considerations

There seem to be no official recommendation on when to use categories and how to name them. Istio is using:

• istio-io
• telemetry-istio-io knative uses:
  • knative
  • serving

gardener and calico seem to not use categories

Decision

All user facing CRDs should have categories attached in a consistent approach using the following pattern:

General categories:

• 'kyma-modules' - all module CRDs and the Kyma CRD are using the category Module specific categories (using 'telemetry' module as example):
• 'kyma-telemetry' - all user-facing CRDs of the 'telemetry' module incl telemetry module CR
• 'kyma-telemetry-pipelines' - all telemetry pipeline CRDs

Example CRD assignment categories:

• Telemetry CRD - kyma-modules, kyma-telemetry
• LogPipeline CRD - kyma-telemetry, kyma-telemetry-pipelines

[a-thaler]

Decision got accepted

[a-thaler]

We identified that the "kyma" category will collide with the CRD called "kyma" and will confuse end users. As the use case of listing all kyma resources is maybe not really existent, we decided to remove the category from the proposal, I adjusted the description.