Skip to content

Latest commit

 

History

History
1565 lines (1565 loc) · 28.3 KB

api.md

File metadata and controls

1565 lines (1565 loc) · 28.3 KB
title description draft images menu weight toc
API reference
StarRocks operator generated API reference docs
false
operator
211
true

This page is automatically generated with gen-crd-api-reference-docs.

Packages:

starrocks.com/v1alpha1

Resource Types:

    AutoScalingPolicy

    (Appears on:StarRocksCnSpec)

    AutoScalingPolicy defines the auto scale

    Field Description
    hpaPolicy
    HPAPolicy

    the policy of
    minReplicas
    int32     		(Optional)

    the min numbers of target.
    maxReplicas
    int32     		(Optional)

    the max numbers of target.

    ClusterPhase (string alias)

    (Appears on:StarRocksClusterStatus)

    ConfigMapInfo

    (Appears on:StarRocksBeSpec, StarRocksCnSpec, StarRocksFeSpec)

    Field Description
    configMapName
    string

    the config info for start progress.
    resolveKey
    string

    the config response key in configmap.

    HPAPolicy

    (Appears on:AutoScalingPolicy)

    Field Description
    metrics
    []Kubernetes autoscaling/v2.MetricSpec     		(Optional)

    Metrics specifies how to scale based on a single metric
    behavior
    Kubernetes autoscaling/v2.HorizontalPodAutoscalerBehavior     		(Optional)

    HorizontalPodAutoscalerBehavior configures the scaling behavior of the target

    MemberPhase (string alias)

    (Appears on:StarRocksBeStatus, StarRocksCnStatus, StarRocksFeStatus)

    StarRocksBeSpec

    (Appears on:StarRocksClusterSpec)

    StarRocksBeSpec defines the desired state of be.

    Field Description
    replicas
    int32

    Replicas is the number of desired be Pod. the default value=3 Optional
    image
    string

    Image for a starrocks be deployment.
    name
    string     		(Optional)

    name of the starrocks be cluster.
    service
    StarRocksService     		(Optional)

    Service defines the template for the associated Kubernetes Service object. the service for user access be.
    limits
    Kubernetes core/v1.ResourceList     		(Optional)

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    requests
    Kubernetes core/v1.ResourceList     		(Optional)

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    configMapInfo
    ConfigMapInfo     		(Optional)

    the reference for be configMap.
    probe
    StarRocksProbe     		(Optional)

    Probe defines the mode probe service in container is alive.
    storageVolumes
    []StorageVolume     		(Optional)

    StorageVolumes defines the additional storage for be storage data and log.
    ReplicaInstances
    []string     		(Optional)

    ReplicaInstance is the names of replica starrocksbe cluster.
    nodeSelector
    map[string]string     		(Optional)

    (Optional) If specified, the pod’s nodeSelector，displayName=“Map of nodeSelectors to match when scheduling pods on nodes”
    beEnvVars
    []Kubernetes core/v1.EnvVar     		(Optional)

    beEnvVars is a slice of environment variables that are added to the pods, the default is empty.
    affinity
    Kubernetes core/v1.Affinity     		(Optional)

    If specified, the pod’s scheduling constraints.
    tolerations
    []Kubernetes core/v1.Toleration     		(Optional)

    (Optional) Tolerations for scheduling pods onto some dedicated nodes

    StarRocksBeStatus

    (Appears on:StarRocksClusterStatus)

    StarRocksBeStatus represents the status of starrocks be.

    Field Description
    serviceName
    string

    the name of be service for fe find be instance.
    failedInstances
    []string

    FailedInstances deploy failed instance of be.
    creatingInstances
    []string

    CreatingInstances represents status in creating pods of be.
    runningInstances
    []string

    RunningInstances represents status in running pods of be.
    resourceNames
    []string

    The statefulset names of be.
    phase
    MemberPhase

    Phase the value from all pods of be status. If be have one failed pod phase=failed, also if be have one creating pod phase=creating, also if be all running phase=running, others unknown.
    reason
    string     		(Optional)

    the reason for the phase.

    StarRocksCluster

    StarRocksCluster defines a starrocks cluster deployment.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    StarRocksClusterSpec

    Specification of the desired state of the starrocks cluster.



    serviceAccount
    string     		(Optional)

    Specify a Service Account for starRocksCluster use k8s cluster.
    starRocksFeSpec
    StarRocksFeSpec

    StarRocksFeSpec define fe configuration for start fe service.
    starRocksBeSpec
    StarRocksBeSpec

    StarRocksBeSpec define be configuration for start be service.
    starRocksCnSpec
    StarRocksCnSpec

    StarRocksCnSpec define cn configuration for start cn service.
    status
    StarRocksClusterStatus

    Most recent observed status of the starrocks cluster

    StarRocksClusterSpec

    (Appears on:StarRocksCluster)

    StarRocksClusterSpec defines the desired state of StarRocksCluster

    Field Description
    serviceAccount
    string     		(Optional)

    Specify a Service Account for starRocksCluster use k8s cluster.
    starRocksFeSpec
    StarRocksFeSpec

    StarRocksFeSpec define fe configuration for start fe service.
    starRocksBeSpec
    StarRocksBeSpec

    StarRocksBeSpec define be configuration for start be service.
    starRocksCnSpec
    StarRocksCnSpec

    StarRocksCnSpec define cn configuration for start cn service.

    StarRocksClusterStatus

    (Appears on:StarRocksCluster)

    StarRocksClusterStatus defines the observed state of StarRocksCluster.

    Field Description
    phase
    ClusterPhase

    Represents the state of cluster. the possible value are: running, failed, pending
    starRocksFeStatus
    StarRocksFeStatus

    Represents the status of fe. the status have running, failed and creating pods.
    starRocksBeStatus
    StarRocksBeStatus

    Represents the status of be. the status have running, failed and creating pods.
    starRocksCnStatus
    StarRocksCnStatus

    Represents the status of cn. the status have running, failed and creating pods.

    StarRocksCnSpec

    (Appears on:StarRocksClusterSpec)

    StarRocksCnSpec defines the desired state of cn.

    Field Description
    name
    string     		(Optional)

    name of the starrocks be cluster.
    replicas
    int32     		(Optional)

    Replicas is the number of desired cn Pod.
    image
    string

    Image for a starrocks cn deployment.
    service
    StarRocksService

    Service defines the template for the associated Kubernetes Service object. the service for user access cn.
    configMapInfo
    ConfigMapInfo     		(Optional)

    the reference for cn configMap.
    limits
    Kubernetes core/v1.ResourceList     		(Optional)

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    requests
    Kubernetes core/v1.ResourceList     		(Optional)

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    probe
    StarRocksProbe

    Probe defines the mode probe service in container is alive.
    autoScalingPolicy
    AutoScalingPolicy

    AutoScalingPolicy auto scaling strategy
    nodeSelector
    map[string]string     		(Optional)

    (Optional) If specified, the pod’s nodeSelector，displayName=“Map of nodeSelectors to match when scheduling pods on nodes”
    cnEnvVars
    []Kubernetes core/v1.EnvVar     		(Optional)

    cnEnvVars is a slice of environment variables that are added to the pods, the default is empty.
    affinity
    Kubernetes core/v1.Affinity     		(Optional)

    If specified, the pod’s scheduling constraints.
    tolerations
    []Kubernetes core/v1.Toleration     		(Optional)

    (Optional) Tolerations for scheduling pods onto some dedicated nodes

    StarRocksCnStatus

    (Appears on:StarRocksClusterStatus)

    Field Description
    serviceName
    string

    the name of cn service for fe find cn instance.
    failedInstances
    []string

    FailedInstances deploy failed cn pod names.
    creatingInstances
    []string

    CreatingInstances in creating status cn pod names.
    runningInstances
    []string

    RunningInstances in running status be pod names.
    resourceNames
    []string

    The statefulset names of be.
    HpaName
    string

    The policy name of autoScale.
    phase
    MemberPhase

    Phase the value from all pods of cn status. If cn have one failed pod phase=failed, also if cn have one creating pod phase=creating, also if cn all running phase=running, others unknown.
    reason
    string     		(Optional)

    the reason for the phase.

    StarRocksFeSpec

    (Appears on:StarRocksClusterSpec)

    StarRocksFeSpec defines the desired state of fe.

    Field Description
    name
    string     		(Optional)

    name of the starrocks be cluster.
    replicas
    int32

    Replicas is the number of desired fe Pod, the number is 1,3,5
    image
    string

    Image for a starrocks fe deployment..
    service
    StarRocksService     		(Optional)

    Service defines the template for the associated Kubernetes Service object.
    limits
    Kubernetes core/v1.ResourceList     		(Optional)

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    requests
    Kubernetes core/v1.ResourceList     		(Optional)

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    configMapInfo
    ConfigMapInfo     		(Optional)

    the reference for fe configMap.
    probe
    StarRocksProbe     		(Optional)

    Probe defines the mode probe service in container is alive.
    storageVolumes
    []StorageVolume     		(Optional)

    StorageVolumes defines the additional storage for fe meta storage.
    nodeSelector
    map[string]string     		(Optional)

    (Optional) If specified, the pod’s nodeSelector，displayName=“Map of nodeSelectors to match when scheduling pods on nodes”
    FeEnvVars
    []Kubernetes core/v1.EnvVar     		(Optional)

    feEnvVars is a slice of environment variables that are added to the pods, the default is empty.
    affinity
    Kubernetes core/v1.Affinity     		(Optional)

    If specified, the pod’s scheduling constraints.
    tolerations
    []Kubernetes core/v1.Toleration     		(Optional)

    (Optional) Tolerations for scheduling pods onto some dedicated nodes

    StarRocksFeStatus

    (Appears on:StarRocksClusterStatus)

    StarRocksFeStatus represents the status of starrocks fe.

    Field Description
    serviceName
    string

    the name of fe service exposed for user.
    failedInstances
    []string

    FailedInstances failed fe pod names.
    creatingInstances
    []string

    CreatingInstances in creating pod names.
    runningInstances
    []string

    RunningInstances in running status pod names.
    resourceNames
    []string

    ResourceNames the statefulset names of fe in v1alpha1 version.
    phase
    MemberPhase

    Phase the value from all pods of fe status. If fe have one failed pod phase=failed, also if fe have one creating pod phase=creating, also if fe all running phase=running, others unknown.
    reason
    string     		(Optional)

    Reason represents the reason of not running.

    StarRocksProbe

    (Appears on:StarRocksBeSpec, StarRocksCnSpec, StarRocksFeSpec)

    StarRocksProbe defines the mode for probe be alive.

    Field Description
    type
    string

    Type identifies the mode of probe main container
    initialDelaySeconds
    int32     		(Optional)

    Number of seconds after the container has started before liveness probes are initiated. Default to 10 seconds.
    periodSeconds
    int32     		(Optional)

    How often (in seconds) to perform the probe. Default to Kubernetes default (10 seconds). Minimum value is 1.

    StarRocksService

    (Appears on:StarRocksBeSpec, StarRocksCnSpec, StarRocksFeSpec)

    Field Description
    name
    string     		(Optional)

    Name assigned to service.
    type
    Kubernetes core/v1.ServiceType     		(Optional)

    type of service,the possible value for the service type are : ClusterIP, NodePort, LoadBalancer,ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
    ports
    []StarRocksServicePort     		(Optional)

    Ports the components exposed ports and listen ports in pod.

    StarRocksServicePort

    (Appears on:StarRocksService)

    Field Description
    name
    string

    Name of the map about coming port and target port
    port
    int32

    Port the pod is exposed on service.
    containerPort
    int32

    ContainerPort the service listen in pod.
    nodePort
    int32

    The easiest way to expose fe, cn or be is to use a Service of type NodePort.

    StorageVolume

    (Appears on:StarRocksBeSpec, StarRocksFeSpec)

    StorageVolume defines additional PVC template for StatefulSets and volumeMount for pods that mount this PVC

    Field Description
    name
    string

    name of a storage volume.
    storageClassName
    string     		(Optional)

    storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
    storageSize
    string

    StorageSize is a valid memory size type based on powers-of-2, so 1Mi is 1024Ki. Supported units:Mi, Gi, GiB, Ti, Ti, Pi, Ei, Ex: 512Mi.
    mountPath
    string

    MountPath specify the path of volume mount.