GoogleCloudPlatform / k8s-config-connector

GCP Config Connector, a Kubernetes add-on for managing GCP resources
https://cloud.google.com/config-connector/docs/overview
Apache License 2.0
893 stars 222 forks source link

No documentation for ConfigConnectorContext resource itself #344

Open dpetersen opened 3 years ago

dpetersen commented 3 years ago

I was reading the recent release notes and saw, in version 1.28.0:

Add spec.requestProjectPolicy field to ConfigConnectorContext CRD

While there is excellent documentation in this repository for all the resource CRDs, there isn't any documentation about ConfigConnectorContext. I have no idea what this new field does (I'm hoping it changes the behavior of how a resource defaults to trying to create in a project named after its Kubernetes namespace, but that's not what this ticket is about).

It would be really wonderful if the source for the controller manager was available to view, as this isn't the first time I've been left with questions from a vague entry in the release notes. I'm sure this CRD exists somewhere, just not where I can see it. I think I would have to update to that version and then read the YAML spec for the CRD from my own cluster.

caieo commented 3 years ago

Hi @dpetersen, thank you for pointing this out to us -- we will work on adding documentation for the ConfigConnectorContext CRD. In the meantime, if you need to find the schema easily, you can run kubectl get crd configconnectorcontexts.core.cnrm.cloud.google.com -o yaml.