New wording about edit-config script in docs (#18639)
Fotis Voutsas committed
Oct 2, 2024 at 12:43 UTC
f3efa0f8705e6a705f946acdbb8176d997ceaee1
10 files changed
+22
-20
docs/deployment-guides/deployment-strategies.md
+5
-5
@@ -32,7 +32,7 @@ In this example, Machine Learning and Alerting are disabled for the Child, so th
32
33
##### netdata.conf
34
35
-On the child node, edit `netdata.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script and set the following parameters:
35
+On the child node, edit `netdata.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script and set the following parameters:
36
37
```yaml
38
[db]
@@ -63,7 +63,7 @@ On the child node, edit `netdata.conf` by using the [edit-config](/docs/netdata-
63
64
##### stream.conf
65
66
-To edit `stream.conf`, use again the [edit-config](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script and set the following parameters:
66
+To edit `stream.conf`, use again the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script and set the following parameters:
67
68
```yaml
69
[stream]
@@ -90,7 +90,7 @@ Requiring:
90
91
##### netdata.conf
92
93
-On the Parent, edit `netdata.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script and set the following parameters:
93
+On the Parent, edit `netdata.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script and set the following parameters:
94
95
```yaml
96
[db]
@@ -120,7 +120,7 @@ On the Parent, edit `netdata.conf` by using the [edit-config](/docs/netdata-agen
120
121
##### stream.conf
122
123
-On the Parent node, edit `stream.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script and set the following parameters:
123
+On the Parent node, edit `stream.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script and set the following parameters:
124
125
```yaml
126
[API_KEY]
@@ -132,7 +132,7 @@ On the Parent node, edit `stream.conf` by using the [edit-config](/docs/netdata-
132
133
In order to setup active–active streaming between Parent 1 and Parent 2, Parent 1 needs to be instructed to stream data to Parent 2 and Parent 2 to stream data to Parent 1. The Child Agents need to be configured with the addresses of both Parent Agents. An Agent will only connect to one Parent at a time, falling back to the next upon failure. These examples use the same API key between Parent Agents and for connections for Child Agents.
134
135
-On both Netdata Parent and all Child Agents, edit `stream.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script:
135
+On both Netdata Parent and all Child Agents, edit `stream.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script:
136
137
#### stream.conf on Parent 1
138
docs/developer-and-contributor-corner/raspberry-pi-anomaly-detection.md
+1
-1
@@ -23,7 +23,7 @@ Read on to learn all the steps and enable unsupervised anomaly detection on your
23
24
First make sure Netdata is using Python 3 when it runs Python-based data collectors.
25
26
-Next, open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-netdataconf)
26
+Next, open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config)
27
from within the [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). Scroll down to the
28
`[plugin:python.d]` section to pass in the `-ppython3` command option.
29
docs/netdata-agent/configuration/README.md
+7
-5
@@ -1,6 +1,6 @@
1
# Netdata Agent Configuration
2
3
-The main Netdata agent configuration is `netdata.conf`.
3
+The main Netdata Agent configuration is `netdata.conf`.
4
5
## The Netdata config directory
6
@@ -10,12 +10,15 @@ few directories, and a shell script named `edit-config`.
10
11
> Some operating systems will use `/opt/netdata/etc/netdata/` as the config directory. If you're not sure where yours
12
> is, navigate to `http://NODE:19999/netdata.conf` in your browser, replacing `NODE` with the IP address or hostname of
13
-> your node, and find the `# config directory = ` setting. The value listed is the config directory for your system.
13
+> your node, and find the `# config directory =` setting. The value listed is the config directory for your system.
14
15
All of Netdata's documentation assumes that your config directory is at `/etc/netdata`, and that you're running any scripts from inside that directory.
16
17
+## Edit a configuration file using `edit-config`
18
18
-## edit `netdata.conf`
19
+We recommend the use of the `edit-config` script for configuration changes.
20
+
21
+It exists inside your config directory (read above) and helps manage and safely edit configuration files.
22
23
To edit `netdata.conf`, run this on your terminal:
24
@@ -28,7 +31,7 @@ Your editor will open.
31
32
## downloading `netdata.conf`
33
31
-The running version of `netdata.conf` can be downloaded from a running Netdata agent, at this URL:
34
+The running version of `netdata.conf` can be downloaded from a running Netdata Agent, at this URL:
35
36
```
37
http://agent-ip:19999/netdata.conf
@@ -40,4 +43,3 @@ You can save and use this version, using these commands:
43
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
44
curl -ksSLo /tmp/netdata.conf.new http://localhost:19999/netdata.conf && sudo mv -i /tmp/netdata.conf.new netdata.conf
45
```
43
-
src/collectors/charts.d.plugin/README.md
+1
-1
@@ -21,7 +21,7 @@ By default, `charts.d.plugin` is not included as part of the install when using
21
22
## Configuration
23
24
-`charts.d.plugin` itself can be [configured](/docs/netdata-agent/configuration/README.md#edit-netdataconf)using the configuration file `/etc/netdata/charts.d.conf`. This file is also a BASH script.
24
+`charts.d.plugin` itself can be [configured](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config)using the configuration file `/etc/netdata/charts.d.conf`. This file is also a BASH script.
25
26
In this file, you can place statements like this:
27
src/collectors/ebpf.plugin/README.md
+3
-3
@@ -49,7 +49,7 @@ To enable or disable the entire eBPF collector:
49
cd /etc/netdata
50
```
51
52
-2. Use the [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script to edit `netdata.conf`.
52
+2. Use the [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script to edit `netdata.conf`.
53
54
```bash
55
./edit-config netdata.conf
@@ -73,7 +73,7 @@ To edit the `ebpf.d.conf`:
73
```bash
74
cd /etc/netdata
75
```
76
-2. Use the [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script to edit [`ebpf.d.conf`](https://github.com/netdata/netdata/blob/master/src/collectors/ebpf.plugin/ebpf.d.conf).
76
+2. Use the [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script to edit [`ebpf.d.conf`](https://github.com/netdata/netdata/blob/master/src/collectors/ebpf.plugin/ebpf.d.conf).
77
78
```bash
79
./edit-config ebpf.d.conf
@@ -276,7 +276,7 @@ To configure an eBPF thread:
276
```bash
277
cd /etc/netdata
278
```
279
-2. Use the [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-netdataconf) script to edit a thread configuration file. The following configuration files are available:
279
+2. Use the [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script to edit a thread configuration file. The following configuration files are available:
280
281
- `network.conf`: Configuration for the [`network` thread](#network-configuration). This config file overwrites the global options and also
282
lets you specify which network the eBPF collector monitors.
src/collectors/profile.plugin/README.md
+1
-1
@@ -12,7 +12,7 @@ A user can specify:
12
13
## Configuration
14
15
-Edit the `netdata.conf` configuration file using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-netdataconf) from the [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
15
+Edit the `netdata.conf` configuration file using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) from the [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
16
17
Scroll down to the `[plugin:profile]` section to find the available options:
18
src/collectors/statsd.plugin/README.md
+1
-1
@@ -785,7 +785,7 @@ visualize all the available operations.
785
786
Start by creating a new configuration file under the `statsd.d/` folder in the
787
[Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
788
-Use [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-netdataconf)
788
+Use [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config)
789
to create a new file called `k6.conf`.
790
791
```bash=
src/health/notifications/README.md
+1
-1
@@ -10,7 +10,7 @@ The default script is `alarm-notify.sh`.
10
>
11
> This file mentions editing configuration files.
12
>
13
-> - To edit configuration files in a safe way, we provide the [`edit config` script](/docs/netdata-agent/configuration/README.md#edit-netdataconf)located in your [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically.
13
+> - To edit configuration files in a safe way, we provide the [`edit config` script](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config)located in your [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically.
14
> Note that to run the script you need to be inside your Netdata config directory.
15
>
16
> - Please also note that after most configuration changes you will need to [restart the Agent](/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for the changes to take effect.
src/ml/ml-configuration.md
+1
-1
@@ -4,7 +4,7 @@ Netdata's [Machine Learning](/src/ml/README.md) capabilities are enabled by defa
4
5
To enable or disable Machine Learning capabilities on a node:
6
7
-1. [Edit `netdata.conf`](/docs/netdata-agent/configuration/README.md#edit-netdataconf)
7
+1. [Edit `netdata.conf`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config)
8
2. In the `[ml]` section, set `enabled = yes` to enable or `enabled = no` to disable
9
3. [Restart Netdata](/docs/netdata-agent/start-stop-restart.md)
10
src/registry/README.md
+1
-1
@@ -183,7 +183,7 @@ Both files are machine readable text files.
183
184
Beginning with `v1.30.0`, when the Netdata Agent's web server processes a request, it delivers the `SameSite=none`
185
and `Secure` cookies. If you have problems accessing the local Agent dashboard or Netdata Cloud, disable these
186
-cookies by [editing `netdata.conf`](/docs/netdata-agent/configuration/README.md#edit-netdataconf):
186
+cookies by [editing `netdata.conf`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config):
187
188
```conf
189
[registry]