Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.88 KB

install_guide.md

File metadata and controls

66 lines (43 loc) · 2.88 KB

Install Guide

Instead of manually installing, scaling, upgrading, and uninstalling NebulaGraph in a production environment, you can instead let the Nebula operator manage the installation for you. This relieves you of the burden of managing different versions and managing the NebulaGraph cluster more easier. Simply update the operator custom resource (CR) and the operator controller will apply the corresponding configuration changes for you.

Follow this guide to install Nebula Operator using Helm for in-depth evaluation.

Requirements

Add-ons

See add ons for how to install the add-ons.

Get Repo Info

helm repo add nebula-operator https://vesoft-inc.github.io/nebula-operator/charts
helm repo update

See helm repo for command documentation.

Install Operator

# helm install [NAME] [CHART] [flags]
$ helm install nebula-operator nebula-operator/nebula-operator --namespace=nebula-operator-system --version=${chart_version}

Note:
If the corresponding nebula-system namespace does not exist, you can create the namespace first by running the kubectl create namespace nebula-operator-system command.

${chart_version} represents the chart version of Nebula Operator. For example, v0.1.0. You can view the currently supported versions by running the helm search repo -l nebula-operator command.

See configuration below.

See helm install for command documentation.

Configure Operator

See Customizing the Chart Before Installing. To see all configurable options with detailed comments, visit the chart's values.yaml, or run the following commands:

$ helm show values nebula-operator/nebula-operator

Upgrade Operator

If you need to upgrade the Nebula Operator, modify the ${HOME}/nebula-operator/values.yaml file, and then execute the following command to upgrade:

$ helm upgrade nebula-operator nebula-operator/nebula-operator --namespace=nebula-operator-system -f `${HOME}/nebula-operator/values.yaml`

Uninstall Operator

$ helm uninstall nebula-operator --namespace=nebula-operator-system
$ kubectl delete crd nebulaclusters.apps.nebula-graph.io