-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* reorg operator in 3.5.0-sc * Update mkdocs.yml * Update 3.1.customize-installation.md * Update 3.1.customize-installation.md
- Loading branch information
1 parent
692e163
commit bb724d9
Showing
43 changed files
with
2,328 additions
and
1,818 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
docs-2.0/k8s-operator/2.get-started/2.1.install-operator.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Install NebulaGraph Operator | ||
|
||
You can deploy NebulaGraph Operator with [Helm](https://helm.sh/). | ||
|
||
## Background | ||
|
||
[NebulaGraph Operator](../1.introduction-to-nebula-operator.md) automates the management of NebulaGraph clusters, and eliminates the need for you to install, scale, upgrade, and uninstall NebulaGraph clusters, which lightens the burden on managing different application versions. | ||
|
||
## Prerequisites | ||
|
||
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.18 | | ||
| [Helm](https://helm.sh) | \>= 3.2.0 | | ||
| [CoreDNS](https://github.com/coredns/coredns) | \>= 1.6.0 | | ||
|
||
!!! note | ||
|
||
- If using a role-based access control policy, you need to enable [RBAC](https://kubernetes.io/docs/admin/authorization/rbac) (optional). | ||
|
||
- [CoreDNS](https://coredns.io/) is a flexible and scalable DNS server that is [installed](https://github.com/coredns/helm) for Pods in NebulaGraph clusters. | ||
|
||
## Steps | ||
|
||
1. Add the NebulaGraph Operator Helm repository. | ||
|
||
```bash | ||
helm repo add nebula-operator https://vesoft-inc.github.io/nebula-operator/charts | ||
``` | ||
|
||
2. Update information of available charts locally from repositories. | ||
|
||
```bash | ||
helm repo update | ||
``` | ||
|
||
For more information about `helm repo`, see [Helm Repo](https://helm.sh/docs/helm/helm_repo/). | ||
|
||
3. Create a namespace for NebulaGraph Operator. | ||
|
||
```bash | ||
kubectl create namespace <namespace_name> | ||
``` | ||
|
||
For example, run the following command to create a namespace named `nebula-operator-system`. | ||
|
||
```bash | ||
kubectl create namespace nebula-operator-system | ||
``` | ||
|
||
All the resources of NebulaGraph Operator are deployed in this namespace. | ||
|
||
4. Install NebulaGraph Operator. | ||
|
||
```bash | ||
helm install nebula-operator nebula-operator/nebula-operator --namespace=<namespace_name> --version=${chart_version} | ||
``` | ||
|
||
For example, the command to install NebulaGraph Operator of version {{operator.release}} is as follows. | ||
|
||
```bash | ||
helm install nebula-operator nebula-operator/nebula-operator --namespace=nebula-operator-system --version={{operator.release}} | ||
``` | ||
|
||
`{{operator.release}}` is the version of the nebula-operator chart. When not specifying `--version`, the latest version of the nebula-operator chart is used by default. | ||
|
||
Run `helm search repo -l nebula-operator` to see chart versions. | ||
|
||
You can customize the configuration items of the NebulaGraph Operator chart before running the installation command. For more information, see [Customize installation defaults](../3.operator-management/3.1.customize-installation.md). | ||
|
||
5. View the information about the default-created CRD. | ||
|
||
```bash | ||
kubectl get crd | ||
``` | ||
|
||
Output: | ||
|
||
```bash | ||
NAME CREATED AT | ||
nebulaautoscalers.autoscaling.nebula-graph.io 2023-11-01T04:16:51Z | ||
nebulaclusters.apps.nebula-graph.io 2023-10-12T07:55:32Z | ||
nebularestores.apps.nebula-graph.io 2023-02-04T23:01:00Z | ||
``` | ||
|
||
## What's next | ||
|
||
[Deploy LM](2.2.deploy-lm.md) |
Oops, something went wrong.