Browse Source

Docs install cleanup (#12057)

* Extensively reworked MacOS installation page.

* Removing outdated information

* Updated more instances of the old kickstart script

* Update kickstart command with tmp directories

* amend command to avoid merge conflict

* Removed reviewers note
Tina Luedtke 3 years ago
parent
commit
d46870e3c9

+ 2 - 2
README.md

@@ -120,9 +120,9 @@ and builds all dependencies, including those required to connect to [Netdata Clo
 choose, and enables [automatic nightly
 updates](https://learn.netdata.cloud/docs/agent/packaging/installer#nightly-vs-stable-releases) and [anonymous
 statistics](https://learn.netdata.cloud/docs/agent/anonymous-statistics).
-
+<!-- candidate for reuse -->
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
 ```
 
 To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`.

+ 7 - 7
claim/README.md

@@ -73,7 +73,7 @@ When coming from  [Nodes view page](https://learn.netdata.cloud/docs/cloud/visua
 If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
 
 ```
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
 ```
 The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see
 the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
@@ -101,7 +101,7 @@ The default user is `netdata`. Yours may be different, so pay attention to the o
 and run the script.
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
 ```
 ### Connect an agent running in Docker
 
@@ -227,7 +227,7 @@ you don't see the node in your Space after 60 seconds, see the [troubleshooting
 To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/methods/macos.md#install-netdata-with-our-automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
 ```
 The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see
 the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
@@ -267,7 +267,7 @@ You can now move on to connecting. When you connect with the [kickstart](/packag
 append the same proxy setting you added to `netdata.conf`.
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud --claim-proxy socks5h://203.0.113.0:1080
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud --claim-proxy http://[user:pass@]host:ip
 ```
 
 Hit **Enter**. The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if
@@ -474,13 +474,13 @@ Our suggestion is to first run kickstart to upgrade your agent by running the co
 **Linux**
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
 ```
 
 **macOS**
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/
 ```
 ### Claiming script
 
@@ -499,7 +499,7 @@ using `sudo`, or as the user running the Agent (typically `netdata`), and passin
 -hostname=HOSTNAME
     where HOSTNAME is the result of the hostname command by default.
 -proxy=PROXY_URL
-    where PROXY_URL is the endpoint of a SOCKS5 proxy.
+    where PROXY_URL is the endpoint of a HTTP or HTTPS proxy.
 ```
 
 For example, the following command connects an Agent and adds it to rooms `room1` and `room2`:

+ 1 - 1
docs/guides/export/export-netdata-metrics-graphite.md

@@ -32,7 +32,7 @@ If you don't have the Netdata Agent installed already, visit the [installation g
 for the recommended instructions for your system. In most cases, you can use the one-line installation script:
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
 ```
 
 Once installation finishes, open your browser and navigate to `http://NODE:19999`, replacing `NODE` with the IP address

+ 1 - 1
docs/guides/monitor/lamp-stack.md

@@ -60,7 +60,7 @@ If you don't have the free, open-source Netdata monitoring agent installed on yo
 kickstart command](/docs/get-started.mdx):
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
 ```
 
 The Netdata Agent is now collecting metrics from your node every second. You don't need to jump into the dashboard yet,

+ 1 - 1
docs/guides/monitor/pi-hole-raspberry-pi.md

@@ -53,7 +53,7 @@ On Raspberry Pis running Raspbian, the best way to install Netdata is our one-li
 you to install dependencies, then compiles Netdata from source via [GitHub](https://github.com/netdata/netdata).
 
 ```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
 ```
 
 Once installed on a Raspberry Pi 4 with no accessories, Netdata starts collecting roughly 1,500 metrics every second and

+ 11 - 3
docs/guides/step-by-step/step-00.md

@@ -46,9 +46,17 @@ This script will install Netdata from source, keep it up to date with nightly re
 [registry](/registry/README.md), and sends [_anonymous statistics_](/docs/anonymous-statistics.md) about how you use
 Netdata. We use this information to better understand how we can improve the Netdata experience for all our users.
 
-```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
-```
+To install Netdata, run the following as your normal user:
+
+´´´bash
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
+´´´
+Or, if you have cURL but not wget (such as on macOS):
+
+´´´bash
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
+´´´
+
 
 Once finished, you'll have Netdata installed, and you'll be set up to get _nightly updates_ to get the latest features,
 improvements, and bugfixes.

+ 0 - 4
docs/guides/step-by-step/step-09.md

@@ -122,10 +122,6 @@ libraries to make this exporting connection exist. Since you most likely install
 script, all you have to do is run that script again. Don't worry—any configuration changes you made along the way will
 be retained!
 
-```bash
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
-```
-
 Now, from your Netdata config directory, initialize and edit a `exporting.conf` file to tell Netdata where to find the
 database you just created.
 

+ 2 - 1
exporting/WALKTHROUGH.md

@@ -68,8 +68,9 @@ link](/packaging/installer/README.md), the Netdata devs give us several one-line
 any issues with these one liners and their bootstrapping scripts so far (If you guys run into anything do share). Run
 the following command in your container.
 
+<!-- candidate for reuse -->
 ```sh
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --dont-wait
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --dont-wait
 ```
 
 After the install completes you should be able to hit the Netdata dashboard at <http://localhost:19999/> (replace

+ 13 - 10
exporting/prometheus/README.md

@@ -7,10 +7,6 @@ sidebar_label: Using Netdata with Prometheus
 
 # Using Netdata with Prometheus
 
-> IMPORTANT: the format Netdata sends metrics to Prometheus has changed since Netdata v1.7. The new Prometheus exporting
-> connector for Netdata supports a lot more features and is aligned to the development of the rest of the Netdata
-> exporting connectors.
-
 Prometheus is a distributed monitoring system which offers a very simple setup along with a robust data model. Recently
 Netdata added support for Prometheus. I'm going to quickly show you how to install both Netdata and Prometheus on the
 same server. We can then use Grafana pointed at Prometheus to obtain long term metrics Netdata offers. I'm assuming we
@@ -21,10 +17,20 @@ are starting at a fresh ubuntu shell (whether you'd like to follow along in a VM
 ### Installing Netdata
 
 There are number of ways to install Netdata according to [Installation](/packaging/installer/README.md). The suggested way
-of installing the latest Netdata and keep it upgrade automatically. Using one line installation:
+of installing the latest Netdata and keep it upgrade automatically.
 
-```sh
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
+<!-- candidate for reuse -->
+
+To install Netdata, run the following as your normal user:
+
+```bash
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
+```
+
+Or, if you have cURL but not wget (such as on macOS):
+
+```bash
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
 ```
 
 At this point we should have Netdata listening on port 19999. Attempt to take your browser here:
@@ -208,9 +214,6 @@ this and click on 'targets' We should see the Netdata host as a scraped target.
 
 ## Netdata support for Prometheus
 
-> IMPORTANT: the format Netdata sends metrics to Prometheus has changed since Netdata v1.6. The new format allows easier
-> queries for metrics and supports both `as collected` and normalized metrics.
-
 Before explaining the changes, we have to understand the key differences between Netdata and Prometheus.
 
 ### understanding Netdata metrics

+ 3 - 4
packaging/installer/methods/kickstart.md

@@ -19,7 +19,7 @@ The kickstart script works on all Linux distributions and macOS environments. By
 To install Netdata, run the following as your normal user:
 
 ```bash
-wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./kickstart.sh
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
 ```
 
 Or, if you have cURL but not wget (such as on macOS):
@@ -89,15 +89,14 @@ area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
 - `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
   after the install.
 - `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
-- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of
-  `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or `http://[user:pass@]host:ip` for an HTTP(S) proxy.
+- `--claim-proxy`: 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](/claim/README.md#connect-through-a-proxy) for details.
 - `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
 
 For example:
 
 ```bash
-wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./kickstart.sh --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
 ```
 
 Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](/claim/README.md#connect-an-agent-without-root-privileges) section.

Some files were not shown because too many files changed in this diff