comment changes

nginxinc · Dec 15, 2023 · 3d3e17f · 3d3e17f
1 parent beea17c
commit 3d3e17f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/internal/certification/certificates.go b/internal/certification/certificates.go
@@ -33,11 +33,6 @@ const (
 )
 
 type Certificates struct {
-	// {
-	// 		ClientCertificateSecretKey: {
-	// 			"tls.crt": []byte
-	// 		}
-	// }
 	Certificates map[string]map[string]core.SecretBytes
 
 	// Context is the context used to control the application.

diff --git a/internal/configuration/settings.go b/internal/configuration/settings.go
@@ -179,7 +179,6 @@ func (s *Settings) Initialize() error {
 
 	certificates := certification.NewCertificates(s.Context, s.K8sClient)
 
-	// q. Why is this a separate step?
 	err = certificates.Initialize()
 	if err != nil {
 		return fmt.Errorf(`error occurred initializing certificates: %w`, err)

diff --git a/internal/core/secret_bytes.go b/internal/core/secret_bytes.go
@@ -4,6 +4,12 @@ import (
 	"encoding/json"
 )
 
+// Wraps byte slices which potentially could contain
+// sensitive data that should not be output to the logs.
+// This will output [REDACTED] if attempts are made
+// to print this type in logs, serialize to JSON, or
+// otherwise convert it to a string.
+// Usage: core.SecretBytes(myByteSlice)
 type SecretBytes []byte
 
 func (sb SecretBytes) String() string {