Branch Application To Cloud Application Connectivity

Console UI

1. Navigate to Manage Gateways Page
2. Click on + sign in the top right corner.
3. Click on "Create Gateway" on the VCPE Gateway Card
4. Fill in the required information and click on "Create"
5. Copy the Client Registration Key
6. Click on "Download" button on the Installation Package Card
7. Download the correct image for the desired Hypervisor.
8. Follow the installation procedure linked in the description of each image type (i.e. "Click Here").
9. Once installed, login into it locally with ssh and register it using the key copied in the previous step. Run the following command sudo nfnreg "reg key"
10. Once registered, one should see the gateway status turn to green in NF Console UI
11. Done

Console UI

1. Navigate to Manage Gateways Page
2. Click on + sign in the top right corner.
3. Click on "Create Gateway" on the Azure Cloud Gateway Card
4. Fill in the required information and click on "Create"
5. Copy the Client Registration Key
6. Click on "Deploy to Microsoft Azure". It will take you to the Azure Portal and ask you for your login credentials.
7. You will be presented with the template that needs to be filled. The first section is the Basics regarding your Subscription and Resource Group this gateway will be deployed in.
8. The second section related to resources associated with this gateway. e.g. vm name, ip address space, security groups, etc. you will paste the registration key copied in step 5. You will also need the public ssh key to use for access to this gateway remotely.
9. You will need to agree to Azure Marketplace Terms and Conditions and click to "Purchase" to continue.
10. If the NF Gateway was deployed successfully. Here is the view of the Resource Group and NF Conole UI.
11. Done

Console UI

1. Navigate to Manage Services Page under Manage Appwans
2. Click on + sign in the top right corner.
3. Click on "Create an IP Host Service"
4. Fill in the required information for SSH and click on "Create"
5. If successfully, the service is green.
6. Done

Console UI

1. Navigate to Manage AppWANS Page under Manage Appwans
2. Click on + sign in the top right corner.
3. Click on "Component Builder Appwan"
4. Move the desired gateway (e.g. DemoGateway01) from "Available" Gateways to "Selected" Endpoints. Move the desired service (e.g. DemoServiceSsh) from "Available" to "Selected" Services.
5. Click on "Create".
6. Done

Steps

1. Log in to a Client App Host in Branch DataCenter
2. Run ssh username@privateIpOfServerAppHostInAzure

Steps

