[Enhancement] Support sidecars

Signed-off-by: yandongxiao <yandongxiao@starrocks.com>
StarRocks · Apr 1, 2024 · 367ca4d · 367ca4d
1 parent 8bff52b
commit 367ca4d
Show file tree

Hide file tree

Showing 12 changed files with 11,729 additions and 4,304 deletions.
diff --git a/config/crd/bases/starrocks.com_starrocksclusters.yaml b/config/crd/bases/starrocks.com_starrocksclusters.yaml
diff --git a/config/crd/bases/starrocks.com_starrockswarehouses.yaml b/config/crd/bases/starrocks.com_starrockswarehouses.yaml
diff --git a/deploy/starrocks.com_starrocksclusters.yaml b/deploy/starrocks.com_starrocksclusters.yaml
diff --git a/deploy/starrocks.com_starrockswarehouses.yaml b/deploy/starrocks.com_starrockswarehouses.yaml
diff --git a/doc/api.md b/doc/api.md
@@ -1078,6 +1078,22 @@ Set this value longer than the expected cleanup time for your process.
 Defaults to 120 seconds.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>sidecars</code><br/>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#container-v1-core">
+[]Kubernetes core/v1.Container
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+You can use this field to launch helper containers that provide additional functionality to the main container.
+See <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container">https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container</a> for more details.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="starrocks.com/v1.StarRocksComponentStatus">StarRocksComponentStatus

diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/templates/starrockscluster.yaml b/helm-charts/charts/kube-starrocks/charts/starrocks/templates/starrockscluster.yaml
@@ -157,6 +157,10 @@ spec:
     lifecycle:
       {{- toYaml .Values.starrocksFESpec.lifecycle | nindent 6 }}
     {{- end }}
+    {{- if .Values.starrocksFESpec.sidecars }}
+    sidecars:
+      {{- toYaml .Values.starrocksFESpec.sidecars | nindent 6 }}
+    {{- end }}
 {{- if .Values.starrocksFESpec.secrets }}
     secrets:
     {{- range .Values.starrocksFESpec.secrets }}
@@ -366,6 +370,10 @@ spec:
     lifecycle:
       {{- toYaml .Values.starrocksBeSpec.lifecycle | nindent 6 }}
     {{- end }}
+    {{- if .Values.starrocksBeSpec.sidecars }}
+    sidecars:
+      {{- toYaml .Values.starrocksBeSpec.sidecars | nindent 6 }}
+    {{- end }}
 {{- if .Values.starrocksBeSpec.secrets }}
     secrets:
     {{- range .Values.starrocksBeSpec.secrets }}
@@ -532,6 +540,10 @@ spec:
     lifecycle:
       {{- toYaml .Values.starrocksCnSpec.lifecycle | nindent 6 }}
     {{- end }}
+    {{- if .Values.starrocksCnSpec.sidecars }}
+    sidecars:
+      {{- toYaml .Values.starrocksCnSpec.sidecars | nindent 6 }}
+    {{- end }}
     {{- if and .Values.starrocksCluster.enabledCn .Values.starrocksCnSpec.autoScalingPolicy }}
     autoScalingPolicy:
       {{- toYaml .Values.starrocksCnSpec.autoScalingPolicy | nindent 6 }}

diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/values.yaml b/helm-charts/charts/kube-starrocks/charts/starrocks/values.yaml
@@ -300,6 +300,10 @@ starrocksFESpec:
     #     - /bin/sh
     #     - -c
     #     - echo "Hello, world!"
+  # Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+  # You can use this field to launch helper containers that provide additional functionality to the main container.
+  # See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to define sidecars.
+  sidecars: []
 
 # spec for compute node, compute node provide compute function.
 starrocksCnSpec:
@@ -522,6 +526,10 @@ starrocksCnSpec:
     #     - /bin/sh
     #     - -c
     #     - echo "Hello, world!"
+  # Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+  # You can use this field to launch helper containers that provide additional functionality to the main container.
+  # See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to define sidecars.
+  sidecars: []
 
 # spec for component be, provide storage and compute function.
 starrocksBeSpec:
@@ -707,6 +715,10 @@ starrocksBeSpec:
     #     - /bin/sh
     #     - -c
     #     - echo "Hello, world!"
+  # Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+  # You can use this field to launch helper containers that provide additional functionality to the main container.
+  # See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to define sidecars.
+  sidecars: []
 
 # create secrets if necessary.
 secrets: []

