From 3733145273d67ef9838a9238d31cd25190efd3a6 Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 16 Nov 2021 15:22:45 +0800 Subject: [PATCH] add crd updates --- docs-2.0/20.appendix/6.eco-tool-version.md | 2 +- .../2.deploy-nebula-operator.md | 51 ++++++++++++++++++- .../4.connect-to-nebula-graph-service.md | 4 +- 3 files changed, 52 insertions(+), 5 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 53aea374fab..18e6b2b3fc1 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -68,7 +68,7 @@ Nebula Operator (Operator for short) is a tool to automate the deployment, opera |Nebula Graph version|Operator version（commit id）| |:---|:---| -| {{ nebula.release }} | {{operator.release}}（6d1104e） | +| {{ nebula.release }} | {{operator.release}}（ba88e28） | ## Nebula Importer 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 d171aa517bb..446b3be595d 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:latest + image: vesoft/nebula-operator:{{operator.branch}} 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:latest` | The image of Nebula Operator, version of which is {{operator.release}}. | +| `image.nebulaOperator.image` | `vesoft/nebula-operator:{{operator.branch}}` | 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. | @@ -197,6 +197,53 @@ After installing Nebula Operator, you can update it by modifying the parameter v ```bash helm upgrade nebula-operator nebula-operator/nebula-operator --namespace= --version={{operator.release}} ``` + + For example: + + ```bash + helm upgrade nebula-operator nebula-operator/nebula-operator --namespace=nebula-operator-system --version={{operator.release}} + ``` + + Output: + + ```bash + Release "nebula-operator" has been upgraded. Happy Helming! + NAME: nebula-operator + LAST DEPLOYED: Tue Nov 16 02:21:08 2021 + NAMESPACE: nebula-operator-system + STATUS: deployed + REVISION: 3 + TEST SUITE: None + NOTES: + Nebula Operator installed! + ``` + +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). + + ```bash + helm pull nebula-operator/nebula-operator + ``` + +4. Upgrade the CRD configuration file. + + ```bash + kubectl apply -f .yaml + ``` + + For example: + + ```bash + kubectl apply -f config/crd/bases/apps.nebula-graph.io_nebulaclusters.yaml + ``` + + Output: + + ```bash + customresourcedefinition.apiextensions.k8s.io/nebulaclusters.apps.nebula-graph.io created + ``` ### Uninstall Nebula Operator 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 1f125912bba..0fc44bd49ce 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 @@ -151,9 +151,9 @@ Nginx Ingress is an implementation of Kubernetes Ingress. Nginx Ingress watches You can use Nginx Ingress to connect to a Nebula Graph cluster from outside the cluster using a combination of the HostNetwork and DaemonSet pattern. -As HostNetwork is used，the Nginx Ingress pod cannot be scheduled to the same node. To avoid listening port conflicts, some nodes can be selected and labeled as edge nodes in advance, which are specially used for Nginx Ingress deployment. Nginx Ingress is then deployed on these nodes in a DaemonSet mode. +As HostNetwork is used, the Nginx Ingress pod cannot be scheduled to the same node. To avoid listening port conflicts, some nodes can be selected and labeled as edge nodes in advance, which are specially used for the Nginx Ingress deployment. Nginx Ingress is then deployed on these nodes in a DaemonSet mode. -Ingress does not support TCP or UDP services. For this reason，the nginx-ingress-controller pod uses the flags `--tcp-services-configmap` and `--udp-services-configmap` to point to an existing ConfigMap where the key refers to the external port to be used and the value refers to the format of the service to be exposed. The format of the value `:`. +Ingress does not support TCP or UDP services. For this reason, the nginx-ingress-controller pod uses the flags `--tcp-services-configmap` and `--udp-services-configmap` to point to an existing ConfigMap where the key refers to the external port to be used and the value refers to the format of the service to be exposed. The format of the value is `:`. For example, the configurations of the ConfigMap named as `tcp-services` is as follows: