claim -> connect in docs (#19060)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
Nov 22, 2024 at 21:25 UTC
a2cbfa5290007d1e630e415066adf8dbef8c9ee1
14 files changed
+22
-26
README.md
+1
-1
@@ -259,7 +259,7 @@ You can also use Netdata Parents to:
259
260
### 5. **Connect to Netdata Cloud** :cloud:
261
262
-[Sign-in](https://app.netdata.cloud/sign-in) to [Netdata Cloud](https://www.netdata.cloud/) and claim your Netdata Agents and Parents.
262
+[Sign-in](https://app.netdata.cloud/sign-in) to [Netdata Cloud](https://www.netdata.cloud/) and connect your Netdata Agents and Parents.
263
If you connect your Netdata Parents, there is no need to connect your Netdata Agents. They will be connected via the Parents.
264
265
When your Netdata nodes are connected to Netdata Cloud, you can (on top of the above):
docs/dashboards-and-charts/README.md
+1
-1
@@ -25,7 +25,7 @@ The Netdata dashboard consists of the following main sections:
25
26
> **Note**
27
>
28
-> Some sections of the dashboard, when accessed through the Agent, may require the user to be signed in to Netdata Cloud or have the Agent claimed to Netdata Cloud for their full functionality. Examples include saving visualization settings on charts or custom dashboards, claiming the node to Netdata Cloud, or executing functions on an Agent.
28
+> Some dashboard sections may require the user to be signed in and have the Agent connected to Netdata Cloud for their full functionality when accessed through the Agent. Examples include saving visualization settings on charts or custom dashboards, connecting a node to Netdata Cloud, or executing functions on an Agent.
29
30
## How to access the dashboards?
31
docs/deployment-guides/deployment-strategies.md
+1
-1
@@ -24,7 +24,7 @@ An API key is a key created with `uuidgen` and is used for authentication and/or
24
25
#### Child config
26
27
-As mentioned above, we do not recommend to claim the Child to Cloud directly during your setup.
27
+As mentioned above, we do not recommend to connect the Child to Cloud directly during your setup.
28
29
This is done in order to reduce the footprint of the Netdata Agent on your production system, as some capabilities can be switched OFF for the Child and kept ON for the Parent.
30
docs/deployment-guides/standalone-deployment.md
+1
-1
@@ -134,7 +134,7 @@ flowchart LR
134
135
### Configuration steps for standalone Netdata Agents with Netdata Cloud
136
137
-- Install Netdata Agents using the commands given by Netdata Cloud, so that they will be automatically connected to your Netdata Cloud space. Otherwise, install Netdata Agents and then claim them via the command line or their dashboard.
137
+- Install Netdata Agents using the commands given by Netdata Cloud so that they will be automatically connected to your Space. Otherwise, install Netdata Agents and connect them via the command line or their dashboard.
138
139
- Optionally: disable their direct dashboard access to secure them.
140
docs/glossary.md
+1
-1
@@ -149,4 +149,4 @@ even thousands of nodes. There are no actual bottlenecks especially if you retai
149
150
## Z
151
152
-- **Zero Configuration**: Netdata is pre-configured and capable to autodetect and monitor any well known application that runs on your system. You just deploy and claim Netdata Agents in your Netdata space, and monitor them in seconds.
152
+- **Zero Configuration**: Netdata is pre-configured and capable to autodetect and monitor any well-known application that runs on your system. You just deploy and connect Netdata Agents in your Netdata space, and monitor them in seconds.
docs/security-and-privacy-design/netdata-agent-security.md
+2
-2
@@ -32,8 +32,8 @@ configures it.
32
33
The Netdata Agent's web API can also use TLS if configured.
34
35
-When Netdata Agents are claimed to Netdata Cloud, the communication happens via MQTT over Web Sockets over TLS, and
36
-public/private keys are used for authorizing access. These keys are exchanged during the claiming process (usually
35
+When Netdata Agents are connected to the Cloud, the communication happens via MQTT over Web Sockets over TLS, and
36
+public/private keys are used for authorizing access. These keys are exchanged during the connecting process (usually
37
during the provisioning of each Agent).
38
39
## Authentication
docs/top-monitoring-netdata-functions.md
+1
-1
@@ -13,7 +13,7 @@ For more details please check out documentation on how we use our internal colle
13
14
The following is required to be able to run Functions from Netdata Cloud.
15
16
-- At least one of the nodes claimed to your Space should be on a Netdata Agent version higher than `v1.37.1`
16
+- At least one of the nodes connected to your Space should be on a Netdata Agent version higher than `v1.37.1`
17
- Ensure that the node has the collector that exposes the function you want enabled
18
19
## What functions are currently available?
integrations/deploy.yaml
+1
-1
@@ -9,7 +9,7 @@
9
keywords:
10
- linux
11
most_popular: true
12
- install_description: "Run the following command on your node to install and claim Netdata:"
12
+ install_description: "Run the following command on your node to install and connnect Netdata to your Space:"
13
methods:
14
- &ks_wget
15
method: wget
packaging/docker/README.md
+2
-2
@@ -135,7 +135,7 @@ volumes:
135
136
> :bookmark_tabs: Note
137
>
138
-> If you plan to Claim the node to Netdata Cloud, you can find the command with the right parameters by clicking the "
138
+> If you plan to connect the node to Netdata Cloud, you can find the command with the right parameters by clicking the "
139
> Add Nodes" button in your Space's "Nodes" view.
140
141
### With systemd units monitoring
@@ -531,7 +531,7 @@ docker run -d --name=netdata \
531
532
> :bookmark_tabs: Note
533
>
534
-> If you plan to Claim the node to Netdata Cloud, you can find the command with the right parameters by clicking the "
534
+> If you plan to connect the node to Netdata Cloud, you can find the command with the right parameters by clicking the "
535
> Add Nodes" button in your Space's "Nodes" view.
536
537
## Docker tags
packaging/installer/methods/freebsd.md
+1
-1
@@ -118,7 +118,7 @@ The following options are mutually exclusive and specify special operations othe
118
- `--reinstall-even-if-unsafe`: If there is an existing install, reinstall it instead of trying to update it, even if doing so is known to potentially break things (for example, if we cannot detect what type of installation it is). If there is not an existing install, install Netdata normally.
119
- `--reinstall-clean`: If there is an existing install, uninstall it before trying to install Netdata. Fails if there is no existing install.
120
- `--uninstall`: Uninstall an existing installation of Netdata. Fails if there is no existing install.
121
-- `--claim-only`: If there is an existing install, only try to claim it without attempting to update it. If there is no existing install, install and claim Netdata normally.
121
+- `--claim-only`: If there is an existing install, only try to connect it without attempting to update it. If there is no existing install, install and connect Netdata normally.
122
- `--repositories-only`: Only install repository configuration packages instead of doing a full install of Netdata. Automatically sets --native-only.
123
- `--prepare-offline-install-source`: Instead of installing the Agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
124
packaging/installer/methods/kickstart.md
+2
-2
@@ -112,7 +112,7 @@ By default, the script installs a cron job to automatically update Netdata to th
112
By default, the kickstart script will provide a Netdata Agent installation that can potentially communicate with Netdata Cloud if the Netdata Agent is further configured to do so.
113
114
- `--claim-token`
115
- Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node after the installation. This will connect and claim the Netdata Agent to Netdata Cloud.
115
+ Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node after the installation. This will connect and connect the Netdata Agent to Netdata Cloud.
116
- `--claim-url`
117
Specify a URL to use when connecting to the Cloud. Defaults to `https://app.netdata.cloud`. Use this option to change the Netdata Cloud URL to point to your Netdata Cloud installation.
118
- `--claim-rooms`
@@ -120,7 +120,7 @@ By default, the kickstart script will provide a Netdata Agent installation that
120
- `--claim-proxy`
121
Specify a proxy to use when connecting to the Cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
122
- `--claim-only`
123
- If there is an existing installation, only try to claim it without attempting to update it. If there is no existing installation, install and claim Netdata normally.
123
+ If there is an existing installation, only try to connect it without attempting to update it. If there is no existing installation, install and connect Netdata normally.
124
125
### anonymous telemetry
126
packaging/installer/methods/macos.md
+1
-1
@@ -49,7 +49,7 @@ curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /t
49
50
The Netdata Agent is installed under `/usr/local/netdata` on your machine. Your machine will also show up as a node in your Netdata Cloud.
51
52
-If you experience issues while claiming your node, follow the steps in our [Troubleshoot](/src/claim/README.md#troubleshoot) documentation.
52
+If you experience issues while connecting your node, follow the steps in our [Troubleshoot](/src/claim/README.md#troubleshoot) documentation.
53
54
## Install Netdata via Homebrew
55
packaging/windows/WINDOWS_INSTALLER.md
+1
-1
@@ -47,7 +47,7 @@ Connect your Agent to your Netdata Cloud Space with token `<YOUR_TOKEN>` and roo
47
msiexec /qn /i netdata-x64.msi TOKEN="<YOUR_TOKEN>" ROOMS="<YOUR_ROOM>"
48
```
49
50
-Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your Netdata Cloud Space claim token and room ID, respectively.
50
+Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your Space claim token and Room ID, respectively.
51
52
> **Note**
53
>
src/claim/README.md
+6
-10
@@ -1,8 +1,6 @@
1
# Connect Agent to Cloud
2
3
-This section guides you through installing and securely connecting a new Netdata Agent to Netdata Cloud via the
4
-encrypted Agent-Cloud Link ([ACLK](/src/aclk/README.md)). Connecting your Agent to Netdata Cloud unlocks additional
5
-features like centralized monitoring and easier collaboration.
3
+This section guides you through installing and securely connecting a new Agent to Netdata Cloud via the encrypted Agent-Cloud Link ([ACLK](/src/aclk/README.md)). Connecting your Agent to Netdata Cloud unlocks additional features like centralized monitoring and easier collaboration.
4
5
## Connect
6
@@ -14,8 +12,7 @@ There are two places in the UI where you can add/connect your Node:
12
select "Nodes." Click the "+" button to add a new node.
13
- [**Nodes tab**](/docs/dashboards-and-charts/nodes-tab.md): Click on the "Add nodes" button.
14
17
-Netdata Cloud will generate a command that you can execute on your Node to install and claim the Agent. The command is
18
-available for different installation methods:
15
+Netdata Cloud will generate a command that you can execute on your Node to install and connect the Agent to your Space. The command is available for different installation methods:
16
17
| Method | Description |
18
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -70,10 +67,9 @@ example:
67
insecure = no
68
```
69
73
-If the Agent is already running, you can either run `netdatacli reload-claiming-state` or restart the Agent.
74
-Otherwise, the Agent will be claimed when it starts.
70
+If the Agent is already running, you can either run `netdatacli reload-claiming-state` or restart the Agent. Otherwise, the Agent will be connected when it starts.
71
76
-If the claiming process fails, the reason will be logged in daemon.log (search for "CLAIM") and the `cloud` section of `http://ip:19999/api/v2/info`.
72
+If the connection process fails, the reason will be logged in daemon.log (search for "CLAIM") and the `cloud` section of `http://ip:19999/api/v2/info`.
73
74
#### Automatically, via environment variables
75
@@ -85,9 +81,9 @@ Netdata will use the following environment variables:
81
- `NETDATA_CLAIM_PROXY`: The URL of a proxy server to use for the connection (optional)
82
- `NETDATA_EXTRA_CLAIM_OPTS`, may contain a space separated list of options. The option `-insecure` is the only currently used.
83
88
-The `NETDATA_CLAIM_TOKEN` alone is enough for triggering the claiming process.
84
+The `NETDATA_CLAIM_TOKEN` alone is enough for triggering the connection process.
85
90
-If the claiming process fails, the reason will be logged in daemon.log (search for "CLAIM") and the `cloud` section of `http://ip:19999/api/v2/info`.
86
+If the connection process fails, the reason will be logged in daemon.log (search for "CLAIM") and the `cloud` section of `http://ip:19999/api/v2/info`.
87
88
## Reconnect
89