add-agent-config-desc

docs-2.0/nebula-operator/10.backup-restore-using-operator.md

@@ -46,6 +46,20 @@ To backup and restore data using NebulaGraph Operator, the following conditions
 - The cluster executing incremental backups and the cluster specified for the last backup must be the same, and the (storage bucket) path for the last backup must be the same.
 - Ensure that the time between each incremental backup and the last backup is less than a `wal_ttl`.
 - Specifying the backup data of a specified graph space is not supported.
+- Before backing up data, you need to create a Secret to restore the credential for pulling the image of the BR-ent tool.
+
+  ```
+  kubectl - <nebula> create secret docker-registry <br-ent-secret> \
+  --docker-server=REGISTRY_SERVER \
+  --docker-username=REGISTRY_USERNAME \
+  --docker-password=REGISTRY_PASSWORD \
+  ```
+
+  - `<nebula>`: The namespace where the Secret is located.
+  - `<br-ent-secret>`: The name of the Secret.
+  - `REGISTRY_SERVER`: The address of the private image repository server from which the image is pulled, for example, `reg.example-inc.com`.
+  - `REGISTRY_USERNAME`: The username for logging in to the private image repository server.
+  - `REGISTRY_PASSWORD`: The password for logging in to the private image repository server.
 
 ### Full backup
 
@@ -63,6 +77,8 @@ spec:
   ttlSecondsAfterFinished: 60
   template:
     spec:
+      imagePullSecrets: 
+        - name: br-ent-secret  # The name of the Secret for pulling the image of the BR-ent tool.
       restartPolicy: OnFailure
       containers:
         - image: vesoft/br-ent:v{{br_ent.release}}

docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md

@@ -72,6 +72,7 @@ The following example shows how to create a NebulaGraph cluster by creating a cl
     | `spec.storaged.dataVolumeClaims.resources.storageClassName` | - | The data disk storage configurations for Storaged. If not specified, the global storage parameter is applied. |
     | `spec.storaged.logVolumeClaim.storageClassName`|-                                           | The log disk storage configurations for the Storaged service.|
     | `spec.storaged.enableAutoBalance` | `true` |Whether to balance data automatically. |
+    |`spec.agent`|`{}`| Configuration of the Agent service. This is used for backup and recovery as well as log cleanup functions. If you do not customize this configuration, the default configuration will be used.|
     | `spec.reference.name`        | -                                                            | The name of the dependent controller.           |
     | `spec.schedulerName`         | -                                                            | The scheduler name.                 |
     | `spec.imagePullPolicy`       | The image policy to pull the NebulaGraph image. For details, see [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy). | The image pull policy in Kubernetes.               |

docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md

@@ -206,4 +206,5 @@ helm uninstall nebula --namespace=nebula
 | `nebula.storaged.readinessProbe` |  `{}` | ReadinessProbe for the Metad pod. |
 | `nebula.storaged.sidecarContainers` |  `{}` | Sidecar containers for the Metad pod. |
 | `nebula.storaged.sidecarVolumes` | `{}` | Sidecar volumes for the Metad pod. |
+|`nebula.agent`|`{}`| Configuration of the Agent service. This is used for backup and recovery as well as log cleanup functions. If you do not customize this configuration, the default configuration will be used.|
 | `imagePullSecrets`          | `[]`                                                         | The Secret to pull the NebulaGraph Enterprise cluster image.                                           |