Deploying TAS for VMs with NSX-T Networking

Page last updated:

This topic describes how to install VMware Tanzu Application Service for VMs (TAS for VMs) on vSphere with NSX-T internal networking, using the VMware NSX-T Container Plug-in for Ops Manager.

Note: These instructions have been updated to use the NSX-T Policy API, the next-generation interface for integrating with the NSX-T networking and security framework.

Overview

TAS for VMs uses a Container Network Interface (CNI) plugin to support secure and direct internal communication between containers. This plugin can be:

Prerequisites

Before deploying TAS for VMs with NSX-T networking, you must have the following:

  • An NSX-T environment with NSX-T components installed and configured, including a Tier-0 gateway (configured in Active/Passive HA mode) attached to a North-South Transport Zone and a NSX-T edge cluster. The NSX-T version must support the versions of NCP and TAS for VMs you intend to use. Verify the compatibility between NSX-T, NCP and TAS for VMs with the following documentation:

  • BOSH and Ops Manager installed and configured on vSphere. For more information, see Deploying Ops Manager on vSphere and Configuring BOSH Director on vSphere.

  • The VMware NSX-T Container Plug-in for Ops Manager tile downloaded from VMware Tanzu Network and imported to the Ops Manager Installation Dashboard. For information about downloading and importing VMware Tanzu products to the Installation Dashboard, see Adding and Importing Products.

  • The TAS for VMs tile downloaded from VMware Tanzu Network and imported to the Ops Manager Installation Dashboard. The TAS for VMs tile must be in one of the following two states:

    • Configured but not deployed yet; you have not yet clicked Review Pending Changes, then Apply Changes on this version of TAS for VMs.
    • Deployed previously, with the Container network interface plugin field set to External in the Networking pane of the TAS for VMs tile.

      Note: Deploying TAS for VMs with its container network interface (CNI) set to Silk configures Diego Cells to use an internally-managed container network. Subsequently switching the CNI interface to External NSX-T leads to errors.

Architecture

The following diagram shows how to deploy an NSX-T machine to run TAS for VMs across multiple vSphere hardware clusters. NSX-T runs a Tier-0 (T0) gateway and multiple Tier-1 (T1) gateways, each connecting to a network within Ops Manager. Each vSphere hardware column cluster corresponds to an Availability Zone in Ops Manager:

NSX-T & TAS for VMs Overview

When a developer pushes an app to a new org for the first time, the NSX-T plugin triggers NSX-T to create a new T1 gateway and allocate an address range for the org, on demand.

Install and Configure TAS for VMs and NSX-T

Installing NSX-T to run with TAS for VMs requires:

  1. Configure NSX-T to Integrate with TAS for VMs

  2. Enable NSX-T Mode in the BOSH Director

  3. Configure TAS for VMs for External Container Networking

  4. Install and Configure the NSX-T Tile

Set Up NSX-T to Integrate with TAS for VMs

To set up NSX-T to integrate with TAS for VMs, complete these procedures:

Configure NATs

To configure Network Address Translation (NAT) rules:

  1. Create network address translation (NAT) rules to communicate with Ops Manager:
    1. Go to Networking.
    2. Go to the NAT pane.
    3. Select your T0 gateway.
    4. Choose ADD NAT RULE.
    5. Add a rule for destination NAT (DNAT) with:
      • The externally-specified destination IP address of incoming requests. If your Ops Manager has a DNS entry (for example, opsmgr.example.com), this is its IP address.
      • The Ops Manager internal network address.
      • Firewall Setting “bypass” - the packet bypasses firewall rules. NSX-T
    6. Add the corresponding source NAT (SNAT) rule with:
      • The externally-specified destination IP address.
      • The Ops Manager internal network address.
      • Firewall Setting “bypass” - the packet bypasses firewall rules. NSX-T
    7. Add a rule for source NAT (SNAT) for the infrastructure and deployment networks:
      • The externally-specified destination IP address.
      • The internal network address in CIDR notation.
      • Firewall Setting “bypass” - the packet bypasses firewall rules. NSX-T

Configure Gateways

