From 4a456446ffd6471ee7b098a76817fabd72bcbcfc Mon Sep 17 00:00:00 2001 From: Matt Moyer Date: Tue, 11 May 2021 21:23:43 -0500 Subject: [PATCH] Update doc comments for types_credentialissuer.go.tmpl. Update to follow https://golang.org/doc/effective_go#commentary: > The first sentence should be a one-sentence summary that starts with the name being declared. Signed-off-by: Matt Moyer --- .../v1alpha1/types_credentialissuer.go.tmpl | 16 +++++++++++----- ...concierge.pinniped.dev_credentialissuers.yaml | 7 ++++--- generated/1.17/README.adoc | 4 ++-- .../config/v1alpha1/types_credentialissuer.go | 16 +++++++++++----- ...concierge.pinniped.dev_credentialissuers.yaml | 7 ++++--- generated/1.18/README.adoc | 4 ++-- .../config/v1alpha1/types_credentialissuer.go | 16 +++++++++++----- ...concierge.pinniped.dev_credentialissuers.yaml | 7 ++++--- generated/1.19/README.adoc | 4 ++-- .../config/v1alpha1/types_credentialissuer.go | 16 +++++++++++----- ...concierge.pinniped.dev_credentialissuers.yaml | 7 ++++--- generated/1.20/README.adoc | 4 ++-- .../config/v1alpha1/types_credentialissuer.go | 16 +++++++++++----- ...concierge.pinniped.dev_credentialissuers.yaml | 7 ++++--- .../config/v1alpha1/types_credentialissuer.go | 16 +++++++++++----- 15 files changed, 94 insertions(+), 53 deletions(-) diff --git a/apis/concierge/config/v1alpha1/types_credentialissuer.go.tmpl b/apis/concierge/config/v1alpha1/types_credentialissuer.go.tmpl index 3c0c8ba0..4a6607c5 100644 --- a/apis/concierge/config/v1alpha1/types_credentialissuer.go.tmpl +++ b/apis/concierge/config/v1alpha1/types_credentialissuer.go.tmpl @@ -5,15 +5,19 @@ package v1alpha1 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +// StrategyType enumerates a type of "strategy" used to implement credential access on a cluster. // +kubebuilder:validation:Enum=KubeClusterSigningCertificate;ImpersonationProxy type StrategyType string +// FrontendType enumerates a type of "frontend" used to provide access to users of a cluster. // +kubebuilder:validation:Enum=TokenCredentialRequestAPI;ImpersonationProxy type FrontendType string +// StrategyStatus enumerates whether a strategy is working on a cluster. // +kubebuilder:validation:Enum=Success;Error type StrategyStatus string +// StrategyReason enumerates the detailed reason why a strategy is in a particular status. // +kubebuilder:validation:Enum=Listening;Pending;Disabled;ErrorDuringSetup;CouldNotFetchKey;CouldNotGetClusterInfo;FetchedKey type StrategyReason string @@ -36,7 +40,7 @@ const ( FetchedKeyStrategyReason = StrategyReason("FetchedKey") ) -// Status of a credential issuer. +// CredentialIssuerStatus describes the status of the Concierge. type CredentialIssuerStatus struct { // List of integration strategies that were attempted by Pinniped. Strategies []CredentialIssuerStrategy `json:"strategies"` @@ -47,7 +51,8 @@ type CredentialIssuerStatus struct { KubeConfigInfo *CredentialIssuerKubeConfigInfo `json:"kubeConfigInfo,omitempty"` } -// Information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// CredentialIssuerKubeConfigInfo provides the information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// This type is deprecated and will be removed in a future version. type CredentialIssuerKubeConfigInfo struct { // The K8s API server URL. // +kubebuilder:validation:MinLength=1 @@ -59,7 +64,7 @@ type CredentialIssuerKubeConfigInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Status of an integration strategy that was attempted by Pinniped. +// CredentialIssuerStrategy describes the status of an integration strategy that was attempted by Pinniped. type CredentialIssuerStrategy struct { // Type of integration attempted. Type StrategyType `json:"type"` @@ -81,6 +86,7 @@ type CredentialIssuerStrategy struct { Frontend *CredentialIssuerFrontend `json:"frontend,omitempty"` } +// CredentialIssuerFrontend describes how to connect using a particular integration strategy. type CredentialIssuerFrontend struct { // Type describes which frontend mechanism clients can use with a strategy. Type FrontendType `json:"type"` @@ -118,7 +124,7 @@ type ImpersonationProxyInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Describes the configuration status of a Pinniped credential issuer. +// CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. // +genclient // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -133,7 +139,7 @@ type CredentialIssuer struct { Status CredentialIssuerStatus `json:"status"` } -// List of CredentialIssuer objects. +// CredentialIssuerList is a list of CredentialIssuer objects. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object type CredentialIssuerList struct { metav1.TypeMeta `json:",inline"` diff --git a/deploy/concierge/config.concierge.pinniped.dev_credentialissuers.yaml b/deploy/concierge/config.concierge.pinniped.dev_credentialissuers.yaml index 8123f238..992331de 100644 --- a/deploy/concierge/config.concierge.pinniped.dev_credentialissuers.yaml +++ b/deploy/concierge/config.concierge.pinniped.dev_credentialissuers.yaml @@ -21,7 +21,8 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - description: Describes the configuration status of a Pinniped credential issuer. + description: CredentialIssuer describes the configuration and status of the + Pinniped Concierge credential issuer. properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -60,8 +61,8 @@ spec: description: List of integration strategies that were attempted by Pinniped. items: - description: Status of an integration strategy that was attempted - by Pinniped. + description: CredentialIssuerStrategy describes the status of an + integration strategy that was attempted by Pinniped. properties: frontend: description: Frontend describes how clients can connect using diff --git a/generated/1.17/README.adoc b/generated/1.17/README.adoc index edda79aa..67ca2720 100644 --- a/generated/1.17/README.adoc +++ b/generated/1.17/README.adoc @@ -220,7 +220,7 @@ Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration [id="{anchor_prefix}-go-pinniped-dev-generated-1-17-apis-concierge-config-v1alpha1-credentialissuer"] ==== CredentialIssuer -Describes the configuration status of a Pinniped credential issuer. +CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. .Appears In: **** @@ -278,7 +278,7 @@ Describes the configuration status of a Pinniped credential issuer. [id="{anchor_prefix}-go-pinniped-dev-generated-1-17-apis-concierge-config-v1alpha1-credentialissuerstatus"] ==== CredentialIssuerStatus -Status of a credential issuer. +CredentialIssuerStatus describes the status of the Concierge. .Appears In: **** diff --git a/generated/1.17/apis/concierge/config/v1alpha1/types_credentialissuer.go b/generated/1.17/apis/concierge/config/v1alpha1/types_credentialissuer.go index 3c0c8ba0..4a6607c5 100644 --- a/generated/1.17/apis/concierge/config/v1alpha1/types_credentialissuer.go +++ b/generated/1.17/apis/concierge/config/v1alpha1/types_credentialissuer.go @@ -5,15 +5,19 @@ package v1alpha1 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +// StrategyType enumerates a type of "strategy" used to implement credential access on a cluster. // +kubebuilder:validation:Enum=KubeClusterSigningCertificate;ImpersonationProxy type StrategyType string +// FrontendType enumerates a type of "frontend" used to provide access to users of a cluster. // +kubebuilder:validation:Enum=TokenCredentialRequestAPI;ImpersonationProxy type FrontendType string +// StrategyStatus enumerates whether a strategy is working on a cluster. // +kubebuilder:validation:Enum=Success;Error type StrategyStatus string +// StrategyReason enumerates the detailed reason why a strategy is in a particular status. // +kubebuilder:validation:Enum=Listening;Pending;Disabled;ErrorDuringSetup;CouldNotFetchKey;CouldNotGetClusterInfo;FetchedKey type StrategyReason string @@ -36,7 +40,7 @@ const ( FetchedKeyStrategyReason = StrategyReason("FetchedKey") ) -// Status of a credential issuer. +// CredentialIssuerStatus describes the status of the Concierge. type CredentialIssuerStatus struct { // List of integration strategies that were attempted by Pinniped. Strategies []CredentialIssuerStrategy `json:"strategies"` @@ -47,7 +51,8 @@ type CredentialIssuerStatus struct { KubeConfigInfo *CredentialIssuerKubeConfigInfo `json:"kubeConfigInfo,omitempty"` } -// Information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// CredentialIssuerKubeConfigInfo provides the information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// This type is deprecated and will be removed in a future version. type CredentialIssuerKubeConfigInfo struct { // The K8s API server URL. // +kubebuilder:validation:MinLength=1 @@ -59,7 +64,7 @@ type CredentialIssuerKubeConfigInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Status of an integration strategy that was attempted by Pinniped. +// CredentialIssuerStrategy describes the status of an integration strategy that was attempted by Pinniped. type CredentialIssuerStrategy struct { // Type of integration attempted. Type StrategyType `json:"type"` @@ -81,6 +86,7 @@ type CredentialIssuerStrategy struct { Frontend *CredentialIssuerFrontend `json:"frontend,omitempty"` } +// CredentialIssuerFrontend describes how to connect using a particular integration strategy. type CredentialIssuerFrontend struct { // Type describes which frontend mechanism clients can use with a strategy. Type FrontendType `json:"type"` @@ -118,7 +124,7 @@ type ImpersonationProxyInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Describes the configuration status of a Pinniped credential issuer. +// CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. // +genclient // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -133,7 +139,7 @@ type CredentialIssuer struct { Status CredentialIssuerStatus `json:"status"` } -// List of CredentialIssuer objects. +// CredentialIssuerList is a list of CredentialIssuer objects. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object type CredentialIssuerList struct { metav1.TypeMeta `json:",inline"` diff --git a/generated/1.17/crds/config.concierge.pinniped.dev_credentialissuers.yaml b/generated/1.17/crds/config.concierge.pinniped.dev_credentialissuers.yaml index 8123f238..992331de 100644 --- a/generated/1.17/crds/config.concierge.pinniped.dev_credentialissuers.yaml +++ b/generated/1.17/crds/config.concierge.pinniped.dev_credentialissuers.yaml @@ -21,7 +21,8 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - description: Describes the configuration status of a Pinniped credential issuer. + description: CredentialIssuer describes the configuration and status of the + Pinniped Concierge credential issuer. properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -60,8 +61,8 @@ spec: description: List of integration strategies that were attempted by Pinniped. items: - description: Status of an integration strategy that was attempted - by Pinniped. + description: CredentialIssuerStrategy describes the status of an + integration strategy that was attempted by Pinniped. properties: frontend: description: Frontend describes how clients can connect using diff --git a/generated/1.18/README.adoc b/generated/1.18/README.adoc index cc33968f..5f9555d9 100644 --- a/generated/1.18/README.adoc +++ b/generated/1.18/README.adoc @@ -220,7 +220,7 @@ Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration [id="{anchor_prefix}-go-pinniped-dev-generated-1-18-apis-concierge-config-v1alpha1-credentialissuer"] ==== CredentialIssuer -Describes the configuration status of a Pinniped credential issuer. +CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. .Appears In: **** @@ -278,7 +278,7 @@ Describes the configuration status of a Pinniped credential issuer. [id="{anchor_prefix}-go-pinniped-dev-generated-1-18-apis-concierge-config-v1alpha1-credentialissuerstatus"] ==== CredentialIssuerStatus -Status of a credential issuer. +CredentialIssuerStatus describes the status of the Concierge. .Appears In: **** diff --git a/generated/1.18/apis/concierge/config/v1alpha1/types_credentialissuer.go b/generated/1.18/apis/concierge/config/v1alpha1/types_credentialissuer.go index 3c0c8ba0..4a6607c5 100644 --- a/generated/1.18/apis/concierge/config/v1alpha1/types_credentialissuer.go +++ b/generated/1.18/apis/concierge/config/v1alpha1/types_credentialissuer.go @@ -5,15 +5,19 @@ package v1alpha1 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +// StrategyType enumerates a type of "strategy" used to implement credential access on a cluster. // +kubebuilder:validation:Enum=KubeClusterSigningCertificate;ImpersonationProxy type StrategyType string +// FrontendType enumerates a type of "frontend" used to provide access to users of a cluster. // +kubebuilder:validation:Enum=TokenCredentialRequestAPI;ImpersonationProxy type FrontendType string +// StrategyStatus enumerates whether a strategy is working on a cluster. // +kubebuilder:validation:Enum=Success;Error type StrategyStatus string +// StrategyReason enumerates the detailed reason why a strategy is in a particular status. // +kubebuilder:validation:Enum=Listening;Pending;Disabled;ErrorDuringSetup;CouldNotFetchKey;CouldNotGetClusterInfo;FetchedKey type StrategyReason string @@ -36,7 +40,7 @@ const ( FetchedKeyStrategyReason = StrategyReason("FetchedKey") ) -// Status of a credential issuer. +// CredentialIssuerStatus describes the status of the Concierge. type CredentialIssuerStatus struct { // List of integration strategies that were attempted by Pinniped. Strategies []CredentialIssuerStrategy `json:"strategies"` @@ -47,7 +51,8 @@ type CredentialIssuerStatus struct { KubeConfigInfo *CredentialIssuerKubeConfigInfo `json:"kubeConfigInfo,omitempty"` } -// Information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// CredentialIssuerKubeConfigInfo provides the information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// This type is deprecated and will be removed in a future version. type CredentialIssuerKubeConfigInfo struct { // The K8s API server URL. // +kubebuilder:validation:MinLength=1 @@ -59,7 +64,7 @@ type CredentialIssuerKubeConfigInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Status of an integration strategy that was attempted by Pinniped. +// CredentialIssuerStrategy describes the status of an integration strategy that was attempted by Pinniped. type CredentialIssuerStrategy struct { // Type of integration attempted. Type StrategyType `json:"type"` @@ -81,6 +86,7 @@ type CredentialIssuerStrategy struct { Frontend *CredentialIssuerFrontend `json:"frontend,omitempty"` } +// CredentialIssuerFrontend describes how to connect using a particular integration strategy. type CredentialIssuerFrontend struct { // Type describes which frontend mechanism clients can use with a strategy. Type FrontendType `json:"type"` @@ -118,7 +124,7 @@ type ImpersonationProxyInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Describes the configuration status of a Pinniped credential issuer. +// CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. // +genclient // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -133,7 +139,7 @@ type CredentialIssuer struct { Status CredentialIssuerStatus `json:"status"` } -// List of CredentialIssuer objects. +// CredentialIssuerList is a list of CredentialIssuer objects. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object type CredentialIssuerList struct { metav1.TypeMeta `json:",inline"` diff --git a/generated/1.18/crds/config.concierge.pinniped.dev_credentialissuers.yaml b/generated/1.18/crds/config.concierge.pinniped.dev_credentialissuers.yaml index 8123f238..992331de 100644 --- a/generated/1.18/crds/config.concierge.pinniped.dev_credentialissuers.yaml +++ b/generated/1.18/crds/config.concierge.pinniped.dev_credentialissuers.yaml @@ -21,7 +21,8 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - description: Describes the configuration status of a Pinniped credential issuer. + description: CredentialIssuer describes the configuration and status of the + Pinniped Concierge credential issuer. properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -60,8 +61,8 @@ spec: description: List of integration strategies that were attempted by Pinniped. items: - description: Status of an integration strategy that was attempted - by Pinniped. + description: CredentialIssuerStrategy describes the status of an + integration strategy that was attempted by Pinniped. properties: frontend: description: Frontend describes how clients can connect using diff --git a/generated/1.19/README.adoc b/generated/1.19/README.adoc index d0effe28..8f16ea55 100644 --- a/generated/1.19/README.adoc +++ b/generated/1.19/README.adoc @@ -220,7 +220,7 @@ Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration [id="{anchor_prefix}-go-pinniped-dev-generated-1-19-apis-concierge-config-v1alpha1-credentialissuer"] ==== CredentialIssuer -Describes the configuration status of a Pinniped credential issuer. +CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. .Appears In: **** @@ -278,7 +278,7 @@ Describes the configuration status of a Pinniped credential issuer. [id="{anchor_prefix}-go-pinniped-dev-generated-1-19-apis-concierge-config-v1alpha1-credentialissuerstatus"] ==== CredentialIssuerStatus -Status of a credential issuer. +CredentialIssuerStatus describes the status of the Concierge. .Appears In: **** diff --git a/generated/1.19/apis/concierge/config/v1alpha1/types_credentialissuer.go b/generated/1.19/apis/concierge/config/v1alpha1/types_credentialissuer.go index 3c0c8ba0..4a6607c5 100644 --- a/generated/1.19/apis/concierge/config/v1alpha1/types_credentialissuer.go +++ b/generated/1.19/apis/concierge/config/v1alpha1/types_credentialissuer.go @@ -5,15 +5,19 @@ package v1alpha1 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +// StrategyType enumerates a type of "strategy" used to implement credential access on a cluster. // +kubebuilder:validation:Enum=KubeClusterSigningCertificate;ImpersonationProxy type StrategyType string +// FrontendType enumerates a type of "frontend" used to provide access to users of a cluster. // +kubebuilder:validation:Enum=TokenCredentialRequestAPI;ImpersonationProxy type FrontendType string +// StrategyStatus enumerates whether a strategy is working on a cluster. // +kubebuilder:validation:Enum=Success;Error type StrategyStatus string +// StrategyReason enumerates the detailed reason why a strategy is in a particular status. // +kubebuilder:validation:Enum=Listening;Pending;Disabled;ErrorDuringSetup;CouldNotFetchKey;CouldNotGetClusterInfo;FetchedKey type StrategyReason string @@ -36,7 +40,7 @@ const ( FetchedKeyStrategyReason = StrategyReason("FetchedKey") ) -// Status of a credential issuer. +// CredentialIssuerStatus describes the status of the Concierge. type CredentialIssuerStatus struct { // List of integration strategies that were attempted by Pinniped. Strategies []CredentialIssuerStrategy `json:"strategies"` @@ -47,7 +51,8 @@ type CredentialIssuerStatus struct { KubeConfigInfo *CredentialIssuerKubeConfigInfo `json:"kubeConfigInfo,omitempty"` } -// Information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// CredentialIssuerKubeConfigInfo provides the information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// This type is deprecated and will be removed in a future version. type CredentialIssuerKubeConfigInfo struct { // The K8s API server URL. // +kubebuilder:validation:MinLength=1 @@ -59,7 +64,7 @@ type CredentialIssuerKubeConfigInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Status of an integration strategy that was attempted by Pinniped. +// CredentialIssuerStrategy describes the status of an integration strategy that was attempted by Pinniped. type CredentialIssuerStrategy struct { // Type of integration attempted. Type StrategyType `json:"type"` @@ -81,6 +86,7 @@ type CredentialIssuerStrategy struct { Frontend *CredentialIssuerFrontend `json:"frontend,omitempty"` } +// CredentialIssuerFrontend describes how to connect using a particular integration strategy. type CredentialIssuerFrontend struct { // Type describes which frontend mechanism clients can use with a strategy. Type FrontendType `json:"type"` @@ -118,7 +124,7 @@ type ImpersonationProxyInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Describes the configuration status of a Pinniped credential issuer. +// CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. // +genclient // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -133,7 +139,7 @@ type CredentialIssuer struct { Status CredentialIssuerStatus `json:"status"` } -// List of CredentialIssuer objects. +// CredentialIssuerList is a list of CredentialIssuer objects. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object type CredentialIssuerList struct { metav1.TypeMeta `json:",inline"` diff --git a/generated/1.19/crds/config.concierge.pinniped.dev_credentialissuers.yaml b/generated/1.19/crds/config.concierge.pinniped.dev_credentialissuers.yaml index 8123f238..992331de 100644 --- a/generated/1.19/crds/config.concierge.pinniped.dev_credentialissuers.yaml +++ b/generated/1.19/crds/config.concierge.pinniped.dev_credentialissuers.yaml @@ -21,7 +21,8 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - description: Describes the configuration status of a Pinniped credential issuer. + description: CredentialIssuer describes the configuration and status of the + Pinniped Concierge credential issuer. properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -60,8 +61,8 @@ spec: description: List of integration strategies that were attempted by Pinniped. items: - description: Status of an integration strategy that was attempted - by Pinniped. + description: CredentialIssuerStrategy describes the status of an + integration strategy that was attempted by Pinniped. properties: frontend: description: Frontend describes how clients can connect using diff --git a/generated/1.20/README.adoc b/generated/1.20/README.adoc index 348c55d0..0bbef389 100644 --- a/generated/1.20/README.adoc +++ b/generated/1.20/README.adoc @@ -220,7 +220,7 @@ Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration [id="{anchor_prefix}-go-pinniped-dev-generated-1-20-apis-concierge-config-v1alpha1-credentialissuer"] ==== CredentialIssuer -Describes the configuration status of a Pinniped credential issuer. +CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. .Appears In: **** @@ -278,7 +278,7 @@ Describes the configuration status of a Pinniped credential issuer. [id="{anchor_prefix}-go-pinniped-dev-generated-1-20-apis-concierge-config-v1alpha1-credentialissuerstatus"] ==== CredentialIssuerStatus -Status of a credential issuer. +CredentialIssuerStatus describes the status of the Concierge. .Appears In: **** diff --git a/generated/1.20/apis/concierge/config/v1alpha1/types_credentialissuer.go b/generated/1.20/apis/concierge/config/v1alpha1/types_credentialissuer.go index 3c0c8ba0..4a6607c5 100644 --- a/generated/1.20/apis/concierge/config/v1alpha1/types_credentialissuer.go +++ b/generated/1.20/apis/concierge/config/v1alpha1/types_credentialissuer.go @@ -5,15 +5,19 @@ package v1alpha1 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +// StrategyType enumerates a type of "strategy" used to implement credential access on a cluster. // +kubebuilder:validation:Enum=KubeClusterSigningCertificate;ImpersonationProxy type StrategyType string +// FrontendType enumerates a type of "frontend" used to provide access to users of a cluster. // +kubebuilder:validation:Enum=TokenCredentialRequestAPI;ImpersonationProxy type FrontendType string +// StrategyStatus enumerates whether a strategy is working on a cluster. // +kubebuilder:validation:Enum=Success;Error type StrategyStatus string +// StrategyReason enumerates the detailed reason why a strategy is in a particular status. // +kubebuilder:validation:Enum=Listening;Pending;Disabled;ErrorDuringSetup;CouldNotFetchKey;CouldNotGetClusterInfo;FetchedKey type StrategyReason string @@ -36,7 +40,7 @@ const ( FetchedKeyStrategyReason = StrategyReason("FetchedKey") ) -// Status of a credential issuer. +// CredentialIssuerStatus describes the status of the Concierge. type CredentialIssuerStatus struct { // List of integration strategies that were attempted by Pinniped. Strategies []CredentialIssuerStrategy `json:"strategies"` @@ -47,7 +51,8 @@ type CredentialIssuerStatus struct { KubeConfigInfo *CredentialIssuerKubeConfigInfo `json:"kubeConfigInfo,omitempty"` } -// Information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// CredentialIssuerKubeConfigInfo provides the information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// This type is deprecated and will be removed in a future version. type CredentialIssuerKubeConfigInfo struct { // The K8s API server URL. // +kubebuilder:validation:MinLength=1 @@ -59,7 +64,7 @@ type CredentialIssuerKubeConfigInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Status of an integration strategy that was attempted by Pinniped. +// CredentialIssuerStrategy describes the status of an integration strategy that was attempted by Pinniped. type CredentialIssuerStrategy struct { // Type of integration attempted. Type StrategyType `json:"type"` @@ -81,6 +86,7 @@ type CredentialIssuerStrategy struct { Frontend *CredentialIssuerFrontend `json:"frontend,omitempty"` } +// CredentialIssuerFrontend describes how to connect using a particular integration strategy. type CredentialIssuerFrontend struct { // Type describes which frontend mechanism clients can use with a strategy. Type FrontendType `json:"type"` @@ -118,7 +124,7 @@ type ImpersonationProxyInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Describes the configuration status of a Pinniped credential issuer. +// CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. // +genclient // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -133,7 +139,7 @@ type CredentialIssuer struct { Status CredentialIssuerStatus `json:"status"` } -// List of CredentialIssuer objects. +// CredentialIssuerList is a list of CredentialIssuer objects. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object type CredentialIssuerList struct { metav1.TypeMeta `json:",inline"` diff --git a/generated/1.20/crds/config.concierge.pinniped.dev_credentialissuers.yaml b/generated/1.20/crds/config.concierge.pinniped.dev_credentialissuers.yaml index 8123f238..992331de 100644 --- a/generated/1.20/crds/config.concierge.pinniped.dev_credentialissuers.yaml +++ b/generated/1.20/crds/config.concierge.pinniped.dev_credentialissuers.yaml @@ -21,7 +21,8 @@ spec: - name: v1alpha1 schema: openAPIV3Schema: - description: Describes the configuration status of a Pinniped credential issuer. + description: CredentialIssuer describes the configuration and status of the + Pinniped Concierge credential issuer. properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -60,8 +61,8 @@ spec: description: List of integration strategies that were attempted by Pinniped. items: - description: Status of an integration strategy that was attempted - by Pinniped. + description: CredentialIssuerStrategy describes the status of an + integration strategy that was attempted by Pinniped. properties: frontend: description: Frontend describes how clients can connect using diff --git a/generated/latest/apis/concierge/config/v1alpha1/types_credentialissuer.go b/generated/latest/apis/concierge/config/v1alpha1/types_credentialissuer.go index 3c0c8ba0..4a6607c5 100644 --- a/generated/latest/apis/concierge/config/v1alpha1/types_credentialissuer.go +++ b/generated/latest/apis/concierge/config/v1alpha1/types_credentialissuer.go @@ -5,15 +5,19 @@ package v1alpha1 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +// StrategyType enumerates a type of "strategy" used to implement credential access on a cluster. // +kubebuilder:validation:Enum=KubeClusterSigningCertificate;ImpersonationProxy type StrategyType string +// FrontendType enumerates a type of "frontend" used to provide access to users of a cluster. // +kubebuilder:validation:Enum=TokenCredentialRequestAPI;ImpersonationProxy type FrontendType string +// StrategyStatus enumerates whether a strategy is working on a cluster. // +kubebuilder:validation:Enum=Success;Error type StrategyStatus string +// StrategyReason enumerates the detailed reason why a strategy is in a particular status. // +kubebuilder:validation:Enum=Listening;Pending;Disabled;ErrorDuringSetup;CouldNotFetchKey;CouldNotGetClusterInfo;FetchedKey type StrategyReason string @@ -36,7 +40,7 @@ const ( FetchedKeyStrategyReason = StrategyReason("FetchedKey") ) -// Status of a credential issuer. +// CredentialIssuerStatus describes the status of the Concierge. type CredentialIssuerStatus struct { // List of integration strategies that were attempted by Pinniped. Strategies []CredentialIssuerStrategy `json:"strategies"` @@ -47,7 +51,8 @@ type CredentialIssuerStatus struct { KubeConfigInfo *CredentialIssuerKubeConfigInfo `json:"kubeConfigInfo,omitempty"` } -// Information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// CredentialIssuerKubeConfigInfo provides the information needed to form a valid Pinniped-based kubeconfig using this credential issuer. +// This type is deprecated and will be removed in a future version. type CredentialIssuerKubeConfigInfo struct { // The K8s API server URL. // +kubebuilder:validation:MinLength=1 @@ -59,7 +64,7 @@ type CredentialIssuerKubeConfigInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Status of an integration strategy that was attempted by Pinniped. +// CredentialIssuerStrategy describes the status of an integration strategy that was attempted by Pinniped. type CredentialIssuerStrategy struct { // Type of integration attempted. Type StrategyType `json:"type"` @@ -81,6 +86,7 @@ type CredentialIssuerStrategy struct { Frontend *CredentialIssuerFrontend `json:"frontend,omitempty"` } +// CredentialIssuerFrontend describes how to connect using a particular integration strategy. type CredentialIssuerFrontend struct { // Type describes which frontend mechanism clients can use with a strategy. Type FrontendType `json:"type"` @@ -118,7 +124,7 @@ type ImpersonationProxyInfo struct { CertificateAuthorityData string `json:"certificateAuthorityData"` } -// Describes the configuration status of a Pinniped credential issuer. +// CredentialIssuer describes the configuration and status of the Pinniped Concierge credential issuer. // +genclient // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -133,7 +139,7 @@ type CredentialIssuer struct { Status CredentialIssuerStatus `json:"status"` } -// List of CredentialIssuer objects. +// CredentialIssuerList is a list of CredentialIssuer objects. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object type CredentialIssuerList struct { metav1.TypeMeta `json:",inline"`