Merge pull request #96 from marklogic/MLE-21295/automountServiceAccountToken-to-false

MLE-21295: Enforce automountServiceAccountToken=false

Author: rwinieski

api/v1/marklogiccluster_types.go

@@ -46,6 +46,8 @@ type MarklogicClusterSpec struct {
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf", message="ServiceAccountName can not be changed"
 	// The name of the service account to assigned to the MarkLogic pods
 	ServiceAccountName string `json:"serviceAccountName,omitempty"`
+	// +kubebuilder:default:=false
+	AutomountServiceAccountToken *bool `json:"automountServiceAccountToken,omitempty"`
 	// +kubebuilder:default:={enabled: true, size: "10Gi"}
 	Persistence                   *Persistence                 `json:"persistence,omitempty"`
 	Resources                     *corev1.ResourceRequirements `json:"resources,omitempty"`

api/v1/marklogicgroup_types.go

@@ -37,13 +37,15 @@ type MarklogicGroupSpec struct {
 	// +kubebuilder:default:="progressofficial/marklogic-db:11.3.0-ubi-rootless"
 	Image string `json:"image"`
 	// +kubebuilder:default:="IfNotPresent"
-	ImagePullPolicy               string                        `json:"imagePullPolicy,omitempty"`
-	ImagePullSecrets              []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
-	Auth                          *AdminAuth                    `json:"auth,omitempty"`
-	ServiceAccountName            string                        `json:"serviceAccountName,omitempty"`
-	Persistence                   *Persistence                  `json:"persistence,omitempty"`
-	Resources                     *corev1.ResourceRequirements  `json:"resources,omitempty"`
-	TerminationGracePeriodSeconds *int64                        `json:"terminationGracePeriodSeconds,omitempty"`
+	ImagePullPolicy    string                        `json:"imagePullPolicy,omitempty"`
+	ImagePullSecrets   []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
+	Auth               *AdminAuth                    `json:"auth,omitempty"`
+	ServiceAccountName string                        `json:"serviceAccountName,omitempty"`
+	// +kubebuilder:default:=false
+	AutomountServiceAccountToken  *bool                        `json:"automountServiceAccountToken,omitempty"`
+	Persistence                   *Persistence                 `json:"persistence,omitempty"`
+	Resources                     *corev1.ResourceRequirements `json:"resources,omitempty"`
+	TerminationGracePeriodSeconds *int64                       `json:"terminationGracePeriodSeconds,omitempty"`
 	// +kubebuilder:validation:Enum=OnDelete;RollingUpdate
 	// +kubebuilder:default:="OnDelete"
 	UpdateStrategy appsv1.StatefulSetUpdateStrategyType `json:"updateStrategy,omitempty"`

api/v1/zz_generated.deepcopy.go

@@ -3260,6 +3260,9 @@ spec:
                   walletPassword:
                     type: string
                 type: object
+              automountServiceAccountToken:
+                default: false
+                type: boolean
               clusterDomain:
                 default: cluster.local
                 type: string

config/crd/bases/marklogic.progress.com_marklogicclusters.yaml

@@ -3265,6 +3265,9 @@ spec:
                   walletPassword:
                     type: string
                 type: object
+              automountServiceAccountToken:
+                default: false
+                type: boolean
               bootstrapHost:
                 type: string
               clusterDomain:

config/crd/bases/marklogic.progress.com_marklogicgroups.yaml

@@ -5,7 +5,7 @@ metadata:
   namespace: prod
   annotations: {}
 spec:
-  image: "progressofficial/marklogic-db:11.3.1-ubi-rootless-2.1.1"
+  image: "progressofficial/marklogic-db:11.3.1-ubi-rootless-2.2.1"
   imagePullPolicy: IfNotPresent
   imagePullSecrets: 
     - name: regcred

config/samples/complete.yaml

@@ -5,7 +5,7 @@ metadata:
   name: ml-cluster
   namespace: prod
 spec:
-  image: "progressofficial/marklogic-db:11.3.1-ubi-rootless-2.1.1"
+  image: "progressofficial/marklogic-db:11.3.1-ubi-rootless-2.2.1"
   ## It is recommended to use Kubernetes secrets to store the admin credentials
   ## To create a secret, run the following command in the same namespace as the CR:
   ## kubectl create secret generic admincreds --from-literal=username=admin --from-literal=password=admin

config/samples/minimal-production.yaml

@@ -4,24 +4,17 @@ metadata:
   name: single-node
   annotations: {}
 spec:
-  image: "progressofficial/marklogic-db:11.3.0-ubi-rootless"
+  image: "progressofficial/marklogic-db:11.3.1-ubi-rootless-2.2.1"
   ## It is recommended to use Kubernetes secrets to store the admin credentials
   ## To create a secret, run the following command in the same namespace as the CR:
   ## kubectl create secret generic admincreds --from-literal=username=admin --from-literal=password=admin
   ## If you do not provide the admin credentials, the operator will generate a secret for you containing admin credentials
   persistence:
-    enabled: true
+    enabled: false
     size: 10Gi
   markLogicGroups:
   - replicas: 1
     name: node
     groupConfig:
       name: node
-    resources:
-      requests:
-        memory: "4Gi"
-        cpu: 2000m
-      limits:
-        memory: "4Gi"
-        cpu: 2000m
     isBootstrap: true

config/samples/quick-start.yaml

@@ -19,6 +19,7 @@ type MarkLogicGroupParameters struct {
 	Replicas                       *int32
 	Name                           string
 	ServiceAccountName             string
+	AutomountServiceAccountToken   *bool
 	Labels                         map[string]string
 	Annotations                    map[string]string
 	GroupConfig                    *marklogicv1.GroupConfig
@@ -124,6 +125,7 @@ func (cc *ClusterContext) GenerateMarkLogicGroupDef(cr *marklogicv1.MarklogicClu
 			GroupConfig:                    params.GroupConfig,
 			Auth:                           params.Auth,
 			ServiceAccountName:             params.ServiceAccountName,
+			AutomountServiceAccountToken:   params.AutomountServiceAccountToken,
 			Image:                          params.Image,
 			Labels:                         params.Labels,
 			Annotations:                    params.Annotations,
@@ -261,6 +263,9 @@ func generateMarkLogicClusterParams(cr *marklogicv1.MarklogicCluster) *MarkLogic
 }
 
 func generateMarkLogicGroupParams(cr *marklogicv1.MarklogicCluster, index int, clusterParams *MarkLogicClusterParameters) *MarkLogicGroupParameters {
+	// Always enforce automountServiceAccountToken to false for security
+	falseValue := false
+
 	markLogicGroupParameters := &MarkLogicGroupParameters{
 		Replicas:                       cr.Spec.MarkLogicGroups[index].Replicas,
 		Name:                           cr.Spec.MarkLogicGroups[index].Name,
@@ -273,6 +278,7 @@ func generateMarkLogicGroupParams(cr *marklogicv1.MarklogicCluster, index int, c
 		ImagePullSecrets:               clusterParams.ImagePullSecrets,
 		Auth:                           clusterParams.Auth,
 		ServiceAccountName:             clusterParams.ServiceAccountName,
+		AutomountServiceAccountToken:   &falseValue, // Always false for security
 		License:                        clusterParams.License,
 		Persistence:                    clusterParams.Persistence,
 		TerminationGracePeriodSeconds:  clusterParams.TerminationGracePeriodSeconds,

pkg/k8sutil/marklogicServer.go

@@ -32,6 +32,7 @@ type statefulSetParameters struct {
 	ImagePullSecrets               []corev1.LocalObjectReference
 	AdditionalVolumeClaimTemplates *[]corev1.PersistentVolumeClaim
 	ServiceAccountName             string
+	AutomountServiceAccountToken   *bool
 }
 
 type containerParameters struct {
@@ -238,6 +239,9 @@ func generateStatefulSetsDef(stsMeta metav1.ObjectMeta, params statefulSetParame
 	if params.ServiceAccountName != "" {
 		statefulSet.Spec.Template.Spec.ServiceAccountName = params.ServiceAccountName
 	}
+	if params.AutomountServiceAccountToken != nil {
+		statefulSet.Spec.Template.Spec.AutomountServiceAccountToken = params.AutomountServiceAccountToken
+	}
 	if containerParams.Tls != nil && containerParams.Tls.EnableOnDefaultAppServers {
 		copyCertsVM := []corev1.VolumeMount{
 			{
@@ -349,10 +353,14 @@ func generateContainerDef(name string, containerParams containerParameters) []co
 }
 
 func generateStatefulSetsParams(cr *marklogicv1.MarklogicGroup) statefulSetParameters {
+	// Always enforce automountServiceAccountToken to false for security
+	falseValue := false
+
 	params := statefulSetParameters{
 		Replicas:                       cr.Spec.Replicas,
 		Name:                           cr.Spec.Name,
 		ServiceAccountName:             cr.Spec.ServiceAccountName,
+		AutomountServiceAccountToken:   &falseValue, // Always false for security
 		TerminationGracePeriodSeconds:  cr.Spec.TerminationGracePeriodSeconds,
 		UpdateStrategy:                 cr.Spec.UpdateStrategy,
 		NodeSelector:                   cr.Spec.NodeSelector,