To configure Tier-1 (T1) gateways:

  1. Create T1 gateways for TAS for VMs, to connect from the T0 gateway. For each Ops Manager network, Infrastructure, Deployment, and so on, create a T1 gateway as follows:
  2. In the NSX-T Manager UI, navigate to Networking > Tier-1 Gateways.

    1. Click ADD TIER-1 GATEWAY.
    2. Configure the gateway. Include the Edge Cluster as it is required to enable the Load Balancer. The Infrastructure network gateway configuration might look like the following diagram: NSX-T
  3. Advertise the routes of the T1 gateways to the T0 gateway, so the T0 gateway can correctly route incoming requests based on their destination IP address:

    1. Edit your T1 Gateway and navigate to Route Advertisement.
    2. Enable All Connected Segments & Service Ports.
    3. Enable All LB VIP Routes. (necessary if Load Balancing service is configured). NSX-T
  4. Allocate an IP block for TAS for VMs orgs.

    1. From the NSX-T Manager, navigate to Networking > IP Address Pools, click “IP ADDRESS BLOCKS tab and click ADD IP ADDRESS BLOCK.
    2. Enter a name (for example, TAS for VMs-container-ip-block). This IP block name is also used in the VMware NSX-T tile in the NCP section under IP Blocks of Container Networks.
    3. Enter a description, such as Subnets are allocated from this pool to each newly-created org.
    4. Enter a CIDR to allocate an address block large enough to accommodate all TAS for VMs apps. A /14 CIDR is large enough for ~1,000 Orgs with ~250 apps each. If you are planning such a large foundation, see VMware NSX-T TAS for VMs limits in the VMware documentation. NSX-T
  5. Create an external SNAT IP pool.

    1. Navigate to Networking > IP Address Pools, click "IP ADDRESS POOLS tab and click ADD IP ADDRESS POOL.
    2. Enter a name (such as external-ip-pool) and a description (such as IP pool that provides 1 public IP for each TAS for VMs Org). Later, you will enter this pool name on the VMware NSX-T tile in the NCP section under IP Pools used to provide External (NAT) IP Addresses to Org Networks.
    3. Set a subnet of externally routable ip addresses for future NAT ip addresses NSX-T NSX-T

Configure Segments

To configure segments:

  1. In vSphere, create segments that correspond to the networks that Ops Manager uses.
    1. Log in to the NSX-T Manager Dashboard.
    2. Go to Networking.
    3. Go to the Segments pane.
    4. For each of these networks…
      • Infrastructure (BOSH and Ops Manager, defined in the Assign AZs and Networks pane of the BOSH Director tile)
      • Deployment (TAS for VMs, defined in the Assign AZs and Networks pane of the TAS for VMs tile)
      • Services and Dynamic Services (marketplace services and on-demand services, also defined in the TAS for VMs tile)
      • Isolation Segment (optional, defined in the Assign AZs and Networks pane of the Isolation Segment tile) …do the following:
        1. Click ADD SEGMENT.
        2. Enter a name for the segment
        3. Enter a Gateway to connect to.
        4. Click SAVE. NSX-T

Configure Load Balancer

