Merge pull request #10 from NetNeutralNetworks/feat-tenants-adds-default-vpn-config

Add template generation when using tenant add command

Author: draggeta

setup/profile-nc-vpn.sh

@@ -25,53 +25,61 @@ vpnctl --install-completion > /dev/null
 
 printf "\n"
 print_service_state "ncubed-vpnc"
-
 DEFAULT="\e[0m"
 BOLD="\e[1m"
-printf "\e[1m
+
+printf "$BOLD
                    _               _
                   | |             | |
  ____   ____ _   _| |__  _____  __| |
 |  _ \ / ___) | | |  _ \| ___ |/ _  |
 | | | ( (___| |_| | |_) ) ____( (_| |
 |_| |_|\____)____/|____/|_____)\____|
-\e[0m
+$DEFAULT
 
 VPNC configuration is stored in /opt/ncubed/config/vpnc
 This directory contains the active and candidate configuration directories.
 
 Manage the configuration by using the 'vpnctl' command. This binary has autocompletion.
 
 $BOLD> vpnctl tenants$DEFAULT
-List the configured tenants
+shows a list of all configured tenants VPNs
 
-$BOLD> vpnctl tenants C0001 [network-instances C0001-00 [connections 0]] show [--active] [--full]$DEFAULT
-Show a tenant configuration
-Full shows the connection configurations when run against the tenant and not a specific network instance.
+$BOLD> vpnctl tenants <TENANTID> show (--active) (--full)$DEFAULT
+shows the <TENANTID> (active) tenant VPN configuration without the VPN tunnel configuration
+full shows the tunnel configurations as well
 
-$BOLD> vpnctl tenants C0001 [network-instances C0001-00 [connections 0]] summary$DEFAULT
-Show connection status summary
+$BOLD> vpnctl tenants <TENANTID> add --name <Customer name>
+add a new tenant
 
-$BOLD> vpnctl tenants C0001 nat$DEFAULT
-Show used NAT translations
+$BOLD> vpnctl tenants <TENANTID> delete/set/unset$DEFAULT
+delete a tenant
+set a tenant property
+remove a tenant property
 
-$BOLD> vpnctl tenants C0001 (add|delete)$DEFAULT
-Add or delete a tenant
+$BOLD> vpnctl tenants <TENANTID> edit$DEFAULT
+opens the default editor for editing the tenants configuration. These edits are validated. Invalid
+configurations cannot be applied and will be rolled back.
 
-$BOLD> vpnctl tenants C0001 edit$DEFAULT
-Open the default editor to edit the tenant configuration.
-The edited configuration is validated.
-Invalid configurations cannot be applied and will be rolled back.
+$BOLD> vpnctl tenants <TENANTID> connection$DEFAULT
+shows a list of all configured tunnels for a tenants
 
-$BOLD> vpnctl tenants C0001 commit [--dry-run] [--diff] [--revert]$DEFAULT
-Copy the candidate configuration to the active configuration
-Reverting the candidate configuration, dry-runs and diffs are possible
+$BOLD> vpnctl tenants <TENANTID> connection 0 show$DEFAULT
+shows the <TENANTID> tenant tunnel 0 VPN configuration
 
-$BOLD> vpnctl bgp show$DEFAULT
-Show the BGP configuration
+$BOLD> vpnctl tenants <TENANTID> connection 0 add/delete/set/unset$DEFAULT
+add a new connection
+delete a connection
+set a connection property
+remove a connection property
 
-$BOLD> vpnctl bgp summary$DEFAULT
-Show the BGP status summary
+$BOLD> vpnctl tenants <TENANTID> commit$DEFAULT
+copy the candidate configuration to the active configuration
+reverting the candidate configuration, dry-runs and diffs are possible
 
+$BOLD> vpnctl bgp show$DEFAULT
+shows the bgp configuration
 
+$BOLD> vpnctl bgp summary$DEFAULT
+shows the active bgp state summary
 "

vpnc/pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
     "pyroute2~=0.7",
     "PyYAML~=6.0",
     "tabulate~=0.9",
-    "typer~=0.12.4",
+    "typer~=0.24.1",
     "vici~=5.9",
     "watchdog~=4.0",
     "packaging",

vpnc/src/vpnc/ctl/tenants.py

@@ -215,6 +215,53 @@ def add(
     if tenant_id == config.DEFAULT_TENANT:
         print(f"Tenant '{tenant_id}' already exists.")
         return
+
+    all_args["network_instances"] = {
+        f"{tenant_id}-00": {
+            "connections": {
+                "0": {
+                    "config": {
+                        "ike_lifetime": 86400,
+                        "ike_proposal": "aes256-sha384-ecp384",
+                        "ike_version": "2",
+                        "initiation": "start",
+                        "ipsec_lifetime": 3600,
+                        "ipsec_proposal": "aes256gcm-prfsha384-ecp384",
+                        "local_id": None,
+                        "psk": "PSK-STRING",
+                        "remote_addrs": [
+                            "127.0.0.1",
+                        ],
+                        "remote_id": None,
+                        "traffic_selectors": {
+                            "local": [],
+                            "remote": [],
+                        },
+                        "type": "ipsec",
+                    },
+                    "id": 0,
+                    "interface": {
+                        "ipv4": [],
+                        "ipv6": [],
+                    },
+                    "metadata": {},
+                    "routes": {
+                        "ipv4": [
+                            {
+                                "to": "0.0.0.0/0",
+                                "via": None,
+                            },
+                        ],
+                        "ipv6": [],
+                    },
+                },
+            },
+            "id": f"{tenant_id}-00",
+            "metadata": {},
+            "type": "downlink",
+        },
+    }
+
     path = helpers.get_config_path(ctx, active=False)
     tenant_path = path.joinpath(f"{tenant_id}.yaml")
     if tenant_path.exists():