The module lifecycle stage: Preview
The module has requirements for installation
Module Overview
StarRocks is a high-performance analytical database (OLAP) designed for real-time analytics, data warehousing, and BI workloads. It uses an MPP architecture with Frontend (FE) and Backend (BE) nodes, supports standard SQL, vectorized query execution, and high-throughput data ingestion (including Stream Load).
The managed-starrocks module deploys and operates StarRocks clusters in Kubernetes clusters through a declarative API. It allows teams to provision analytical databases, enforce sizing and configuration policies, and scale compute and storage according to workload requirements.
Main features:
- Automatic Deployment: Deploys a StarRocks instance using a simple YAML configuration
- Policy-Based Governance: Separate
StarrocksClassresource for sizing limits, default FE/BE settings, and CEL-based validation of user configs - Analytical Workload Tuning: Configurable parameters for data loading (
streamingLoadMaxMb,loadProcessMaxMemoryLimitPercent) and catalog management (catalogTrashExpireSecond) - TLS Support: Optional TLS for the FE HTTP proxy (HTTPS :8443) via cert-manager or custom certificates. The MySQL query port (:9030) remains non-TLS
- Status: Conditions for configuration validity, scaling, and availability; with TLS,
status.certificate.serverreports certificate TTL / failure
Enabling the Module
To enable the managed-starrocks module, apply the following manifest:
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: managed-starrocks
spec:
enabled: true
version: 1After enabling the module, a cluster-wide StarrocksClass resource named default will be created automatically.
Quick Start
For module usage examples, see:
Main Resources
The Managed Service StarRocks module provides tools for two conditional roles: User and Administrator.
The main module objects are Starrocks, StarrocksClass resources and the StarRocks Operator state controller.
Conditional Administrator role:
- manages the cluster wide
StarrocksClassresource and creates validation templates, scheduling rules, and default FE/BE configuration for StarRocks instances deployed in DKP. - Has access to the system namespace
d8-managed-starrocks, whereStarRocks Operatoris deployed, to its service logs and state.
Conditional User role:
- manages the
Starrocksresource and configures the analytical database instance within the limits defined by theStarrocksClasscreated by the Administrator.
Administrator Resources
StarrocksClass
The StarrocksClass resource allows you to restrict invalid configurations and predefine default values for StarRocks FE/BE settings.
Every Starrocks resource must be linked to an existing StarrocksClass resource.
Before deploying the service, all configuration will be checked against the corresponding StarrocksClass.
Detailed resource description
StarRocks Operator
When the module is enabled, the StarRocks Operator controller is deployed in the system namespace d8-managed-starrocks
and reconciles the states of Starrocks resources and the final StarRocks service in all user namespaces.
User Resources
Starrocks
The main resource that describes the desired state of a StarRocks analytical database instance. It must be created within the user namespace and serves as the source of truth for the deployed StarRocks cluster. Detailed resource description