To configure a load balancer:

  1. Create Active Monitors (health checks) for use by the virtual servers later on. In the NSX-T Manager UI, navigate to Networking > Load Balancing and click the Monitors tab.

    1. Create the health monitor for web load balancing:
      1. Click ADD ACTIVE MONITOR.
      2. Select HTTP
        • Name: tas-web-monitor
        • Monitoring Port: 8080
      3. Configure Additional Properties:
        • HTTP Request URL: /health
        • HTTP Response Code: 200
      4. Click Save.
    2. Create the health monitor for TCP load balancing:
      1. Click ADD ACTIVE MONITOR.
      2. Select HTTP
        • Name: tas-tcp-monitor
        • Monitoring Port: 80
      3. Configure Additional Properties:
        • HTTP Request URL: /health
        • HTTP Response Code: 200
      4. Click Save.
    3. Create the health monitor for SSH load balancing:
      1. Click ADD ACTIVE MONITOR.
      2. Select TCP:
        • Name: tas-ssh-monitor
        • Monitoring Port: 2222
      3. Click Save.
  2. Create Server Pools (collections of VMs which handle traffic) for use by the virtual servers. In the NSX-T Manager UI, navigate to Networking > Load Balancing and click the Server Pools tab.

    1. Create the server pool for web load balancing:
      1. Click ADD SERVER POOL to add a new pool.
        • Name: tas-web-pool
      2. Enter SNAT Translation: Automap
      3. Click Select Members:
        • Membership Type: Static
      4. Click Active Monitor Set:
        • Select tas-web-monitor
        • Click Apply
      5. Click Save.
    2. Create the server pool for TCP load balancing:
      1. Click ADD SERVER POOL to add a new pool.
        • Name: tas-tcp-pool
      2. Enter SNAT Translation: Disabled
      3. Click Select Members:
        • Membership Type: Static
      4. Click Active Monitor Set:
        • Select tas-tcp-monitor
        • Click Apply
      5. Click Save.
    3. Create the server pool for SSH load balancing:
      1. Click ADD SERVER POOL to add a new pool.
        • Name: tas-ssh-pool
      2. Enter SNAT Translation: Disabled
      3. Click Select Members:
        • Membership Type: Static
      4. Click Active Monitor Set:
        • Select tas-ssh-monitor
        • Click Apply
      5. Click Save.
  3. Create the load balancer. In the NSX-T Manager UI, navigate to Networking > Load Balancing and click the Load Balancers tab.

    1. Click ADD LOAD BALANCER.
      1. Enter the fields:
        • Name: tas-lb
        • Load Balancer Size: Choose Small unless you have a larger Foundation
        • Attachment: t1-deployment Attach your load balancer to the Tier 1 gateway fronting your deployment instances
      2. Click Save
      3. Click YES when prompted Want to continue configuring this Load Balancer?
      4. Click Virtual Servers Set
    2. Create the virtual server which forwards unencrypted web (HTTP) traffic to the foundation:

      Note: Foundations requiring end-to-end encryption should not enable the virtual server on port 80, or, if enabled, should configure it to redirect traffic to the encrypted port (443).

      1. Click ADD VIRTUAL SERVER.
      2. Select L4 TCP
        • Name: tas-web-vs
        • Application Profile: default-tcp-lb-app-profile
        • IP Address: use the address of the DNS record of *.system.YOUR-SYSTEM-DOMAIN.com
        • Port: 80,443
        • Server Pool: tas-web-pool
      3. Click SAVE.
    3. Create the virtual server which forwards traffic to apps with custom tcp ports to the foundation:
      1. Click ADD VIRTUAL SERVER.
      2. Select L4 TCP
        • Name: tas-tcp-vs
        • Application Profile: default-tcp-lb-app-profile
        • IP Address: use the address of the DNS record of tcp.apps.YOUR-SYSTEM-DOMAIN.com
        • Port: use the same ports as configured in the TAS for VMs Tile > Networking > TCP Routing Ports, e.g. 1024-1123,5900
        • Server Pool: tas-tcp-pool
      3. Click SAVE.
    4. Create the virtual server which forwards SSH traffic to the foundation:
      1. Click ADD VIRTUAL SERVER.
      2. Select L4 TCP
        • Name: tas-ssh-vs
        • Application Profile: default-tcp-lb-app-profile
        • IP Address: use the address of the DNS record of ssh.system.YOUR-SYSTEM-DOMAIN.com
        • Port: 2222
        • Server Pool: tas-ssh-pool
      3. Click SAVE.

Enable NSX-T Mode in the BOSH Director

To enable NSX-T mode in the BOSH Director:

  1. From the Ops Manager Installation Dashboard, open the BOSH Director for vSphere tile.

  2. In the vCenter Config pane, click the pencil icon for the vCenter Config you want to edit.

  3. Select NSX Networking below.

  4. Configure BOSH Director authentication to the NSX Manager by following the NSX Networking instructions in the Step 2: Configure vCenter section of Configuring BOSH Director on vSphere.

  5. Ensure the "Use NSX-T Policy API” option is selected. NSX-T

Configure TAS for VMs for External Container Networking

To configure TAS for VMs for external container networking:

  1. If you have not already done so, download the TAS for VMs tile from VMware Tanzu Network and import it to the Installation Dashboard. For instructions, see Adding and Importing Products. Ops Manager Installation Dashboard with NSX-T tile

  2. Configure TAS for VMs, following the directions in Configuring TAS for VMs. When you configure Networking, select External under Container networking interface plugin.
    NSX-T

  3. Configure TAS for VMs to add router, diego_brain, and tcp_router instances to the corresponding NSX-T server pools upon deployment.

    1. Open the TAS for VMs tile > Resource Config pane.
    2. Click the arrow next to each job to reveal the NSX-T CONFIGURATION column.
    3. Under Logical Load Balancer, fill in the JSON server_pools list with the NSX-T Server Pool these instance should be added to upon deployment.
      • router -> tas-web-pool
      • diego_brain -> tas-ssh-pool
      • tcp_router -> tas-tcp-pool
    4. Click Save NSX-T

