Conversation
…iextensions into improve-generation # Conflicts: # pkg/crd/pkged.go
| openAPIV3Schema: | ||
| description: | | ||
| The CertConfig resource is used in a Giant Swarm installation to ensure TLS communication between | ||
| a component (e. g. prometheus) and the tenant cluster nodes. It is reconciled by cert-operator. | ||
| For each CertConfig resource, cert-operator ensures the existence of an X.509 certificate as | ||
| defined in RFC 5280. | ||
| properties: | ||
| spec: | ||
| type: object | ||
| properties: | ||
| cert: | ||
| description: | | ||
| Defines an X.509 certificate to be ensured by cert-operator. | ||
| type: object | ||
| properties: | ||
| allowBareDomains: | ||
| description: | | ||
| Specifies if clients can request certificates matching the value of the actual | ||
| domains themselves. | ||
| type: bool | ||
| altNames: | ||
| description: | | ||
| Specifies host names to set in the certificate as Subject Alternative Names. | ||
| type: array | ||
| items: | ||
| type: string | ||
| clusterComponent: | ||
| description: | | ||
| Name of the component this certificate is for. | ||
| type: string | ||
| clusterID: | ||
| description: | | ||
| Unique identifier of the tenant cluster this certificate is for. | ||
| type: string | ||
| commonName: | ||
| description: | | ||
| The value of the Common Name (CN) attribute of the certificate. | ||
| disableRegeneration: | ||
| description: | | ||
| Disable automatic certificate rotation before expiry. | ||
| type: bool | ||
| ipSans: | ||
| description: | | ||
| Specifies requested IP Subject Alternative Names to be set in the | ||
| certificate. | ||
| type: array | ||
| items: | ||
| type: string | ||
| organizations: | ||
| description: | | ||
| Organizations to set in the Organizations (O) attribute of the | ||
| certificate. | ||
| type: array | ||
| items: | ||
| type: string | ||
| ttl: | ||
| description: | | ||
| Expiry duration after creation. The value must consist of a number | ||
| combined with a unit, without blanks, to be parsed by the Go | ||
| [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) function. | ||
| type: string | ||
| versionBundle: | ||
| description: | | ||
| No longer used | ||
| type: object |
There was a problem hiding this comment.
I still don't see where these descriptions are going. The according go fields don't have any comments, so the only way to recover this information will be to dig in the git history of the repo if we remove this now. (This CRD is only one example out of several affected.)
* generate-crds: specify number type for kvmconfig quantity fields
I like that. But surely we shouldn't write books in those templates. |
* Add fields to AWSCluster * Changelog * remove github folder * make work all the things * add changelog Co-authored-by: Tim Schindler <xh3b4sd@gmail.com>
…ons into improve-generation
…ons into improve-generation
|
We took this over. After testing and gaining confidence we merge this to master now to get a workable tag in other projects. Thanks a lot to everyone especially @tfussell who did some invaluable contributions for the sake of the whole team. It was a bit bumpy but I hope we are all kind of cool with it. We rollin'. |
|
@marians there are some descriptions missing but I will bring them back next week. |
|
I'm wondering why there are still two CRD YAML files in
Why have those not moved to |
|
When we work on bringing back descriptions, and we use Go comments for them, can we agree that we don't have to repeat the name of the property in the comment? We already have this here with the
It doesn't seem to trigger any lint/fmt errors in my tooling (Go 1.14). |
| singular: release | ||
| preserveUnknownFields: false | ||
| scope: Cluster | ||
| scope: Namespaced |
There was a problem hiding this comment.
Why did this change from cluster to namespace scoped? Just curious..
There was a problem hiding this comment.
Uncertain, but I think @tfussell knows more about it.
There was a problem hiding this comment.
We need to add // +kubebuilder:resource:scope=Cluster to CRs to get the back to parity with our old manually defined CRDs. I can do some if it, but the work will hopefully be divided into teams responsible for each CRD.
8 participants
As a follow-up from #409, this PR allows CRDs to be loaded in go code as structs from the generated YAMLs. Most of the interesting changes are in the scripts directory.
Checklist