Improve docstrings on AuthSpec type

hashicorp · Nov 4, 2022 · 7fc5266 · 7fc5266
1 parent 7349560
commit 7fc5266
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/config/crd/bases/api-gateway.consul.hashicorp.com_gatewayclassconfigs.yaml b/config/crd/bases/api-gateway.consul.hashicorp.com_gatewayclassconfigs.yaml
@@ -60,11 +60,11 @@ spec:
                     properties:
                       account:
                         description: The name of an existing Kubernetes ServiceAccount
-                          to authenticate as. Ignored if !Managed.
+                          to authenticate as. Ignored if !managed.
                         type: string
                       managed:
                         description: Whether deployments should be run with "managed"
-                          service accounts created by the gateway controller.
+                          Kubernetes ServiceAccounts created by the gateway controller.
                         type: boolean
                       method:
                         description: The Consul auth method used for initial authentication
@@ -75,7 +75,7 @@ spec:
                         type: string
                       podSecurityPolicy:
                         description: The name of an existing Kubernetes PodSecurityPolicy
-                          to bind to the ServiceAccount if Managed
+                          to bind to the ServiceAccount if managed.
                         type: string
                     type: object
                   ports:

diff --git a/pkg/apis/v1alpha1/types.go b/pkg/apis/v1alpha1/types.go
@@ -125,15 +125,15 @@ type CopyAnnotationsSpec struct {
 }
 
 type AuthSpec struct {
-	// Whether deployments should be run with "managed" service accounts created by the gateway controller.
+	// Whether deployments should be run with "managed" Kubernetes ServiceAccounts created by the gateway controller.
 	Managed bool `json:"managed,omitempty"`
 	// The Consul auth method used for initial authentication by consul-api-gateway.
 	Method string `json:"method,omitempty"`
-	// The name of an existing Kubernetes ServiceAccount to authenticate as. Ignored if !Managed.
+	// The name of an existing Kubernetes ServiceAccount to authenticate as. Ignored if !managed.
 	Account string `json:"account,omitempty"`
 	// The Consul namespace to use for authentication.
 	Namespace string `json:"namespace,omitempty"`
-	// The name of an existing Kubernetes PodSecurityPolicy to bind to the ServiceAccount if Managed
+	// The name of an existing Kubernetes PodSecurityPolicy to bind to the ServiceAccount if managed.
 	PodSecurityPolicy string `json:"podSecurityPolicy,omitempty"`
 }