From 9b5383cf6f2be7ecfaf89144ff6bfa886e5715b4 Mon Sep 17 00:00:00 2001 From: afeiszli Date: Tue, 16 Jan 2024 16:54:45 +0530 Subject: [PATCH] modifying prereq section --- quick-start.rst | 52 +++++++++++++++++++++++++++++-------------------- 1 file changed, 31 insertions(+), 21 deletions(-) diff --git a/quick-start.rst b/quick-start.rst index c1f20efb..ee2004c5 100644 --- a/quick-start.rst +++ b/quick-start.rst @@ -21,27 +21,37 @@ Important Notes 0. Prerequisites ================== -- **Virtual Machine** - - - Preferably from a cloud provider (e.x: DigitalOcean, Linode, AWS, GCP, etc.) - - - We **highly recommend** that Netmaker be deployed in a dedicated networking environment. It should not share a local network with the clients which it will be managing. This can cause routing issues. - - - We do not recommend Oracle Cloud, as VM's here have been known to cause network interference. - - - The machine should have a public, static IP address - - - The machine should have at least 1GB RAM and 1 CPU (2GB RAM preferred for production installs) - - - 2GB+ of storage - - - Ubuntu 21.04 Installed - -- **Domain** - - - A publicly owned domain (e.x. example.com, mysite.biz) - - Permission and access to modify DNS records via DNS service (e.x: Route53) - - **Note on Cloudflare:** Many of our users use Cloudflare for DNS. Cloudflare has limitations on subdomains you must be aware of, which can cause issues once Netmaker is deployed. Cloudflare will also proxy connections, which MQ does not like. This can be disabled in the Cloudflare dashboard. If setting up your Netmaker server using Cloudflare for DNS, be aware that the configuration of Cloudflare may cause problems with Netmaker which must be resolved, and at this point, Netmaker is not providing guidance on this setup. + +Server +----------------- + +All components of Netmaker can be run on a single server (Virtual Machine or Bare Metal). Here some recommendations for setting up the server: + +- We **highly recommend** that Netmaker be deployed in a dedicated networking environment. It should not share a local network with the clients which it will be managing. This can cause routing issues. +- The machine should have a public, static IP address +- The machine should have at least 1GB RAM and 1 CPU (2GB RAM preferred for production installs) +- 2GB+ of storage +- Ubuntu 21.04 Installed + +If you do not have a host for this server, here are some recommendations: + +- `DigitalOcean (preferred) `_ +- `Linode `_ +- `KeepSec `_ +- `AWS `_ +- `Azure `_ +- `GCP `_ +- We **do not** recommend Oracle Cloud. There are known issues with their network configuration. + +Domain +-------- + +Your server will host several services (netmaker server, UI, etc.) each of which requires a dedicated, public subdomain. Here are some recommendations: + +- Use a publicly owned domain (e.x. example.com, mysite.biz) +- Designate a subdomain (e.g. netmaker.example.com) for netmaker's services (e.g. dashboard.netmaker.example.com) +- Make sure you have permission and access to modify DNS records for your domain (e.x: Route53) +- **Note on Cloudflare:** Many of our users use Cloudflare for DNS. Cloudflare has limitations on subdomains you must be aware of, which can cause issues once Netmaker is deployed. Cloudflare will also proxy connections, which MQ does not like. This can be disabled in the Cloudflare dashboard. If setting up your Netmaker server using Cloudflare for DNS, be aware that the configuration of Cloudflare may cause problems with Netmaker which must be resolved, and at this point, Netmaker is not providing guidance on this setup. 1. Prepare DNS ================