Windows deploy metadata (#18733)
* deploy meta, WINDOWS-INSTALLER markdwon changes and deploy template changes * multiline command * de-hardcode nighlty version * note for beta and nightly availability * note for paid win installer * frontend does not support blockquotes and bold, make it one sentence * reorder * remove dup * reword
Fotis Voutsas committed
Oct 10, 2024 at 08:24 UTC
65a94cde3ff6f8c8a6560bb45b2a6c13704f7b3a
3 files changed
+53
-22
integrations/deploy.yaml
+46
-19
@@ -16,23 +16,19 @@
16
commands:
17
- channel: nightly
18
command: >
19
- wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh
20
- --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
19
+ wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
20
- channel: stable
21
command: >
23
- wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh
24
- --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
22
+ wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
23
- &ks_curl
24
method: curl
25
commands:
26
- channel: nightly
27
command: >
30
- curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
31
- --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
28
+ curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
29
- channel: stable
30
command: >
34
- curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
35
- --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
31
+ curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
32
additional_info: &ref_containers >
33
Did you know you can also deploy Netdata on your OS using {% goToCategory navigateToSettings=$navigateToSettings categoryId="deploy.docker-kubernetes" %}Kubernetes{% /goToCategory %} or {% goToCategory categoryId="deploy.docker-kubernetes" %}Docker{% /goToCategory %}?
34
clean_additional_info: &ref_clean_containers >
@@ -562,14 +558,47 @@
558
keywords:
559
- windows
560
install_description: |
565
- 1. Install [Windows Exporter](https://github.com/prometheus-community/windows_exporter) on every Windows host you want to monitor.
566
- 2. Install Netdata agent on Linux, FreeBSD or Mac.
567
- 3. Configure Netdata to collect data remotely from your Windows hosts by adding one job per host to windows.conf file. See the [configuration section](https://learn.netdata.cloud/docs/data-collection/monitor-anything/System%20Metrics/Windows-machines#configuration) for details.
568
- 4. Enable [virtual nodes](https://learn.netdata.cloud/docs/data-collection/windows-systems#virtual-nodes) configuration so the windows nodes are displayed as separate nodes.
561
+ Netdata offers a convenient Windows installer for easy setup. This executable provides two distinct installation modes, outlined below.
562
+
563
+ The Windows installer is currently under beta, and thus it is only available in the nightly release channel. A stable version will be released soon.
564
+
565
+ ## Graphical User Interface (GUI)
566
+
567
+ 1. Download the Netdata [Windows installer](https://github.com/netdata/netdata-nightlies/releases) from the latest nightly release.
568
+ 2. Run the `.exe` file and proceed with the installation process.
569
+ 3. At a minimum, you will need your Netdata Cloud Space's claim token to connect your Agent to your Space.
570
+
571
+ ## Silent Mode (Command line)
572
+
573
+ If you prefer to install Netdata through the command line, you can do so by running the following command on Windows Powershell with administrator rights.
574
methods:
570
- - *ks_wget
571
- - *ks_curl
572
- additional_info: ""
575
+ - method: Silent Mode (Command line)
576
+ commands:
577
+ - channel: stable
578
+ command: |
579
+ $ProgressPreference = 'SilentlyContinue';
580
+ Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-installer-x64.exe -OutFile "netdata-installer-x64.exe";
581
+ .\netdata-installer-x64.exe /S /A `
582
+ {% if $showClaimingOptions %}/TOKEN={% claim_token %} /ROOMS={% $claim_rooms %}{% /if %}
583
+ - channel: nightly
584
+ command: |
585
+ $ProgressPreference = 'SilentlyContinue';
586
+ Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-installer-x64.exe -OutFile "netdata-installer-x64.exe";
587
+ .\netdata-installer-x64.exe /S /A `
588
+ {% if $showClaimingOptions %}/TOKEN={% claim_token %} /ROOMS={% $claim_rooms %}{% /if %}
589
+ additional_info: |
590
+ ### Available Options
591
+
592
+ | Option | Description |
593
+ |-----------|--------------------------------------------------------------------------------------------------|
594
+ | `/S` | Enables silent mode installation. |
595
+ | `/A` | Accepts all Netdata licenses. This option is mandatory for silent installations. |
596
+ | `/D` | Specifies the desired installation directory (defaults to `C:\Program Files\Netdata`). |
597
+ | `/T` | Opens the `MSYS2` terminal after installation. |
598
+ | `/I` | Forces insecure connections, bypassing hostname verification (use only if absolutely necessary). |
599
+ | `/TOKEN=` | Sets the Claim Token for your Netdata Cloud Space. |
600
+ | `/ROOMS=` | Comma-separated list of Room IDs where you want your node to appear. |
601
+ | `/PROXY=` | Sets the proxy server address if your network requires one. |
602
related_resources: {}
603
most_popular: true
604
platform_info:
@@ -600,12 +629,10 @@
629
commands:
630
- channel: nightly
631
command: >
603
- fetch -o /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh
604
- --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
632
+ fetch -o /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
633
- channel: stable
634
command: >
607
- fetch -o /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh
608
- --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
635
+ fetch -o /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %}
636
additional_info: |
637
Netdata can also be installed via [FreeBSD ports](https://www.freshports.org/net-mgmt/netdata).
638
related_resources: {}
integrations/templates/platform_info.md
+1
-1
@@ -6,6 +6,6 @@ We build native packages for the following releases:
6
[% for e in entries %]
7
| [[ e.version ]] | [[ e.support ]] | [[ ', '.join(e.arches) ]] | [[ e.notes ]] |
8
[% endfor %]
9
-[% endif %]
9
10
On other releases of this distribution, a static binary will be installed in `/opt/netdata`.
11
+[% endif %]
packaging/windows/WINDOWS_INSTALLER.md
+6
-2
@@ -4,7 +4,7 @@ Netdata offers a convenient Windows installer for easy setup. This executable pr
4
5
> **Note**
6
>
7
-> This feature is currently only available for Nightly releases, and the installer can be found in our [nightlies repo](https://github.com/netdata/netdata-nightlies)
7
+> This feature is currently under beta and only available for Nightly releases, and the installer can be found in our [nightlies repo](https://github.com/netdata/netdata-nightlies). A stable version will be released soon.
8
9
## Graphical User Interface (GUI)
10
@@ -54,11 +54,15 @@ This section provides instructions for installing Netdata in silent mode, which
54
Connect your Agent to your Netdata Cloud Space with token `<YOUR_TOKEN>` and room `<YOUR_ROOM>`:
55
56
```bash
57
-netdata-installer.exe /S /A /TOKEN=<YOUR_TOKEN> /ROOMS=<YOUR_ROOM>
57
+netdata-installer-x64.exe /S /A /TOKEN=<YOUR_TOKEN> /ROOMS=<YOUR_ROOM>
58
```
59
60
Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your actual Netdata Cloud Space claim token and room ID, respectively.
61
62
+> **Note**
63
+>
64
+> The Windows version of Netdata is intended for users on paid plans.
65
+
66
## Uninstalling
67
68
To uninstall Netdata, run the `uninstall.exe` file in your Netdata installation directory, typically `<YOUR_INSTALL_LOCATION>\Netdata`.