VPN Bootstrap

This section guides you through setting up a VPN connection between Aether Central in GCP and ACE. We will be using GitOps based Aether CI/CD system for this and what you need to do is create a patch for the new edge in aether-pod-configs, where all edge infrastructure configuration is stored.

Here is a brief overview of each step. Note that some of the steps described here are not directly related to setting up a VPN, but are prerequisites for adding a new edge.

1. Add deployment jobs Each edge has its own Jenkins jobs that build and execute an infrastructure change plan based on the configurations specified in aether-pod-configs. In this step, you’ll add those jobs to Aether CI/CD system for the new edge.

2. Update global resource maps aether-pod-configs maintains complete list of clusters, VPN connections, and users in separate global resource files. Before adding edge specific configurations, it is required to update those global resource maps first.

3. Generate Ansible and Terraform configs In this step, you’ll add Ansible and Terraform configs necessary to install and configure VPN software at the edge and set up VPN gateway, router, and firewall on GCP.

4. Submit your changes Finally, submit your aether-pod-configs changes to run the deployment job added in the first step.


If you are adding another ACE to an existing VPN connection, go to Add ACE to an existing VPN connection.


Make sure that UDP port 500, UDP port 4500, and ESP from gcpvpn1.infra.aetherproject.net( and gcpvpn2.infra.aetherproject.net( are allowed in the firewall at the edge.

Add deployment jobs

First, you need to add Jenkins jobs to Aether CI/CD system that build and apply infrastructure change plans for the new edge. This can be done by creating a patch to aether-ci-management repository.

Download aether-ci-management repository.

$ git clone "ssh://[username]@gerrit.opencord.org:29418/aether-ci-management"

Add the jobs for the new cluster at the end of the cd-pipeline-terraform-ace-prd project job list. Make sure to add both pre-merge and post-merge jobs. Note that the cluster name specified here will be used in the rest of the deployment procedure.

$ cd $WORKDIR/aether-ci-management
$ vi jjb/repos/cd-pipeline-terraform.yaml

# Add jobs for the new cluster
diff jjb/repos/cd-pipeline-terraform.yamll
--- a/jjb/repos/cd-pipeline-terraform.yaml
+++ b/jjb/repos/cd-pipeline-terraform.yaml
@@ -227,3 +227,9 @@
       - 'cd-pipeline-terraform-postmerge-cluster':
           cluster: 'ace-eks'
+      - 'cd-pipeline-terraform-premerge-cluster':
+          cluster: 'ace-test'
+          disable-job: false
+      - 'cd-pipeline-terraform-postmerge-cluster':
+          cluster: 'ace-test'
+          disable-job: false

Submit your change and wait for the jobs you just added available in Aether Jenkins.

$ git status
Changes not staged for commit:

  modified:   jjb/repos/cd-pipeline-terraform.yaml

$ git add .
$ git commit -m "Add test ACE deployment job"
$ git review

Get access to encrypted files in aether-pod-configs repository

git-crypt is used to securely store encrypted files in the aether-pod-configs repository. Before proceeding, (1) install git-crypt and gpg, (2) create a GPG keypair, and (3) ask a member of the Aether OPs team to add your public key to the aether-pod-configs keyring. To create the keypair follow these steps:

$ gpg --full-generate-key
$ gpg --output <key-name>.gpg --armor --export <your-email-address>

Update global resource maps

Download aether-pod-configs repository.

$ git clone "ssh://[username]@gerrit.opencord.org:29418/aether-pod-configs"
$ git-crypt unlock

Add the new cluster information at the end of the following global resource maps.

  • cluster_map.tfvars

  • vpn_map.tfvars

$ cd $WORKDIR/aether-pod-configs/production
$ vi cluster_map.tfvars

# Add the new K8S cluster information at the end of the map
$ git diff cluster_map.tfvars
--- a/production/cluster_map.tfvars
+++ b/production/cluster_map.tfvars
@@ cluster_map = {
      kube_dns_cluster_ip     = ""
      cluster_domain          = "prd.menlo.aetherproject.net"
      calico_ip_detect_method = "can-reach=www.google.com"
+    },
+    ace-test = {
+      cluster_name            = "ace-test"
+      management_subnets      = [""]
+      k8s_version             = "v1.18.8-rancher1-1"
+      k8s_pod_range           = ""
+      k8s_cluster_ip_range    = ""
+      kube_dns_cluster_ip     = ""
+      cluster_domain          = "prd.test.aetherproject.net"
+      calico_ip_detect_method = "can-reach=www.google.com"
$ cd $WORKDIR/aether-pod-configs/production
$ vi vpn_map.tfvars

# Add VPN and tunnel information at the end of the map
$ git diff vpn_map.tfvars
--- a/production/vpn_map.tfvars
+++ b/production/vpn_map.tfvars
@@ vpn_map = {
   bgp_peer_ip_address_1    = ""
   bgp_peer_ip_range_2      = ""
   bgp_peer_ip_address_2    = ""
+  },
+  ace-test = {
+    peer_name                = "production-ace-test"
+    peer_vpn_gateway_address = ""
+    tunnel_shared_secret     = "UMAoZA7blv6gd3IaArDqgK2s0sDB8mlI"
+    bgp_peer_asn             = "65003"
+    bgp_peer_ip_range_1      = ""
+    bgp_peer_ip_address_1    = ""
+    bgp_peer_ip_range_2      = ""
+    bgp_peer_ip_address_2    = ""


Use this site to generate a strong tunnel shared secret.


Unless you have a specific requirement, set ASN to the next available value in the map. For BGP peer IP range and address, use the next available /30 subnet in the map.

Generate Ansible and Terraform configurations

In this step, we will create a directory under production with the same name as the cluster, and add Ansible and Terraform configurations needed to configure a VPN in ACE and GCP using a tool.

$ cd $WORKDIR/aether-pod-configs/tools
$ cp ace_config.yaml.example ace_config.yaml

# Set all values in ace_config.yaml
$ vi ace_config.yaml

$ make vpn
Created ../production/ace-test
Created ../production/ace-test/provider.tf
Created ../production/ace-test/cluster.tf
Created ../production/ace-test/gcp_ha_vpn.tf
Created ../production/ace-test/gcp_fw.tf
Created ../production/ace-test/backend.tf
Created ../production/ace-test/cluster_val.tfvars
Created ../production/ace-test/ansible
Created ../production/ace-test/ansible/hosts.ini
Created ../production/ace-test/ansible/extra_vars.yml

Submit your change

$ cd $WORKDIR/aether-pod-configs/production
$ git status
On branch tools
Changes not staged for commit:

   modified:   cluster_map.tfvars
   modified:   vpn_map.tfvars

Untracked files:
(use "git add <file>..." to include in what will be committed)


$ git add .
$ git commit -m "Add test ACE"
$ git review

Wait for a while until the post-merge job finishes after the change is merged.

Verify VPN connection

You can verify the VPN connections by checking the routing table from the management server and trying to ping to one of the central cluster VMs.

Be sure there are two tunnel interfaces, gcp_tunnel1 and gcp_tunnel2, and three additional routing entries via one of the tunnel interfaces.

# Verify routings
$ netstat -rn
Kernel IP routing table
Destination     Gateway         Genmask         Flags   MSS Window  irtt Iface         UG        0 0          0 eno1 U         0 0          0 eno2 U         0 0          0 mgmt800   UG        0 0          0 gcp_tunnel1   UG        0 0          0 gcp_tunnel1   UG        0 0          0 mgmt800   UG        0 0          0 gcp_tunnel1   U         0 0          0 eno1 U         0 0          0 gcp_tunnel1 U         0 0          0 gcp_tunnel2

# Verify ACC VM access
$ ping

# Verify ACC K8S Service access
$ nslookup kube-dns.kube-system.svc.prd.acc.gcp.aetherproject.net

You can also login to GCP console and check if the edge subnets exist in VPC Network > Routes > Dynamic.

Post VPN setup

Once you verify the VPN connections, update ansible directory name to _ansible to prevent the ansible playbook from being rerun.

$ cd $WORKDIR/aether-pod-configs/production/$ACE_NAME
$ mv ansible _ansible
$ git add .
$ git commit -m "Ansible done for test ACE"
$ git review

Add another ACE to an existing VPN connection

VPN connections can be shared when there are multiple ACE clusters in a site. In order to add another cluster to an existing VPN connection, you’ll have to SSH into the management node and manually update BIRD configuration.


This step needs improvements in the future.

$ sudo vi /etc/bird/bird.conf
protocol static {
   # Routings for the existing cluster
   route via;

   # Add routings for the new ACE's K8S cluster IP range via cluster nodes
   # TODO: Configure iBGP peering with Calico nodes and dynamically learn these routings
   route <NEW-ACE-CLUSTER-IP> via <SERVER1>
   route <NEW-ACE-CLUSTER-IP> via <SERVER2>
   route <NEW-ACE-CLUSTER-IP> via <SERVER3>

filter gcp_tunnel_out {
   # Add the new ACE's K8S cluster IP range and the management subnet if required to the list
   if (net ~ [,, <NEW-ACE-CLUSTER-MGMT-SUBNET>, <NEW-ACE-CLUSTER-IP-RANGE> ]) then accept;
   else reject;
# Save and exit

$ sudo birdc configure

# Confirm the static routes are added
$ sudo birdc show route