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

Update 2.deploy-nebula-operator.md #1729

Merged
merged 1 commit into from
Nov 1, 2022
Merged
Changes from all commits
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
32 changes: 3 additions & 29 deletions docs-2.0/nebula-operator/2.deploy-nebula-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,19 @@ You can deploy NebulaGraph Operator with [Helm](https://helm.sh/).

## Prerequisites

### Install software

Before installing NebulaGraph Operator, you need to install the following software and ensure the correct version of the software:
Before installing NebulaGraph Operator, you need to install the following software and ensure the correct version of the software :

| Software | Requirement |
| ------------------------------------------------------------ | --------- |
| [Kubernetes](https://kubernetes.io) | \>= 1.16 |
| [Helm](https://helm.sh) | \>= 3.2.0 |
| [CoreDNS](https://github.com/coredns/coredns) | \>= 1.6.0 |
| [CertManager](https://cert-manager.io) | \>= 1.2.0 |
| [OpenKruise](https://openkruise.io) | \>= 0.8.0 |

If using a role-based access control policy, you need to enable [RBAC](https://kubernetes.io/docs/admin/authorization/rbac) (optional).

### Description of software

!!! note

The following software used by NebulaGraph Operator is from the third party. NebulaGraph Operator is not responsible for any problems that may arise during the software installation.

- [CoreDNS](https://coredns.io/)

CoreDNS is a flexible and scalable DNS server that is [installed](https://github.com/coredns/deployment/tree/master/kubernetes) for Pods in NebulaGraph clusters.

Components in a NebulaGraph cluster communicate with each other via DNS resolutions for domain names, like `x.default.svc.cluster.local`.

- [cert-manager](https://cert-manager.io/)

!!! note

If you have set the value of the NebulaGraph Operator configuration item `admissionWebhook.create` to `false`, there is no need to install cert-manager. For details about NebulaGraph Operator configuration items, see the **Customize Helm charts** section in **Install NebulaGraph Operator** below.

cert-manager is a tool that automates the management of certificates. It leverages extensions of the Kubernetes API and uses the Webhook server to provide dynamic access control to cert-manager resources. For more information about installation, see [cert-manager installation documentation](https://cert-manager.io/docs/installation/kubernetes/).

cert-manager is used to validate the numeric value of replicas for each component in a NebulaGraph cluster. If you run it in a production environment and care about the high availability of NebulaGraph clusters, it is recommended to set the value of `admissionWebhook.create` to `true` before installing cert-manager.

- [OpenKruise](https://openkruise.io/en-us/)
- If using a role-based access control policy, you need to enable [RBAC](https://kubernetes.io/docs/admin/authorization/rbac) (optional).

OpenKruise is a full set of standard extensions for Kubernetes. It works well with original Kubernetes and provides more powerful and efficient features for managing Pods, sidecar containers, and even container images in clusters. OpenKruise is required to enable advanced features for StatefulSets when NebulaGraph Operator starts. For information about installation, see [openkruise installation documentation](https://openkruise.io/en-us/docs/installation.html).
- [CoreDNS](https://coredns.io/) is a flexible and scalable DNS server that is [installed](https://github.com/coredns/deployment/tree/master/kubernetes) for Pods in NebulaGraph clusters.

## Steps

Expand Down