summaryrefslogtreecommitdiffstats
path: root/docs/netdata-cloud-onprem/getting-started-light-poc.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/netdata-cloud-onprem/getting-started-light-poc.md')
-rw-r--r--docs/netdata-cloud-onprem/getting-started-light-poc.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/netdata-cloud-onprem/getting-started-light-poc.md b/docs/netdata-cloud-onprem/getting-started-light-poc.md
new file mode 100644
index 00000000..dfe0a0c8
--- /dev/null
+++ b/docs/netdata-cloud-onprem/getting-started-light-poc.md
@@ -0,0 +1,51 @@
+# Getting started with Netdata Cloud On-Prem Light PoC
+Due to the high demand, we designed a very light and easy-to-install version of netdata for clients who do not have Kubernetes cluster installed. Please keep in mind that this is (for now) only designed to be used as a PoC with no built-in resiliency on failures of any kind.
+
+Requirements:
+ - Ubuntu 22.04 (clean installation will work best).
+ - 10 CPU Cores and 24 GiB of memory.
+ - Access to shell as a sudo.
+ - TLS certificate for Netdata Cloud On-Prem PoC. A single endpoint is required. The certificate must be trusted by all entities connecting to the On-Prem installation by any means.
+ - AWS ID and Key - contact Netdata Product Team - info@netdata.cloud
+ - License Key - contact Netdata Product Team - info@netdata.cloud
+
+To install the whole environment, log in to the designated host and run:
+```shell
+curl https://netdata-cloud-netdata-static-content.s3.amazonaws.com/provision.sh -o provision.sh
+chmod +x provision.sh
+sudo ./provision.sh --install
+```
+
+What does the script do during installation?
+1. Prompts user to provide:
+ - ID and KEY for accessing the AWS (to pull helm charts and container images)
+ - License Key
+ - URL under which Netdata Cloud Onprem PoC is going to function (without protocol like `https://`)
+ - Path for certificate file (PEM format)
+ - Path for private key file (PEM format)
+2. After getting all of the information installation is starting. The script will install:
+ - Helm
+ - Kubectl
+ - AWS CLI
+ - K3s cluster (single node)
+3. When all the required software is installed script starts to provision the K3s cluster with gathered data.
+
+After cluster provisioning netdata is ready to be used.
+
+##### How to log in?
+Because this is a PoC with 0 configurations required, only log in by mail can work. What's more every mail that Netdata Cloud On-Prem sends will appear on the mailcatcher, which acts as the SMTP server with a simple GUI to read the mails. Steps:
+1. Open Netdata Cloud On-Prem PoC in the web browser on URL you specified
+2. Provide email and use the button to confirm
+3. Mailcatcher will catch all the emails so go to `<URL from point 1.>/mailcatcher`. Find yours and click the link.
+4. You are now logged into the netdata. Add your first nodes!
+
+##### How to remove Netdata Cloud On-Prem PoC?
+To uninstall the whole PoC, use the same script that installed it, with the `--uninstall` switch.
+
+```shell
+cd <script dir>
+sudo ./provision.sh --uninstall
+```
+
+#### WARNING
+This script will automatically expose not only netdata but also a mailcatcher under `<URL from point 1.>/mailcatcher`.