docs: replace OLM-based installation with Helm-based installation#30
Merged
Conversation
- 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
There was a problem hiding this comment.
Pull request overview
This PR updates the Quick Start installation docs to reflect Kubedoop’s move from OLM-based operator installation to Helm-based installation, for both English and Chinese (zh-Hans) docs.
Changes:
- Replaced OLM install/subscription steps with Helm repo setup and
helm installworkflows. - Documented installation of built-in prerequisite operators (commons/listener/secret) before installing
hive-operator. - Updated the Hive Metastore example manifest and cleanup steps to match the Helm-based flow.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/quick-start/installation.md | Rewrites Quick Start to use Helm for operator installation and updates HiveMetastore example/cleanup accordingly. |
| i18n/zh/docusaurus-plugin-content-docs/current/quick-start/installation.md | Applies the same Helm-based installation and updated examples/cleanup in Chinese. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 安装 Operator | ||
|
|
||
| Kubedoop 使用 Helm Chart 来部署和管理 Operator。 | ||
| 所有 Chart 发布在 [quay.io](https://quay.io/kubedoopcharts)。 |
Comment on lines
+67
to
+73
| ```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: |
|
|
||
| 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). |
Comment on lines
+59
to
+60
| The Hive cluster is managed by the hive-operator. You can deploy a Hive | ||
| Metastore by creating a HiveCluster custom resource: |
Comment on lines
+62
to
+66
| ```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 |
2 tasks
whg517
force-pushed
the
docs/remove-olm-use-helm
branch
from
fa8000d to
51d0d4e
Compare
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replace all OLM (Operator Lifecycle Manager) references with Helm-based
installation, as the project has moved away from OLM deployment model.
Changes
helm repo add kubedoop)helm installfor Operator deploymenthelm uninstallTesting
npm run buildpasses for both en and zh-Hans localesNotes
docs/architecture.mdin PR docs: add operator documentation template and architecture overview #28 also contains OLM references in Mermaiddiagrams — will be addressed after docs: add operator documentation template and architecture overview #28 merges