weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

update CRD field comments

Browse Source 
Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
This commit is contained in:
Tim Ramlot 2024-05-14 17:49:56 +02:00
parent 1aacfd826a
commit e51f4a46db
No known key found for this signature in database
GPG Key ID: 47428728E0C2878D
6 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
deploy/crds/crd-certificates.yaml
View File

@ -308,9 +308,6 @@ spec:
Cannot be set if the `subject` or `commonName` field is set.
This is an Alpha Feature and is only enabled with the
`--feature-gates=LiteralCertificateSubject=true` option set on both
the controller and webhook components.
type: string
nameConstraints:
description: |-

3
internal/apis/certmanager/types_certificate.go
View File

@ -117,9 +117,6 @@ type CertificateSpec struct {
// More info: https://github.com/cert-manager/cert-manager/issues/4424
//
// Cannot be set if the `subject` or `commonName` field is set.
// This is an Alpha Feature and is only enabled with the
// `--feature-gates=LiteralCertificateSubject=true` option set on both
// the controller and webhook components.
LiteralSubject string
// Requested common name X509 certificate subject attribute.

13
internal/apis/certmanager/v1alpha2/types_certificate.go
View File

@ -84,9 +84,16 @@ type CertificateSpec struct {
// +optional
Subject *X509Subject `json:"subject,omitempty"`
// LiteralSubject is an LDAP formatted string that represents the [X.509 Subject field](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6).
// Use this *instead* of the Subject field if you need to ensure the correct ordering of the RDN sequence, such as when issuing certs for LDAP authentication. See https://github.com/cert-manager/cert-manager/issues/3203, https://github.com/cert-manager/cert-manager/issues/4424.
// This field is alpha level and is only supported by cert-manager installations where LiteralCertificateSubject feature gate is enabled on both cert-manager controller and webhook.
// Requested X.509 certificate subject, represented using the LDAP "String
// Representation of a Distinguished Name" [1].
// Important: the LDAP string format also specifies the order of the attributes
// in the subject, this is important when issuing certs for LDAP authentication.
// Example: `CN=foo,DC=corp,DC=example,DC=com`
// More info [1]: https://datatracker.ietf.org/doc/html/rfc4514
// More info: https://github.com/cert-manager/cert-manager/issues/3203
// More info: https://github.com/cert-manager/cert-manager/issues/4424
//
// Cannot be set if the `subject` or `commonName` field is set.
// +optional
LiteralSubject string `json:"literalSubject,omitempty"`

13
internal/apis/certmanager/v1alpha3/types_certificate.go
View File

@ -86,9 +86,16 @@ type CertificateSpec struct {
// +optional
Subject *X509Subject `json:"subject,omitempty"`
// LiteralSubject is an LDAP formatted string that represents the [X.509 Subject field](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6).
// Use this *instead* of the Subject field if you need to ensure the correct ordering of the RDN sequence, such as when issuing certs for LDAP authentication. See https://github.com/cert-manager/cert-manager/issues/3203, https://github.com/cert-manager/cert-manager/issues/4424.
// This field is alpha level and is only supported by cert-manager installations where LiteralCertificateSubject feature gate is enabled on both cert-manager controller and webhook.
// Requested X.509 certificate subject, represented using the LDAP "String
// Representation of a Distinguished Name" [1].
// Important: the LDAP string format also specifies the order of the attributes
// in the subject, this is important when issuing certs for LDAP authentication.
// Example: `CN=foo,DC=corp,DC=example,DC=com`
// More info [1]: https://datatracker.ietf.org/doc/html/rfc4514
// More info: https://github.com/cert-manager/cert-manager/issues/3203
// More info: https://github.com/cert-manager/cert-manager/issues/4424
//
// Cannot be set if the `subject` or `commonName` field is set.
// +optional
LiteralSubject string `json:"literalSubject,omitempty"`

13
internal/apis/certmanager/v1beta1/types_certificate.go
View File

@ -87,9 +87,16 @@ type CertificateSpec struct {
// +optional
Subject *X509Subject `json:"subject,omitempty"`
// LiteralSubject is an LDAP formatted string that represents the [X.509 Subject field](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6).
// Use this *instead* of the Subject field if you need to ensure the correct ordering of the RDN sequence, such as when issuing certs for LDAP authentication. See https://github.com/cert-manager/cert-manager/issues/3203, https://github.com/cert-manager/cert-manager/issues/4424.
// This field is alpha level and is only supported by cert-manager installations where LiteralCertificateSubject feature gate is enabled on both cert-manager controller and webhook.
// Requested X.509 certificate subject, represented using the LDAP "String
// Representation of a Distinguished Name" [1].
// Important: the LDAP string format also specifies the order of the attributes
// in the subject, this is important when issuing certs for LDAP authentication.
// Example: `CN=foo,DC=corp,DC=example,DC=com`
// More info [1]: https://datatracker.ietf.org/doc/html/rfc4514
// More info: https://github.com/cert-manager/cert-manager/issues/3203
// More info: https://github.com/cert-manager/cert-manager/issues/4424
//
// Cannot be set if the `subject` or `commonName` field is set.
// +optional
LiteralSubject string `json:"literalSubject,omitempty"`

3
pkg/apis/certmanager/v1/types_certificate.go
View File

@ -128,9 +128,6 @@ type CertificateSpec struct {
// More info: https://github.com/cert-manager/cert-manager/issues/4424
//
// Cannot be set if the `subject` or `commonName` field is set.
// This is an Alpha Feature and is only enabled with the
// `--feature-gates=LiteralCertificateSubject=true` option set on both
// the controller and webhook components.
// +optional
LiteralSubject string `json:"literalSubject,omitempty"`