Backstage catalog API entity for a Kubernetes CRD

giantswarm / roadmap

Giant Swarm Product Roadmap

https://github.com/orgs/giantswarm/projects/273

Apache License 2.0

3 stars 0 forks source link

Backstage catalog API entity for a Kubernetes CRD #3486

Open marians opened 3 weeks ago

marians commented 3 weeks ago

The Backstage catalog supports entities of kind API to enable discovery and document usage of APIs of certain standard types (Rest/OpenAPI, GraphQL, grpc, AsyncAPI).

To make Giant Swarm management API CRDs available in the catalog, we should

investigate whether the community provides support for Kubernetes CRDs as an API entity type
or evaluate providing this ourselves

marians commented 3 weeks ago

I just read the documentation for the .spec.type property more thoroughly and learned that it can be any value. And based on the value, the UI should decide how to represent the .spec.definition content.

I've asked on Discord about code for rendering a Kubernetes CRD.

marians commented 3 weeks ago

We removed the plugin-api-docs from the API entity page in https://github.com/giantswarm/backstage/pull/32 - probably because we had no use for it yet. This would require us to add it again.

gusevda commented 2 weeks ago

@marians Do you know if it would be possible to generate OpenAPI spec based on a CRD?

marians commented 2 weeks ago

@gusevda I think it would be possible. A CRD already includes this property named openAPIV3Schema‎. Example