Merge branch 'role_netmaker_server'

2 years ago · 25ceb0f456
parent 0d8d5e8528 cdd4c9babb
commit 25ceb0f456
17 changed files with 512 additions and 0 deletions
--- a/netmaker_server/defaults/credentials.yml
+++ b/netmaker_server/defaults/credentials.yml
@ -0,0 +1,5 @@
+netmaker_creds:
+  rqlite_password: 
+  mq_admin_password: 
+
+  master_key: 
--- a/netmaker_server/defaults/main.yml
+++ b/netmaker_server/defaults/main.yml
@ -0,0 +1,28 @@
+# Overwrite for specific nodes to force dynamic-ip (disable setting public-ip and forces external lookup for public-ip)
+#  When false, will check itself for dynamic-ip (based on private-ip)
+netmaker_dynamicIp: false
+
+netmaker_nginx:
+  # Listen-port
+  tls_port:       51820
+  # Advertise-Port for services
+  #  (must also be reachable by internal services!)
+  advertise_port: 51820
+
+# This is the base-domain used for generating hostnames for services
+netmaker_base_domain: 
+
+# host + base_domain
+netmaker_api:
+  host: netmaker-api
+netmaker_ui:
+  host: netmaker-ui
+# MQTT-broker
+netmaker_broker:
+  tls_host:     netmaker-broker
+
+# host + node_hostname
+netmaker_rqlite:
+  http_host:    netmaker-rqlite-http
+  cluster_host: netmaker-rqlite-cluster
+    
--- a/netmaker_server/files/opt/netmaker_server/docs/architecture.puml
+++ b/netmaker_server/files/opt/netmaker_server/docs/architecture.puml
@ -0,0 +1,37 @@
+@startuml
+
+interface ng_TLS
+
+component netmaker_server {
+  component nginx {
+    component ng_stream
+    component ng_http
+
+    ng_stream -up- ng_TLS 
+
+    ng_stream -right-> ng_http : tls-termination
+  }
+
+  component nm_ui
+  nm_ui -up- nm_ui_http
+  ng_http -down-( nm_ui_http
+
+  component Mosquitto
+  Mosquitto -up- mq_plain
+  Mosquitto -up- mq_tls
+  ng_stream -down-( mq_tls
+
+  component rqlite
+  rqlite -up- rq_http
+  rqlite -up- rq_cluster
+  ng_stream -down-( rq_cluster
+  ng_http -down-( rq_http
+
+  component nm_api
+  nm_api -down- nm_api_http
+  ng_http --( nm_api_http
+  nm_api -up-( ng_TLS : db-connection to rqlite-master
+  nm_api --( mq_plain
+}
+
+@enduml
--- a/netmaker_server/files/opt/netmaker_server/mosquitto/config/mosquitto.conf
+++ b/netmaker_server/files/opt/netmaker_server/mosquitto/config/mosquitto.conf
@ -0,0 +1,12 @@
+per_listener_settings false
+
+listener 8883
+allow_anonymous false
+certfile /certs/node.crt
+keyfile /certs/node.key
+
+listener 1883
+allow_anonymous false
+
+plugin /usr/lib/mosquitto_dynamic_security.so
+plugin_opt_config_file /mosquitto/data/dynamic-security.json
--- a/netmaker_server/files/opt/netmaker_server/mosquitto/config/wait.sh
+++ b/netmaker_server/files/opt/netmaker_server/mosquitto/config/wait.sh
@ -0,0 +1,23 @@
+#!/bin/ash
+
+wait_for_netmaker() {
+  echo "SERVER: ${NETMAKER_SERVER_HOST}"
+  until curl --output /dev/null --silent --fail --head \
+    --location "${NETMAKER_SERVER_HOST}/api/server/health"; do
+    echo "Waiting for netmaker server to startup"
+    sleep 1
+  done
+}
+
+main(){
+ # wait for netmaker to startup
+ apk add curl
+ wait_for_netmaker
+ echo "Starting MQ..."
+ # Run the main container command.
+ /docker-entrypoint.sh
+ /usr/sbin/mosquitto -c /mosquitto/config/mosquitto.conf
+
+}
+
+main "${@}"
--- a/netmaker_server/files/opt/netmaker_server/nginx/nginx.conf
+++ b/netmaker_server/files/opt/netmaker_server/nginx/nginx.conf
@ -0,0 +1,33 @@
+
+user  nginx;
+worker_processes  auto;
+
+error_log  /var/log/nginx/error.log notice;
+pid        /var/run/nginx.pid;
+
+
+events {
+    worker_connections  1024;
+}
+
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    access_log  /var/log/nginx/access.log  main;
+
+    sendfile        on;
+    #tcp_nopush     on;
+
+    keepalive_timeout  65;
+
+    #gzip  on;
+
+    include /etc/nginx/conf.d/*.conf;
+}
+include /etc/nginx/stream.d/*.conf;
--- a/netmaker_server/meta/main.yml
+++ b/netmaker_server/meta/main.yml
@ -0,0 +1,3 @@
+---
+#  dependencies:
+#    - role: docker
--- a/netmaker_server/tasks/certs.yml
+++ b/netmaker_server/tasks/certs.yml
@ -0,0 +1,40 @@
+- name: Generate PrivateKey
+  community.crypto.openssl_privatekey:
+    path: /opt/netmaker_server/certs/node.key
+    owner: 1883   #  Set owner to mosquitto-user (all other containers seem to run as root)
+
+- name: Generate Certificate-Signing-Request from privateKey
+  community.crypto.openssl_csr:
+    path: /opt/netmaker_server/certs/node.csr
+    privatekey_path: /opt/netmaker_server/certs/node.key
+    common_name: "{{ ansible_facts.nodename }}"
+    subject_alt_name: 
+     "DNS:{{ netmaker_rqlite.http_host }}.{{ ansible_facts.nodename }},\
+      DNS:{{ netmaker_rqlite.cluster_host }}.{{ ansible_facts.nodename }},\
+      DNS:{{ netmaker_broker.tls_host }}.{{ netmaker_base_domain }},\
+      DNS:{{ netmaker_api.host }}.{{ netmaker_base_domain }},\
+      DNS:{{ netmaker_ui.host }}.{{ netmaker_base_domain }}"
+
+- name: Fetch CSR
+  ansible.builtin.fetch:
+    src: /opt/netmaker_server/certs/node.csr
+    dest: tmp_files/
+
+- name: Sign CSR locally with CA
+  local_action: community.crypto.x509_certificate
+  args:
+    path: tmp_files/{{ inventory_hostname }}/opt/netmaker_server/certs/node.crt
+    csr_path: tmp_files/{{ inventory_hostname }}/opt/netmaker_server/certs/node.csr
+    ownca_path: secret_files/netmaker_server/ca/ca.crt
+    ownca_privatekey_path: secret_files/netmaker_server/ca/ca.key
+    provider: ownca
+  
+- name: Copy Signed Certificate
+  ansible.builtin.copy:
+    src: tmp_files/{{ inventory_hostname }}/opt/netmaker_server/certs/node.crt
+    dest: /opt/netmaker_server/certs/node.crt
+
+- name: Copy CA Certificate
+  ansible.builtin.copy:
+    src: secret_files/netmaker_server/ca/ca.crt
+    dest: /opt/netmaker_server/certs/ca.crt
--- a/netmaker_server/tasks/main.yml
+++ b/netmaker_server/tasks/main.yml
@ -0,0 +1,20 @@
+- import_tasks: ./prerequisites.yml
+
+- name: Copy folder-structure
+  ansible.builtin.copy:
+    src: opt/netmaker_server
+    dest: /opt/
+    mode: preserve
+
+- name: Deploy compose file
+  ansible.builtin.template:
+    src: docker-compose.yml.template
+    dest: /opt/netmaker_server/docker-compose.yml
+
+- import_tasks: ./certs.yml
+
+- import_tasks: ./nginx.yml
+
+- import_tasks: ./rqlite.yml
+
+- import_tasks: ./netmaker.yml
--- a/netmaker_server/tasks/netmaker.yml
+++ b/netmaker_server/tasks/netmaker.yml
@ -0,0 +1,57 @@
+- name: Start rest of netmaker-services
+  command: "docker-compose --project-directory /opt/netmaker_server/ up -d"
+  register: command
+  failed_when: command.rc != 0
+
+- name: Wait for netmaker-api to become available
+  uri:
+    url: 'https://{{ netmaker_api.host }}.{{ netmaker_base_domain }}:{{ netmaker_nginx.advertise_port }}'
+    return_content: yes
+    validate_certs: no
+    status_code:
+      - 404
+  until: uri_output.status == 404
+  retries: 24 # Retries for 24 * 5 seconds = 120 seconds = 2 minutes
+  delay: 5 # Every 5 seconds
+  register: uri_output
+
+# todo: check if exists?
+
+- name: Create default mesh-network 'server'
+  uri:
+    validate_certs: no
+    url: 'https://{{ netmaker_api.host }}.{{ netmaker_base_domain }}:{{ netmaker_nginx.advertise_port }}/api/networks'
+    method: POST
+    body:
+      netid: servnet
+      addressrange: 10.92.0.0/24
+      addressrange6: fd92::/64
+    body_format: json
+    headers:
+      Authorization: 'Bearer {{ netmaker_creds.master_key }}'
+      Content-Type: application/json
+  when: "inventory_hostname == groups['netmaker'][0]"
+  register: default_mesh
+  until: "default_mesh is not failed"
+  retries: 2
+  delay: 10
+
+# todo: check if exists?
+
+- name: Create token for default-network
+  uri:
+    validate_certs: no
+    url: 'https://{{ netmaker_api.host }}.{{ netmaker_base_domain }}:{{ netmaker_nginx.advertise_port }}/api/networks/servnet/keys' # todo: do implementation
+    method: POST
+    body:
+      name: ""
+      uses: 0
+    body_format: json
+    headers:
+      Authorization: 'Bearer {{ netmaker_creds.master_key }}'
+      Content-Type: application/json
+  when: "inventory_hostname == groups['netmaker'][0]"
+  register: default_mesh_key
+  until: "default_mesh_key is not failed"
+  retries: 2
+  delay: 10
--- a/netmaker_server/tasks/nginx.yml
+++ b/netmaker_server/tasks/nginx.yml
@ -0,0 +1,18 @@
+- name: Deploy nginx configs
+  template:
+    src: "{{item.src}}"
+    dest: "{{item.dst}}"
+  loop:
+    - { src: 'nginx/proxy.conf.template',       dst: '/opt/netmaker_server/nginx/conf/conf.d/proxy.conf' }
+    - { src: 'nginx/passthrough.conf.template', dst: '/opt/netmaker_server/nginx/conf/stream.d/passthrough.conf' }
+
+- name: Start nginx service
+  command: "docker-compose --project-directory /opt/netmaker_server/ up -d nginx"
+  register: command
+  failed_when: command.rc != 0
+
+- name: Waiting for nginx to accept connections
+  ansible.builtin.wait_for:
+    host: "{{ inventory_hostname }}"
+    port: 51820
+    state: started
--- a/netmaker_server/tasks/prerequisites.yml
+++ b/netmaker_server/tasks/prerequisites.yml
@ -0,0 +1,9 @@
+- name: Install wireguard
+  package:
+    name:
+      - wireguard
+    state: latest
+
+- name: Check if default-ipv4-address is private
+  set_fact:
+    private_ipv4_address: "{{ ansible_facts.default_ipv4.address | regex_search('^((10)|(192\\.168)|(172\\.((1[6-9])|(2[0-9])|(3[0-1])))|(100))\\.') }}"
--- a/netmaker_server/tasks/rqlite.yml
+++ b/netmaker_server/tasks/rqlite.yml
@ -0,0 +1,42 @@
+- name: Deploy rqlite config
+  ansible.builtin.template:
+    src: rqlite-config.json.template
+    dest: /opt/netmaker_server/rqlite/config.json
+
+- name: Start rqlite service for 1st-node
+  command: "docker-compose --project-directory /opt/netmaker_server/ up -d rqlite"
+  register: command
+  failed_when: command.rc != 0
+  when: "inventory_hostname == groups['netmaker_server'][0]"
+
+- name: Waiting for rqlite to accept connections on 1st-node
+  uri:
+    url: 'https://{{ netmaker_rqlite.http_host }}.{{ inventory_hostname }}:{{ netmaker_nginx.advertise_port }}/status'
+    return_content: yes
+    validate_certs: no
+    status_code:
+      - 401
+  until: uri_output.status == 401
+  retries: 24 # Retries for 24 * 5 seconds = 120 seconds = 2 minutes
+  delay: 5 # Every 5 seconds
+  register: uri_output
+  when: "inventory_hostname == groups['netmaker_server'][0]"
+
+- name: Start rqlite service for other nodes
+  command: "docker-compose --project-directory /opt/netmaker_server/ up -d rqlite"
+  register: command
+  failed_when: command.rc != 0
+  when: "inventory_hostname != groups['netmaker_server'][0]"
+
+- name: Waiting for rqlite to accept connections on other nodes
+  uri:
+    url: 'https://{{ netmaker_rqlite.http_host }}.{{ inventory_hostname }}:{{ netmaker_nginx.advertise_port }}/status'
+    return_content: yes
+    validate_certs: no
+    status_code:
+      - 401
+  until: uri_output.status == 401
+  retries: 24 # Retries for 24 * 5 seconds = 120 seconds = 2 minutes
+  delay: 5 # Every 5 seconds
+  register: uri_output
+  when: "inventory_hostname != groups['netmaker_server'][0]"
--- a/netmaker_server/templates/docker-compose.yml.template
+++ b/netmaker_server/templates/docker-compose.yml.template
@ -0,0 +1,128 @@
+version: "3.4"
+
+services:
+  nginx:
+    image: nginx
+    restart: unless-stopped
+    volumes:
+      - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro # Override nginx-config to add stream-import
+      - ./nginx/conf/conf.d/:/etc/nginx/conf.d:ro  # conf.d
+      - ./nginx/conf/stream.d/:/etc/nginx/stream.d:ro  # conf.d
+      - ./certs:/certs:ro # SSL-certificates
+    ports:
+      - {{ netmaker_nginx.tls_port }}:443
+
+  rqlite: # Distributed sqlite-db
+    image: rqlite/rqlite
+    restart: unless-stopped
+    hostname: "{{ ansible_facts.nodename }}"
+    volumes:
+      - "./rqlite/data:/rqlite/file"
+      - "./rqlite/config.json:/config.json:ro"
+      - "./certs:/certs:ro"
+      - ./certs/ca.crt:/etc/ssl/certs/netmaker-ca.pem:ro  # Add CA to system-trust-store
+    command: "
+    -http-adv-addr {{  netmaker_rqlite.http_host }}.{{ ansible_facts.nodename }}:{{ netmaker_nginx.advertise_port }}
+    -raft-addr     [::]:4002
+    -raft-adv-addr {{  netmaker_rqlite.cluster_host }}.{{ ansible_facts.nodename }}:{{ netmaker_nginx.advertise_port }}
+
+    -node-encrypt
+    -node-cert    /certs/node.crt
+    -node-key     /certs/node.key
+    -node-no-verify
+
+    -auth         /config.json
+
+{% if inventory_hostname != groups['netmaker'][0] %}
+    -join-as  netmaker
+    -join     https://{{  netmaker_rqlite.http_host }}.{{ groups['netmaker'][0] }}:{{ netmaker_nginx.advertise_port }}
+{% endif %}
+    "
+    # FIXME: /\ \/ Change http -> https
+
+  netmaker: # The Primary Server for running Netmaker
+    image: gravitl/netmaker:v0.16.1
+    depends_on:
+      - rqlite
+    cap_add: 
+      - NET_ADMIN
+      - NET_RAW
+      - SYS_MODULE
+    sysctls:
+      - net.ipv4.ip_forward=1
+      - net.ipv4.conf.all.src_valid_mark=1
+      - net.ipv6.conf.all.disable_ipv6=0
+      - net.ipv6.conf.all.forwarding=1
+    restart: unless-stopped
+    volumes: # Volume mounts necessary for sql, coredns, and mqtt
+      - ./dnsconfig/:/root/config/dnsconfig
+      - ./mosquitto/data/:/etc/netmaker/
+      - ./certs/ca.crt:/etc/ssl/certs/netmaker-ca.pem:ro  # Add CA to system-trust-store
+    hostname: "{{ ansible_facts.nodename }}"
+    environment: # Necessary capabilities to set iptables when running in container
+      NODE_ID: "{{ ansible_facts.nodename }}"
+      MASTER_KEY: "{{ netmaker_creds.master_key }}" # The admin master key for accessing the API. Change this in any production installation.
+
+{% if not private_ipv4_address and not netmaker_dynamicIp %}
+      SERVER_HOST: "{{ ansible_facts.default_ipv4.address }}" # Set to public IP of machine.
+{% endif %}
+      SERVER_NAME: "{{  netmaker_broker.tls_host }}.{{ netmaker_base_domain }}" # The domain/host IP indicating the mq broker address
+      SERVER_HTTP_HOST: "{{  netmaker_api.host }}.{{ netmaker_base_domain }}" # Overrides SERVER_HOST if set. Useful for making HTTP available via different interfaces/networks.
+      SERVER_API_CONN_STRING: "{{  netmaker_api.host }}.{{ netmaker_base_domain }}:{{ netmaker_nginx.advertise_port }}"
+
+      DISABLE_REMOTE_IP_CHECK: "off" # If turned "on", Server will not set Host based on remote IP check. This is already overridden if SERVER_HOST is set. Turned "off" by default.
+      DNS_MODE: "off" # Enables DNS Mode, meaning all nodes will set hosts file for private dns settings.
+
+      API_PORT: "8081" # The HTTP API port for Netmaker. Used for API calls / communication from front end. If changed, need to change port of BACKEND_URL for netmaker-ui.
+      REST_BACKEND: "on" # Enables the REST backend (API running on API_PORT at SERVER_HTTP_HOST). Change to "off" to turn off.
+      RCE: "off" # Enables setting PostUp and PostDown (arbitrary commands) on nodes from the server. Off by default.
+      CORS_ALLOWED_ORIGIN: "*" # The "allowed origin" for API requests. Change to restrict where API requests can come from.
+      DISPLAY_KEYS: "on" # Show keys permanently in UI (until deleted) as opposed to 1-time display.
+      
+      DATABASE: "rqlite"
+      SQL_CONN: "https://netmaker:{{ netmaker_creds.rqlite_password }}@{{ netmaker_rqlite.http_host }}.{{ ansible_facts.nodename }}:{{ netmaker_nginx.advertise_port }}/"
+
+      MQ_HOST: "mosquitto"    # the address of the mq server. If running from docker compose it will be "mq". Otherwise, need to input address. If using "host networking", it will find and detect the IP of the mq container.
+      MQ_SERVER_PORT: "1883"  # the reachable port of MQ by the server - change if internal MQ port changes (or use external port if MQ is not on the same machine)
+      MQ_PORT: "{{ netmaker_nginx.advertise_port }}" # the reachable port of MQ - change if external MQ port changes (port on proxy, not necessarily the one exposed in docker-compose)
+      MQ_ADMIN_PASSWORD: "{{ netmaker_creds.mq_admin_password }}"
+      
+      HOST_NETWORK: "off" # whether or not host networking is turned on. Only turn on if configured for host networking (see docker-compose.hostnetwork.yml). Will set host-level settings like iptables.
+      PORT_FORWARD_SERVICES: "" # decide which services to port forward ("dns","ssh", or "mq")
+
+      # this section is for OAuth
+      AUTH_PROVIDER: ""   # "<azure-ad|github|google|oidc>"
+      CLIENT_ID: ""       # "<client id of your oauth provider>"
+      CLIENT_SECRET: ""   # "<client secret of your oauth provider>"
+      FRONTEND_URL: ""    # "https://dashboard.<netmaker base domain>"
+      AZURE_TENANT: ""    # "<only for azure, you may optionally specify the tenant for the OAuth>"
+      OIDC_ISSUER: ""     # https://oidc.yourprovider.com - URL of oidc provider
+      
+      VERBOSITY: "1" # logging verbosity level - 1, 2, or 3
+      TELEMETRY: "off" # Whether or not to send telemetry data to help improve Netmaker. Switch to "off" to opt out of sending telemetry.
+    ports:
+      - "51821-51830:51821-51830/udp" # wireguard ports
+
+  netmaker-ui:  # The Netmaker UI Component
+    image: gravitl/netmaker-ui:v0.16.1
+    depends_on:
+      - netmaker
+    links:
+      - "netmaker:api"
+    restart: unless-stopped
+    environment:
+      BACKEND_URL: "https://{{ netmaker_api.host }}.{{ netmaker_base_domain }}:{{ netmaker_nginx.advertise_port }}" # URL where UI will send API requests. Change based on SERVER_HOST, SERVER_HTTP_HOST, and API_PORT
+
+  mosquitto: # the MQTT broker for netmaker
+    image: eclipse-mosquitto:2.0.11-openssl
+    restart: unless-stopped
+    volumes:
+      - ./mosquitto/config:/mosquitto/config
+      - ./mosquitto/data:/mosquitto/data
+      - ./mosquitto/logs:/mosquitto/log
+      - "./certs:/certs:ro"
+    depends_on:
+      - netmaker
+    command: ["/mosquitto/config/wait.sh"]
+    environment:
+      NETMAKER_SERVER_HOST: "http://netmaker:8081"
--- a/netmaker_server/templates/nginx/passthrough.conf.template
+++ b/netmaker_server/templates/nginx/passthrough.conf.template
@ -0,0 +1,25 @@
+stream{
+    # Map target-hosts based on hostname
+    map $ssl_preread_server_name $target_host {
+        hostnames;  # Enable matching including prefix/suffix-mask
+
+        {{ netmaker_ui.host }}.{{ netmaker_base_domain }}   127.0.0.1:8443;
+        {{ netmaker_api.host }}.{{ netmaker_base_domain }}  127.0.0.1:8443;
+
+        {{ netmaker_broker.tls_host }}.{{ netmaker_base_domain }}   mosquitto:8883; # todo: tls-terminate?
+
+        {{ netmaker_rqlite.http_host }}.{{ ansible_facts.nodename }}    127.0.0.1:8443;
+        {{ netmaker_rqlite.cluster_host }}.{{ ansible_facts.nodename }}   rqlite:4002;
+
+        default         127.0.0.1:1;
+    }
+
+    server {
+        resolver 127.0.0.11; # Explicitly set docker-resolver
+        
+        listen      443;
+        ssl_preread on;
+
+        proxy_pass  $target_host;
+    }
+}
--- a/netmaker_server/templates/nginx/proxy.conf.template
+++ b/netmaker_server/templates/nginx/proxy.conf.template
@ -0,0 +1,27 @@
+map $host    $proxy_name {
+    hostnames;
+    
+    {{ netmaker_ui.host }}.{{ netmaker_base_domain }}               netmaker-ui:80;
+    {{ netmaker_api.host }}.{{ netmaker_base_domain }}              netmaker:8081;
+    
+    {{ netmaker_rqlite.http_host }}.{{ ansible_facts.nodename }}    rqlite:4001;
+
+    default         444;
+}
+
+server {
+    resolver 127.0.0.11; # Explicitly set docker-resolver
+
+    listen 8443 ssl;
+
+    ssl_certificate /certs/node.crt;
+    ssl_certificate_key /certs/node.key;
+
+    if ($proxy_name = 444){
+        return 444;
+    }
+
+    location / {
+        proxy_pass http://$proxy_name;
+    }
+}
--- a/netmaker_server/templates/rqlite-config.json.template
+++ b/netmaker_server/templates/rqlite-config.json.template
@ -0,0 +1,5 @@
+[{
+    "username": "netmaker",
+    "password": "{{ netmaker_creds.rqlite_password }}",
+    "perms": ["all"]
+}]