From 372260a126492e9bab7fc3369a6c64174ea86b10 Mon Sep 17 00:00:00 2001 From: Dan Roscigno Date: Mon, 25 Sep 2023 18:45:34 -0400 Subject: [PATCH] Update deploy_a_starrocks_cluster_with_share_data_mode.yaml (#273) * Update deploy_a_starrocks_cluster_with_share_data_mode.yaml * Add note to examples page --- examples/starrocks/README.md | 4 ++++ .../deploy_a_starrocks_cluster_with_share_data_mode.yaml | 7 ++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/examples/starrocks/README.md b/examples/starrocks/README.md index 9a0409c4..cdf5730d 100644 --- a/examples/starrocks/README.md +++ b/examples/starrocks/README.md @@ -9,3 +9,7 @@ references, and tailor them as necessary to fit the requirement. It primarily co 6. [Deploying a StarRocks cluster running in shared_data mode](./deploy_a_starrocks_cluster_with_share_data_mode.yaml) 7. [Deploying a StarRocks cluster with the FE Proxy component](./deploy_a_starrocks_cluster_with_fe_proxy.yaml) 8. [Deploying a StarRocks cluster with all the above features](./deploy_a_starrocks_cluster_with_all_features.yaml) + +> Note: +> +> Some of the example YAML files need to be edited before using them. For example, the `shared_data mode` example needs editing to specify the shared data (MinIO, AWS, OSS, etc.) location and credentials. When editing these examples you will generally be editing ConfigMaps in the example file. diff --git a/examples/starrocks/deploy_a_starrocks_cluster_with_share_data_mode.yaml b/examples/starrocks/deploy_a_starrocks_cluster_with_share_data_mode.yaml index bff1a9e2..275b2512 100644 --- a/examples/starrocks/deploy_a_starrocks_cluster_with_share_data_mode.yaml +++ b/examples/starrocks/deploy_a_starrocks_cluster_with_share_data_mode.yaml @@ -1,5 +1,10 @@ -# This manifest deploys a StarRocks cluster running in share data mode. +# This manifest deploys a StarRocks cluster running in shared data mode. # see https://docs.starrocks.io/en-us/latest/deployment/deploy_shared_data for more information about share data mode. +# +# You will have to download and edit this YAML file to specify the details for your shared storage. See the +# examples in the docs, and add your customizations to the ConfigMap `starrockscluster-sample-fe-cm` at the +# bottom of this file. +# https://docs.starrocks.io/en-us/latest/deployment/deploy_shared_data#configure-fe-nodes-for-shared-data-starrocks apiVersion: starrocks.com/v1 kind: StarRocksCluster