Install and Configure the NSX-T Container Plug-In

To install and configure the tile:

  1. If you have not already done so, download the VMware NSX-T Container Plug-in for Ops Manager tile from VMware Tanzu Network and import it to the Installation Dashboard. For instructions, see Adding and Importing Products. Ops Manager Installation Dashboard with NSX-T tile

  2. Click the VMware NSX-T tile to open its Settings tab, and configure the NSX Manager pane as follows:

    • NSX Manager Address: The NSX-T Manager host address or IP address.
    • Use Client Certificates or Username/Password: Configure this setting as follows:
      1. If you are using VMware Workspace ONE Access, formerly called VMware Identity Manager (vIDM), then select Client Certificate Authentication.
      2. Otherwise, select Basic Authentication with Username and Password and enter NSX Manager Admin Username and Admin Password credentials in the fields underneath.
    • NSX Manager CA Cert: Obtain this certificate from NSX-T Manager as follows:
      1. ssh into NSX-T Manager using the admin account that you created when you deployed NSX-T Manager.
      2. From the NSX-T Manager command line, run get certificate api to retrieve the certificate. NSX-T tile config: NSX-T Manager
  3. Open and configure the NCP (NSX-T Container Plugin) pane as follows:

    • TAS for VMs Foundation Name: If unsure, use TAS for VMs. If multiple foundations co-exist on the same NSX-T Manager, choose a unique string, such as TAS for VMs-beta. NCP creates artifacts, such as T1 gateways and prefixes their names with this string for easy identification.
    • Overlay Transport Zone: A uniquely identifying string for the Transport Zone that you chose when you created segments for each network. This can be the name of the transport zone if no other zones in NSX-T share the same name, or else the UUID for the transport zone.
    • Tier-0 Router: A uniquely identifying string for the T0 gateway. This can be the tag string that you gave the gateway in NSX-T Manager if no other T0 gateways in NSX-T share the same name, or else the UUID for the gateway.
    • IP Blocks of Container Networks: Use the same IP block created Configure Gateways.
    • Subnet Prefix of Container Networks: Subnet mask to set the address range size for apps in a single org. Defaults to 24. This number must be higher than the mask for all TAS for VMs orgs in the NSX-T Manager New IP Block pane, to define each org’s fraction of the total TAS for VMs address space.
    • IP Pools used to provide External (NAT) IP Addresses to Org Networks: Use the same IP Pool created iin Configure Gateways.
    • Enable NSX-T Policy API: Enable this checkbox to use the new Policy API. NSX-T tile config: NCP
  4. In the NSX Node Agent pane, enable the Enable Debug Level of Logging for NSX Node Agent checkbox. NSX-T tile config: NSX-T Node Agent

  5. Click Save and return to the Installation Dashboard.

  6. After you have configured both the TAS for VMs tile and the VMware NSX-T tile, click Review Pending Changes, then Apply Changes to deploy TAS for VMs with NSX-T networking.

Upgrade TAS for VMs with NSX-T Networking

After you have deployed TAS for VMs with NSX-T, you may need to upgrade either Ops Manager, TAS for VMs, the NSX-T Container Plug-in or NSX-T Data Center. If you upgrade one of these components, you may need to upgrade the other components as well.

For example, if you want to upgrade NSX-T Data Center, you may need to upgrade the NSX-T Container Plug-in first.

To upgrade TAS for VMs with NSX-T Networking:

  1. Plan the upgrade by determining the compatibility of NCP, NSX-T and TAS for VMs by checking the following documentation:

  2. Download the desired version of VMware NSX-T Container Plug-in for Ops Manager tile from VMware Tanzu Network.

  3. In Ops Manager, import the new version of the tile to the Installation Dashboard. For instructions, see Adding and Importing Products.

  4. Click Review Pending Changes and review your changes.

  5. Click Apply Changes.

  6. Continue with the upgrade of Ops Manager, TAS for VMs, or NSX-T Data Center. For more information, see Upgrade NCP in a Ops Manager Environment in the VMware NSX-T Data Center documentation.