update crd docs and regenerate

pluralsh · Sep 10, 2024 · 6974365 · 6974365
1 parent 109fa9f
commit 6974365
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 13 deletions.
diff --git a/api/v1alpha1/upgradeinsights_types.go b/api/v1alpha1/upgradeinsights_types.go
@@ -120,16 +120,16 @@ type AWSProviderCredentials struct {
 	//	apiVersion: v1
 	//	kind: Secret
 	//	metadata:
-	//		name: eks-credentials
-	//		namespace: upgrade-insights-test
+	//    name: eks-credentials
+	//    namespace: upgrade-insights-test
 	//	stringData:
-	//		secretAccessKey: "changeme"
-	// 
+	//    secretAccessKey: "changeme"
+	//
 	// Then it can be referenced like this:
-	// 		...
-	//		secretAccessKeyRef:
-	//			name: eks-credentials
-	//			namespace: upgrade-insights-test
+	//    ...
+	//    secretAccessKeyRef:
+	//      name: eks-credentials
+	//      namespace: upgrade-insights-test
 	//
 	// +kubebuilder:validation:Required
 	SecretAccessKeyRef corev1.SecretReference `json:"secretAccessKeyRef"`

diff --git a/config/crd/bases/deployments.plural.sh_upgradeinsights.yaml b/config/crd/bases/deployments.plural.sh_upgradeinsights.yaml
@@ -72,10 +72,11 @@ spec:
                           is a cluster-scoped resource we can't use local reference.\n\n\nSecretAccessKey
                           must be stored in a key named \"secretAccessKey\".\n\n\nAn
                           example secret can look like this:\n\tapiVersion: v1\n\tkind:
-                          Secret\n\tmetadata:\n\t\tname: eks-credentials\n\t\tnamespace:
-                          upgrade-insights-test\n\tstringData:\n\t\tsecretAccessKey:
-                          \"changeme\"\n\n\nThen it can be referenced like this:\n\t\t...\n\t\tsecretAccessKeyRef:\n\t\t\tname:
-                          eks-credentials\n\t\t\tnamespace: upgrade-insights-test"
+                          Secret\n\tmetadata:\n   name: eks-credentials\n   namespace:
+                          upgrade-insights-test\n\tstringData:\n   secretAccessKey:
+                          \"changeme\"\n\n\nThen it can be referenced like this:\n
+                          \  ...\n   secretAccessKeyRef:\n     name: eks-credentials\n
+                          \    namespace: upgrade-insights-test"
                         properties:
                           name:
                             description: name is unique within a namespace to reference

diff --git a/docs/api.md b/docs/api.md
@@ -31,7 +31,7 @@ _Appears in:_
 | --- | --- | --- | --- |
 | `region` _string_ | Region is the name of the AWS region cluster lives in. |  | Required: {} <br /> |
 | `accessKeyID` _string_ | AccessKeyID is your access key ID used to authenticate against AWS API. |  | Required: {} <br /> |
-| `secretAccessKeyRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | SecretAccessKeyRef is a reference to the secret that contains secret access key.<br />Since UpgradeInsights is a cluster-scoped resource we can't use local reference.<br />SecretAccessKey must be stored in a key named "secretAccessKey".<br />An example secret can look like this:<br />	apiVersion: v1<br />	kind: Secret<br />	metadata:<br />		name: eks-credentials<br />		namespace: upgrade-insights-test<br />	stringData:<br />		secretAccessKey: "changeme"<br />Then it can be referenced like this:<br />		...<br />		secretAccessKeyRef:<br />			name: eks-credentials<br />			namespace: upgrade-insights-test |  | Required: {} <br /> |
+| `secretAccessKeyRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | SecretAccessKeyRef is a reference to the secret that contains secret access key.<br />Since UpgradeInsights is a cluster-scoped resource we can't use local reference.<br />SecretAccessKey must be stored in a key named "secretAccessKey".<br />An example secret can look like this:<br />	apiVersion: v1<br />	kind: Secret<br />	metadata:<br />   name: eks-credentials<br />   namespace: upgrade-insights-test<br />	stringData:<br />   secretAccessKey: "changeme"<br />Then it can be referenced like this:<br />   ...<br />   secretAccessKeyRef:<br />     name: eks-credentials<br />     namespace: upgrade-insights-test |  | Required: {} <br /> |
 
 
 #### AgentHelmConfiguration