Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

intro&deploy-nebula-operator-en #757

Merged
merged 6 commits into from
Sep 29, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# What is Nebula Operator

## Concept of Nebula Operator

Nebula Operator is a tool to automate the deployment, and operation and maintenance of [Nebula Graph](https://github.com/vesoft-inc/nebula) clusters on [Kubernetes](https://kubernetes.io). Building upon the excellent scalability mechanism of Kubernetes, Nebula Graph introduced its operation and maintenance knowledge into the Kubernetes system, which makes Nebula Graph a real [cloud-native graph database](https://www.nebula-cloud.io/).
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

## How it works

For resource types that do not exist within Kubernetes,you can register them by adding custom API objects. The common way is to use the [CustomResourceDefinition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions).

Nebula Operator abstracts the deployment management of Nebula Graph clusters as a CRD. By combining multiple built-in API objects including StatefulSet, Service, and ConfigMap, the routine management and maintenance of a Nebula Graph cluster are coded as a control loop in the Kubernetes system. When a CR instance is submitted, Nebula Operator drives database clusters to the final state according to the control process.
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

## Functionalities of Nebula Operator
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

The following features are already available in Nebula Operator:

- **Deploy and uninstall clusters**:Nebula Operator simplifies the process of deploying and uninstalling clusters for users. Nebula Operator allows you to quickly create, update, or delete a Nebula Graph cluster by simply providing the corresponding CR file. For more information, see [Deploy Nebula Graph Clusters with Kubectl](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) or [Deploy Nebula Graph Clusters with Helm](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md).
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

- **Scale clusters**:Nebula Operator calls Nebula Graph's native scaling interfaces in a control loop to implement the scaling logic. You can simply perform scaling operations with YAML configurations and ensure the stability of data. For more information, see [Scale clusters with Kubectl](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md#_3) or [Scale clusters with Helm](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md#_2).
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

- **Self-Healing**:Nebula Operator calls the interface provided by Nebula Graph clusters to dynamically sense cluster service status. Once an exception is detected, Nebula Operator performs fault tolerance. For more information, see [Self-Healing](5.operator-failover.md).
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

- **Balance Scheduling**: Based on the scheduler extension interface, the scheduler provided by Nebula Operator evenly distributes Pods in a Nebula Graph cluster across all nodes.

## Limitations

### Version limitations

Nebula Operator does not support v1.x version of Nebula Graph. Nebula Operator version and the corresponding Nebula Graph version are as follows:
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

| Nebula Operator version | Nebula Graph version |
| ------------------- | ---------------- |
| {{operator.release}}| {{nebula.release}} |

### Functionality limitations
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

Nebula Operator currently only support manual scaling of Nebula Graph clusters, and does not support automatic scaling of Nebula Graph clusters.
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved