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 1532adb9713..a30808415a2 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 @@ -48,4 +48,4 @@ The Nebula Operator scaling feature is only available for the Enterprise Edition ## Release note -[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/v{{operator.tag}}) \ No newline at end of file +[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/{{operator.tag}}) \ 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 481ffafb59c..5274cd8dd1a 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:v{{operator.release}} + image: vesoft/nebula-operator:{{operator.tag}} 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:v{{operator.release}}` | The image of Nebula Operator, version of which is {{operator.release}}. | +| `image.nebulaOperator.image` | `vesoft/nebula-operator:{{operator.tag}}` | 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. | @@ -195,7 +195,7 @@ For more information about `helm install`, see [Helm Install](https://helm.sh/do helm repo update ``` -2. Upgrade Operator to v{{operator.release}}. +2. Upgrade Operator to {{operator.tag}}. ```bash helm upgrade nebula-operator nebula-operator/nebula-operator --namespace= --version={{operator.release}} @@ -224,7 +224,7 @@ For more information about `helm install`, see [Helm Install](https://helm.sh/do 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/v{{operator.release}}/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/{{operator.tag}}/config/crd/bases/apps.nebula-graph.io_nebulaclusters.yaml). 1. Pull the Nebula Operator chart package. @@ -236,7 +236,7 @@ For more information about `helm install`, see [Helm Install](https://helm.sh/do 2. Run `tar -zxvf` to unpack the charts. - For example: To unpack v{{operator.release}} chart to the `/tmp` path, run the following command: + For example: To unpack {{operator.tag}} chart to the `/tmp` path, run the following command: ```bash tar -zxvf nebula-operator-{{operator.release}}.tgz -C /tmp 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 aefefe4a9ee..3f7c9e355f2 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 @@ -32,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: v{{nebula.release}} + version: {{nebula.tag}} service: type: NodePort externalTrafficPolicy: Local @@ -51,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: v{{nebula.release}} + version: {{nebula.tag}} dataVolumeClaim: resources: requests: @@ -72,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: v{{nebula.release}} + version: {{nebula.tag}} dataVolumeClaim: resources: requests: @@ -97,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` | `v{{nebula.release}}` | The version of the Graphd service. | + | `spec.graphd.version` | `{{nebula.tag}}` | 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` | `v{{nebula.release}}` | The version of the Metad service. | + | `spec.metad.version` | `{{nebula.tag}}` | 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` | `v{{nebula.release}}` | The version of the Storaged service. | + | `spec.storaged.version` | `{{nebula.tag}}` | 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. | @@ -165,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: v{{nebula.release}} + version: {{nebula.tag}} 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 181cd8c3d20..67e1c6c0e0f 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 @@ -90,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/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. +You can click on [nebula-cluster/values.yaml](https://github.com/vesoft-inc/nebula-operator/blob/{{operator.tag}}/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 @@ -109,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` | `v{{nebula.release}}` | The version of Nebula Graph. | +| `nebula.version` | `{{nebula.tag}}` | 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 364c83f5639..644bb620fef 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/v{{operator.release}}/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/{{operator.tag}}/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 74bc068e0ac..89575a801c9 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: v{{nebula.release}} + version: {{nebula.tag}} storageClaim: resources: requests: 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 6c154c38c81..d04b042efa4 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: v{{nebula.release}} + version: {{nebula.tag}} 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: v{{nebula.release}} + version: {{nebula.tag}} 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: v{{nebula.release}} + version: {{nebula.tag}} ... ``` 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 f5fb692b75b..5db5e886eb2 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: v{{nebula.release}} + version: {{nebula.tag}} 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: v{{nebula.release}} + version: {{nebula.tag}} 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: v{{nebula.release}} + version: {{nebula.tag}} ... ``` 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 5f8d59d5648..6d5aa0bc29b 100644 --- a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md +++ b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md @@ -37,7 +37,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `{{opera 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 {{operator.upgrade_from}} to v{{nebula.release}}. +2. Edit the `apps_v1alpha1_nebulacluster.yaml` file by changing the values of all the `version` parameters from {{operator.upgrade_from}} to {{nebula.tag}}. 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 `{{opera memory: "1Gi" replicas: 1 image: vesoft/nebula-graphd - version: v{{nebula.release}} //Change the value from {{operator.upgrade_from}} to v{{nebula.release}}. + version: {{nebula.tag}} //Change the value from {{operator.upgrade_from}} to {{nebula.tag}}. service: type: NodePort externalTrafficPolicy: Local @@ -76,7 +76,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `{{opera memory: "1Gi" replicas: 1 image: vesoft/nebula-metad - version: v{{nebula.release}} //Change the value from {{operator.upgrade_from}} to v{{nebula.release}}. + version: {{nebula.tag}} //Change the value from {{operator.upgrade_from}} to {{nebula.tag}}. dataVolumeClaim: resources: requests: @@ -97,7 +97,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `{{opera memory: "1Gi" replicas: 3 image: vesoft/nebula-storaged - version: v{{nebula.release}} //Change the value from {{operator.upgrade_from}} to v{{nebula.release}}. + version: {{nebula.tag}} //Change the value from {{operator.upgrade_from}} to {{nebula.tag}}. dataVolumeClaim: resources: requests: @@ -121,7 +121,7 @@ The version of the Nebula Graph cluster to be upgraded in this topic is `{{opera 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 v{{nebula.release}}. +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.tag}}. ```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 `{{opera Output: ```bash - 1 vesoft/nebula-graphd:v{{nebula.release}} - 1 vesoft/nebula-metad:v{{nebula.release}} - 3 vesoft/nebula-storaged:v{{nebula.release}} + 1 vesoft/nebula-graphd:{{nebula.tag}} + 1 vesoft/nebula-metad:{{nebula.tag}} + 3 vesoft/nebula-storaged:{{nebula.tag}} ``` ## 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 v{{nebula.release}}. + For example, upgrade a cluster to {{nebula.tag}}. ```bash helm upgrade "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \ --namespace="${NEBULA_CLUSTER_NAMESPACE}" \ --set nameOverride=${NEBULA_CLUSTER_NAME} \ - --set nebula.version=v{{nebula.release}} + --set nebula.version={{nebula.tag}} ``` 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:v{{nebula.release}} - 1 vesoft/nebula-metad:v{{nebula.release}} - 3 vesoft/nebula-storaged:v{{nebula.release}} + 1 vesoft/nebula-graphd:{{nebula.tag}} + 1 vesoft/nebula-metad:{{nebula.tag}} + 3 vesoft/nebula-storaged:{{nebula.tag}} ```