nebula-operator

Install Guide

Instead of manually installing, scaling, upgrading, and uninstalling NebulaGraph in a production environment, you can use the Nebula operator to manage NebulaGraph automatically.

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

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


_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._

### Install Operator

```shell script
# 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:

```shell script $ 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:

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

Uninstall Operator

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