resources: add support for setting custom samba configuration

Add new fields to handle custom Samba configurations.
For [global] section, a new field customGlobalConfig is added
under smbCommonConfig to handle custom settings. For individual
share configurations, modifications can be made in customShareConfig
field under smbShare. This design is chosen because, in group mode,
a single server may correspond to several grouped shares.

Signed-off-by: FTS152 <[email protected]>

Author: Frank Hsiao

api/v1alpha1/smbcommonconfig_types.go

@@ -38,6 +38,12 @@ type SmbCommonConfigSpec struct {
 	// under PodSettings allow admins and users to customize how pods
 	// are scheduled in a kubernetes cluster.
 	PodSettings *SmbCommonConfigPodSettings `json:"podSettings,omitempty"`
+
+	// GloabalConfig are configuration values that are applied to [gloabal]
+	// section in smb.conf for the smb server. This allows users to add or
+	// override default configurations.
+	// +opional
+	CustomGlobalConfig *SmbCommonConfigGlobalConfig `json:"customGlobalConfig,omitempty"`
 }
 
 // SmbCommonNetworkSpec values define networking properties for the services
@@ -61,6 +67,13 @@ type SmbCommonConfigPodSettings struct {
 	Affinity *corev1.Affinity `json:"affinity,omitempty"`
 }
 
+// SmbCommonConfigGlobalConfig contains values for customizing configs in
+// [global] section in smb.conf
+type SmbCommonConfigGlobalConfig struct {
+	//Configs specify keys and values to smb.conf
+	Configs map[string]string `json:"configs,omitempty"`
+}
+
 // SmbCommonConfigStatus defines the observed state of SmbCommonConfig
 type SmbCommonConfigStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster

api/v1alpha1/smbshare_types.go

@@ -64,6 +64,11 @@ type SmbShareSpec struct {
 	// +optional
 	CommonConfig string `json:"commonConfig,omitempty"`
 
+	// CustomShareConfig specifies custom config values to be applied
+	// to share section in smb.conf
+	// +optional
+	CustomShareConfig *SmbShareConfig `json:"customShareConfig,omitempty"`
+
 	// Scaling specifies parameters relating to how share resources can and
 	// should be scaled.
 	Scaling *SmbShareScalingSpec `json:"scaling,omitempty"`
@@ -76,6 +81,11 @@ type SmbShareStorageSpec struct {
 	Pvc *SmbSharePvcSpec `json:"pvc,omitempty"`
 }
 
+type SmbShareConfig struct {
+	//Configs specify keys and values to smb.conf
+	Configs map[string]string `json:"configs,omitempty"`
+}
+
 // SmbSharePvcSpec defines how a PVC may be associated with a share.
 type SmbSharePvcSpec struct {
 	// Name of the PVC to use for the share.

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

@@ -510,6 +510,15 @@ 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

@@ -54,6 +54,15 @@ spec:
                   description: CommonConfig specifies which SmbCommonConfig CR is to be used for this share. If left blank, the operator's default will be used.
                   minLength: 1
                   type: string
+                customShareConfig:
+                  description: custom configuration that are applied to [share] section in smb.conf for the smb server.
+                  properties:
+                    configs:
+                      additionalProperties:
+                        type: string
+                      description: configuration keys and values.
+                      type: object
+                  type: object
                 readOnly:
                   default: false
                   description: ReadOnly controls if this share is to be read-only or not.

internal/planner/configuration.go

@@ -96,6 +96,14 @@ func (pl *Planner) Update() (changed bool, err error) {
 		pl.ConfigState.Shares[shareKey] = share
 		changed = true
 	}
+	if pl.CommonConfig != nil {
+		if c := applyCustomGlobal(pl.ConfigState.Globals[smbcc.Globals], pl.CommonConfig.Spec); c {
+			changed = true
+		}
+	}
+	if c := applyCustomShare(share, pl.SmbShare.Spec); c {
+		changed = true
+	}
 	if c := applyShareValues(share, pl.SmbShare.Spec); c {
 		changed = true
 	}
@@ -165,6 +173,34 @@ func (pl *Planner) Prune() (changed bool, err error) {
 	return
 }
 
+func applyCustomGlobal(globals smbcc.GlobalConfig, spec api.SmbCommonConfigSpec) bool {
+	changed := false
+	if spec.CustomGlobalConfig != nil {
+		for k, v := range spec.CustomGlobalConfig.Configs {
+			oriValue, ok := globals.Options[k]
+			if !ok || (ok && oriValue != v) {
+				globals.Options[k] = v
+				changed = true
+			}
+		}
+	}
+	return changed
+}
+
+func applyCustomShare(share smbcc.ShareConfig, spec api.SmbShareSpec) bool {
+	changed := false
+	if spec.CustomShareConfig != nil {
+		for k, v := range spec.CustomShareConfig.Configs {
+			oriValue, ok := share.Options[k]
+			if !ok || (ok && oriValue != v) {
+				share.Options[k] = v
+				changed = true
+			}
+		}
+	}
+	return changed
+}
+
 func applyShareValues(share smbcc.ShareConfig, spec api.SmbShareSpec) bool {
 	changed := false