Updating Docker Node Instructions for Clarity (#11713)
* Update optional parameters for upcoming installer. Listed the parameters that are shared between the old and new, removed reference to the new installer (until it's available), and made notations of optional parameters being removed. * Update kickstart.md * Update README.md * Update README.md * Update kickstart.md * Update New Chart Information and Link Adding an alert to describe the new charts available on Netdata Cloud with the notice that it will be delivered to the agent eventually. * Update README.md * Update Charts * Update interact-charts.mdx * Update README.md * Update README.md * Update README.md
DShreve2 committed
Oct 27, 2021 at 10:04 UTC
f5cc1e3aa7598e4d87e80b1a1d9df08cd70283ac
2 files changed
+25
-13
claim/README.md
+21
-12
@@ -39,7 +39,8 @@ There are two important notes regarding connecting nodes:
39
## How to connect a node
40
41
There will be three main flows from where you might want to connect a node to Netdata Cloud.
42
-* when you are on an [empty War Room](#empty-war-room) and you want to connect your first node
42
+* when you are on an [
43
+War Room](#empty-war-room) and you want to connect your first node
44
* when you are at the [Manage Space](#manage-space-or-war-room) area and you select **Connect Nodes** to connect a node, coming from Manage Space or Manage War Room
45
* when you are on the [Nodes view page](https://learn.netdata.cloud/docs/cloud/visualize/nodes) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
46
@@ -47,9 +48,9 @@ Please note that only the administrators of a Space in Netdata Cloud can view th
48
49
### Empty War Room
50
50
-Either at your first sign in or following ones, when you enter Netdata Cloud and are at a War Room that doesn’t have any node added to it you will be able to:
51
-* connect a new node to Netdata Cloud and add it to the War Room you are in
52
-* add a previously connected node to the War Room you are in
51
+Either at your first sign in or following ones, when you enter Netdata Cloud and are at a War Room that doesn’t have any node added to it, you will be able to:
52
+* connect a new node to Netdata Cloud and add it to the War Room
53
+* add a previously connected node to the War Room
54
55
If your case is to connect a new node and add it to the War Room, you will need to tell us what environment the node is running on (Linux, Docker, macOS, Kubernetes) and then we will provide you with a script to initiate the connection process. You just will need to copy and paste it into your node's terminal. See one of the following sections depending on your case:
56
* [Linux](#connect-an-agent-running-in-linux)
@@ -59,6 +60,7 @@ If your case is to connect a new node and add it to the War Room, you will need
60
61
Repeat this process with every node you want to add to Netdata Cloud during onboarding. You can also add more nodes once you've
62
finished onboarding.
63
+
64
### Manage Space or War Room
65
66
To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy and paste the script
@@ -103,9 +105,12 @@ bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-
105
```
106
### Connect an agent running in Docker
107
106
-To connect an instance of the Netdata Agent running inside of a Docker container, either set claiming environment
107
-variables in the container to have it automatically connected on startup or restart, or use `docker exec` to manually
108
-connect an already running container.
108
+To connect an instance of the Netdata Agent running inside of a Docker container, it is recommended that you follow
109
+the instructions and use the commands provided either in the `Nodes` tab of an [empty War Room](#empty-war-room) on Netdata Cloud or
110
+in the shelf that appears when you click **Connect Nodes** and select **Docker**.
111
+
112
+However, users can also claim a new node by claiming environment variables in the container to have it automatically
113
+connected on startup or restart.
114
115
For the connection process to work, the contents of `/var/lib/netdata` _must_ be preserved across container
116
restarts using a persistent volume. See our [recommended `docker run` and Docker Compose
@@ -125,11 +130,11 @@ it will use these values to attempt to connect the container, automatically addi
130
Rooms. If a proxy is specified, it will be used for the connection process and for connecting to Netdata Cloud.
131
132
These variables can be specified using any mechanism supported by your container tooling for setting environment
128
-variables inside containers. For example, when creating a new Netdata container using `docker run`, the following
133
+variables inside containers.
134
135
When using the `docker run` command, if you have an agent container already running, it is important to know that there will be a short period of downtime. This is due to the process of recreating the new agent container.
136
132
-The command that Netdata Cloud will provide to you is:
137
+The command to connect a new node to Netdata Cloud is:
138
139
```bash
140
docker run -d --name=netdata \
@@ -151,6 +156,10 @@ docker run -d --name=netdata \
156
-e NETDATA_CLAIM_PROXY=PROXY \
157
netdata/netdata
158
```
159
+>Note: This command is suggested for connecting a new container. Using this command for an existing container recreates the container, though data
160
+and configuration of the old container may be preserved. If you are claiming an existing container that can not be recreated,
161
+you can add the container by going to Netdata Cloud, clicking the **Nodes** tab, clicking **Connect Nodes**, selecting **Docker**, and following
162
+the instructions and commands provided or by following the instructions in an [empty War Room](#empty-war-room).
163
164
The output that would be seen from the connection process when using other methods will be present in the container logs.
165
@@ -159,7 +168,7 @@ as it works in the widest variety of situations and simplifies configuration man
168
169
#### Using Docker compose
170
162
-If you use `docker compose` you can copy the config provided by Netdata Cloud, which should be same as the one below:
171
+If you use `docker compose`, you can copy the config provided by Netdata Cloud, which should be same as the one below:
172
173
```bash
174
version: '3'
@@ -200,7 +209,6 @@ Then run the following command in the same directory as the `docker-compose.yml`
209
```bash
210
docker-compose up -d
211
```
203
-
212
#### Using docker exec
213
214
Connect a _running Netdata Agent container_, where you don't want to recreate the existing container, append the script offered by Netdata Cloud to a `docker exec ...` command, replacing
@@ -209,6 +217,7 @@ Connect a _running Netdata Agent container_, where you don't want to recreate th
217
```bash
218
docker exec -it netdata netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud
219
```
220
+The values for `ROOM1,ROOM2` can be found by by going to Netdata Cloud, clicking the **Nodes** tab, clicking **Connect Nodes**, selecting **Docker**, and copying the `rooms=` value in the command provided.
221
222
The script should return `Agent was successfully claimed.`. If the connection process returns errors, or if
223
you don't see the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
@@ -411,7 +420,7 @@ sudo rm -rf cloud.d/
420
This node no longer has access to the credentials it was used when connecting to Netdata Cloud via the ACLK.
421
You will still be able to see this node in your War Rooms in an **unreachable** state.
422
414
-If you want to reconnect this node into a different Space, you need to create a new identity by adding `-id=$(uuidgen)` to
423
+If you want to reconnect this node, you need to create a new identity by adding `-id=$(uuidgen)` to
424
the claiming script parameters (not yet supported on the kickstart script). Make sure that you have the `uuidgen-runtime` package installed, as it is used to run the command `uuidgen`. For example:
425
426
**Claiming script**
docs/dashboard/interact-charts.mdx
+4
-1
@@ -7,6 +7,9 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/i
7
8
# Interact with charts
9
10
+> ⚠️ There is a new version of charts that is currently **only** available on [Netdata Cloud](/docs/cloud/visualize/interact-with-new-charts). We didn't
11
+> want to keep this valuable feature from you, so after we get this into your hands on the Cloud, we will collect and implement your feedback to make sure we are providing the best possible version of the feature on the Netdata Agent dashboard as quickly as possible.
12
+
13
While charts that update every second with new metrics are helpful for understanding the immediate state of a node, deep
14
troubleshooting and root cause analysis begins by manipulating the default charts. To help you troubleshoot, Netdata
15
synchronizes every chart every time you interact with one of them.
@@ -130,7 +133,7 @@ your needs.
133
134
- Dashboard
135
- [How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)
133
- - **[Interact with charts](/docs/dashboard/interact-charts.mdx)**
136
+ - [Netdata Cloud · Interact with new charts](https://learn.netdata.cloud/docs/cloud/visualize/interact-with-new-charts)
137
- [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx)
138
- [Select timeframes to visualize](/docs/dashboard/visualization-date-and-time-controls.mdx)
139
- [Import, export, and print a snapshot](/docs/dashboard/import-export-print-snapshot.mdx)