Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dynamic-changes-to-configs #1974

Merged
merged 3 commits into from
Feb 28, 2023
Merged

dynamic-changes-to-configs #1974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ec67bb
dynamic-changes-to-configs
abby-cyber Feb 27, 2023
3beedb3
updates
abby-cyber Feb 27, 2023
a719e90
Update 1.configurations.md
abby-cyber Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions docs-2.0/5.configurations-and-logs/1.configurations/.1.get-configurations.md
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions docs-2.0/5.configurations-and-logs/1.configurations/.5.console-config.md
View file
Open in desktop

This file was deleted.

26 changes: 26 additions & 0 deletions docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,14 @@ For clusters installed with Kubectl through NebulaGraph Operator, the configurat

## Modify configurations

You can modify the configurations of NebulaGraph in the configuration file or use commands to dynamically modify configurations.

!!! caution

Using both methods to modify the configuration can cause the configuration information to be managed inconsistently, which may result in confusion. It is recommended to only use the configuration file to manage the configuration, or to make the same modifications to the configuration file after dynamically updating the configuration through commands to ensure consistency.

### Modifying configurations in the configuration file

By default, each NebulaGraph 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
Expand All @@ -120,3 +128,21 @@ By default, each NebulaGraph service gets configured from its configuration file
* For clusters installed with Kubectl

For details, see [Customize configuration parameters for a NebulaGraph cluster](../../nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md).

### Dynamically modifying configurations using command

You can dynamically modify the configuration of NebulaGraph by using the curl command. For example, to modify the `wal_ttl` parameter of the Storage service to `600`, use the following command:

```bash
curl -X PUT -H "Content-Type: application/json" -d'{"wal_ttl":"600"}' -s "http://192.168.15.6:19779/flags"
```

In this command, ` {"wal_ttl":"600"}` specifies the configuration parameter and its value to be modified, and `192.168.15.6:19779` specifies the IP address and HTTP port number of the Storage service.

!!! caution

- The functionality of dynamically modifying configurations is only applicable to prototype verification and testing environments. It is not recommended to use this feature in production environments. This is because when the `local_config` value is set to `true`, the dynamically modified configuration is not persisted, and the configuration will be restored to the initial configuration after the service is restarted.

- Only **part of** the configuration parameters can be dynamically modified. For the specific list of parameters that can be modified, see the description of **Whether supports runtime dynamic modifications** in the respective service configuration.


Loading