Deploy Nebula Graph clusters with Helm¶

Prerequisite¶

Install Nebula Operator

Create clusters¶

1. Add the Nebula Operator chart repository to Helm（If you have already added the chart, skip the 1-2 steps and start from step 3).

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

2. Update information of available charts locally from chart repositories.

   helm repo update
   

3. Set environment variables to your desired values.

   export NEBULA_CLUSTER_NAME=nebula         # The desired Nebula Graph cluster name.
   export NEBULA_CLUSTER_NAMESPACE=nebula    # The desired namespace where your Nebula Graph cluster locates.
   export STORAGE_CLASS_NAME=gp2             # The desired StorageClass name in your Nebula Graph cluster.
   

4. Create a namespace for your Nebula Graph cluster（If you have created one, skip this step）.

   kubectl create namespace "${NEBULA_CLUSTER_NAMESPACE}"
   

5. Apply the variables to the Helm chart to create a Nebula Graph cluster.

   helm install "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \
       --namespace="${NEBULA_CLUSTER_NAMESPACE}" \
       --set nameOverride=${NEBULA_CLUSTER_NAME} \
       --set nebula.storageClassName="${STORAGE_CLASS_NAME}"
   

6. Check the status of the Nebula Graph cluster you created.

   kubectl -n "${NEBULA_CLUSTER_NAMESPACE}" get pod -l "app.kubernetes.io/cluster=${NEBULA_CLUSTER_NAME}"
   

   Output:

   NAME                READY   STATUS    RESTARTS   AGE
   nebula-graphd-0     1/1     Running   0          5m34s
   nebula-graphd-1     1/1     Running   0          5m34s
   nebula-metad-0      1/1     Running   0          5m34s
   nebula-metad-1      1/1     Running   0          5m34s
   nebula-metad-2      1/1     Running   0          5m34s
   nebula-storaged-0   1/1     Running   0          5m34s
   nebula-storaged-1   1/1     Running   0          5m34s
   nebula-storaged-2   1/1     Running   0          5m34s
   

Scaling clusters¶

You can scale a Nebula Graph cluster by defining the value of the replicas corresponding to the different services in the cluster.

For example, run the following command to scale out a Nebula Graph cluster by changing the number of Storage services from 2 (the original value) to 5:

helm upgrade "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \
    --namespace="${NEBULA_CLUSTER_NAMESPACE}" \
    --set nameOverride=${NEBULA_CLUSTER_NAME} \
    --set nebula.storageClassName="${STORAGE_CLASS_NAME}" \
    --set nebula.storaged.replicas=5

Similarly, you can scale in a Nebula Graph cluster by setting the value of the replicas corresponding to the different services in the cluster smaller than the original value.

You can click on nebula-cluster/values.yaml to see more configurable parameters of the nebula-cluster chart. For more information about the descriptions of configurable parameters, see Configuration parameters of the nebula-cluster Helm chart below.

Delete clusters¶

Run the following command to delete a Nebula Graph cluster with Helm:

helm uninstall "${NEBULA_CLUSTER_NAME}" --namespace="${NEBULA_CLUSTER_NAMESPACE}"

What's next¶

Connect to Nebula Graph Databases

Configuration parameters of the nebula-cluster Helm chart¶