From a90857414679e3d80896d56df9f198600c525b22 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 21 Apr 2022 15:19:28 +0800 Subject: [PATCH] full-docs changes for operator 1.1.0 (#1256) * full-docs changes for operator 1.1.0 * use macros for version * Update 1.configurations.md * bug fix * Update docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> * Update 6.eco-tool-version.md * Update 9.upgrade-nebula-cluster.md * Update mkdocs.yml Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> --- docs-2.0/20.appendix/6.eco-tool-version.md | 8 ++- docs-2.0/20.appendix/learning-path.md | 4 +- .../1.configurations/1.configurations.md | 3 +- .../1.introduction-to-nebula-operator.md | 13 +++- .../2.deploy-nebula-operator.md | 64 +++++++++++-------- .../3.1create-cluster-with-kubectl.md | 21 +++--- .../3.2create-cluster-with-helm.md | 11 +++- .../4.connect-to-nebula-graph-service.md | 2 +- .../8.1.custom-conf-parameter.md | 4 +- .../8.2.pv-reclaim.md | 6 +- .../8.3.balance-data-when-scaling-storage.md | 6 +- .../9.upgrade-nebula-cluster.md | 46 ++++++------- mkdocs.yml | 32 +++++----- 13 files changed, 127 insertions(+), 93 deletions(-) diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index cfb7fa9e5ce..3ad95740c48 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -74,9 +74,13 @@ Nebula Exchange (Exchange for short) is an Apache Spark&trade application for ba |:---|:---|:--| | {{ nebula.release }} | {{exchange.release}} | {{exchange_ent.release}} | - +Nebula Operator (Operator for short) is a tool to automate the deployment, operation, and maintenance of Nebula Graph clusters on Kubernetes. 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. For more information, see [What is Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md). + +|Nebula Graph version|Operator version| +|:---|:---| +| {{ nebula.release }} | {{operator.release}}| ## Nebula Importer diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index 70c77283d3f..b27d4dc5096 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -179,11 +179,11 @@ This topic is for anyone interested in learning more about Nebula Graph. You can | ------------------------------------------------------------ | | [Nebula Bench](../nebula-bench.md) | - + | [Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md) | - Graph algorithm diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md index 12fc0353f5c..926381a6f37 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md @@ -89,7 +89,6 @@ Each initial configuration file of all services contains `local_config`. The def For clusters installed with Docker Compose, the configuration file's default installation path of the cluster is `/nebula-docker-compose/docker-compose.yaml`. The parameters in the `command` field of the file are the launch parameters for each service. - +2. Choose an appropriate time to restart **all** Nebula Graph services to make the modifications valid. diff --git a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md index 4e6702a1aa6..b93a15ef9e3 100644 --- a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md +++ b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md @@ -18,7 +18,7 @@ The following features are already available in Nebula Operator: - **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) or [Scale clusters with Helm](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md). -- **Cluster Upgrade**: Nebula Operator supports cluster upgrading from version 2.5.x to version 2.6.x. +- **Cluster Upgrade**: Nebula Operator supports cluster upgrading from version {{operator.upgrade_from}} to version {{operator.upgrade_to}}. - **Self-Healing**: Nebula Operator calls interfaces 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). @@ -32,13 +32,20 @@ Nebula Operator does not support the v1.x version of Nebula Graph. Nebula Operat | Nebula Operator version | Nebula Graph version | | ------------------- | ---------------- | -| {{operator.release}}| 2.5.x ~ 2.6.x | +| 1.1.0| 3.0.0 ~ 3.1.x | +| 1.0.0| 3.0.0 ~ 3.1.x | +| 0.9.0| 2.5.x ~ 2.6.x | |0.8.0|2.5.x| +!!! Compatibility "Legacy version compatibility" + + - The 1.x version Nebula Operator is not compatible with Nebula Graph of version below v3.x. + - Starting from Nebula Operator 0.9.0, logs and data are stored separately. Using Nebula Operator 0.9.0 or later versions to manage a Nebula Graph 2.5.x cluster created with Operator 0.8.0 can cause compatibility issues. You can backup the data of the Nebula Graph 2.5.x cluster and then create a 2.6.x cluster with Operator 0.9.0. + ### Feature limitations Nebula Operator currently only supports manual scaling of Nebula Graph clusters, and does not support automatic scaling of Nebula Graph clusters. ## Release note -[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/{{operator.branch}}) \ No newline at end of file +[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/v{{operator.release}}) \ No newline at end of file diff --git a/docs-2.0/nebula-operator/2.deploy-nebula-operator.md b/docs-2.0/nebula-operator/2.deploy-nebula-operator.md index 446b3be595d..481ffafb59c 100644 --- a/docs-2.0/nebula-operator/2.deploy-nebula-operator.md +++ b/docs-2.0/nebula-operator/2.deploy-nebula-operator.md @@ -94,7 +94,7 @@ For example: [k8s@master ~]$ helm show values nebula-operator/nebula-operator image: nebulaOperator: - image: vesoft/nebula-operator:{{operator.branch}} + image: vesoft/nebula-operator:v{{operator.release}} imagePullPolicy: Always kubeRBACProxy: image: gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0 @@ -139,7 +139,7 @@ Part of the above parameters are described as follows: | Parameter | Default value | Description | | :------------------------------------- | :------------------------------ | :----------------------------------------- | -| `image.nebulaOperator.image` | `vesoft/nebula-operator:{{operator.branch}}` | The image of Nebula Operator, version of which is {{operator.release}}. | +| `image.nebulaOperator.image` | `vesoft/nebula-operator:v{{operator.release}}` | The image of Nebula Operator, version of which is {{operator.release}}. | | `image.nebulaOperator.imagePullPolicy` | `IfNotPresent` | The image pull policy in Kubernetes. | | `imagePullSecrets` | - | The image pull secret in Kubernetes. | | `kubernetesClusterDomain` | `cluster.local` | The cluster domain. | @@ -162,29 +162,32 @@ For more information about `helm install`, see [Helm Install](https://helm.sh/do ### Update Nebula Operator -After installing Nebula Operator, you can update it by modifying the parameter values in the `${HOME}/nebula-operator/charts/nebula-operator/values.yaml` file. - -1. Clone the Nebula Operator repository to your local server. +1. Update the information of available charts locally from chart repositories. ```bash - git clone https://github.com/vesoft-inc/nebula-operator.git - ``` + helm repo update + ``` -2. Modify the parameter values in `${HOME}/nebula-operator/charts/nebula-operator/values.yaml`. +2. Update Nebula Operator by passing configuration parameters via `-set` or `-values` flag. + + - `--set`：Overrides values using the command line. + - `--values` (or `-f`)：Overrides values using YAML files. + + For configurable items, see the above-mentioned section **Customize Helm charts**. + + For example, to disable the AdmissionWebhook ( AdmissionWebhook is enabled by default), run the following command: -3. Run the following command to update Nebula Operator. - ```bash - helm upgrade nebula-operator nebula-operator/nebula-operator --namespace= -f ${HOME}/nebula-operator/charts/nebula-operator/values.yaml + helm upgrade nebula-operator nebula-operator/nebula-operator --namespace=nebula-operator-system --version={{operator.release}} --set admissionWebhook.create=false ``` - `` is a user-created namespace name. Pods related to the nebula-operator repository are in this namespace. + For more information, see [Helm upgrade](https://helm.sh/docs/helm/helm_update/). ### Upgrade Nebula Operator !!! Compatibility "Legacy version compatibility" - Starting from Nebula Operator 0.9.0, logs and data are stored separately. Managing a Nebula Graph 2.5.x cluster with Nebula Operator 0.9.0 or later versions can cause compatibility issues. You can backup the data of the Nebula Graph 2.5.x cluster and then create a 2.6.x cluster with Operator. + The 1.x version Nebula Operator is not compatible with Nebula Graph of version below v3.x. 1. Update the information of available charts locally from chart repositories. @@ -192,7 +195,7 @@ After installing Nebula Operator, you can update it by modifying the parameter v helm repo update ``` -2. Upgrade Operator. +2. Upgrade Operator to v{{operator.release}}. ```bash helm upgrade nebula-operator nebula-operator/nebula-operator --namespace= --version={{operator.release}} @@ -209,7 +212,7 @@ After installing Nebula Operator, you can update it by modifying the parameter v ```bash Release "nebula-operator" has been upgraded. Happy Helming! NAME: nebula-operator - LAST DEPLOYED: Tue Nov 16 02:21:08 2021 + LAST DEPLOYED: Tue Apr 16 02:21:08 2022 NAMESPACE: nebula-operator-system STATUS: deployed REVISION: 3 @@ -221,28 +224,37 @@ After installing Nebula Operator, you can update it by modifying the parameter v 3. Pull the latest CRD configuration file. !!! note - You need to upgrade the corresponding CRD configurations after Nebula Operator is upgraded. Otherwise, the creation of Nebula Graph clusters will fail. For information about the CRD configurations, see [apps.nebula-graph.io_nebulaclusters.yaml](https://github.com/vesoft-inc/nebula-operator/blob/{{operator.branch}}/config/crd/bases/apps.nebula-graph.io_nebulaclusters.yaml). + You need to upgrade the corresponding CRD configurations after Nebula Operator is upgraded. Otherwise, the creation of Nebula Graph clusters will fail. For information about the CRD configurations, see [apps.nebula-graph.io_nebulaclusters.yaml](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/config/crd/bases/apps.nebula-graph.io_nebulaclusters.yaml). - ```bash - helm pull nebula-operator/nebula-operator - ``` + 1. Pull the Nebula Operator chart package. -4. Upgrade the CRD configuration file. + ```bash + helm pull nebula-operator/nebula-operator --version={{operator.release}} + ``` - ```bash - kubectl apply -f .yaml - ``` + - `--version`: The Nebula Operator version you want to upgrade to. If not specified, the latest version will be pulled. - For example: + 2. Run `tar -zxvf` to unpack the charts. + + For example: To unpack v{{operator.release}} chart to the `/tmp` path, run the following command: + + ```bash + tar -zxvf nebula-operator-{{operator.release}}.tgz -C /tmp + ``` + + - `-C /tmp`: If not specified, the chart files will be unpacked to the current directory. + + +4. Upgrade the CRD configuration file in the `nebula-operator` directory. ```bash - kubectl apply -f config/crd/bases/apps.nebula-graph.io_nebulaclusters.yaml + kubectl apply -f crds/nebulacluster.yaml ``` Output: ```bash - customresourcedefinition.apiextensions.k8s.io/nebulaclusters.apps.nebula-graph.io created + customresourcedefinition.apiextensions.k8s.io/nebulaclusters.apps.nebula-graph.io configured ``` ### Uninstall Nebula Operator diff --git a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md index 8fdabda443b..aefefe4a9ee 100644 --- a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md +++ b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md @@ -1,5 +1,9 @@ # Deploy Nebula Graph clusters with Kubectl +!!! Compatibility "Legacy version compatibility" + + The 1.x version Nebula Operator is not compatible with Nebula Graph of version below v3.x. + ## Prerequisites [Install Nebula Operator](../2.deploy-nebula-operator.md) @@ -28,7 +32,7 @@ The following example shows how to create a Nebula Graph cluster by creating a c memory: "1Gi" replicas: 1 image: vesoft/nebula-graphd - version: {{nebula.branch}} + version: v{{nebula.release}} service: type: NodePort externalTrafficPolicy: Local @@ -47,7 +51,7 @@ The following example shows how to create a Nebula Graph cluster by creating a c memory: "1Gi" replicas: 1 image: vesoft/nebula-metad - version: {{nebula.branch}} + version: v{{nebula.release}} dataVolumeClaim: resources: requests: @@ -68,7 +72,7 @@ The following example shows how to create a Nebula Graph cluster by creating a c memory: "1Gi" replicas: 3 image: vesoft/nebula-storaged - version: {{nebula.branch}} + version: v{{nebula.release}} dataVolumeClaim: resources: requests: @@ -93,17 +97,17 @@ The following example shows how to create a Nebula Graph cluster by creating a c | `metadata.name` | - | The name of the created Nebula Graph cluster. | | `spec.graphd.replicas` | `1` | The numeric value of replicas of the Graphd service. | | `spec.graphd.images` | `vesoft/nebula-graphd` | The container image of the Graphd service. | - | `spec.graphd.version` | `{{nebula.branch}}` | The version of the Graphd service. | + | `spec.graphd.version` | `v{{nebula.release}}` | The version of the Graphd service. | | `spec.graphd.service` | - | The Service configurations for the Graphd service. | | `spec.graphd.logVolumeClaim.storageClassName` | - | The log disk storage configurations for the Graphd service. | | `spec.metad.replicas` | `1` | The numeric value of replicas of the Metad service. | | `spec.metad.images` | `vesoft/nebula-metad` | The container image of the Metad service. | - | `spec.metad.version` | `{{nebula.branch}}` | The version of the Metad service. | + | `spec.metad.version` | `v{{nebula.release}}` | The version of the Metad service. | | `spec.metad.dataVolumeClaim.storageClassName` | - | The data disk storage configurations for the Metad service. | | `spec.metad.logVolumeClaim.storageClassName`|- | The log disk storage configurations for the Metad service.| | `spec.storaged.replicas` | `3` | The numeric value of replicas of the Storaged service. | | `spec.storaged.images` | `vesoft/nebula-storaged` | The container image of the Storaged service. | - | `spec.storaged.version` | `{{nebula.branch}}` | The version of the Storaged service. | + | `spec.storaged.version` | `v{{nebula.release}}` | The version of the Storaged service. | | `spec.storaged.dataVolumeClaim.storageClassName` | - | The data disk storage configurations for the Storaged service. | | `spec.storaged.logVolumeClaim.storageClassName`|- | The log disk storage configurations for the Storaged service.| | `spec.reference.name` | - | The name of the dependent controller. | @@ -139,7 +143,8 @@ The following example shows how to create a Nebula Graph cluster by creating a c !!! enterpriseonly - The cluster scaling feature is for Nebula Graph Enterprise Edition only. Scaling a Nebula Graph cluster for Enterprise Edition is supported only with Nebula Operator version 1.1.0 or later. + - The cluster scaling feature is for Nebula Graph Enterprise Edition only. + - Scaling a Nebula Graph cluster for Enterprise Edition is supported only with Nebula Operator version 1.1.0 or later. You can modify the value of `replicas` in `apps_v1alpha1_nebulacluster.yaml` to scale a Nebula Graph cluster. @@ -160,7 +165,7 @@ The following shows how to scale out a Nebula Graph cluster by changing the numb memory: "1Gi" replicas: 5 image: vesoft/nebula-storaged - version: {{nebula.branch}} + version: v{{nebula.release}} dataVolumeClaim: resources: requests: diff --git a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md index 14b6041bc7c..181cd8c3d20 100644 --- a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md +++ b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md @@ -1,5 +1,9 @@ # Deploy Nebula Graph clusters with Helm +!!! Compatibility "Legacy version compatibility" + + The 1.x version Nebula Operator is not compatible with Nebula Graph of version below v3.x. + ## Prerequisite [Install Nebula Operator](../2.deploy-nebula-operator.md) @@ -65,7 +69,8 @@ !!! enterpriseonly - The cluster scaling feature is for Nebula Graph Enterprise Edition only. Scaling a Nebula Graph cluster for Enterprise Edition is supported only with Nebula Operator version 1.1.0 or later. + - The cluster scaling feature is for Nebula Graph Enterprise Edition only. + - Scaling a Nebula Graph cluster for Enterprise Edition is supported only with Nebula Operator version 1.1.0 or later. You can scale a Nebula Graph cluster by defining the value of the `replicas` corresponding to the different services in the cluster. @@ -85,7 +90,7 @@ Similarly, you can scale in a Nebula Graph cluster by setting the value of the ` Nebula Operator currently only supports scaling Graph and Storage services and does not support scale Meta services. -You can click on [nebula-cluster/values.yaml](https://github.com/vesoft-inc/nebula-operator/blob/{{operator.branch}}/charts/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. +You can click on [nebula-cluster/values.yaml](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/charts/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 @@ -104,7 +109,7 @@ helm uninstall "${NEBULA_CLUSTER_NAME}" --namespace="${NEBULA_CLUSTER_NAMESPACE} | Parameter | Default value | Description | | :-------------------------- | :----------------------------------------------------------- | ------------------------------------------------------------ | | `nameOverride` | `nil` | Replaces the name of the chart in the `Chart.yaml` file. | -| `nebula.version` | `{{nebula.branch}}` | The version of Nebula Graph. | +| `nebula.version` | `v{{nebula.release}}` | The version of Nebula Graph. | | `nebula.imagePullPolicy` | `IfNotPresent` | The Nebula Graph image pull policy. For details, see [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy). | | `nebula.storageClassName` | `nil` | The StorageClass name. StorageClass is the default persistent volume type. | | `nebula.schedulerName` | `default-scheduler` | The scheduler name of a Nebula Graph cluster. | diff --git a/docs-2.0/nebula-operator/4.connect-to-nebula-graph-service.md b/docs-2.0/nebula-operator/4.connect-to-nebula-graph-service.md index cd76a52a5bb..28ccf869e70 100644 --- a/docs-2.0/nebula-operator/4.connect-to-nebula-graph-service.md +++ b/docs-2.0/nebula-operator/4.connect-to-nebula-graph-service.md @@ -172,7 +172,7 @@ Steps are as follows. 1. Create a file named `nginx-ingress-daemonset-hostnetwork.yaml`. - Click on [nginx-ingress-daemonset-hostnetwork.yaml](https://github.com/vesoft-inc/nebula-operator/blob/{{operator.branch}}/config/samples/nginx-ingress-daemonset-hostnetwork.yaml) to view the complete content of the example YAML file. + Click on [nginx-ingress-daemonset-hostnetwork.yaml](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/config/samples/nginx-ingress-daemonset-hostnetwork.yaml) to view the complete content of the example YAML file. !!! note diff --git a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md index cf8ff49075d..74bc068e0ac 100644 --- a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md +++ b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md @@ -45,7 +45,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat memory: "1Gi" replicas: 1 image: vesoft/nebula-graphd - version: {{nebula.branch}} + version: v{{nebula.release}} storageClaim: resources: requests: @@ -59,7 +59,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat 3. Run `kubectl apply -f nebula_cluster.yaml` to push your configuration changes to the cluster. -After customizing the parameters `enable_authorize` and `auth_type`, the configurations in the corresponding ConfigMap (`nebula-graphd`) of the Graph service will be overwritten. + After customizing the parameters `enable_authorize` and `auth_type`, the configurations in the corresponding ConfigMap (`nebula-graphd`) of the Graph service will be overwritten. ## Learn more diff --git a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md index bedf935c81f..6c154c38c81 100644 --- a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md +++ b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md @@ -44,7 +44,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat requests: cpu: 500m memory: 500Mi - version: {{nebula.branch}} + version: v{{nebula.release}} imagePullPolicy: IfNotPresent metad: dataVolumeClaim: @@ -66,7 +66,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat requests: cpu: 500m memory: 500Mi - version: {{nebula.branch}} + version: v{{nebula.release}} nodeSelector: nebula: cloud reference: @@ -93,7 +93,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat requests: cpu: 500m memory: 500Mi - version: {{nebula.branch}} + version: v{{nebula.release}} ... ``` diff --git a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md index 9b7f6a94126..f5fb692b75b 100644 --- a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md +++ b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md @@ -47,7 +47,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat requests: cpu: 500m memory: 500Mi - version: {{nebula.branch}} + version: v{{nebula.release}} imagePullPolicy: IfNotPresent metad: dataVolumeClaim: @@ -69,7 +69,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat requests: cpu: 500m memory: 500Mi - version: {{nebula.branch}} + version: v{{nebula.release}} nodeSelector: nebula: cloud reference: @@ -97,7 +97,7 @@ The following example uses a cluster named `nebula` and the cluster's configurat requests: cpu: 500m memory: 500Mi - version: {{nebula.branch}} + version: v{{nebula.release}} ... ``` diff --git a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md index 7a8130a75a6..5f8d59d5648 100644 --- a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md +++ b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md @@ -2,15 +2,15 @@ This topic introduces how to upgrade a Nebula Graph cluster created with Nebula Operator. +!!! Compatibility "Legacy version compatibility" -## Limits - -- Only Nebula Graph clusters created with Nebula Operator are supported. + The 1.x version Nebula Operator is not compatible with Nebula Graph of version below v3.x. -- Only upgrading Nebula Graph from 2.5.x to 2.6.x is supported. +## Limits -- Upgrading clusters created via Nebula Operator of version 0.8.0 is not supported. +- Only for Nebula Graph clusters that have been created with Nebula Operator. +- Only support upgrading the Nebula Graph version from {{operator.upgrade_from}} to {{operator.upgrade_to}}. ## Upgrade a Nebula Graph cluster with Kubectl @@ -18,7 +18,7 @@ This topic introduces how to upgrade a Nebula Graph cluster created with Nebula You have created a Nebula Graph cluster with Kubectl. For details, see [Create a Nebula Graph cluster with Kubectl](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md). -The version of the Nebula Graph cluster to be upgraded in this topic is `2.5.1`, and its YAML file name is `apps_v1alpha1_nebulacluster.yaml`. +The version of the Nebula Graph cluster to be upgraded in this topic is `{{operator.upgrade_from}}`, and its YAML file name is `apps_v1alpha1_nebulacluster.yaml`. ### Steps @@ -32,12 +32,12 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `2.5.1`, Output: ```bash - 1 vesoft/nebula-graphd:v2.5.1 - 1 vesoft/nebula-metad:v2.5.1 - 3 vesoft/nebula-storaged:v2.5.1 + 1 vesoft/nebula-graphd:{{operator.upgrade_from}} + 1 vesoft/nebula-metad:{{operator.upgrade_from}} + 3 vesoft/nebula-storaged:{{operator.upgrade_from}} ``` -2. Edit the `apps_v1alpha1_nebulacluster.yaml` file by changing the values of all the `version` parameters from v2.5.1 to {{nebula.branch}}. +2. Edit the `apps_v1alpha1_nebulacluster.yaml` file by changing the values of all the `version` parameters from {{operator.upgrade_from}} to v{{nebula.release}}. The modified YAML file reads as follows: @@ -57,7 +57,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `2.5.1`, memory: "1Gi" replicas: 1 image: vesoft/nebula-graphd - version: {{nebula.branch}} //Change the value from v2.5.1 to {{nebula.branch}}. + version: v{{nebula.release}} //Change the value from {{operator.upgrade_from}} to v{{nebula.release}}. service: type: NodePort externalTrafficPolicy: Local @@ -76,7 +76,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `2.5.1`, memory: "1Gi" replicas: 1 image: vesoft/nebula-metad - version: {{nebula.branch}} //Change the value from v2.5.1 to {{nebula.branch}}. + version: v{{nebula.release}} //Change the value from {{operator.upgrade_from}} to v{{nebula.release}}. dataVolumeClaim: resources: requests: @@ -97,7 +97,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `2.5.1`, memory: "1Gi" replicas: 3 image: vesoft/nebula-storaged - version: {{nebula.branch}} //Change the value from v2.5.1 to {{nebula.branch}}. + version: v{{nebula.release}} //Change the value from {{operator.upgrade_from}} to v{{nebula.release}}. dataVolumeClaim: resources: requests: @@ -121,7 +121,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `2.5.1`, kubectl apply -f apps_v1alpha1_nebulacluster.yaml ``` -4. After waiting for about 2 minutes, run the following command to see if the image versions of the services in the cluster have been changed to {{nebula.branch}}. +4. After waiting for about 2 minutes, run the following command to see if the image versions of the services in the cluster have been changed to v{{nebula.release}}. ```bash kubectl get pods -l app.kubernetes.io/cluster=nebula -o jsonpath="{.items[*].spec.containers[*].image}" |tr -s '[[:space:]]' '\n' |sort |uniq -c @@ -130,9 +130,9 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `2.5.1`, Output: ```bash - 1 vesoft/nebula-graphd:{{nebula.branch}} - 1 vesoft/nebula-metad:{{nebula.branch}} - 3 vesoft/nebula-storaged:{{nebula.branch}} + 1 vesoft/nebula-graphd:v{{nebula.release}} + 1 vesoft/nebula-metad:v{{nebula.release}} + 3 vesoft/nebula-storaged:v{{nebula.release}} ``` ## Upgrade a Nebula Graph cluster with Helm @@ -158,13 +158,13 @@ You have created a Nebula Graph cluster with Helm. For details, see [Create a Ne 3. Upgrade a Nebula Graph cluster. - For example, upgrade a cluster to {{nebula.branch}}. + For example, upgrade a cluster to v{{nebula.release}}. ```bash helm upgrade "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \ --namespace="${NEBULA_CLUSTER_NAMESPACE}" \ --set nameOverride=${NEBULA_CLUSTER_NAME} \ - --set nebula.version={{nebula.branch}} + --set nebula.version=v{{nebula.release}} ``` The value of `--set nebula.version` specifies the version of the cluster you want to upgrade to. @@ -190,7 +190,7 @@ You have created a Nebula Graph cluster with Helm. For details, see [Create a Ne ```bash $ kubectl get pods -l app.kubernetes.io/cluster=nebula -o jsonpath="{.items[*].spec.containers[*].image}" |tr -s '[[:space:]]' '\n' |sort |uniq -c - 1 vesoft/nebula-graphd:{{nebula.branch}} - 1 vesoft/nebula-metad:{{nebula.branch}} - 3 vesoft/nebula-storaged:{{nebula.branch}} - ``` \ No newline at end of file + 1 vesoft/nebula-graphd:v{{nebula.release}} + 1 vesoft/nebula-metad:v{{nebula.release}} + 3 vesoft/nebula-storaged:v{{nebula.release}} + ``` diff --git a/mkdocs.yml b/mkdocs.yml index c907e114447..b8b75cb689a 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -124,6 +124,8 @@ extra: operator: release: 1.1.0 branch: release-1.1 + upgrade_from: 3.0.0 + upgrade_to: 3.1.x exporter: release: 3.0.0 branch: release-3.1 @@ -492,21 +494,21 @@ nav: - Export data from Nebula Graph: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md - Exchange FAQ: nebula-exchange/ex-ug-FAQ.md -# excluded in 3.0.0 - Nebula Operator: -# - What is Nebula Operator: nebula-operator/1.introduction-to-nebula-operator.md -# - Overview of using Nebula Operator: nebula-operator/6.get-started-with-operator.md -# - Deploy Nebula Operator: nebula-operator/2.deploy-nebula-operator.md -# - Deploy clusters: -# - Deploy clusters with Kubectl: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md -# - Deploy clusters with Helm: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md -# - Configure clusters: -# - Custom configuration parameters for a Nebula Graph cluster: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md -# - Reclaim PVs: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md -# #banlance-3.1 notice Exclude - Balance storage data after scaling out: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md -# - Upgrade Nebula Graph clusters: nebula-operator/9.upgrade-nebula-cluster.md -# - Connect to Nebula Graph databases: nebula-operator/4.connect-to-nebula-graph-service.md -# - Self-healing: nebula-operator/5.operator-failover.md -# - FAQ: nebula-operator/7.operator-faq.md + - Nebula Operator: + - What is Nebula Operator: nebula-operator/1.introduction-to-nebula-operator.md + - Overview of using Nebula Operator: nebula-operator/6.get-started-with-operator.md + - Deploy Nebula Operator: nebula-operator/2.deploy-nebula-operator.md + - Deploy clusters: + - Deploy clusters with Kubectl: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md + - Deploy clusters with Helm: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md + - Configure clusters: + - Custom configuration parameters for a Nebula Graph cluster: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md + - Reclaim PVs: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md + - Balance storage data after scaling out: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + - Upgrade Nebula Graph clusters: nebula-operator/9.upgrade-nebula-cluster.md + - Connect to Nebula Graph databases: nebula-operator/4.connect-to-nebula-graph-service.md + - Self-healing: nebula-operator/5.operator-failover.md + - FAQ: nebula-operator/7.operator-faq.md - Nebula Algorithm: nebula-algorithm.md