diff --git a/helm-charts/charts/kube-starrocks/values.yaml b/helm-charts/charts/kube-starrocks/values.yaml
@@ -408,6 +408,10 @@ starrocks:
       #     - /bin/sh
       #     - -c
       #     - echo "Hello, world!"
+    # Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+    # You can use this field to launch helper containers that provide additional functionality to the main container.
+    # See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to define sidecars.
+    sidecars: []
 
   # spec for compute node, compute node provide compute function.
   starrocksCnSpec:
@@ -630,6 +634,10 @@ starrocks:
       #     - /bin/sh
       #     - -c
       #     - echo "Hello, world!"
+    # Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+    # You can use this field to launch helper containers that provide additional functionality to the main container.
+    # See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to define sidecars.
+    sidecars: []
 
   # spec for component be, provide storage and compute function.
   starrocksBeSpec:
@@ -815,6 +823,10 @@ starrocks:
       #     - /bin/sh
       #     - -c
       #     - echo "Hello, world!"
+    # Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+    # You can use this field to launch helper containers that provide additional functionality to the main container.
+    # See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to define sidecars.
+    sidecars: []
 
   # create secrets if necessary.
   secrets: []

diff --git a/pkg/apis/starrocks/v1/component_type.go b/pkg/apis/starrocks/v1/component_type.go
@@ -54,6 +54,12 @@ type StarRocksComponentSpec struct {
 	// Defaults to 120 seconds.
 	// +optional
 	TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`
+
+	// Sidecars is an optional list of containers that are run in the same pod as the starrocks component.
+	// You can use this field to launch helper containers that provide additional functionality to the main container.
+	// See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to configure a container.
+	// +optional
+	Sidecars []corev1.Container `json:"sidecars,omitempty"`
 }
 
 // StarRocksComponentStatus represents the status of a starrocks component.
@@ -134,3 +140,7 @@ func (spec *StarRocksComponentSpec) GetTerminationGracePeriodSeconds() *int64 {
 func (spec *StarRocksComponentSpec) GetCapabilities() *corev1.Capabilities {
 	return spec.Capabilities
 }
+
+func (spec *StarRocksComponentSpec) GetSidecars() []corev1.Container {
+	return spec.Sidecars
+}
diff --git a/pkg/apis/starrocks/v1/starrockscluster_types.go b/pkg/apis/starrocks/v1/starrockscluster_types.go
@@ -75,6 +75,7 @@ type SpecInterface interface {
 	GetRunAsNonRoot() (*int64, *int64)
 	GetTerminationGracePeriodSeconds() *int64
 	GetCapabilities() *corev1.Capabilities
+	GetSidecars() []corev1.Container
 }
 
 var _ SpecInterface = &StarRocksFeSpec{}
@@ -195,9 +196,16 @@ func (spec *StarRocksFeProxySpec) GetTerminationGracePeriodSeconds() *int64 {
 	return nil
 }
 
+// GetCapabilities
 // fe proxy does not have field Capabilities
 func (spec *StarRocksFeProxySpec) GetCapabilities() *corev1.Capabilities { return nil }
 
+// GetSidecars
+// fe proxy does not have field Sidecars
+func (spec *StarRocksFeProxySpec) GetSidecars() []corev1.Container {
+	return nil
+}
+
 // Phase is defined under status, e.g.
 // 1. StarRocksClusterStatus.Phase represents the phase of starrocks cluster.
 // 2. StarRocksWarehouseStatus.Phase represents the phase of starrocks warehouse.

diff --git a/pkg/apis/starrocks/v1/zz_generated.deepcopy.go b/pkg/apis/starrocks/v1/zz_generated.deepcopy.go
diff --git a/pkg/k8sutils/templates/pod/spec.go b/pkg/k8sutils/templates/pod/spec.go
@@ -254,8 +254,12 @@ func Ports(spec v1.SpecInterface, config map[string]interface{}) []corev1.Contai
 }
 
 func Spec(spec v1.SpecInterface, container corev1.Container, volumes []corev1.Volume) corev1.PodSpec {
+	containers := []corev1.Container{container}
+	if len(spec.GetSidecars()) > 0 {
+		containers = append(containers, spec.GetSidecars()...)
+	}
 	podSpec := corev1.PodSpec{
-		Containers:                    []corev1.Container{container},
+		Containers:                    containers,
 		Volumes:                       volumes,
 		ServiceAccountName:            spec.GetServiceAccount(),
 		TerminationGracePeriodSeconds: spec.GetTerminationGracePeriodSeconds(),