From 51d0d4e2b540c2722900d846101e444e018fdfb4 Mon Sep 17 00:00:00 2001 From: whg517 Date: Sat, 2 May 2026 18:31:23 +0800 Subject: [PATCH 1/2] docs: replace OLM-based installation with Helm-based installation - Remove OLM installation steps (curl install script, Subscription CRD) - Replace with Helm-based Operator deployment (helm repo add + helm install) - Add built-in Operators (commons, listener, secret) as prerequisites - Update HiveMetastore CRD example to match current API - Update clean up steps to use helm uninstall - Apply changes to both English and Chinese documentation --- docs/quick-start/installation.md | 78 +++++++++++++---- .../current/quick-start/installation.md | 87 ++++++++++++++----- 2 files changed, 125 insertions(+), 40 deletions(-) diff --git a/docs/quick-start/installation.md b/docs/quick-start/installation.md index 5a5b05e..80d6fad 100644 --- a/docs/quick-start/installation.md +++ b/docs/quick-start/installation.md @@ -1,39 +1,54 @@ # Quick Start -In this quick start, we will use Kubedoop's hive-operator as an example to show how to deploy a Hive Metastore in a Kubernetes cluster. +In this quick start, we will use Kubedoop's hive-operator as an example to show +how to deploy a Hive Metastore in a Kubernetes cluster. ## Prerequisites To start using Kubedoop, you need to meet the following requirements: - Install [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) +- Install [Helm](https://helm.sh/docs/intro/install/) v3+ - Prepare a Kubernetes cluster -## Install OLM +## Install the Operator -Kubedoop relies on the Operator Lifecycle Manager (OLM) to manage Operators. If OLM is not installed in your cluster, you can install it with the following command: +Kubedoop uses Helm charts to deploy and manage Operators. +All charts are published to [quay.io](https://quay.io/kubedoopcharts). + +### Add the Helm Repository ```bash -curl -sL https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.25.0/install.sh | bash -s v0.25.0 +helm repo add kubedoop https://zncdatadev.github.io/kubedoop-helm-charts/ +helm repo update ``` -## Install hive-operator +### Install Built-in Operators -OLM manages the installation of Operators through [Subscription](https://olm.operatorframework.io/docs/concepts/subscriptions/). We can install the hive-metastore-operator by creating a Subscription: +The commons-operator, listener-operator, and secret-operator are required +dependencies for all product Operators. Install them first: -```yaml -kubectl apply -f https://raw.githubusercontent.com/kubedoop.dev/kubedatastack/main/examples/hive/olm-subscriptions.yaml +```bash +helm install commons-operator kubedoop/commons-operator -n operators --create-namespace +helm install listener-operator kubedoop/listener-operator -n operators +helm install secret-operator kubedoop/secret-operator -n operators +``` + +### Install the Hive Operator + +```bash +helm install hive-operator kubedoop/hive-operator -n operators ``` -Verify that the operator's pod is running normally: +Verify that the Operator pod is running normally: ```bash -kubectl get pods -n operator +kubectl get pods -n operators ``` ## Create Namespace -Create a namespace for hive to deploy the hive cluster: +Create a namespace for Hive to deploy the Hive cluster: ```bash kubectl create ns hive @@ -41,15 +56,39 @@ kubectl create ns hive ## Deploy a Hive Cluster -The Hive cluster is managed by the hive-operator. We can deploy a Hive Metastore by creating a HiveCluster object: +The Hive cluster is managed by the hive-operator. You can deploy a Hive +Metastore by creating a HiveCluster custom resource: ```yaml -kubectl apply -f https://raw.githubusercontent.com/kubedoop.dev/kubedatastack/main/examples/hive/hive-metastore.yaml +apiVersion: hive.kubedoop.dev/v1alpha1 +kind: HiveMetastore +metadata: + name: hive-metastore + namespace: hive +spec: + roleGroups: + default: + replicas: 1 +``` + +```bash +kubectl apply -f - < Date: Sat, 2 May 2026 19:16:00 +0800 Subject: [PATCH 2/2] docs: address Copilot review feedback on installation docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Clarify: container images on quay.io, charts via Helm repo - Fix: HiveCluster → HiveMetastore in description text - Remove duplicate YAML block, keep only kubectl apply heredoc - Apply same fixes to Chinese documentation --- docs/quick-start/installation.md | 17 +++-------------- .../current/quick-start/installation.md | 15 ++------------- 2 files changed, 5 insertions(+), 27 deletions(-) diff --git a/docs/quick-start/installation.md b/docs/quick-start/installation.md index 80d6fad..ff90f39 100644 --- a/docs/quick-start/installation.md +++ b/docs/quick-start/installation.md @@ -14,7 +14,8 @@ To start using Kubedoop, you need to meet the following requirements: ## Install the Operator Kubedoop uses Helm charts to deploy and manage Operators. -All charts are published to [quay.io](https://quay.io/kubedoopcharts). +Container images are published to [quay.io](https://quay.io/kubedoopcharts) and +charts are distributed via a Helm repository. ### Add the Helm Repository @@ -57,19 +58,7 @@ kubectl create ns hive ## Deploy a Hive Cluster The Hive cluster is managed by the hive-operator. You can deploy a Hive -Metastore by creating a HiveCluster custom resource: - -```yaml -apiVersion: hive.kubedoop.dev/v1alpha1 -kind: HiveMetastore -metadata: - name: hive-metastore - namespace: hive -spec: - roleGroups: - default: - replicas: 1 -``` +Metastore by creating a HiveMetastore custom resource: ```bash kubectl apply -f - <