1. Clone this repo (git clone https://github.com/netfoundry/mop.git)
2. Update Resource yaml file with the desired options to feed into the wrapper script as described in the following code snippet. All Resource.yml Options
3. Run this from the root folder to create GW in NF Console UI and Azure.

   python3 quickstarts/docs/api/python/source/netfoundry/nf_resources.py --file quickstarts/docs/api/python/etc/nf_resources.yml
   

   Required Configuration Parameters for Gateway Creation

   environment: production
   network_action: get
   network_name: DemoNet01
   gateway_list:
   - action: create
     cloud: azure
     count: 1
     names: []
     region: westus
     regionalCidr: [10.20.10.0/24]
     regkeys: []
     resourceGroup:
       name: demoPythonTerraform01
       region: centralus
     tag: TerraformDemo
   terraform:
     bin: terraform
     output: 'no'
     source: ./quickstarts/docs/terraform
     work_dir: .
   

4. After the script is run successfully, one can see that the gateway name and registration key were saved in Resource.yml file. The name is created automatically based on region and gateway type joined with x and gateway count (AZCPEGW means an azure type gateway in NF console). One can create more than one gateway in the same region by increasing the count to more than 1.

   environment: production
   gateway_list:
   - action: create
     cloud: azure
     count: 1
     names:
     - AZCPEGWx0xWESTUS
     region: westus
     regionalCidr:
     - 10.20.10.0/24
     regkeys:
     - 21DB86724EC3F31C11C1C9D68CE5ECD6A06F057E
     resourceGroup:
       name: demoPythonTerraform01
       region: centralus
     tag: TerraformDemo
   network_action: get
   network_name: DemoNet01
   terraform:
     bin: terraform
     output: 'no'
     source: ./quickstarts/docs/terraform
     work_dir: .
   

   
5. Create a test server vm on the same vNet if not already present.
6. Update the Resoure.yaml file to include the Service option to create the NF service on the gateway create in the previous step. Don't forget to change the action on the gateway to "get".

   environment: production
   gateway_list:
   - action: get
     cloud: azure
     count: 1
     names:
     - AZCPEGWx0xWESTUS
     region: westus
     regionalCidr:
     - 10.20.10.0/24
     regkeys:
     - 21DB86724EC3F31C11C1C9D68CE5ECD6A06F057E
     resourceGroup:
       name: demoPythonTerraform01
       region: centralus
     tag: TerraformDemo
   network_action: get
   network_name: DemoNet01
   terraform:
     bin: terraform
     output: 'no'
     source: ./quickstarts/docs/terraform
     work_dir: .
   services:
   - action: create
     gateway: AZCPEGWx0xWESTUS
     ip: 10.20.10.5
     port: 22
     name:
     type: host
   

7. After the script run again successfully, the service section should have been populated with the service name as so.

   services:
   - action: create
     gateway: AZCPEGWx0xWESTUS
     ip: 10.20.10.5
     name: AZCPEGWx0xWESTUS--10.20.10.5--22
     port: 22
     type: host
   

   
8. Create a gateway in the branch as the steps in the UI section indicated. We will provide code snippets for private hypervisors deployment through python in later releases (e.g. vSphere)
9. Update the Resoure.yaml file to include the AppWan option to create the NF AppWan tying the gateway, client and service created in the previous steps. Don't forget to change the action on the service option to "get".

   environment: production
   gateway_list:
   - action: get
     cloud: azure
     count: 1
     names:
     - AZCPEGWx0xWESTUS
     region: westus
     regionalCidr:
     - 10.20.10.0/24
     regkeys:
     - 21DB86724EC3F31C11C1C9D68CE5ECD6A06F057E
     resourceGroup:
       name: demoPythonTerraform01
       region: centralus
     tag: TerraformDemo
   network_action: get
   network_name: DemoNet01
   services:
   - action: get
     gateway: AZCPEGWx0xWESTUS
     ip: 10.20.10.5
     name: AZCPEGWx0xWESTUS--10.20.10.5--22
     port: 22
     type: host
   terraform:
     bin: terraform
     output: 'no'
     source: ./quickstarts/docs/terraform
     work_dir: .
   appwans:
   - action: create
     endpoints:
     - BranchGatewayName
     - ClientName
     name: appwan-ssh-22
     services:
     - AZCPEGWx0xWESTUS--10.20.10.5--22
   

10. After the script ran again successfully, the connectivity should have been up.
11. To test connectivity, log in to the Remote Client or Branch App Server and run ssh "username"@"privateIp"
12. To delete resources created, just follow the reverse order. Change the action to delete for AppWans first, then other resources as indicated in the code snippets.

    appwans:
    - action: delete
      endpoints:
      - BranchGatewayName
      - ClientName
      name: null
      services:
      - AZCPEGWx0xWESTUS--10.20.10.5--22
    

13. Services

    services:
    - action: delete
      gateway: AZCPEGWx0xWESTUS
      ip: 10.20.10.5
      name: null
      port: 22
      type: host
    

14. Endpoints - will delete all resources in Azure as well.
    1. terraform state rm "{tf resource name for RG}" // run this before the python script if Resource Group needs to be preserved 1.

       gateway_list:
       - action: delete
         cloud: azure
         count: 1
         names: []
         region: westus
         regionalCidr:
         - 10.20.10.0/24
         regkeys: []
         resourceGroup:
           name: demoPythonTerraform01
           region: centralus
         tag: TerraformDemo
       

15. Network

    environment:  production
    network_action: delete
    network_name: DemoNet01
    

16. Done

Setting Up Jenkins Pipeline

1. Login to Jenkins
2. Click on " New Item"
3. Name you Project, select pipeline option and click "Ok"
4. In the pipeline details, fill in the scm details as seen in the image below and click "Save". Everything default apart from:
   1. Repository Url: https://github.com/netfoundry/mop.git
   2. Script Path: pipeline/netfoundrydeploy2cloud.jenkinsfile
5. Set up users for Azure API and NF MOP API access -- More on Credentials setup
6. Run Jenkinsjob by selecting on the pipeline created in the previous step. Click on "Build with Parameters"

To create the resources

1. Fill in the Azure Details (e.g. RG, Tenant Id, etc) and select the following:

   1. NF Environment, e.g. production
   2. NETWORK_ACTION - create
   3. NETWORK_NAME, e.g. DEMONET
   4. GATEWAY_ACTION - create
   5. If Azure RG needs to be preserved, then KEEP_RG option must be left checked.
   6. LOCATION, e.g. westus - location where the Azure GW will be deployed in
   7. SUBNET_PREFIX, e.g. 10.20.10.0/24 - the subnet used for the vNet in the location of the Azure GW deployment.

2. Run Jenkins job again by selecting on the pipeline created in the previous step. Click on "Build with Parameters"

3. Fill in service and appwan details by selecting the following:
   1. KEEP_RG - not selected
   2. NF Environment, e.g. production
   3. SERVICE_ACTION - create
   4. APPWAN_ACTION - create
   5. GATEWAY_NAME, e.g. AZCPEGWx0xWESTUS (this is created in the previous step automatically)
   6. SERVICE_NAME, e.g. AZCPEGWx0xWESTUS--10.20.10.5--22 (this is created automatically during this step)
   7. SERVICE_IP, e.g. 10.20.10.5
   8. SERVICE_PORT, e.g. 22
   9. APPWAN_NAME, e.g. appwan-ssh-22
   10. APPWAN_PRIVATE_GATEWAY, e.g. private-gateway-name (this is created outside of the jenkins job, prior to running this step)
   11. APPWAN_PRIVATE_CLIENT, e.g. client-name (this is created outside of the jenkins job, prior to running this step)
   12. APPWAN_SERVICE, e.g. AZCPEGWx0xWESTUS--10.20.10.5--22

To delete the resources

1. Run Jenkins job again by selecting on the pipeline created in the previous step. Click on "Build with Parameters"

2. Fill in the Azure Details (e.g. RG, Tenant Id, etc) and select the following:

   1. NF Environment, e.g. production
   2. NETWORK_ACTION - delete
   3. NETWORK_NAME, e.g. DEMONET
   4. GATEWAY_ACTION - delete

   Pipeline View

3. Done

Console UI

1. Navigate to Manage Services Page under Manage Appwans
2. Click on + sign in the top right corner.
3. Click on "Create an IP Host Service"
4. Fill in the required information for SSH and click on "Create"
5. If successfully, the service is green.
6. Done

Console UI

1. Navigate to Manage AppWANS Page under Manage Appwans
2. Click on + sign in the top right corner.
3. Click on "Component Builder Appwan"
4. Move the desired gateway (e.g. DemoGateway01) from "Available" Gateways to "Selected" Endpoints. Move the desired service (e.g. DemoServiceSsh) from "Available" to "Selected" Services.
5. Click on "Create".
6. Done