Replica of 3.6.0 (#2325)

* Update mkdocs.yml * release 3.6.0 (#2222) * release 3.6.0 * Update mkdocs.yml --------- Co-authored-by: abby.huang <[email protected]> * Update nebula-comm-release-note.md * Update 1.text-based-index-restrictions.md * Update mkdocs.yml * Update nebula-comm-release-note.md * Update 1.introduction-to-nebula-operator.md * add compile using docker (#2223) * add compile using docker * Update 7.compile-using-docker.md * Update canvas-snapshot.md * index desc updates (#2227) * Update 1.numeric.md * helm chart install updates (#2228) * Update 2.management-user.md * exchange vid support prefix (#2232) (#2233) * Update use-importer.md * Update upgrade-nebula-ent-from-3.x-3.4.md (#2234) * add-find-single-shortest-path (#2236) * Update ex-ug-export-from-nebula.md * Update 4.ldap.md * Update 0-2.relates.md * Update logs.md * Update 0.FAQ.md * add-reserved-keywords-in-ent3.6.0 (#2237) * Update 1.configurations.md * Update 4.schema.md * hide ent-content in 3.6.0 (#2238) * hide ent-content in 3.6.0 * Update mkdocs.yml * tag more ent content * more fixes * Update 1.quick-start-workflow.md * add the inner join clause doc (#2239) * add the inner join clause doc * Update 2.find-path.md * Update use-importer.md * sync-sc-to-v3.6.0-ent (#2242) * Update mkdocs.yml * fix links (#2243) * Update 1.text-based-index-restrictions.md * Update 3.graph-config.md * Update 1.authentication.md * Update 2.compile-br.md * Update mkdocs.yml (#2244) * Update st-ug-limitations.md * Update st-ug-import-data.md * Update 11.import-data.md * Update st-ug-import-data.md * Update use-importer.md * Update use-importer.md * Update notification-endpoint.md * dashboard advanced config (#2245) * balance leader desc updates (#2247) * Update notification-endpoint.md * Update 2.deploy-connect-dashboard-ent.md (#2248) * Update manage-storage-host.md (#2249) * Update 2.deploy-connect-dashboard-ent.md * Update 4.storage-config.md * comment fixes (#2252) * Update 5.show-native-index-status.md * Update 9.notification.md * Update notification-endpoint.md * update screenshots (#2256) * fixed missing installation step (#2257) * Update 3.2create-cluster-with-helm.md * [TO BE REVIEWED]v3.5.0-sc core-zone updates (#2250) (#2258) * v3.5.0-sc core-zone updates additions v3.5.0-sc core-zone updates * updates * Update 5.zone.md * Update docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md * fix comment * comment fix and change routing to reading * Update 3.graph-config.md * commit fix * comment fix * Update docs-2.0/4.deployment-and-installation/5.zone.md * Update 5.zone.md * fix comments * [wip] [sc]updates for operator (#2255) (#2259) * Update 4.ssl.md (#2260) added enable_storage_ssl * Update 6.delete-tag.md (#2262) * Update 1.search-with-text-based-index.md * Opt fix (#2266) * two more opts * ttl opts Update ttl-options.md * operator-version-updated (#2269) * returned info updates using docker compose deployment (#2270) * Update 5.zone.md * add note for using memtracker (#2271) * Remove parameters from dynamic flags (#2273) * update (#2276) * dashboard database user (#2275) * dashboard database user * update * Update 1.configurations.md (#2279) * example of scope and order of variable and set operator (#2280) * update explorer iframe (#2282) * update (#2281) * update * Update docs-2.0/nebula-dashboard-ent/8.faq.md * Update docs-2.0/nebula-explorer/faq.md * Update ex-ug-deploy.md * Update faq.md * Update nebula-console.md * Update nebula-console.md * Update 1.numeric.md * update use-importer.md: add notes on csv delimiter (#2285) (#2287) * update use-importer.md add notes on csv delimiter * Update docs-2.0/nebula-importer/use-importer.md --------- Co-authored-by: jyf111 <[email protected]> * update alter user (#2289) * Update 2.management-user.md * Update 2.management-user.md * rotate audit logs (#2296) * rotate audit logs * Update audit-log.md * Update audit-log.md * Update audit-log.md * Update audit-log.md * record slow queries in log files (#2297) * record slow queries in log files * Update 3.graph-config.md * remove DML from slow queries (#2298) * 3.6.0 ent release note (#2300) * 3.6.0 ent release note * Update nebula-ent-release-note.md * Update nebula-ent-release-note.md * Update nebula-ent-release-note.md * Update 3.graph-config.md * Update source-monitoring-metrics.md * Explorer compatibility (#2299) * explorer/studio compatibility * Update ex-ug-deploy.md * Update ex-ug-deploy.md * Update studio-release-note.md * Update st-ug-what-is-graph-studio.md * Update explorer-release-note.md * Update studio-release-note.md * Update ex-ug-deploy.md * change zone fields to dynamically configurable (#2304) * upgrade-doc-for-3.6.0-ent (#2303) * upgrade-doc-for-3.6.0-ent * Update upgrade-nebula-ent-from-3.x-3.4.md * Update upgrade-nebula-ent-from-3.x-3.4.md * Update upgrade-nebula-ent-from-3.x-3.4.md * upgrade 2.x-3.x (#2305) * Update nebula-ent-release-note.md * Update nebula-ent-release-note.md * Update ex-ug-connect.md * Importer 4.1.0 update (#2286) * importer 4.1.0 support ssl (#2284) * importer 4.1.0 support ssl * update * Update mkdocs.yml * Operator updates for 3.6.0 (#2277) * operator-updates-for-3.6.0 * operator-updates-for-3.6.0 * Update 3.1create-cluster-with-kubectl.md * Update 3.1create-cluster-with-kubectl.md * Update 3.2create-cluster-with-helm.md * Update 3.2create-cluster-with-helm.md * minor fixes * Update 4.connect-to-nebula-graph-service.md * Update 4.connect-to-nebula-graph-service.md * Update 8.5.enable-ssl.md * add schedulerName * comment fix * studio 3.8.0 (#2307) * studio 3.8.0 * Update docs-2.0/20.appendix/release-notes/studio-release-note.md * Update Java and go client versions (#2308) * Filter out community content and support bilingual (#2314) * Update keywords-and-reserved-words.md * Update keywords-and-reserved-words.md * new docs pv expansion & admission control (#2319) * new docs pv expansion & admission control 1. add new docs pv expansion & admission control 2. reorganize content catalogue * add operator 1.7.x * keep operator comm content consistency between en & ch (#2318) * keep operator comm content consistency between en & ch * broken link fix * Add operator port (#2320) * Add operator port * Update port desc * Update docs-2.0-zh/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md * Update port --------- Co-authored-by: abby.huang <[email protected]> --------- Co-authored-by: cooper-lzy <[email protected]> Co-authored-by: abby.huang <[email protected]> Co-authored-by: Omar Arab Oghli <[email protected]> Co-authored-by: jyf111 <[email protected]>
vesoft-inc · Oct 31, 2023 · 6385157 · 6385157
1 parent f88fdfa
commit 6385157
Show file tree

Hide file tree

Showing 21 changed files with 916 additions and 90 deletions.
diff --git a/.github/workflows/deploy-all.yml b/.github/workflows/deploy-all.yml
@@ -9,6 +9,7 @@ on:
     # Remember to add v before the following version number unless the version is master.
       - master
 
+
 jobs:
   deploy-zh:
     uses: ./.github/workflows/deploy-zh.yml

diff --git a/.github/workflows/deploy-en.yml b/.github/workflows/deploy-en.yml
@@ -1,12 +1,16 @@
 name: Publish English docs via GitHub Pages
 env:
+
   ACTIONTEST: master # no need to add v before the version number
+
 on:
   workflow_call:
   push:
     branches:
     # Remember to add v before the following version number unless the version is master.
+
       - master
+
     paths:
       - 'docs-2.0-en/**'
 
@@ -35,6 +39,7 @@ jobs:
           git fetch origin gh-pages --depth=1 # fix mike's CI update
           mike list
           mike deploy ${{ env.ACTIONTEST }}  -p --rebase
+
       #   The set-default command is only applicable to the latest version and must be commented in older versions.
       #    mike set-default ${{ env.ACTIONTEST }} -p --rebase
       #    mike list

diff --git a/.github/workflows/deploy-zh.yml b/.github/workflows/deploy-zh.yml
@@ -1,15 +1,19 @@
 name: Publish Chinese docs via GitHub Pages and upload to server
 env:
 # Remember to add v before the following version number unless the version is master.
+
   ACTIONTEST: master
+
 on:
   workflow_call:
     secrets:
       ZHSITE_PASSWORD:
         required: true
   push:
     branches:
+
       - master
+
     paths:
       - 'docs-2.0-zh/**'
 
@@ -43,9 +47,11 @@ jobs:
           git fetch origin gh-pages-zh --depth=1 # fix mike's CI update
           mike list
           mike deploy ${{ env.ACTIONTEST }} -b gh-pages-zh -p --rebase
+
       # The set-default command is only applicable to the latest version and must be commented in older versions.
       #   mike set-default ${{ env.ACTIONTEST }} -b gh-pages-zh -p --rebase
       #   mike list
+
 
       - name: show Chinese git branches
         run: |

diff --git a/docs-2.0-en/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md b/docs-2.0-en/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md
@@ -163,6 +163,7 @@ ELSE
 END
 ENDS
 ENDS_WITH
+FALSE
 FORCE
 FULLTEXT
 FUZZY
@@ -230,6 +231,7 @@ TEXT
 TEXT_SEARCH
 THEN
 TOP
+TRUE
 TTL_COL
 TTL_DURATION
 UNWIND
@@ -242,6 +244,4 @@ VID_TYPE
 WILDCARD
 ZONE
 ZONES
-FALSE
-TRUE
 ```
diff --git a/docs-2.0-en/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0-en/nebula-operator/1.introduction-to-nebula-operator.md
@@ -32,7 +32,7 @@ NebulaGraph Operator does not support the v1.x version of NebulaGraph. NebulaGra
 
 | NebulaGraph   | NebulaGraph Operator |
 | ------------- | -------------------- |
-| 3.5.x ~ 3.6.0 | 1.5.0, 1.6.x         |
+| 3.5.x ~ 3.6.0 | 1.5.0 ~ 1.7.x        |
 | 3.0.0 ~ 3.4.1 | 1.3.0, 1.4.0 ~ 1.4.2 |
 | 3.0.0 ~ 3.3.x | 1.0.0, 1.1.0, 1.2.0  |
 | 2.5.x ~ 2.6.x | 0.9.0                |
@@ -43,9 +43,6 @@ NebulaGraph Operator does not support the v1.x version of NebulaGraph. NebulaGra
     - The 1.x version NebulaGraph Operator is not compatible with NebulaGraph of version below v3.x.
     - Starting from NebulaGraph Operator 0.9.0, logs and data are stored separately. Using NebulaGraph Operator 0.9.0 or later versions to manage a NebulaGraph 2.5.x cluster created with Operator 0.8.0 can cause compatibility issues. You can backup the data of the NebulaGraph 2.5.x cluster and then create a 2.6.x cluster with Operator 0.9.0.
 
-### Feature limitations
-
-The NebulaGraph Operator scaling feature is only available for the Enterprise Edition of NebulaGraph clusters and does not support scaling the Community Edition version of NebulaGraph clusters.
 
 ## Release note
 

diff --git a/docs-2.0-en/nebula-operator/2.deploy-nebula-operator.md b/docs-2.0-en/nebula-operator/2.deploy-nebula-operator.md
@@ -18,7 +18,8 @@ Before installing NebulaGraph Operator, you need to install the following softwa
 
 !!! note
 
-    - If using a role-based access control policy, you need to enable [RBAC](https://kubernetes.io/docs/admin/authorization/rbac) (optional).
+    - If using a role-based access control policy, you need to enable [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/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.
 

diff --git a/...nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md b/...nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md
diff --git a/...en/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md b/...en/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md
@@ -65,23 +65,11 @@
   kubectl -n "${NEBULA_CLUSTER_NAMESPACE}" get pod -l "app.kubernetes.io/cluster=${NEBULA_CLUSTER_NAME}"
   ```
 
-  Output:
-
-  ```bash
-  NAME                READY   STATUS    RESTARTS   AGE
-  nebula-graphd-0     1/1     Running   0          5m34s
-  nebula-graphd-1     1/1     Running   0          5m34s
-  nebula-metad-0      1/1     Running   0          5m34s
-  nebula-metad-1      1/1     Running   0          5m34s
-  nebula-metad-2      1/1     Running   0          5m34s
-  nebula-storaged-0   1/1     Running   0          5m34s
-  nebula-storaged-1   1/1     Running   0          5m34s
-  nebula-storaged-2   1/1     Running   0          5m34s
-  ```
 
 ## Scaling clusters
 
-- The cluster scaling feature is for NebulaGraph Enterprise Edition only. 
+The cluster scaling feature is for NebulaGraph Enterprise Edition only.
+
 
 ## Delete clusters
 

diff --git a/...en/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md b/...en/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md
@@ -1,6 +1,8 @@
-# Customize configuration parameters for a NebulaGraph cluster
 
-Meta, Storage, and Graph services in a NebulaGraph Cluster have their own configuration settings, which are defined in the YAML file of the NebulaGraph cluster instance as `config`. These settings are mapped and loaded into the corresponding service's ConfigMap in Kubernetes. At the time of startup, the configuration present in the ConfigMap is mounted onto the directory `/usr/local/nebula/etc/` for every service.
+# Customize parameters for a NebulaGraph cluster
+
+Meta, Storage, and Graph services in a NebulaGraph cluster have their own configuration settings, which are defined in the YAML file of the NebulaGraph cluster instance as `config`. These settings are mapped and loaded into the corresponding service's ConfigMap in Kubernetes. At the time of startup, the configuration present in the ConfigMap is mounted onto the directory `/usr/local/nebula/etc/` for every service.
+
 
 !!! note
 
@@ -11,6 +13,9 @@ The structure of `config` is as follows.
 ```go
 Config map[string]string `json:"config,omitempty"`
 ```
+
+
+
 ## Prerequisites
 
 You have created a NebulaGraph cluster. For how to create a cluster with Kubectl, see [Create a cluster with Kubectl](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md). 
@@ -25,7 +30,9 @@ The following example uses a cluster named `nebula` and the cluster's configurat
   kubectl edit nebulaclusters.apps.nebula-graph.io nebula
   ```
 
-2. Add `enable_authorize` and `auth_type` under `spec.graphd.config`.
+
+2. Customize parameters under the `spec.graphd.config` field. In the following sample, the `enable_authorize` and `auth_type` parameters are used for demonstration purposes.
+
 
   ```yaml
   apiVersion: apps.nebula-graph.io/v1alpha1
@@ -55,20 +62,122 @@ The following example uses a cluster named `nebula` and the cluster's configurat
         "auth_type": "password"
   ...
   ```
+
+
+  The parameters that can be added under the `config` field are listed in detail in the [Meta service configuration parameters](../../5.configurations-and-logs/1.configurations/2.meta-config.md), [Storage service configuration parameters](../../5.configurations-and-logs/1.configurations/4.storage-config.md), and [Graph service configuration parameters](../../5.configurations-and-logs/1.configurations/3.graph-config.md) topics.
+
+  !!! note
+
+      * To update cluster configurations without incurring pod restart, ensure that all parameters added under the `config` field support runtime dynamic modification. Check the **Whether supports runtime dynamic modifications** column of the parameter tables on the aforementioned parameter details pages to see if a parameter supports runtime dynamic modification.
+      * If one or more parameters that do not support runtime dynamic modification are added under the `config` field, pod restart is required for the parameters to take effect.
+
+
 
   To add the `config` for the Meta and Storage services, add `spec.metad.config` and `spec.storaged.config` respectively.
 
 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.
 
-## Modify cluster configurations online
+  After customizing the parameters, the configurations in the corresponding ConfigMap (`nebula-graphd`) of the Graph service will be overwritten.
+
+
+## Customize port configurations
+
+You can add the `port` and `ws_http_port` parameters under the `config` field to customize port configurations. For details about these two parameters, see the Networking configurations section in [Meta service configuration parameters](../../5.configurations-and-logs/1.configurations/2.meta-config.md), [Storage service configuration parameters](../../5.configurations-and-logs/1.configurations/4.storage-config.md), and [Graph service configuration parameters](../../5.configurations-and-logs/1.configurations/3.graph-config.md). 
+
+!!! note
+
+    * Pod restart is required for the `port` and `ws_http_port` parameters to take effect. 
+    * It is NOT recommnended to modify the `port` parameter after the cluster is started.
+
+1. Modifiy the cluster configuration file.
+
+  ```yaml
+  apiVersion: apps.nebula-graph.io/v1alpha1
+  kind: NebulaCluster
+  metadata:
+    name: nebula
+    namespace: default
+  spec:
+    graphd:
+      config:
+        port: "3669"
+        ws_http_port: "8080"
+      resources:
+        requests:
+          cpu: "200m"
+          memory: "500Mi"
+        limits:
+          cpu: "1"
+          memory: "1Gi"
+      replicas: 1
+      image: vesoft/nebula-graphd
+      version: {{nebula.tag}}
+    metad:
+      config:
+        ws_http_port: 8081
+      resources:
+        requests:
+          cpu: "300m"
+          memory: "500Mi"
+        limits:
+          cpu: "1"
+          memory: "1Gi"
+      replicas: 1
+      image: vesoft/nebula-metad
+      version: {{nebula.tag}}
+      dataVolumeClaim:
+        resources:
+          requests:
+            storage: 2Gi
+        storageClassName: local-path
+    storaged:
+      config:
+        ws_http_port: 8082
+      resources:
+        requests:
+          cpu: "300m"
+          memory: "500Mi"
+        limits:
+          cpu: "1"
+          memory: "1Gi"
+      replicas: 1
+      image: vesoft/nebula-storaged
+      version: {{nebula.tag}}
+      dataVolumeClaims:
+      - resources:
+          requests:
+            storage: 2Gi
+        storageClassName: local-path
+      enableAutoBalance: true
+    reference:
+      name: statefulsets.apps
+      version: v1
+    schedulerName: default-scheduler
+    imagePullPolicy: IfNotPresent
+    imagePullSecrets:
+    - name: nebula-image
+    enablePVReclaim: true
+    topologySpreadConstraints:
+    - topologyKey: kubernetes.io/hostname
+      whenUnsatisfiable: "ScheduleAnyway"
+  ```
 
-Cluster configurations are modified online by calling the HTTP interface, without the need to restart the cluster Pod.
+2. Run the `kubectl apply -f nebula_cluster.yaml` to push your configuration changes to the cluster.
 
-It should be noted that only when all configuration items in `config` are the parameters that can be dynamically modified at runtime, can the operation of online modifications be triggered. If the configuration items in `config` contain parameters that cannot be dynamically modified, then the cluster configuration will be updated by restarting the Pod.
+3. Verify that the configuration takes effect.
 
-For information about the parameters that can be dynamically modified for each service, see the parameter table column of **Whether supports runtime dynamic modifications** in [Meta service configuration parameters](../../5.configurations-and-logs/1.configurations/2.meta-config.md), [Storage service configuration parameters](../../5.configurations-and-logs/1.configurations/4.storage-config.md), and [Graph service configuration parameters](../../5.configurations-and-logs/1.configurations/3.graph-config.md), respectively.
+  ```bash
+  kubectl get svc
+  ```
 
+  Sample response:
 
+  ```
+  NAME                        TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)                      AGE
+  nebula-graphd-headless      ClusterIP   None             <none>        3669/TCP,8080/TCP            10m
+  nebula-graphd-svc           ClusterIP   10.102.13.115    <none>        3669/TCP,8080/TCP            10m
+  nebula-metad-headless       ClusterIP   None             <none>        9559/TCP,8081/TCP            11m
+  nebula-storaged-headless    ClusterIP   None             <none>        9779/TCP,8082/TCP,9778/TCP   11m
+  ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ on: @@
         # Remember to add v before the following version number unless the version is master.
           - master
     jobs:
       deploy-zh:
         uses: ./.github/workflows/deploy-zh.yml
@@ Expand Down @@