diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md index 8570ef53510..b8580dc68ed 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md @@ -230,9 +230,6 @@ graphd: 2. In the `nebula-docker-compose` directory, run `docker-compose pull` to update the images of the Graph Service, Storage Service, and Meta Service. - !!! note - Note that all the Nebula Graph services are stopped before running the command `docker-compose pull`. - 3. Run `docker-compose up -d` to start the Nebula Graph services again. 4. After connecting to Nebula Graph with Nebula Console, run `SHOW HOSTS GRAPH`, `SHOW HOSTS STORAGE`, or `SHOW HOSTS META` to check the version of the responding service respectively. diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md index bbcf8b324b2..9f12966e39a 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md @@ -61,7 +61,9 @@ curl 127.0.0.1:19779/flags ## Configuration files -Nebula Graph provides two initial configuration files for each service, `.conf.default` and `.conf.production`. Users can use them in different scenarios conveniently. The default path is `/usr/local/nebula/etc/`. +### Configuration files for clusters installed from source, with an RPM/DEB package, or a TAR package + +Nebula Graph provides two initial configuration files for each service, `.conf.default` and `.conf.production`. You can use them in different scenarios conveniently. For clusters installed from source and with a RPM/DEB package, the default path is `/usr/local/nebula/etc/`. For clusters installed with a TAR package, the path is `//etc`. The configuration values in the initial configuration file are for reference only and can be adjusted according to actual needs. To use the initial configuration file, choose one of the above two files and delete the suffix `.default` or `.production` to make it valid. @@ -83,9 +85,36 @@ Each initial configuration file of all services contains `local_config`. The def It is not recommended to modify the value of `local_config` to `false`. If modified, the Nebula Graph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. +### Configuration files for clusters installed with Docker Compose + +For clusters installed with Docker Compose, the configuration file's default installation path of the cluster is `/nebula-docker-compose/docker-compose.yaml`. The parameters in the `command` field of the file are the launch parameters for each service. + +### Configuration files for clusters installed with Nebula Operator + +For clusters installed with Kubectl through Nebula Operator, the configuration file's path is the path of the cluster YAML file. You can modify the configuration of each service through the `spec.{graphd|storaged|metad}.config` parameter. + +!!! note + + The services cannot be configured for clusters installed with Helm. + ## Modify configurations -By default, each Nebula Graph service gets configurations from its configuration files. Users can modify configurations and make them valid according to the following steps: +By default, each Nebula Graph service gets configured from its configuration files. You can modify configurations and make them valid according to the following steps: + +* For clusters installed from source, with a RPM/DEB, or a TAR package + + 1. Use a text editor to modify the configuration files of the target service and save the modification. + + 2. Choose an appropriate time to restart **all** Nebula Graph services to make the modifications valid. + +* For clusters installed with Docker Compose + + 1. In the `/nebula-docker-compose/docker-compose.yaml` file, modify the configurations of the target service. + 2. In the `nebula-docker-compose` directory, run the command `docker-compose up -d` to restart the service involving configuration modifications. + +* For clusters installed with Kubectl + + For details, see [Customize configuration parameters for a Nebula Graph cluster](../../nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md). 1. Use a text editor to modify the configuration files of the target service and save the modification. 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 d5b9cbffe8f..cf8ff49075d 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 @@ -18,7 +18,7 @@ You have created a Nebula Graph cluster. For how to create a cluster with Kubect ## Steps -The following example uses a cluster named `nebula` to show how to set `config` for the Graph service in a Nebula Graph cluster. +The following example uses a cluster named `nebula` and the cluster's configuration file named `nebula_cluster.yaml` to show how to set `config` for the Graph service in a Nebula Graph cluster. 1. Run the following command to access the edit page of the `nebula` cluster. @@ -57,6 +57,8 @@ The following example uses a cluster named `nebula` to show how to set `config` ... ``` +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. ## Learn more 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 920e1ad657e..bedf935c81f 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 @@ -12,7 +12,7 @@ You have created a cluster. For how to create a cluster with Kubectl, see [Creat ## Steps -The following example uses a cluster named `nebula` to show how to set `enablePVReclaim`: +The following example uses a cluster named `nebula` and the cluster's configuration file named `nebula_cluster.yaml` to show how to set `enablePVReclaim`: 1. Run the following command to access the edit page of the `nebula` cluster. @@ -96,3 +96,5 @@ The following example uses a cluster named `nebula` to show how to set `enablePV version: {{nebula.branch}} ... ``` + + 3. Run `kubectl apply -f nebula_cluster.yaml` to push your configuration changes to the cluster. 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 8ec9d8792f6..8d7f70dc745 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 @@ -12,7 +12,7 @@ You have created a Nebula Graph cluster. For how to create a cluster with Kubect ## Steps -The following example uses a cluster named `nebula` to show how to set `enableAutoBalance`. +The following example uses a cluster named `nebula` and the cluster's configuration file named `nebula_cluster.yaml` to show how to set `enableAutoBalance`. 1. Run the following command to access the edit page of the `nebula` cluster. @@ -101,4 +101,6 @@ The following example uses a cluster named `nebula` to show how to set `enableAu - When the value of `enableAutoBalance` is set to `false`, the Storage data will not be automatically balanced after the Storage service is scaled out. - - When the `enableAutoBalance` parameter is not set, the system will not automatically balance Storage data by default after the Storage service is scaled out. \ No newline at end of file + - When the `enableAutoBalance` parameter is not set, the system will not automatically balance Storage data by default after the Storage service is scaled out. + +3. Run `kubectl apply -f nebula_cluster.yaml` to push your configuration changes to the cluster. \ No newline at end of file