document allowed enum values and default values in all CR spec fields

This commit is contained in:
Ryan Richard
2024-08-03 14:01:44 -07:00
parent 23129da3e2
commit a40c88ebf3
5 changed files with 12 additions and 3 deletions

View File

@@ -7,6 +7,7 @@ package v1alpha1
type CertificateAuthorityDataSourceSpec struct {
// Kind configures whether the CA bundle is being sourced from a Kubernetes secret or a configmap.
// Secrets must be of type kubernetes.io/tls or Opaque.
// Allowed values are "Secret" or "ConfigMap".
// +kubebuilder:validation:Enum=Secret;ConfigMap
Kind string `json:"kind"`
// Name is the resource name of the secret or configmap from which to read the CA bundle.

View File

@@ -1,4 +1,4 @@
// Copyright 2020-2023 the Pinniped contributors. All Rights Reserved.
// Copyright 2020-2024 the Pinniped contributors. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package v1alpha1
@@ -49,6 +49,7 @@ type CredentialIssuerSpec struct {
}
// ImpersonationProxyMode enumerates the configuration modes for the impersonation proxy.
// Allowed values are "auto", "enabled", or "disabled".
//
// +kubebuilder:validation:Enum=auto;enabled;disabled
type ImpersonationProxyMode string
@@ -65,6 +66,7 @@ const (
)
// ImpersonationProxyServiceType enumerates the types of service that can be provisioned for the impersonation proxy.
// Allowed values are "LoadBalancer", "ClusterIP", or "None".
//
// +kubebuilder:validation:Enum=LoadBalancer;ClusterIP;None
type ImpersonationProxyServiceType string