[doc] add artifacthub-repo.yml and update README.md (#177)

* [doc] add artifacthub-repo.yml and update README.md

Signed-off-by: yandongxiao <[email protected]>

Author: yandongxiao

README.md

@@ -1,85 +1,114 @@
 # StarRocks-Kubernetes-Operator
+
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 ## Overview
-**(under development)**  
-This operator is developed with [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder), which can deploy StarRocks CRD resources in kubernetes.
 
-This Kubernetes Operator is able to deploy StarRocks' Front End (FE), Back End (BE) and Compute Node (CN) components into your kubernetes environment. These components run in FQDN (fully qualified domain name) mode by default.
+Using [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder), a framework that enables the deployment of
+StarRocks Custom Resource Definition (CRD) resources within a Kubernetes environment.
+
+The Kubernetes Operator provided by StarRocks facilitates the deployment of StarRocks' Front End (FE), Back End (BE),
+and Compute Node (CN) components within your Kubernetes environment. By default, these components operate in FQDN (fully
+qualified domain name) mode.
 
 ## Requirements
- * kubernetes 1.18+
- * golang 1.18+
+
+* kubernetes 1.18+
+* golang 1.18+
 
 ## Supported Features
+
 * FE decouples with CN and BE. FE is a must-have component, BE and CN can be optionally deployed.
 * Support v2 horizontalpodautoscalers for CN cluster.
 
 ## （Optional) Build the operator images by yourself
+
 Get the official operator image from [here](https://hub.docker.com/r/starrocks/centos-operator/tags).
 
 ### Build starrocks operator docker image
+
 Follow below instructions if you want to build your own image.
 
-```
+```console
 DOCKER_BUILDKIT=1 docker build -t starrocks-kubernetes-operator/operator:<tag> .
 ```
+
 E.g.
-```bash
+
+```console
 DOCKER_BUILDKIT=1 docker build -t starrocks-kubernetes-operator/operator:latest .
 ```
 
 ### Publish starrocks operator docker image
-```
+
+```console
 docker push ghcr.io/OWNER/starrocks-kubernetes-operator/operator:latest
 ```
-E.g. 
-Publish image to ghcr 
-```shell
+
+E.g.
+Publish image to ghcr
+
+```console
 docker push ghcr.io/dengliu/starrocks-kubernetes-operator/operator:latest
 ```
 
 ## Install Operator in kubernetes
+
 Apply the custom resource definition (CRD) for the Operator:
-```shell
+
+```console
 kubectl apply -f https://raw.githubusercontent.com/StarRocks/starrocks-kubernetes-operator/main/deploy/starrocks.com_starrocksclusters.yaml
 ```
-Apply the Operator manifest. By default, the Operator is configured to install in the starrocks namespace. 
-To use the Operator in a custom namespace, download the [Operator manifest](https://raw.githubusercontent.com/StarRocks/starrocks-kubernetes-operator/main/deploy/operator.yaml) and edit all instances of namespace: starrocks to specify your custom namespace.
-Then apply this version of the manifest to the cluster with kubectl apply -f {local-file-path} instead of using the command below.
-```shell
+
+Apply the Operator manifest. By default, the Operator is configured to install in the starrocks namespace.
+To use the Operator in a custom namespace, download
+the [Operator manifest](https://raw.githubusercontent.com/StarRocks/starrocks-kubernetes-operator/main/deploy/operator.yaml)
+and edit all instances of namespace: starrocks to specify your custom namespace.
+Then apply this version of the manifest to the cluster with kubectl apply -f {local-file-path} instead of using the
+command below.
+
+```console
 kubectl apply -f https://raw.githubusercontent.com/StarRocks/starrocks-kubernetes-operator/main/deploy/operator.yaml
 ```
 
 ## Deploy StarRocks
+
 You need to prepare a separate yaml file to deploy the StarRocks FE, BE and CN components.
 The starrocks cluster CRD fields explains in [api.md](./doc/api.md).
 The [examples](./examples/starrocks) directory contains some simple example for reference.
 
-You can use any of the template yaml file as a starting point. You can further add more configurations into the template yaml file following this deployment documentation.
+You can use any of the template yaml file as a starting point. You can further add more configurations into the template
+yaml file following this deployment documentation.
 
 ### Configure the StarRocks' components images
+
 Official FE/CN/BE components images can be found from [dockerhub](https://hub.docker.com/u/starrocks):
 
 You can specify the image name in the yaml file.
 For example, the below configuration uses the `starrocks/fe-ubuntu:2.5.4` image for FE.
+
 ```yaml
 starRocksFeSpec:
   image: starrocks/fe-ubuntu:2.5.4
 ```
 
 ### (Optional) Using ConfigMap to configure your StarRocks cluster
 
-The official images contains default application configuration file, however, they can be overritten by configuring kubernetes configmap deployment crd. 
+The official images contains default application configuration file, however, they can be overritten by configuring
+kubernetes configmap deployment crd.
 
 You can generate the configmap from an StarRocks configuration file.
-Below is an example of creating a Kubernetes configmap `fe-config-map` from the `fe.conf` configuration file. You can do the same with BE and CN.
-```shell
+Below is an example of creating a Kubernetes configmap `fe-config-map` from the `fe.conf` configuration file. You can do
+the same with BE and CN.
+
+```console
 # create fe-config-map from starrocks/fe/conf/fe.conf file
 kubectl create configmap fe-config-map --from-file=starrocks/fe/conf/fe.conf
 ```
+
 Once the configmap is created, you can reference the configmap in the yaml file.
 For example:
+
 ```yaml
 # fe use configmap example
 starRocksFeSpec:
@@ -91,64 +120,82 @@ starRocksCnSpec:
   configMapInfo:
     configMapName: cn-config-map
     resolveKey: cn.conf
-# be use configmap example
+  # be use configmap example
   starRocksBeSpec:
     configMapInfo:
     configMapName: be-config-map
     resolveKey: be.conf
 ```
+
 ### (Optional) Configuring storage volume
-External storage can be used to store FE meta and BE data for persistence. `storageVolumes` can be specified in corresponding component spec to enable external storage volumes auto provisioning. Note that the specific `storageClassName` should be available in kubernetes cluster before enabling this storageVolume feature.
 
-If `StorageVolume` info is not specified in CRD spec, the operator will use emptydir mode to store FE meta and BE data. 
+External storage can be used to store FE meta and BE data for persistence. `storageVolumes` can be specified in
+corresponding component spec to enable external storage volumes auto provisioning. Note that the
+specific `storageClassName` should be available in kubernetes cluster before enabling this storageVolume feature.
+
+If `StorageVolume` info is not specified in CRD spec, the operator will use emptydir mode to store FE meta and BE data.
 
 **FE storage example**
+
 ```yaml
 starRocksFeSpec:
   storageVolumes:
-    - name: fe-meta
-      storageClassName: meta-storage
-      storageSize: 10Gi
-      mountPath: /opt/starrocks/fe/meta # overwrite the default meta path
+  - name: fe-meta
+    storageClassName: meta-storage
+    storageSize: 10Gi
+    mountPath: /opt/starrocks/fe/meta # overwrite the default meta path
 ```
+
 **BE storage example**
+
 ```yaml
 starRocksBeSpec:
   storageVolumes:
-    - name: be-data
-      storageClassName: data-storage
-      storageSize: 1Ti
-      mountPath: /opt/starrocks/be/storage # overwrite the default data path
+  - name: be-data
+    storageClassName: data-storage
+    storageSize: 1Ti
+    mountPath: /opt/starrocks/be/storage # overwrite the default data path
 ```
 
 ### Deploy the StarRocks cluster
-For demonstration purpose, we use the [starrocks-fe-and-be.yaml](./examples/starrocks/starrocks-fe-and-be.yaml) example template to start a 3 FE and 3 BE StarRocks cluster.
 
-```bash
+For demonstration purpose, we use the [starrocks-fe-and-be.yaml](./examples/starrocks/starrocks-fe-and-be.yaml) example
+template to start a 3 FE and 3 BE StarRocks cluster.
+
+```console
 kubectl apply -f starrocks-fe-and-be.yaml
 ```
 
 ### Connect to the deployed StarRocks Cluster
 
-After deploying the StarRocks cluster, you can use `kubectl get svc -n <namespace>` to find the IP to connect to. For example if the namespace that starrocks is deployed into is `starrocks`, you can:
-```bash
+After deploying the StarRocks cluster, you can use `kubectl get svc -n <namespace>` to find the IP to connect to. For
+example if the namespace that starrocks is deployed into is `starrocks`, you can:
+
+```console
 kubectl get svc -n starrocks
 ```
+
 `<your-StarRocksCluster-name>-fe-service`'s clusterIP is the IP to use to connect to StarRocks FE.
 
 ## Stop the StarRocks cluster
 
 Delete the custom resource:
-```shell
+
+```console
 kubectl delete -f starrocks-fe-and-be.yaml
 ```
 
 Remove the Operator:
-```shell
+
+```console
 kubectl delete -f  https://raw.githubusercontent.com/StarRocks/starrocks-kubernetes-operator/main/deploy/operator.yaml
 ```
 
-## Others 
+## Others
+
 ### helm
-StarRocks have supported helm use.  
-[helm chart](https://artifacthub.io/packages/helm/kube-starrocks/kube-starrocks). [github repo](https://github.com/StarRocks/helm-charts)
+
+StarRocks has embraced Helm for its deployment needs. You can find the Helm chart for StarRocks
+at [artifacthub](https://artifacthub.io/packages/helm/kube-starrocks/kube-starrocks).
+Additionally, this GitHub repository also containing the Helm chart can be accessed
+at [kube-starrocks](https://github.com/StarRocks/starrocks-kubernetes-operator/tree/main/helm-charts/charts/kube-starrocks).

artifacthub-repo.yml

@@ -0,0 +1,12 @@
+# Artifact Hub repository metadata file
+#
+# Some settings like the verified publisher flag or the ignored packages won't
+# be applied until the next time the repository is processed. Please keep in
+# mind that the repository won't be processed if it has not changed since the
+# last time it was processed. Depending on the repository kind, this is checked
+# in a different way. For Helm http based repositories, we consider it has
+# changed if the `index.yaml` file changes. For git based repositories, it does
+# when the hash of the last commit in the branch you set up changes. This does
+# NOT apply to ownership claim operations, which are processed immediately.
+#
+repositoryID: 5483bdbd-05c3-49f6-88c8-b32492b7e6f1

deploy/operator.yaml

@@ -240,7 +240,7 @@ spec:
         - /sroperator
         args:
         - --leader-elect
-        image: starrocks/operator:latest
+        image: starrocks/operator:v1.7.0
         name: sroperator
         securityContext:
           allowPrivilegeEscalation: false

helm-charts/README.md

@@ -1,7 +1,6 @@
 # StarRocks Kubernetes Helm Charts
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Release Charts](https://img.shields.io/badge/Release-helmcharts-green.svg)](https://github.com/StarRocks/helm-charts/releases)
 
-This functionality is in beta and is subject to change. The code is provided as-is with no warranties.  Beta features are not subject to the support SLA of official GA features.
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Release Charts](https://img.shields.io/badge/Release-helmcharts-green.svg)](https://github.com/StarRocks/starrocks-kubernetes-operator/releases)
 
 ## Usage
 
@@ -11,20 +10,21 @@ Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
 Once Helm is set up properly, add the repo as follows:
 
 ```console
-helm repo add starrocks-community https://starrocks.github.io/helm-charts
+helm repo add starrocks-community https://starrocks.github.io/starrocks-kubernetes-operator
 ```
 
 You can then run `helm search repo kube-starrocks` to see the charts.
 
 ## Contributing
 
-The source code of all [StarRocks](https://www.starrocks.io/) community [Helm](https://helm.sh) charts can be found on Github: <https://github.com/StarRocks/helm-charts/>
+You can find the source code for all the community Helm charts of StarRocks at the following Github
+repository: https://github.com/StarRocks/starrocks-kubernetes-operator/. StarRocks itself can be explored
+at https://www.starrocks.io/.
 
 ## License
 
-<!-- Keep full URL links to repo files because this README syncs from main to gh-pages.  -->
-[Apache 2.0 License](https://github.com/StarRocks/helm-charts/blob/main/LICENSE).
+[Apache 2.0 License](https://github.com/StarRocks/starrocks-kubernetes-operator/blob/main/LICENSE).
 
 ## Helm charts build status
 
-[![Release Charts](https://img.shields.io/github/Download-StarRocks-helmcharts.svg)](https://github.com/StarRocks/helm-charts/releases)
+[![Release Charts](https://img.shields.io/badge/Release-helmcharts-green.svg)](https://github.com/StarRocks/starrocks-kubernetes-operator/releases)

helm-charts/charts/kube-starrocks/README.md

@@ -1,27 +1,32 @@
 # kube-starrocks
-Install the kube-starrocks, a collectionof Kubernetes manifests to provide easy to operate end-to-end Kubernetes cluster deploy starrocks cluster use [starrocks Operator](https://github.com/StarRocks/starrocks-kubernetes-operator).
+
+Install the kube-starrocks, a collection of Kubernetes manifests to provide easy to operate end-to-end Kubernetes
+cluster deploy starrocks cluster use [starrocks Operator](https://github.com/StarRocks/starrocks-kubernetes-operator).
 
 ## Prerequisites
-- Kbuernetes 1.18.3+
+
+- Kubernetes 1.18.3+
 - Helm 3+
 
 ## Get Helm Repository Info
+
 ```console
-helm repo add starrocks-community https://starrocks.github.io/helm-charts
+helm repo add starrocks-community https://starrocks.github.io/starrocks-kubernetes-operator
 helm repo update
 ```
+
 _See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._
 
 ## Install Helm Chart
 
 1. view the package names in repo.
-```console
-helm search repo starrocks-community
-```
+   ```console
+   helm search repo starrocks-community
+   ```
 2. install specify package.
-```console
-helm install [RELEASE_NAME] starrocks-community/[PACKAGE_NAME]
-```
+   ```
+   helm install [RELEASE_NAME] starrocks-community/[PACKAGE_NAME]
+   ```
 
 _See [configuration](#configuration) below._
 
@@ -38,12 +43,13 @@ _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command doc
 CRDs created by this chart are not removed by default and should be manually cleaned up:
 
 ```console
-    kubectl delete crd starrocksclusters.starrocks.com
+kubectl delete crd starrocksclusters.starrocks.com
 ```
 
 ## Configuration
 
-See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments:
+See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
+To see all configurable options with detailed comments:
 
 ```console
 helm show values starrocks-community/kube-starrocks
@@ -53,5 +59,5 @@ helm show values starrocks-community/kube-starrocks
 
 You can see our documentation at StarRocks website for more in-depth installation and instructions for production:
 
-- [Englist](https://docs.starrocks.io/en-us/latest/introduction/StarRocks_intro)
-- [简体中文](https://docs.starrocks.io/zh-cn/latest/introduction/StarRocks_intro)
+- [English](https://docs.starrocks.io/en-us/latest/introduction/StarRocks_intro)
+- [简体中文](https://docs.starrocks.io/zh-cn/latest/introduction/StarRocks_intro)

helm-charts/charts/kube-starrocks/values.yaml

@@ -28,7 +28,7 @@ starrocksOperator:
   image:
     # image sliced by "repository:tag"
     repository: starrocks/operator
-    tag: latest
+    tag: v1.7.0
   imagePullPolicy: Always
   replicaCount: 1
   resources:
@@ -249,6 +249,9 @@ starrocksCnSpec:
     #   value: "value"
     #   effect: "NoSchedule|PreferNoSchedule|NoExecute(1.6 only)"
   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: