Repository for dip
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

1334 lines
70 KiB

# set the nameOverride values for creating the same resources with the parent chart.
# In version v1.7.1 or before, there is only one chart called kube-starrocks, and the chart name is the prefix
# of some resources created by the chart.
# In version v1.8.0, the kube-starrocks chart is split into two charts, and to keep backward compatibility, the
# nameOverride is used to set the prefix of the resources created by starrocks chart.
nameOverride: "kube-starrocks"
# This configuration is used to modify the root password during initial deployment.
# After deployment is completed, it won't take effect to modify the password here and to do a `helm upgrade`.
# It also supports providing a secret name that contains a password, using the password in the secret instead of the plaintext in the values.yaml.
# When both password and passwordSecret are set, only passwordSecret takes effect.
# Note: If you install StarRocks using helm install without setting the initPassword, then for the following upgrade deployments,
# you should also not set the initPassword.
# If you install StarRocks using helm install and set the initPassword, please always retain the configuration of initPassword.
initPassword:
enabled: false
# Note: If you are using Argo CD to deploy the StarRocks cluster, you must set isInstall to false after the first installation.
# This is because Argo CD supports Helm like this: helm template <options> | kubectl apply -f -. If isInstall is true, the
# initPassword job will be executed every time you run the command.
# See https://github.com/argoproj/argo-cd/discussions/7496#discussioncomment-1609267 for more information
isInstall: true
password: ""
# The secret name that contains the password, the key of the secret is "password", and you should create it first.
passwordSecret: ""
# The image of the initPassword job, if it is not set, the FE image will be used.
# See https://github.com/StarRocks/starrocks-kubernetes-operator/issues/453 for why we need to set the image.
image: ""
# The annotations for the Job, not including the annotations for the pod.
annotations: {}
# The annotations for the Job's Pod, not including the annotations for the job.
podAnnotations: {}
# resources for init_job pod.
resources: {}
#resources:
# requests:
# cpu: 500m
# memory: 400Mi
# limits:
# cpu: 500m
# memory: 800Mi
# TimeZone is used to set the environment variable TZ for pod, with Asia/Shanghai as the default.
timeZone: Asia/Shanghai
# This configuration is used to integrate with an external system DataDog.
# You can enable the integration by setting the enabled to true, e.g., datalog.log.enabled=true will enable datadog agent
# to collect the log.
datadog:
log:
enabled: false
# besides the attributes you added, the chart will append "source" and "service" attributes to the log config.
# see https://docs.datadoghq.com/containers/kubernetes/log/?tab=operator for more details.
logConfig: '{}' # e.g., '{"app": "starrocks", "tags": ["aa", "bb"]}'
metrics:
enabled: false
profiling:
fe: false # change to 'true' to enable profiling on FE pods;
be: false # change to 'true' to enable profiling on BE pods;
cn: false # change to 'true' to enable profiling on CN pods;
env: "starrocks-default" # the default value for DD_ENV;
configMode: "service" # see https://docs.datadoghq.com/containers/cluster_agent/admission_controller/?tab=operator#configure-apm-and-dogstatsd-communication-mode
# This configuration is used to integrate with the external system Prometheus.
metrics:
serviceMonitor:
# Whether to expose metrics to Prometheus by ServiceMonitor.
# Note: make sure the prometheus operator is installed in your cluster.
# If prometheus is not installed by operator, you can add annotations on k8s service to expose metrics.
# See https://github.com/StarRocks/starrocks-kubernetes-operator/blob/main/doc/integration/integration-prometheus-grafana.md#51-turn-on-the-prometheus-metrics-scrape-by-adding-annotations for more details.
enabled: false
# Prometheus ServiceMonitor labels
labels: {}
# scraper: prometheus-operator
# Prometheus ServiceMonitor interval
interval: 15s
# Whether to enable basic auth
basicAuth:
enabled: false
# The name of the secret that contains the username for basic auth.
# The secret should contain a key named "username".
usernameSecretName: ""
# The key in the secret that contains the username for basic auth.
usernameSecretKey: ""
# The name of the secret that contains the password for basic auth.
# The secret should contain a key named "password".
passwordSecretName: ""
# The key in the secret that contains the password for basic auth.
passwordSecretKey: ""
# Whether to enable request parameters for the ServiceMonitor.
endpointParam:
enabled: false
# the parameters for the ServiceMonitor.
# params:
# with_materialized_view_metrics:
# - "all"
params: {}
# deploy a starrocks cluster
starrocksCluster:
# the name of starrockscluster cluster, if not set, the value of nameOverride fields will be used.
name: ""
# the namespace of starrockscluster cluster, if not set, the release namespace will be used.
namespace: ""
# annotations for starrocks cluster.
annotations: {}
# specify the BE/CN deployment or not.
enabledBe: true
enabledCn: false
# Disaster recovery configuration. If you want to enable disaster recovery, you need to set the enabled field to true.
# Note:
# 1. If you are using an existing StarRocks cluster, you need to clean up the meta of the FE component and the data of the CN
# component before enabling disaster recovery. So it is better to use an empty StarRocks cluster to start disaster recovery.
# 2. After disaster recovery, Operator will reboot the cluster as a normal cluster automatically, so if you need more checks by yourself,
# you can
# 1. Set the replicas of FE component to 1
# 2. Set enabledBe and enabledCn to be false to disable to deploy BE and CN components.
# 3. Generation field is used to run multiple times for disaster recovery. For example, if the last disaster recovery is
# not what you want, you can modify related configurations and increase the generation value to run a new disaster recovery.
disasterRecovery:
# enabled: true
# generation: 1
# componentValues field is used to define values for all starrocks cluster components, including starrocksFESpec,
# starrocksBeSpec, starrocksCnSpec, not including starrocksFeProxySpec. So that you do not need to modify them in
# their own spec.
# Note:
# 1. The values in their own spec will take precedence over the values in this field.
# 2. The values in their own spec will replace all the values in this field, not merge.
componentValues:
image:
tag: "4.0.4"
# hostAliases allows adding entries to /etc/hosts inside the containers.
hostAliases: []
# - ip: "127.0.0.1"
# hostnames:
# - "example.com"
# If runAsNonRoot is true, the container is run as a non-root user.
# The userId will be set to 1000, and the groupID will be set to 1000.
# Note: If you have started the container through root, and then FE/BE began to create directories, write files, etc.
# under the mounted directory as root. When you start the container as a non-root user, the container will not
# have permission to access these files. So you'd better set runAsNonRoot to true when you set up the cluster.
runAsNonRoot: false
# schedulerName allows you to specify which scheduler will be used for your pods.
schedulerName: ""
# serviceAccount for access cloud service.
serviceAccount: ""
# imagePullSecrets allows you to use secrets to pull images for pods.
imagePullSecrets: []
# - name: "image-pull-secret"
# tolerations for pod scheduling to nodes with taints
# Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
tolerations: []
# - key: "key"
# operator: "Equal|Exists"
# value: "value"
# effect: "NoSchedule|PreferNoSchedule|NoExecute(1.6 only)"
# topologySpreadConstraints for scheduling pods across failure-domains.
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/
topologySpreadConstraints: []
# - maxSkew: 1
# topologyKey: topology.kubernetes.io/zone
# whenUnsatisfiable: DoNotSchedule|ScheduleAnyway
# labelSelector:
# matchLabels:
# foo: bar
# If specified, the pod's nodeSelector,displayName="Map of nodeSelectors to match when scheduling pods on nodes"
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
nodeSelector: {}
# kubernetes.io/arch: amd64
# kubernetes.io/os: linux
# affinity for pod scheduling.
affinity: {}
# nodeAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# nodeSelectorTerms:
# - matchFields:
# - key: metadata.name
# operator: In
# values:
# - target-host-name
# podAntiAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# - labelSelector:
# matchExpressions:
# - key: app.kubernetes.io/component
# operator: In
# values:
# - fe
# - be
# - cn
# topologyKey: "kubernetes.io/hostname"
# the pod labels for user select or classify pods.
podLabels: {}
# spec to deploy fe.
starrocksFESpec:
# number of replicas to deploy for a FE statefulset.
replicas: 1
image:
# image sliced by "repository:tag"
repository: starrocks/fe-ubuntu
tag: ""
imagePullPolicy: IfNotPresent
# Specify the entrypoint for FE.
# By default, the operator will use '/opt/starrocks/fe_entrypoint.sh' as a command and use '$(FE_SERVICE_NAME)' as args in the container spec.
# If the entrypoint is set, the command will be ["bash", "-c"], and the args will be a filename of the entrypoint script.
# A configmap with the name $cluster-fe-entrypoint-script will be created, and the script will be mounted to /etc/starrocks/entrypoint.sh
# Pod will be restarted if the entrypoint script is updated.
entrypoint: {}
# script: |
# #! /bin/bash
# echo "do something before start fe"
# exec /opt/starrocks/fe_entrypoint.sh $FE_SERVICE_NAME
# add annotations for FE pods. For example, if you want to config monitor for datadog, you can config the annotations.
annotations: {}
# If runAsNonRoot is true, the container is run as a non-root user.
# The userId will be set to 1000, and the groupID will be set to 1000.
# Note: If you have started the container through root, and then FE/BE began to create directories, write files, etc.
# under the mounted directory as root. When you start the container as a non-root user, the container will not
# have permission to access these files. So you'd better set runAsNonRoot to true when you set up the cluster.
runAsNonRoot: false
# Whether this container has a read-only root filesystem.
# Note: The FE/BE/CN container should support read-only root filesystem. The newest version of FE/BE/CN is 3.3.6 and does not support read-only root filesystem.
readOnlyRootFilesystem: false
# add/drop capabilities for FE container.
capabilities: {}
# add:
# - PERFMON
# - SYS_PTRACE
# drop:
# - SYS_ADMIN
# set sysctls for FE pod.
# See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for how to set sysctls.
# Note: The use of unsafe sysctls is at-your-own-risk and can lead to severe problems
sysctls: []
# - name: net.ipv4.ip_unprivileged_port_start
# value: "2048"
# specify the service name and port config and serviceType
# the service type refers https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
service:
# the FE service type, only supported ClusterIP, NodePort, LoadBalancer
type: "ClusterIP"
# the loadBalancerIP for static ip config when the type=LoadBalancer and loadbalancerIp is not empty.
loadbalancerIP: ""
# add annotations for external FE service.
annotations: {}
# Add labels for external FE service. The operator may add its own default labels.
labels: {}
# Config the service port for FE service.
# To assign a specific port or nodePort to a service, you should specify them by the corresponding name or
# containerPort in the service configuration. If both containerPort and name are specified, containerPort takes precedence.
# For fe, port name can be http, query, rpc, edit-log, and their default container port is 8030, 9030, 9020, 9010.
ports: []
# e.g., specify a dedicated node port for FE service by containerPort.
# - nodePort: 30030 # The range of valid ports is 30000-32767
# containerPort: 8030 # The port exported on the container
# specifies the source IP ranges for the load balancer when the type=LoadBalancer.
loadBalancerSourceRanges: []
# - 10.0.0.0/8
# imagePullSecrets allows you to use secrets to pull images for pods.
imagePullSecrets: []
# - name: "image-pull-secret"
# serviceAccount for FE access cloud service.
serviceAccount: ""
# If specified, the pod's nodeSelector,displayName="Map of nodeSelectors to match when scheduling pods on nodes"
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
nodeSelector: {}
# kubernetes.io/arch: amd64
# kubernetes.io/os: linux
# the pod labels for user select or classify pods.
podLabels: {}
# hostAliases allows adding entries to /etc/hosts inside the containers
hostAliases: []
# - ip: "127.0.0.1"
# hostnames:
# - "example.com"
# schedulerName allows you to specify which scheduler will be used for your pods.
schedulerName: ""
# Additional FE container environment variables.
# See https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/ for how to define environment variables.
# Note: If you use slice to define environment variables, and if there are multiple values files, the values in the last values file will take effect.
# If you use a map to define environment variables, the values will be merged.
# You can only use one of the manners to define environment variables.
# To avoid the different types of feEnvVars, we do not define the default value of feEnvVars, e.g., feEnvVars: [] or feEnvVars: {}.
#feEnvVars:
# define environment variables by slice.
# E.g., static environment variable:
# - name: DEMO_GREETING
# value: "Hello from the environment"
# e.g., secret environment variable:
# - name: USERNAME
# valueFrom:
# secretKeyRef:
# name: mysecret
# key: username
# affinity for FE pod scheduling.
# Note: It will affect the scheduling of the init-password job.
affinity: {}
# nodeAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# nodeSelectorTerms:
# - matchFields:
# - key: metadata.name
# operator: In
# values:
# - target-host-name
# podAntiAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# - labelSelector:
# matchExpressions:
# - key: app.kubernetes.io/component
# operator: In
# values:
# - fe
# topologyKey: "kubernetes.io/hostname"
# Node tolerations for FE pod scheduling to nodes with taints
# Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
# Note: It will affect the scheduling of the init-password job.
tolerations: []
# - key: "key"
# operator: "Equal|Exists"
# value: "value"
# effect: "NoSchedule|PreferNoSchedule|NoExecute(1.6 only)"
# topologySpreadConstraints for scheduling pods across failure-domains.
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/
topologySpreadConstraints: []
# - maxSkew: 1
# topologyKey: topology.kubernetes.io/zone
# whenUnsatisfiable: DoNotSchedule|ScheduleAnyway
# labelSelector:
# matchLabels:
# foo: bar
# resources for FE pod.
resources:
requests:
cpu: 4
memory: 4Gi
# If you want to remove one resource limit, e.g., cpu, you can set it to cpu: "unlimited".
limits:
cpu: 8
memory: 8Gi
# FE storageSpec for persistent metadata.
# Note: Once set, the following fields will not be allowed to be modified.
storageSpec:
# Specifies the name prefix of the volumes to mount. If left unspecified,
# `emptyDir` volumes will be used by default, which are ephemeral and data
# will be lost on pod restart.
#
# For persistent storage, specify a volume name prefix.
# For example, using `fe` as the name prefix would be appropriate.
# Note: If the values of the following mountPaths are not default, you must set the name to fe.
name: ""
# The storageClassName represent the used storageclass name. If not set will use k8s cluster default storageclass.
# You must set a name when you set storageClassName.
# Note: Because hostPath field is not supported here, hostPath is not allowed to be set in storageClassName.
storageClassName: ""
# the persistent volume size for data.
# FE container stops running if the disk-free space which the FE meta-directory residents is less than 5Gi.
storageSize: 10Gi
# If storageMountPath is empty, the storageMountPath will be set to /opt/starrocks/fe/meta.
storageMountPath: ""
# If not set will use the value of the storageClassName field.
logStorageClassName: ""
# Setting this parameter can persist log storage, and the mount path is /opt/starrocks/fe/log.
# If you set it to 0Gi, the related PVC will not be created, and the log will not be persisted.
logStorageSize: 5Gi
# If logMountPath is empty, the logMountPath will be set to /opt/starrocks/fe/log.
# If logMountPath is not /opt/starrocks/fe/log, you must add in config the following configuration:
# dump_log_dir = xxx
# sys_log_dir = xxx
# audit_log_dir = xxx
logMountPath: ""
# mount emptyDir volumes if necessary.
# Note: please use storageSpec field for persistent metadata and log.
emptyDirs: []
# e.g., mount an emptyDir volume to /tmp
# - name: tmp-data
# mountPath: /tmp
# mount hostPath volumes if necessary.
# Note: please use storageSpec field for persistent storage data and log.
hostPaths: []
# e.g., mount a hostPath volume to /tmp
# - name: tmp-data
# hostPath:
# path: /tmp
# type: Directory
# mountPath: /tmp
# persistentVolumeClaimRetentionPolicy specifies the retention policy for PersistentVolumeClaims associated with the component.
# The whenDeleted field is supported for all components, and it determines whether to delete PVCs when the StatefulSet is deleted.
# The whenScaled field is only supported for the CN component.
persistentVolumeClaimRetentionPolicy:
# whenDeleted: Delete
# the config for start fe. the base information as follows.
config: |
LOG_DIR = ${STARROCKS_HOME}/log
DATE = "$(date +%Y%m%d-%H%M%S)"
JAVA_OPTS="-Dlog4j2.formatMsgNoLookups=true -Xmx8192m -XX:+UseG1GC -Xlog:gc*:${LOG_DIR}/fe.gc.log.$DATE:time"
http_port = 8030
rpc_port = 9020
query_port = 9030
edit_log_port = 9010
mysql_service_nio_enabled = true
sys_log_level = INFO
# When shutting down FE, it will wait for min_graceful_exit_time_second seconds before refusing new requests. If you
# want to ensure that queries, writes, and other operations complete smoothly, you need to ensure that the time it
# takes for the Pod to become Not Ready is less than min_graceful_exit_time_second. The default Pod configuration is
# probe.FailureThreshold = 3, probe.PeriodSeconds = 5, so in the worst case, the Pod will have (3+1)*5 = 20s to
# transition to Node Not Ready state. Since the default value of min_graceful_exit_time_second is 15, we change it to a larger value.
# Note: StarRocks version must be greater than or equal to 3.4.2 to support this configuration, otherwise it will not take effect.
min_graceful_exit_time_second = 25
# A map object for setting the FE config. When configyaml is set to non-empty, the configs in configyaml will take
# precedence and values in the config field will be discarded.
# Note: When using configyaml, the number needs to be quoted to avoid being converted to scientific notation.
# E.g., brpc_socket_max_unwritten_bytes: "10737418240"
configyaml: {}
# mount secrets if necessary.
# see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
secrets: []
# e.g., mount my-secret to /etc/my-secret
# - name: my-secret
# mountPath: /etc/my-secret
# subPath: ""
# mount configmaps if necessary.
# see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
configMaps: []
# e.g., mount my-configmap to /etc/my-configmap
# - name: my-configmap
# mountPath: /etc/my-configmap
# subPath: ""
# terminationGracePeriodSeconds defines duration in seconds the FE pod needs to terminate gracefully.
# the default value is 120 seconds
terminationGracePeriodSeconds: 120
# Please upgrade the CRD with v1.8.7 released version if you want to use the following configuration.
# including: startupProbeFailureSeconds, livenessProbeFailureSeconds, readinessProbeFailureSeconds
# StartupProbeFailureSeconds defines the total failure seconds of a startup Probe.
# the default value is 300 seconds
# You can set it to "0" to disable the probe.
startupProbeFailureSeconds:
# LivenessProbeFailureSeconds defines the total failure seconds of a liveness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
livenessProbeFailureSeconds:
# ReadinessProbeFailureSeconds defines the total failure seconds of a readiness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
readinessProbeFailureSeconds:
# minReadySeconds specifies the minimum number of seconds for which a newly created pod should be ready
# without any of its container crashing, for it to be considered available.
# Defaults to 0 (pod will be considered available as soon as it is ready).
# see https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#minimum-ready-seconds for more details.
# Note: If you want to this field take effect, you need set podManagementPolicy to OrderedReady.
minReadySeconds: 0
# podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
# The default policy is Parallel which is not the same as statefulset's default policy. The reason is that we previously hoped
# to execute scale-out and scale-in parallel, which is safe for CN, but does pose data security issues for BE.
# Note: If you have changed this field, then the related statefulset object need to be recreated, or there will be an error like this:
# updates to statefulset spec for fields other than 'replicas', 'ordinals', 'template', 'updateStrategy',
# 'persistentVolumeClaimRetentionPolicy' and 'minReadySeconds' are forbidden
podManagementPolicy: Parallel
# Lifecycle describes actions that the management system should take in response to container lifecycle events.
# By default, Operator will add corresponding preStop hooks for different components. For example, the preStop
# script for the FE Component is /opt/starrocks/fe_prestop.sh, for the BE Component is /opt/starrocks/be_prestop.sh,
# and for the CN Component is /opt/starrocks/cn_prestop.sh.
# You can set postStart hook.
lifecycle: {}
# postStart:
# exec:
# command:
# - /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: []
# - name: sidecar-container
# image: busybox
# # If starrocksFESpec.storageSpec.name is FE or not set, you can mount the volume of meta like this.
# command: ['sh', '-c', 'echo "hello from the sidecar container" >/opt/starrocks/fe/meta/sidecar-data.txt && sleep 3600']
# volumeMounts:
# - mountPath: /opt/starrocks/fe/meta
# name: fe-meta # append '-meta' to the end of the name of the starrocksFESpec.storageSpec.name
# sidecarsMap is an optional map of containers that are run in the same pod as the starrocks component.
# The reason for using sidecarsMap please refer to https://github.com/StarRocks/starrocks-kubernetes-operator/issues/618
# sidecarsMap has higher priority than sidecars, and the key of sidecarsMap is the name of the sidecar container.
sidecarsMap: {}
# sidecar-container:
# image: busybox
# # If starrocksFESpec.storageSpec.name is FE or not set, you can mount the volume of meta like this.
# command: ['sh', '-c', 'echo "hello from the sidecar container" >/opt/starrocks/fe/meta/sidecar-data.txt && sleep 3600']
# volumeMounts:
# - mountPath: /opt/starrocks/fe/meta
# name: fe-meta # append '-meta' to the end of the name of the starrocksFESpec.storageSpec.name
# initContainers is an optional list of containers that are run in the same pod as the starrocks component.
# You can use this to launch helper containers that run before the main container starts.
# See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to configure a container.
initContainers: []
# - name: init-container
# image: busybox
# # If starrocksFESpec.storageSpec.name is FE or not set, you can mount the volume of meta like this.
# command: ['sh', '-c', 'echo "hello from the init container" >/opt/starrocks/fe/meta/init-data.txt']
# volumeMounts:
# - mountPath: /opt/starrocks/fe/meta
# name: fe-meta # append '-meta' to the end of the starrocksFESpec.storageSpec.name
# Max unavailable pods for the FE component when doing rolling update.
# This field cannot be 0. The default setting is 1.
# Note: Because Operator uses statefulset to manage this component, the maxUnavailable field is in Alpha stage, and it is honored
# only by API servers that are running with the MaxUnavailableStatefulSet feature gate enabled.
# See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#maximum-unavailable-pods for more details.
maxUnavailablePods:
# Share a single process namespace between all the containers in a pod.
# When this is set, containers will be able to view and signal processes from other containers
# in the same pod, and the first process in each container will not be assigned PID 1.
shareProcessNamespace:
# spec for compute node, compute node provide compute function.
starrocksCnSpec:
# Number of replicas to deploy for the CN component.
#
# When autoscaling of the CN statefulset is used, the `replicas` field is set to null
# by the operator, and autoscaling is controlled by Horizontal Pod Autoscaling (HPA).
# You should only uncomment and set the `replicas` field if autoscaling is disabled.
# replicas: 1
image:
# image sliced by "repository:tag"
repository: starrocks/cn-ubuntu
tag: ""
imagePullPolicy: IfNotPresent
# Specify the entrypoint for CN.
# By default, the operator will use '/opt/starrocks/cn_entrypoint.sh' as command, and use '$(FE_SERVICE_NAME)' as args in container spec.
# If the entrypoint is set, the command will be ["bash", "-c"], and the args will be a filename of the entrypoint script.
# A configmap with the name $cluster-cn-entrypoint-script will be created, and the script will be mounted to /etc/starrocks/entrypoint.sh
# Pod will be restarted if the entrypoint script is updated.
entrypoint: {}
# script: |
# #! /bin/bash
# echo "do something before start cn"
# exec /opt/starrocks/cn_entrypoint.sh $FE_SERVICE_NAME
# serviceAccount for CN access cloud service.
serviceAccount: ""
# add annotations for CN pods. for example, if you want to config monitor for datadog, you can config the annotations.
annotations: {}
# If runAsNonRoot is true, the container is run as a non-root user.
# The userId will be set to 1000, and the groupID will be set to 1000.
# Note: If you have started the container through root, and then FE/BE began to create directories, write files, etc.
# under the mounted directory as root. When you start the container as a non-root user, the container will not
# have permission to access these files. So you'd better set runAsNonRoot to true when you set up the cluster.
runAsNonRoot: false
# Whether this container has a read-only root filesystem.
# Note: The FE/BE/CN container should support read-only root filesystem. The newest version of FE/BE/CN is 3.3.6 and does not support read-only root filesystem.
readOnlyRootFilesystem: false
# add/drop capabilities for CN container.
capabilities: {}
# add:
# - PERFMON
# - SYS_PTRACE
# drop:
# - SYS_ADMIN
# set sysctls for CN pod.
# See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for how to set sysctls.
# Note: The use of unsafe sysctls is at-your-own-risk and can lead to severe problems
sysctls: []
# - name: net.ipv4.ip_unprivileged_port_start
# value: "2048"
# specify the service name and port config and serviceType
# the service type refers https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
service:
# the CN service type, only supported ClusterIP, NodePort, LoadBalancer
type: "ClusterIP"
# the loadBalancerIP for static ip config when the type=LoadBalancer and loadBalancerIp is not empty.
loadbalancerIP: ""
# add annotations for external CN service.
annotations: {}
# Add labels for external CN service. The operator may add its own default labels.
labels: {}
# Config the service port for CN service.
# To assign a specific port or nodePort to a service, you should specify them by the corresponding name or
# containerPort in the service configuration. If both containerPort and name are specified, containerPort takes precedence.
# For cn, the port name can be webserver, heartbeat, brpc, thrift, and their default container port is 8040, 9050, 8060, 9060.
ports: []
# e.g., specify a dedicated node port for CN service by containerPort.
# - nodePort: 30040 # The range of valid ports is 30000-32767
# containerPort: 8040 # The port on the container to expose.
# Specify the source IP ranges for the load balancer when the type=LoadBalancer.
loadBalancerSourceRanges: []
# - 10.0.0.0/8
# imagePullSecrets allows you to use secrets for pulling images for your pods.
imagePullSecrets: []
# - name: "image-pull-secret"
# If specified, the pod's nodeSelector,displayName="Map of nodeSelectors to match when scheduling pods on nodes"
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
nodeSelector: {}
# kubernetes.io/arch: amd64
# kubernetes.io/os: linux
# the pod labels for user select or classify pods.
podLabels: {}
## hostAliases allows adding entries to /etc/hosts inside the containers
hostAliases: []
# - ip: "127.0.0.1"
# hostnames:
# - "example.com"
# schedulerName allows you to specify which scheduler will be used for the pod
schedulerName: ""
# CN container environment variables.
# See https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/ for how to define environment variables.
# Note: If you use slice to define environment variables, and if there are multiple values files, the values in the last values file will take effect.
# If you use a map to define environment variables, the values will be merged.
# You can only use one of the manners to define environment variables.
# To avoid a different type of cnEnvVars, we do not define the default value of cnEnvVars, e.g., cnEnvVars: [] or cnEnvVars: {}.
# cnEnvVars:
# define environment variables by slice.
# E.g., static environment variable:
# - name: DEMO_GREETING
# value: "Hello from the environment"
# e.g., secret environment variable:
# - name: USERNAME
# valueFrom:
# secretKeyRef:
# name: mysecret
# key: username
# affinity for CN pod scheduling.
affinity: {}
# nodeAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# nodeSelectorTerms:
# - matchFields:
# - key: metadata.name
# operator: In
# values:
# - target-host-name
# podAntiAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# - labelSelector:
# matchExpressions:
# - key: app.kubernetes.io/component
# operator: In
# values:
# - cn
# topologyKey: "kubernetes.io/hostname"
# Node tolerations for CN pod scheduling to nodes with taints
# Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
tolerations: []
# - key: "key"
# operator: "Equal|Exists"
# value: "value"
# effect: "NoSchedule|PreferNoSchedule|NoExecute(1.6 only)"
# topologySpreadConstraints for scheduling pods across failure-domains.
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/
topologySpreadConstraints: []
# - maxSkew: 1
# topologyKey: topology.kubernetes.io/zone
# whenUnsatisfiable: DoNotSchedule|ScheduleAnyway
# labelSelector:
# matchLabels:
# foo: bar
autoScalingPolicy: {}
# you can select different versions of HPA (Horizontal Pod Autoscaler) based on the Kubernetes version you are
# using to ensure compatibility and adaptability. the default version is v2beta2.
# version: v2beta2
# maxReplicas: 10
# minReplicas: 1
# hpaPolicy:
# metrics:
# - type: Resource
# resource:
# name: memory
# target:
# averageUtilization: 30
# type: Utilization
# - type: Resource
# resource:
# name: cpu
# target:
# averageUtilization: 30
# type: Utilization
# behavior:
# scaleUp:
# policies:
# - type: Pods
# value: 1
# periodSeconds: 10
# scaleDown:
# selectPolicy: Disabled
# define resources requests and limits for CN pods.
resources:
requests:
cpu: 4
memory: 8Gi
# If you want to remove one resource limit, e.g., cpu, you can set it to cpu: "unlimited".
limits:
cpu: 8
memory: 8Gi
# specify a storageclass name and request size.
# Note: Once set, the following fields will not be allowed to be modified.
storageSpec:
# Specifies the name prefix of the volumes to mount. If left unspecified,
# `emptyDir` volumes will be used, which are ephemeral, and only for log.
# The logs will be lost on pod restart when using emptyDir volumes.
#
# For persistent storage, specify a volume name prefix.
# For example, using `cn` as the name prefix would BE appropriate.
# Note: If the values of the following mountPaths are not default, you must set the name to cn.
name: ""
# The storageClassName represent the used storageclass name. If not set will use k8s cluster default storageclass.
# You must set a name when you set storageClassName
# Note: Because hostPath field is not supported here, hostPath is not allowed to be set in storageClassName.
storageClassName: ""
# the storage size of per persistent volume for data.
storageSize: 1Ti
# The number of persistent volumes for data.
# If storageCount == 1,
# the storageMountPath field is used to specify the mount path of the persistent volume. If storageMountPath is empty,
# the storageMountPath will be set to /opt/starrocks/cn/storage.
# If storageMountPath is not /opt/starrocks/cn/storage, you must add in config the following configuration: storage_root_path = xxx.
# If storageCount > 1,
# the storageMountPath field is used to specify the prefix of the mount path for the persistent volume. For example, if the
# storageMountPath is /opt/starrocks/cn/storage, the real mount path will be /opt/starrocks/cn/storage0, /opt/starrocks/cn/storage1, ...
# You must add in config the following configuration: storage_root_path = /opt/starrocks/cn/storage0;/opt/starrocks/cn/storage1;...
storageCount: 1
# see the comment of storageCount for the usage of storageMountPath.
storageMountPath: ""
# If not set will use the value of the storageClassName field.
logStorageClassName: ""
# The storage size of persistent volume for log, and the mount path is /opt/starrocks/cn/log.
# If you set it to 0Gi, the related PVC will not be created, and the log will not be persisted.
logStorageSize: 20Gi
# If logMountPath is empty, the logMountPath will be set to /opt/starrocks/cn/log.
# If logMountPath is not /opt/starrocks/cn/log, you must add in config the following configuration: sys_log_dir = xxx.
logMountPath: ""
# If not set will use the value of the storageClassName field.
spillStorageClassName: ""
# Setting this parameter can persist spill storage, and the mount path is /opt/starrocks/cn/spill.
# If you set it to 0Gi, the related PVC will not be created, and the spill will not be persisted.
# You need to add spill_local_storage_dir=/opt/starrocks/cn/spill in cn.conf.
spillStorageSize: 0Gi
# If spillMountPath is empty, the spillMountPath will be set to /opt/starrocks/cn/spill.
# If spillMountPath is not /opt/starrocks/cn/spill, you must add in config the following configuration: spill_local_storage_dir = xxx.
spillMountPath: ""
# mount emptyDir volumes if necessary.
# Note: please use storageSpec field for persistent storage data and log.
emptyDirs: []
# e.g., mount an emptyDir volume to /tmp
# - name: tmp-data
# mountPath: /tmp
# mount hostPath volumes if necessary.
# Note:
# 1. Please use the storageSpec field for persistent storage data and log.
# 2. Please use podAntiAffinity to avoid the pods are scheduled on the same node.
# 3. If you use hostPath to mount the volume of cache data, the cache will be lost when the pod is restarted.
hostPaths: []
# e.g., mount a hostPath volume to /tmp
# - name: tmp-data
# hostPath:
# path: /tmp
# type: Directory
# mountPath: /tmp
# persistentVolumeClaimRetentionPolicy specifies the retention policy for PersistentVolumeClaims associated with the component.
# The whenDeleted field is supported for all components, and it determines whether to delete PVCs when the StatefulSet is deleted.
# The whenScaled field is only supported for the CN component.
persistentVolumeClaimRetentionPolicy:
# whenDeleted: Delete
# whenScaled: Delete
# the config start for cn, the base information as follows.
# From StarRocks 3.1, the official documentation uses:
# 1. be_port instead of thrift_port, but the thrift_port is still supported.
# 2. be_http_port instead of webserver_port, but the webserver_port is still supported.
# To avoid the impact of the change on the user's deployment, we still use the old configuration.
config: |
sys_log_level = INFO
# ports for admin, web, heartbeat service
thrift_port = 9060
webserver_port = 8040
heartbeat_service_port = 9050
brpc_port = 8060
# A map object for setting the config. When configyaml is set, to non-empty, the configs in configyaml will take
# precedence and values in the config field will be discarded.
# Note: When using configyaml, the number needs to be quoted to avoid being converted to scientific notation.
# E.g., brpc_socket_max_unwritten_bytes: "10737418240"
configyaml: {}
# mount secrets if necessary.
# see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
secrets: []
# e.g., mount my-secret to /etc/my-secret
# - name: my-secret
# mountPath: /etc/my-secret
# subPath: ""
# mount configmaps if necessary.
# see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
configMaps: []
# e.g., mount my-configmap to /etc/my-configmap
# - name: my-configmap
# mountPath: /etc/my-configmap
# subPath: ""
# terminationGracePeriodSeconds defines duration in seconds the CN pod needs to terminate gracefully.
# the default value is 120 seconds
terminationGracePeriodSeconds: 120
# Please upgrade the CRD with v1.8.7 released version if you want to use the following configuration.
# including: startupProbeFailureSeconds, livenessProbeFailureSeconds, readinessProbeFailureSeconds
# StartupProbeFailureSeconds defines the total failure seconds of a startup Probe.
# the default value is 300 seconds
# You can set it to "0" to disable the probe.
startupProbeFailureSeconds:
# LivenessProbeFailureSeconds defines the total failure seconds of liveness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
livenessProbeFailureSeconds:
# ReadinessProbeFailureSeconds defines the total failure seconds of a readiness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
readinessProbeFailureSeconds:
# minReadySeconds specifies the minimum number of seconds for which a newly created pod should be ready
# without any of its container crashing, for it to be considered available.
# Defaults to 0 (pod will be considered available as soon as it is ready).
# see https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#minimum-ready-seconds for more details.
# Note: If you want to this field take effect, you need set podManagementPolicy to OrderedReady.
minReadySeconds: 0
# podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
# The default policy is Parallel which is not the same as statefulset's default policy. The reason is that we previously hoped
# to execute scale-out and scale-in parallel, which is safe for CN, but does pose data security issues for BE.
# Note: If you have changed this field, then the related statefulset object need to be recreated, or there will be an error like this:
# updates to statefulset spec for fields other than 'replicas', 'ordinals', 'template', 'updateStrategy',
# 'persistentVolumeClaimRetentionPolicy' and 'minReadySeconds' are forbidden
podManagementPolicy: Parallel
# Lifecycle describes actions that the management system should take in response to container lifecycle events.
# By default, Operator will add corresponding preStop hooks for different components. For example, the preStop
# script for the FE Component is /opt/starrocks/fe_prestop.sh, for the BE Component is /opt/starrocks/be_prestop.sh,
# and for the CN Component is /opt/starrocks/cn_prestop.sh.
# You can set postStart hook.
lifecycle: {}
# postStart:
# exec:
# command:
# - /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 configure a container.
sidecars: []
# - name: sidecar-container
# image: busybox
# # If starrocksCnSpec.storageSpec.name is cn, you can mount the volume of cache data like this.
# # If starrocksCnSpec.storageSpec.name is not set, no default volume will be created, so you cannot mount the volume of cache data like this.
# command: ['sh', '-c', 'echo "hello from the sidecar container" >/opt/starrocks/cn/storage/sidecar-data.txt && sleep 3600']
# volumeMounts:
# - mountPath: /opt/starrocks/cn/storage
# name: cn-data # append '-data' to the end of the name of the starrocksCnSpec.storageSpec.name
# sidecarsMap is an optional map of containers that are run in the same pod as the starrocks component.
# The reason for using sidecarsMap please refer to https://github.com/StarRocks/starrocks-kubernetes-operator/issues/618
# sidecarsMap has higher priority than sidecars, and the key of sidecarsMap is the name of the sidecar container.
sidecarsMap: {}
# sidecar-container:
# image: busybox
# # If starrocksCnSpec.storageSpec.name is cn, you can mount the volume of cache data like this.
# # If starrocksCnSpec.storageSpec.name is not set, no default volume will be created, so you cannot mount the volume of cache data like this.
# command: ['sh', '-c', 'echo "hello from the sidecar container" >/opt/starrocks/cn/storage/sidecar-data.txt && sleep 3600']
# volumeMounts:
# - mountPath: /opt/starrocks/cn/storage
# name: cn-data # append '-data' to the end of the name of the starrocksCnSpec.storageSpec.name
# initContainers is an optional list of containers that are run in the same pod as the starrocks component.
# You can use this to launch helper containers that run before the main container starts.
# See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to configure a container.
initContainers: []
# - name: init-container
# image: busybox
# # If starrocksCnSpec.storageSpec.name is cn, you can mount the volume of cache data like this.
# # If starrocksCnSpec.storageSpec.name is not set, no default volume will be created, so you cannot mount the volume of cache data like this.
# command: ['sh', '-c', 'echo "hello from the init container" >/opt/starrocks/cn/storage/init-data.txt']
# volumeMounts:
# - mountPath: /opt/starrocks/cn/storage
# name: cn-data # append '-data' to the end of the starrocksCnSpec.storageSpec.name
# Max unavailable pods for the CN component when doing rolling update.
# This field cannot be 0. The default setting is 1.
# Note: Because Operator uses statefulset to manage this component, the maxUnavailable field is in Alpha stage, and it is honored
# only by API servers that are running with the MaxUnavailableStatefulSet feature gate enabled.
# See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#maximum-unavailable-pods for more details.
maxUnavailablePods:
# Share a single process namespace between all of the containers in a pod.
# When this is set, containers will be able to view and signal processes from other containers
# in the same pod, and the first process in each container will not be assigned PID 1.
shareProcessNamespace:
# spec for component be, provide storage and compute function.
starrocksBeSpec:
# number of replicas to deploy.
replicas: 1
image:
# image sliced by "repository:tag"
repository: starrocks/be-ubuntu
tag: ""
imagePullPolicy: IfNotPresent
# Specify the entrypoint for BE.
# By default, the operator will use '/opt/starrocks/be_entrypoint.sh' as command, and use '$(FE_SERVICE_NAME)' as args in the container spec.
# If the entrypoint is set, the command will be ["bash", "-c"], and the args will be a filename of the entrypoint script.
# A configmap with the name $cluster-be-entrypoint-script will be created, and the script will be mounted to /etc/starrocks/entrypoint.sh
# Pod will be restarted if the entrypoint script is updated.
entrypoint: {}
# script: |
# #! /bin/bash
# echo "do something before start BE"
# exec /opt/starrocks/be_entrypoint.sh $FE_SERVICE_NAME
# serviceAccount for BE access cloud service.
serviceAccount: ""
# add annotations for BE pods. for example, if you want to config monitor for datadog, you can config the annotations.
annotations: {}
# If runAsNonRoot is true, the container is run as a non-root user.
# The userId will be set to 1000, and the groupID will be set to 1000.
# Note: If you have started the container through root, and then FE/BE began to create directories, write files, etc.
# under the mounted directory as root. When you start the container as a non-root user, the container will not
# have permission to access these files. So you'd better set runAsNonRoot to true when you set up the cluster.
runAsNonRoot: false
# Whether this container has a read-only root filesystem.
# Note: The FE/BE/CN container should support read-only root filesystem. The newest version of FE/BE/CN is 3.3.6 and does not support read-only root filesystem.
readOnlyRootFilesystem: false
# add/drop capabilities for BE container.
capabilities: {}
# add:
# - PERFMON
# - SYS_PTRACE
# drop:
# - SYS_ADMIN
# set sysctls for BE pod.
# See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for how to set sysctls.
# Note: The use of unsafe sysctls is at-your-own-risk and can lead to severe problems
sysctls: []
# - name: net.ipv4.ip_unprivileged_port_start
# value: "2048"
# specify the service name and port config and serviceType
# the service type refers https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
service:
# the BE service type only supported ClusterIP, NodePort, LoadBalancer
type: "ClusterIP"
# the loadBalancerIP for static ip config when the type=LoadBalancer and loadbalancerIp is not empty.
loadbalancerIP: ""
# add annotations for external BE service.
annotations: {}
# Add labels for external BE service. The operator may add its own default labels.
labels: {}
# Config the service port for BE service.
# To assign a specific port or nodePort to a service, you should specify them by the corresponding name or
# containerPort in the service configuration. If both containerPort and name are specified, containerPort takes precedence.
# For BE, the port name can be webserver, heartbeat, brpc, be, and their default container port is 8040, 9050, 8060, 9060.
ports: []
# e.g., specify a dedicated node port for BE service by containerPort.
# - nodePort: 30040 # The range of valid ports is 30000-32767
# containerPort: 8040 # The port on the container to expose.
# Specify the source IP ranges for the load balancer when the type=LoadBalancer.
loadBalancerSourceRanges: []
# - 10.0.0.0/8
# imagePullSecrets allows you to use secrets to pull images for pods.
imagePullSecrets: []
# - name: "image-pull-secret"
# If specified, the pod's nodeSelector,displayName="Map of nodeSelectors to match when scheduling pods on nodes"
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
nodeSelector: {}
# kubernetes.io/arch: amd64
# kubernetes.io/os: linux
# the pod labels for user select or classify pods.
podLabels: {}
## hostAliases allows adding entries to /etc/hosts inside the containers
hostAliases: []
# - ip: "127.0.0.1"
# hostnames:
# - "example.com"
# schedulerName allows you to specify which scheduler will be used for the pod
schedulerName: ""
# BE container environment variables.
# See https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/ for how to define environment variables.
# Note: If you use slice to define environment variables, and if there are multiple values files, the values in the last values file will take effect.
# If you use a map to define environment variables, the values will be merged.
# You can only use one of the manners to define environment variables.
# To avoid the different type of beEnvVars, we do not define the default value of beEnvVars, e.g., beEnvVars: [] or beEnvVars: {}.
# beEnvVars:
# define environment variables by slice.
# E.g., static environment variable:
# - name: DEMO_GREETING
# value: "Hello from the environment"
# e.g., secret environment variable:
# - name: USERNAME
# valueFrom:
# secretKeyRef:
# name: mysecret
# key: username
# affinity for BE pod scheduling.
affinity: {}
# nodeAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# nodeSelectorTerms:
# - matchFields:
# - key: metadata.name
# operator: In
# values:
# - target-host-name
# podAntiAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# - labelSelector:
# matchExpressions:
# - key: app.kubernetes.io/component
# operator: In
# values:
# - be
# topologyKey: "kubernetes.io/hostname"
# Node tolerations for BE pod scheduling to nodes with taints
# Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
tolerations: []
# - key: "key"
# operator: "Equal|Exists"
# value: "value"
# effect: "NoSchedule|PreferNoSchedule|NoExecute(1.6 only)"
# topologySpreadConstraints for scheduling pods across failure-domains.
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/
topologySpreadConstraints: []
# - maxSkew: 1
# topologyKey: topology.kubernetes.io/zone
# whenUnsatisfiable: DoNotSchedule|ScheduleAnyway
# labelSelector:
# matchLabels:
# foo: bar
# resources for BE pod.
resources:
requests:
cpu: 4
memory: 4Gi
# If you want to remove one resource limit, e.g., cpu, you can set it to cpu: "unlimited".
limits:
cpu: 8
memory: 8Gi
# BE storageSpec for persistent storage.
# Note: Once set, the following fields will not be allowed to be modified.
storageSpec:
# Specifies the name prefix of the volumes to mount. If left unspecified,
# `emptyDir` volumes will be used by default, which are ephemeral and data
# will be lost on pod restart.
#
# For persistent storage, specify a volume name prefix.
# For example, using `be` as the name prefix would be appropriate.
# Note: If the values of the following mountPaths are not default, you must set the name to be.
name: ""
# The storageClassName represent the used storageclass name. If not set will use k8s cluster default storageclass.
# You must set a name when you set storageClassName
# Note: Because hostPath field is not supported here, hostPath is not allowed to be set in storageClassName.
storageClassName: ""
# the storage size of per persistent volume for data.
storageSize: 1Ti
# The number of persistent volumes for data.
# If storageCount == 1,
# the storageMountPath field is used to specify the mount path of the persistent volume. If storageMountPath is empty,
# the storageMountPath will be set to /opt/starrocks/be/storage.
# If storageMountPath /opt/starrocks/be/storage, you must add in config the following configuration: storage_root_path = xxx.
# If storageCount > 1,
# the storageMountPath field is used to specify the prefix of a mount path for the persistent volume. For example, if the
# storageMountPath is /opt/starrocks/be/storage, the real mount path will be /opt/starrocks/be/storage0, /opt/starrocks/be/storage1, ...
# You must add in config the following configuration: storage_root_path = /opt/starrocks/be/storage0;/opt/starrocks/be/storage1;...
storageCount: 1
# see the comment of storageCount for the usage of storageMountPath.
storageMountPath: ""
# If not set will use the value of the storageClassName field.
logStorageClassName: ""
# Setting this parameter can persist log storage, and the mount path is /opt/starrocks/be/log.
# If you set it to 0Gi, the related PVC will not be created, and the log will not be persisted.
logStorageSize: 20Gi
# If logMountPath is empty, the logMountPath will be set to /opt/starrocks/be/log.
# If logMountPath is not /opt/starrocks/be/log, you must add in config the following configuration: sys_log_dir = xxx.
logMountPath: ""
# If not set will use the value of the storageClassName field.
spillStorageClassName: ""
# Setting this parameter can persist spill storage, and the mount path is /opt/starrocks/be/spill.
# If you set it to 0Gi, the related PVC will not be created, and the spill will not be persisted.
# You need to add spill_local_storage_dir=/opt/starrocks/be/spill in be.conf.
spillStorageSize: 0Gi
# If spillMountPath is empty, the spillMountPath will be set to /opt/starrocks/be/spill.
# If spillMountPath is not /opt/starrocks/be/spill, you must add in config the following configuration: spill_local_storage_dir = xxx.
spillMountPath: ""
# mount emptyDir volumes if necessary.
# Note: please use storageSpec field for persistent storage data and log.
emptyDirs: []
# e.g., mount an emptyDir volume to /tmp
# - name: tmp-data
# mountPath: /tmp
# mount hostPath volumes if necessary.
# Note: please use storageSpec field for persistent storage data and log.
hostPaths: []
# e.g., mount a hostPath volume to /tmp
# - name: tmp-data
# hostPath:
# path: /tmp
# type: Directory
# mountPath: /tmp
# persistentVolumeClaimRetentionPolicy specifies the retention policy for PersistentVolumeClaims associated with the component.
# The whenDeleted field is supported for all components, and it determines whether to delete PVCs when the StatefulSet is deleted.
# The whenScaled field is only supported for the CN component.
persistentVolumeClaimRetentionPolicy:
# whenDeleted: Delete
# the config for start be. The base information is as follows.
# From StarRocks 3.1, the official documentation uses:
# 1. be_http_port instead of webserver_port, but the webserver_port is still supported.
# To avoid the impact of the change on the user's deployment, we still use the old configuration.
config: |
be_port = 9060
webserver_port = 8040
heartbeat_service_port = 9050
brpc_port = 8060
sys_log_level = INFO
default_rowset_type = beta
# A map object for setting the config. When configyaml is set, to non-empty, the configs in configyaml will take
# precedence and values in the config field will be discarded.
# Note: When using configyaml, the number needs to be quoted to avoid being converted to scientific notation.
# E.g., brpc_socket_max_unwritten_bytes: "10737418240"
configyaml: {}
# mount secrets if necessary.
# see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
secrets: []
# e.g., mount my-secret to /etc/my-secret
# - name: my-secret
# mountPath: /etc/my-secret
# subPath: ""
# mount configmaps if necessary.
# see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
configMaps: []
# e.g., mount my-configmap to /etc/my-configmap
# - name: my-configmap
# mountPath: /etc/my-configmap
# subPath: ""
# terminationGracePeriodSeconds defines duration in seconds the BE pod needs to terminate gracefully.
# the default value is 120 seconds
terminationGracePeriodSeconds: 120
# Please upgrade the CRD with v1.8.7 released version if you want to use the following configuration.
# including: startupProbeFailureSeconds, livenessProbeFailureSeconds, readinessProbeFailureSeconds
# StartupProbeFailureSeconds defines the total failure seconds of a startup Probe.
# the default value is 300 seconds
# You can set it to "0" to disable the probe.
startupProbeFailureSeconds:
# LivenessProbeFailureSeconds defines the total failure seconds of liveness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
livenessProbeFailureSeconds:
# ReadinessProbeFailureSeconds defines the total failure seconds of a readiness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
readinessProbeFailureSeconds:
# minReadySeconds specifies the minimum number of seconds for which a newly created pod should be ready
# without any of its container crashing, for it to be considered available.
# Defaults to 0 (pod will be considered available as soon as it is ready).
# see https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#minimum-ready-seconds for more details.
# Note: If you want to this field take effect, you need set podManagementPolicy to OrderedReady.
minReadySeconds: 0
# podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
# The default policy is Parallel which is not the same as statefulset's default policy. The reason is that we previously hoped
# to execute scale-out and scale-in parallel, which is safe for CN, but does pose data security issues for BE.
# Note: If you have changed this field, then the related statefulset object need to be recreated, or there will be an error like this:
# updates to statefulset spec for fields other than 'replicas', 'ordinals', 'template', 'updateStrategy',
# 'persistentVolumeClaimRetentionPolicy' and 'minReadySeconds' are forbidden
podManagementPolicy: Parallel
# Lifecycle describes actions that the management system should take in response to container lifecycle events.
# By default, Operator will add corresponding preStop hooks for different components. For example, the preStop
# script for the FE Component is /opt/starrocks/fe_prestop.sh, for the BE Component is /opt/starrocks/be_prestop.sh,
# and for the CN Component is /opt/starrocks/cn_prestop.sh.
# You can set postStart hook.
lifecycle: {}
# postStart:
# exec:
# command:
# - /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: []
# - name: sidecar-container
# image: busybox
# # If your starrocksBeSpec.storageSpec.name is 'be' or not set, you can mount the volume of data like this.
# command: ['sh', '-c', 'echo "hello from the sidecar container" >/opt/starrocks/be/storage/sidecar-data.txt && sleep 3600']
# volumeMounts:
# - mountPath: /opt/starrocks/be/storage
# name: be-data # append '-data' to the end of the name of the starrocksBeSpec.storageSpec.name
# sidecarsMap is an optional map of containers that are run in the same pod as the starrocks component.
# The reason for using sidecarsMap please refer to https://github.com/StarRocks/starrocks-kubernetes-operator/issues/618
# sidecarsMap has higher priority than sidecars, and the key of sidecarsMap is the name of the sidecar container.
sidecarsMap: {}
# sidecar-container:
# image: busybox
# # If your starrocksBeSpec.storageSpec.name is 'be' or not set, you can mount the volume of data like this.
# command: ['sh', '-c', 'echo "hello from the sidecar container" >/opt/starrocks/be/storage/sidecar-data.txt && sleep 3600']
# volumeMounts:
# - mountPath: /opt/starrocks/be/storage
# name: be-data # append '-data' to the end of the name of the starrocksBeSpec.storageSpec.name
# initContainers is an optional list of containers that are run in the same pod as the starrocks component.
# You can use this to launch helper containers that run before the main container starts.
# See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container for how to configure a container.
initContainers: []
# - name: init-container
# image: busybox
# # If your starrocksBeSpec.storageSpec.name is 'be' or not set, you can mount the volume of data like this.
# command: ['sh', '-c', 'echo "hello from the init container" >/opt/starrocks/be/storage/init-data.txt']
# volumeMounts:
# - mountPath: /opt/starrocks/be/storage
# name: be-data # append '-data' to the end of the starrocksBeSpec.storageSpec.name
# Max unavailable pods for the BE component when doing rolling update.
# This field cannot be 0. The default setting is 1.
# Note: Because Operator uses statefulset to manage this component, the maxUnavailable field is in Alpha stage, and it is honored
# only by API servers that are running with the MaxUnavailableStatefulSet feature gate enabled.
# See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#maximum-unavailable-pods for more details.
maxUnavailablePods:
# Share a single process namespace between all of the containers in a pod.
# When this is set, containers will be able to view and signal processes from other containers
# in the same pod, and the first process in each container will not be assigned PID 1.
shareProcessNamespace:
# create secrets if necessary.
secrets: []
# e.g., create my-secret
# - name: my-secret
# data:
# key: |
# this is the content of the secret
# when mounted, the key will be the name of the file
# create configmaps if necessary.
configMaps: []
# e.g., create my-configmap
# - name: my-configmap
# data:
# key: |
# this is the content of the configmap
# when mounted, the key will be the name of the file
# If you need to deploy other resources, e.g., serviceAccount, you can add them here.
# You can even deploy resources to different namespaces
resources: []
# - apiVersion: v1
# kind: ServiceAccount
# metadata:
# name: sa-for-starrocks
# namespace: starrocks
# specify the FE proxy deployment or not.
starrocksFeProxySpec:
# specify the FE proxy deployment or not.
enabled: false
replicas: 1
imagePullPolicy: IfNotPresent
# default nginx:1.24.0
image:
repository: ""
tag: ""
resources:
requests:
cpu: 1
memory: 2Gi
limits:
cpu: 1
memory: 2Gi
# set the resolver for nginx server, default kube-dns.kube-system.svc.cluster.local
resolver: ""
service:
# the FE proxy service type, only supported ClusterIP, NodePort, LoadBalancer
# default ClusterIP
type: ClusterIP
# the loadBalancerIP for static ip config when the type=LoadBalancer and loadbalancerIp is not empty.
loadbalancerIP: ""
# add annotations for external FE proxy service.
annotations: {}
# Add labels for external FE proxy service. The operator may add its own default labels.
labels: {}
# Config the service port for FE proxy service.
# To assign a specific port or nodePort to a service, you should specify them by the corresponding name or
# containerPort in the service configuration. If both containerPort and name are specified, containerPort takes precedence.
# For FE proxy, the port name can be http-port, and its default container port is 8080.
ports: []
# e.g., specify a dedicated node port for FE proxy service by containerPort.
# - nodePort: 30080 # The range of valid ports is 30000-32767
# containerPort: 8080 # The port on the container to expose.
# Specify the source IP ranges for the load balancer when the type=LoadBalancer.
loadBalancerSourceRanges: []
# - 10.0.0.0/8
# imagePullSecrets allows you to use secrets for pulling images for your pods.
imagePullSecrets: []
# - name: "image-pull-secret"
# If specified, the pod's nodeSelector,displayName="Map of nodeSelectors to match when scheduling pods on nodes"
# Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
nodeSelector: {}
# kubernetes.io/arch: amd64
# kubernetes.io/os: linux
# affinity for FE proxy pod scheduling.
affinity: {}
# nodeAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# nodeSelectorTerms:
# - matchFields:
# - key: metadata.name
# operator: In
# values:
# - target-host-name
# podAntiAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# - labelSelector:
# matchExpressions:
# - key: app.kubernetes.io/component
# operator: In
# values:
# - fe-proxy
# topologyKey: "kubernetes.io/hostname"
# Node tolerations for FE proxy pod scheduling to nodes with taints
# Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
tolerations: []
# - key: "key"
# operator: "Equal|Exists"
# value: "value"
# effect: "NoSchedule|PreferNoSchedule|NoExecute(1.6 only)"
# Please upgrade the CRD with v1.8.7 released version if you want to use the following configuration.
# including: livenessProbeFailureSeconds, readinessProbeFailureSeconds
# LivenessProbeFailureSeconds defines the total failure seconds of liveness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
livenessProbeFailureSeconds:
# ReadinessProbeFailureSeconds defines the total failure seconds of a readiness Probe.
# the default value is 15 seconds
# You can set it to "0" to disable the probe.
readinessProbeFailureSeconds:
# Note: will create emptyDir volume for FE proxy, PVC is not supported.
emptyDirs: []
# e.g., mount an emptyDir volume to /tmp
# - name: tmp-data
# mountPath: /tmp
# the pod labels for user select or classify pods.
podLabels: {}