resources: Add hint for custom configuration

1. Add a key to check if the user already read docs and know the
risks that custom configs may lead to unexpected behaviors.
Custom settings are ignored if acknowledgement flags are not set
if useUnsafeCustomConfig not set to true explicitly.
2. fix comment typoes

Co-authored-by: Spencer B. <[email protected]>
Signed-off-by: FTS152 <[email protected]>

Author: 2 people

api/v1alpha1/smbcommonconfig_types.go

@@ -39,7 +39,7 @@ type SmbCommonConfigSpec struct {
 	// are scheduled in a kubernetes cluster.
 	PodSettings *SmbCommonConfigPodSettings `json:"podSettings,omitempty"`
 
-	// GloabalConfig are configuration values that are applied to [gloabal]
+	// GlobalConfig are configuration values that are applied to [global]
 	// section in smb.conf for the smb server. This allows users to add or
 	// override default configurations.
 	// +opional
@@ -70,7 +70,9 @@ type SmbCommonConfigPodSettings struct {
 // SmbCommonConfigGlobalConfig contains values for customizing configs in
 // [global] section in smb.conf
 type SmbCommonConfigGlobalConfig struct {
-	//Configs specify keys and values to smb.conf
+	// Check if the user wants to use custom configs
+	UseUnsafeCustomConfig bool `json:"useUnsafeCustomConfig,omitempty"`
+	// Configs specify keys and values to smb.conf
 	Configs map[string]string `json:"configs,omitempty"`
 }
 

api/v1alpha1/smbshare_types.go

@@ -81,8 +81,11 @@ type SmbShareStorageSpec struct {
 	Pvc *SmbSharePvcSpec `json:"pvc,omitempty"`
 }
 
+// SmbShareConfig defines custom config values for share section
 type SmbShareConfig struct {
-	//Configs specify keys and values to smb.conf
+	// Check if the user wants to use custom configs
+	UseUnsafeCustomConfig bool `json:"useUnsafeCustomConfig,omitempty"`
+	// Configs specify keys and values to smb.conf
 	Configs map[string]string `json:"configs,omitempty"`
 }
 

config/crd/bases/samba-operator.samba.org_smbcommonconfigs.yaml

@@ -30,6 +30,18 @@ spec:
             spec:
               description: SmbCommonConfigSpec values act as a template for properties of the services that will host shares.
               properties:
+                customGlobalConfig:
+                  description: GlobalConfig are configuration values that are applied to [global] section in smb.conf for the smb server. This allows users to add or override default configurations.
+                  properties:
+                    configs:
+                      additionalProperties:
+                        type: string
+                      description: Configs specify keys and values to smb.conf
+                      type: object
+                    useUnsafeCustomConfig:
+                      description: Check if the user wants to use custom configs
+                      type: boolean
+                  type: object
                 network:
                   description: Network specifies what kind of networking shares associated with this config will use.
                   properties:
@@ -510,15 +522,6 @@ spec:
                       description: NodeSelector values will be assigned to a PodSpec's NodeSelector.
                       type: object
                   type: object
-                customGlobalConfig:
-                  description: custom configuration that are applied to [gloabal] section in smb.conf for the smb server.
-                  properties:
-                    configs:
-                      additionalProperties:
-                        type: string
-                      description: configuration keys and values.
-                      type: object
-                  type: object
               type: object
             status:
               description: SmbCommonConfigStatus defines the observed state of SmbCommonConfig

config/crd/bases/samba-operator.samba.org_smbshares.yaml

@@ -55,13 +55,16 @@ spec:
                   minLength: 1
                   type: string
                 customShareConfig:
-                  description: custom configuration that are applied to [share] section in smb.conf for the smb server.
+                  description: CustomShareConfig specifies custom config values to be applied to share section in smb.conf
                   properties:
                     configs:
                       additionalProperties:
                         type: string
-                      description: configuration keys and values.
+                      description: Configs specify keys and values to smb.conf
                       type: object
+                    useUnsafeCustomConfig:
+                      description: Check if the user wants to use custom configs
+                      type: boolean
                   type: object
                 readOnly:
                   default: false

internal/planner/configuration.go

@@ -97,7 +97,8 @@ func (pl *Planner) Update() (changed bool, err error) {
 		changed = true
 	}
 	if pl.CommonConfig != nil {
-		if c := applyCustomGlobal(pl.ConfigState.Globals[smbcc.Globals], pl.CommonConfig.Spec); c {
+		if c := applyCustomGlobal(pl.ConfigState.Globals[smbcc.Globals],
+			pl.CommonConfig.Spec); c {
 			changed = true
 		}
 	}
@@ -176,6 +177,11 @@ func (pl *Planner) Prune() (changed bool, err error) {
 func applyCustomGlobal(globals smbcc.GlobalConfig, spec api.SmbCommonConfigSpec) bool {
 	changed := false
 	if spec.CustomGlobalConfig != nil {
+		// check if the user wants to use custom configs
+		// if not, just return
+		if !spec.CustomGlobalConfig.UseUnsafeCustomConfig {
+			return changed
+		}
 		for k, v := range spec.CustomGlobalConfig.Configs {
 			oriValue, ok := globals.Options[k]
 			if !ok || (ok && oriValue != v) {
@@ -190,6 +196,11 @@ func applyCustomGlobal(globals smbcc.GlobalConfig, spec api.SmbCommonConfigSpec)
 func applyCustomShare(share smbcc.ShareConfig, spec api.SmbShareSpec) bool {
 	changed := false
 	if spec.CustomShareConfig != nil {
+		// check if the user wants to use custom configs
+		// if not, just return
+		if !spec.CustomShareConfig.UseUnsafeCustomConfig {
+			return changed
+		}
 		for k, v := range spec.CustomShareConfig.Configs {
 			oriValue, ok := share.Options[k]
 			if !ok || (ok && oriValue != v) {