chore: fix comments

Signed-off-by: jacky-xbb <[email protected]>
emqx · Nov 7, 2023 · d3f52dd · d3f52dd
1 parent 692727f
commit d3f52dd
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 17 deletions.
diff --git a/apis/apps/v2beta1/emqx_types.go b/apis/apps/v2beta1/emqx_types.go
@@ -108,8 +108,8 @@ type BootstrapAPIKey struct {
 }
 
 type SecretRef struct {
-	Key    *KeyRef `json:"key"`
-	Secret *KeyRef `json:"secret"`
+	Key    KeyRef `json:"key"`
+	Secret KeyRef `json:"secret"`
 }
 
 type KeyRef struct {

diff --git a/apis/apps/v2beta1/zz_generated.deepcopy.go b/apis/apps/v2beta1/zz_generated.deepcopy.go
diff --git a/controllers/apps/v2beta1/add_bootstrap_resource.go b/controllers/apps/v2beta1/add_bootstrap_resource.go
@@ -10,6 +10,7 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/log"
 
 	appsv2beta1 "github.com/emqx/emqx-operator/apis/apps/v2beta1"
 	innerReq "github.com/emqx/emqx-operator/internal/requester"
@@ -87,17 +88,22 @@ func ReadSecret(k8sClient client.Client, ctx context.Context, namespace string,
 }
 
 func generateBootstrapAPIKeySecret(k8sClient client.Client, ctx context.Context, instance *appsv2beta1.EMQX) *corev1.Secret {
+	logger := log.FromContext(ctx)
 	bootstrapAPIKeys := ""
 
 	for _, apiKey := range instance.Spec.BootstrapAPIKeys {
 		if apiKey.SecretRef != nil {
+			logger.V(1).Info("Read SecretRef")
+
 			// Read key and secret values from the refenced secrets
 			keyValue, err := ReadSecret(k8sClient, ctx, instance.Namespace, apiKey.SecretRef.Key.SecretName, apiKey.SecretRef.Key.SecretKey)
 			if err != nil {
+				logger.V(1).Error(err, "read secretRef", "key")
 				continue
 			}
 			secretValue, err := ReadSecret(k8sClient, ctx, instance.Namespace, apiKey.SecretRef.Secret.SecretName, apiKey.SecretRef.Secret.SecretKey)
 			if err != nil {
+				logger.V(1).Error(err, "read secretRef", "secret")
 				continue
 			}
 			bootstrapAPIKeys += keyValue + ":" + secretValue + "\n"

diff --git a/controllers/apps/v2beta1/add_bootstrap_resource_suite_test.go b/controllers/apps/v2beta1/add_bootstrap_resource_suite_test.go
@@ -113,12 +113,12 @@ var _ = Describe("AddBootstrap", Ordered, Label("bootstrap"), func() {
 		instance.Spec.BootstrapAPIKeys = []appsv2beta1.BootstrapAPIKey{
 			{
 				SecretRef: &appsv2beta1.SecretRef{
-					Key: &appsv2beta1.KeyRef{
+					Key: appsv2beta1.KeyRef{
 						// Note: a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters
 						SecretName: "test-key-secret",
 						SecretKey:  "key",
 					},
-					Secret: &appsv2beta1.KeyRef{
+					Secret: appsv2beta1.KeyRef{
 						SecretName: "test-value-secret",
 						SecretKey:  "secret",
 					},

diff --git a/controllers/apps/v2beta1/add_bootstrap_resource_test.go b/controllers/apps/v2beta1/add_bootstrap_resource_test.go
@@ -133,11 +133,11 @@ func TestGenerateBootstrapAPIKeySecretWithSecretRef(t *testing.T) {
 			BootstrapAPIKeys: []appsv2beta1.BootstrapAPIKey{
 				{
 					SecretRef: &appsv2beta1.SecretRef{
-						Key: &appsv2beta1.KeyRef{
+						Key: appsv2beta1.KeyRef{
 							SecretName: "test-key-secret",
 							SecretKey:  "key",
 						},
-						Secret: &appsv2beta1.KeyRef{
+						Secret: appsv2beta1.KeyRef{
 							SecretName: "test-value-secret",
 							SecretKey:  "secret",
 						},

diff --git a/docs/en_US/reference/v2beta1-reference.md b/docs/en_US/reference/v2beta1-reference.md
@@ -297,6 +297,10 @@ _Appears in:_
 _Appears in:_
 - [SecretRef](#secretref)
 
+| Field | Description |
+| --- | --- |
+| `secretName` _string_ |  |
+| `secretKey` _string_ |  |
 
 
 #### NodeEvacuationStats

diff --git a/docs/zh_CN/reference/v2beta1-reference.md b/docs/zh_CN/reference/v2beta1-reference.md
@@ -297,6 +297,10 @@ _Appears in:_
 _Appears in:_
 - [SecretRef](#secretref)
 
+| Field | Description |
+| --- | --- |
+| `secretName` _string_ |  |
+| `secretKey` _string_ |  |
 
 
 #### NodeEvacuationStats