From e4c379b89675eea1a38aaf9b7ed66d555cc7f9fc Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 26 Jun 2023 19:26:28 +0800 Subject: [PATCH 1/2] add operator faqs --- .../3.1create-cluster-with-kubectl.md | 2 +- docs-2.0/nebula-operator/7.operator-faq.md | 49 +++++++++++++++++++ mkdocs.yml | 8 +-- 3 files changed, 54 insertions(+), 5 deletions(-) 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 5bce2ba952c..219d42be444 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 @@ -153,7 +153,7 @@ The following shows how to scale out a NebulaGraph cluster by changing the numbe 3. Check the number of Storage services. ```bash - kubectl get pods -l app.kubernetes.io/cluster=nebula + kubectl get pods -l app.kubernetes.io/cluster=nebula ``` Output: diff --git a/docs-2.0/nebula-operator/7.operator-faq.md b/docs-2.0/nebula-operator/7.operator-faq.md index ea95c5a6d79..2436fe93fd4 100644 --- a/docs-2.0/nebula-operator/7.operator-faq.md +++ b/docs-2.0/nebula-operator/7.operator-faq.md @@ -15,3 +15,52 @@ It is suggested to back up data in advance so that you can roll back data in cas ## Is the replica in the Operator docs the same as the replica in the NebulaGraph core docs? They are different concepts. A replica in the Operator docs indicates a pod replica in K8s, while a replica in the core docs is a replica of a NebulaGraph storage partition. + + +## How to view the logs of each service in the NebulaGraph cluster? + +The logs for the NebulaGraph cluster are not gathered in the K8s cluster, which also means that they cannot be retrieved through the `kubectl logs` command. To obtain the logs of each cluster service, you need to access the container and view the log files that are stored inside. This is the only option available for users to get the service logs individually in the NebulaGraph cluster. + +Steps to view the logs of each service in the NebulaGraph cluster: + +```bash +# To view the name of the pod where the container you want to access is located. +# Replace with the name of the cluster. +kubectl get pods -l app.kubernetes.io/cluster= + +# To access the container within the pod, such as the nebula-graphd-0 container. +kubectl exec -it nebula-graphd-0 -- /bin/bash + +# To go to /usr/local/nebula/logs directory to view the logs. +cd /usr/local/nebula/logs +``` + +## How to resolve the `host not found:nebula--0.nebula.-headless.default.svc.cluster.local` error? + +This error is generally caused by a DNS resolution failure, and you need to check whether the cluster domain has been modified. If the cluster domain has been modified, you need to modify the `kubernetesClusterDomain` field in the NebulaGraph Operator configuration file accordingly. The steps for modifying the Operator configuration file are as follows: + +1. View the Operator configuration file. + + ```yaml + [abby@master ~]$ helm show values nebula-operator/nebula-operator + image: + nebulaOperator: + image: vesoft/nebula-operator:{{operator.tag}} + imagePullPolicy: Always + kubeRBACProxy: + image: gcr.io/kubebuilder/kube-rbac-proxy:v0.13.0 + imagePullPolicy: Always + kubeScheduler: + image: registry.k8s.io/kube-scheduler:v1.24.11 + imagePullPolicy: Always + + imagePullSecrets: [] + kubernetesClusterDomain: "" # The cluster domain name, and the default is cluster.local. + ``` + +2. Modify the `kubernetesClusterDomain` field to the updated cluster domain name. + + ``` + helm upgrade nebula-operator nebula-operator/nebula-operator --namespace= --version={{operator.release}} --set kubernetesClusterDomain= + ``` + is the namespace where Operator is located and is the updated domain name. diff --git a/mkdocs.yml b/mkdocs.yml index e7801e8563c..ed7d418608d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -240,11 +240,11 @@ extra: branch: release-1.2 tag: v1.2.0 operator: - release: 1.5.0 - tag: v1.5.0 - branch: release-1.5 + release: 1.4.2 + tag: v1.4.2 + branch: release-1.4 upgrade_from: 3.0.0 - upgrade_to: 3.5.0 + upgrade_to: 3.4.1 exporter: release: 3.3.0 branch: release-3.3 From 4b53a83b7829e3bfe5039a732add2ac752a64cb7 Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 26 Jun 2023 19:28:49 +0800 Subject: [PATCH 2/2] Update 7.operator-faq.md --- docs-2.0/nebula-operator/7.operator-faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-operator/7.operator-faq.md b/docs-2.0/nebula-operator/7.operator-faq.md index 2436fe93fd4..5762130a44c 100644 --- a/docs-2.0/nebula-operator/7.operator-faq.md +++ b/docs-2.0/nebula-operator/7.operator-faq.md @@ -58,7 +58,7 @@ This error is generally caused by a DNS resolution failure, and you need to chec kubernetesClusterDomain: "" # The cluster domain name, and the default is cluster.local. ``` -2. Modify the `kubernetesClusterDomain` field to the updated cluster domain name. +2. Modify the value of the `kubernetesClusterDomain` field to the updated cluster domain name. ``` helm upgrade nebula-operator nebula-operator/nebula-operator --namespace= --version={{operator.release}} --set kubernetesClusterDomain=