Configuring the first Controller and enabling the Gateway

Prev Next

The first appliance in an AppGate ZTNA Collective must be a Controller. This section explains the supported ways to create and configure the initial Controller appliance, followed by a guided walkthrough of the interactive setup using cz-setup. Once you configure the Controller, you will enable the Gateway functionality on the Controller.

  • Controllers define access rights for users or devices individually, authenticating them based on unique session claims like browser type, device posture, geolocation, and identity.

  • Gateways act as an enforcement point, responsible for controlling user access to protected resources. After seeding, the Gateway registers with the Controller and can receive client connections.


Controller appliance options

How you configure the first Controller depends on the appliance type you deploy. This guide focuses on cloud and virtual options:

  • Cloud instances. Cloud instances are created from templates that can be customized by the vendor or generalized by cloud provider:

    • If the template includes the required data fields, the instance is preconfigured to appear as the first Controller.

    • If the template also includes a data field for the seed file, the instance boots into the function specified in the seed file.

    • If the instance boots without a seed file, you configure it in the same way as a physical machine.

  • Virtual machines. Virtual machines (VMs) typically require an ISO image when the appliance is created:

    • If the VM type allows a seed file to be specified at creation time, the VM boots into the function specified in the seed file.

    • If the VM boots unseeded, you configure it in the same way as a physical machine.

Hosted instances and physical machines are also available, but outside the scope of this guide.

After cz-setup is used to create the first Controller, additional appliances can be created using seed files.


Configure the Controller using cz-setup

This section walks you through the interactive configuration dialogue used to configure the first Controller appliance. During this process, you will create system administration passwords, including the password for the admin user. You will need this password later to sign in to the admin UI.

Before you begin

  • Ensure you have console access to the virtual appliance.

  • Have the following network configuration details available:

    • Hostnames

    • DNS server information

  • Download the appropriate image from the AppGate Support page.

  • AppGate currently supports the following IaaS platforms: Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP).

    • AWS prerequisites:

      • Sufficient privileges to deploy an EC2 instance in the target cloud environment.

      • The AppGate ZTNA – BYOL instance, available in the AWS Marketplace.

      • An Elastic IP address available to assign the EC2 instance.

    • Azure prerequisites:

      • Sufficient privileges to provision a virtual machine with a static public IP address in the target cloud environment.

      • You must use the AppGate ZTNA VM image, available in the Azure Marketplace.

      • A public IP address available to assign the instance.

    • GCP prerequisites:

      • Sufficient privileges to provision a virtual machine with an external static public IP address in the target cloud environment.

      • The AppGate ZTNA image available in the Google Cloud Marketplace.

      • An external static public IP address available to assign the instance.

      • An existing SSH Key to assign to the virtual appliance

Setting up a cloud instance (before running setup utility)

AppGate currently supports the following IaaS platforms: Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). Follow the relevant steps below to set up your instance. If you are not using a cloud provider, skip to Run the setup utility.

AWS

Ensure you have the following prerequisites before setting up AppGate ZTNA on AWS:

  • Sufficient privileges to deploy an EC2 instance in the target cloud environment.

  • The AppGate ZTNA – BYOL instance, available in the AWS Marketplace.

  • An Elastic IP address available to assign the EC2 instance.

To set up an AppGate ZTNA instance on AWS:

  1. Log in to your AWS Management Console.

  2. Navigate to the EC2 Dashboard.

  3. Click on Launch instance.

  4. Enter a name for this instance, appgate-ctr-1

  5. Under Application and OS Images, search for “AppGate ZTNA - BYOL”.

  6. Click on the AWS Marketplace AMIs tab, and then click the Select button on AppgGate ZTNA - BYOL.

  7. Click Subscribe now.

NOTE

Pricing is the cost of the instance. There is no additional charge for this image.

  1. Under Instance type, choose your preferred instance type, such as t3.small                              

  2. Under Key pair, create a new key pair of type RSA.

  3. Under Network settings, leave the default settings. If your organization requires use of a preexisting security group, then the Controller appliance must be directly accessible to the internet.

  4. Under Configure Storage, no changes are required.

  5. Under Advanced details, enter the Controller seed file in the User data field.

NOTE

Use the Wizard to generate the Gateway seed file. This will require you to provide the public IP address you intend to assign to the virtual appliance.

  1. Click on Launch instance.

  2. Attach the Elastic IP to this instance.

  3. Return to the Wizard. In a couple of minutes, the Controller appliance will come online and the Wizard will let you proceed to the next step.

Azure

Ensure you have the following prerequisites before setting up AppGate ZTNA on Microsoft Azure:

  • Sufficient privileges to provision a virtual machine with a static public IP address in the target cloud environment.

  • You must use the AppGate ZTNA VM image, available in the Azure Marketplace.

  • A public IP address available to assign the instance.

To set up an AppGate ZTNA instance on Azure:

  1. Log in to your Azure Console.

  2. Search for “AppGate ZTNA” in the console’s search bar and click on AppGate ZTNA VM in the Marketplace category.

  3. Click Create.

  4. Under the Basics tab, scroll down to Instance details and enter a name for the virtual machine, such as appgate-ctr-1

  5. Update the Inbound port rules to include both SSH (22) and HTTPS (443).

NOTE

In a production deployment, SSH would not be accessible to the internet.

  1. Under the Networking tab, select the virtual network where the Controller will be deployed.

  2. Set the Public IP value to the public IP you provisioned earlier.

  3. In the Load balancing section, ensure the Load balancing options are set to None.

  4. In the Advanced tab, paste the seed file into the Custom data field.

  5. Select Review + create.

  6. Once the deployment is complete, return to the Wizard and wait until the Connection detected message appears. Click Next to continue the setup.

GCP

Ensure you have the following prerequisites before setting up AppGate ZTNA on GCP:

  • Sufficient privileges to provision a virtual machine with an external static public IP address in the target cloud environment.

  • The AppGate ZTNA image available in the Google Cloud Marketplace.

  • An external static public IP address available to assign the instance.

  • An existing SSH Key to assign to the virtual appliance

To set up an AppGate ZTNA instance on GCP:

  1. Log in to your Google Cloud Console.

  2. Search for “AppGate ZTNA” in the console’s search bar and select it from the search results.

  3. In the product details page, select the Get Started button.

  4. Check the Terms and Agreements box and select Agree.

  5. Enter a Hostname for the virtual machine, such as appgate-ctr-1

  6. In the Wizard, click on Copy Seed to Clipboard.

  7. In the Google Cloud Console, paste the seed in to the czSeed field.

  8. In the czSshKey field, enter an existing SSH Key name.

  9. Under Network interfaces, select the External IP address you provisioned earlier.

  10. Under Firewall, enable:

    • TCP port 22

    • TCP port 443

    • UDP port 443

    • TCP port 8443

  11. For each port option, set the Source IP range to 0.0.0.0/0

  12. Click Deploy. Once the deployment is complete, return to the Wizard and wait until the Connection detected message appears. Click Next to continue the setup.

Run the setup utility

  1. Log in to the appliance.

  2. At the console, enter sudo cz-setup

  3. The Appliance Setup screen appears. Select Seed - Configure the appliance as a first Controller.

  4. From the Configure appliance as a first Controller menu, select Hostnames.

  5. Select Appliance Hostname. Enter a unique, fully-qualified domain name (FQDN) for the appliance and select OK. Using an IP address is not recommended.

  6. Leave the Profile DNS Name with its default setting, as you can change this later in the admin UI.

  7. Press Esc to return to the main menu.

  8. Select Network interfaces.

  9. In the Configure network interfaces screen, select eth0 - Configure eth0.

  10. Select dhcp4 - Use DHCP for IPv4. When the value next to it is True, press Esc twice to go back to the main menu.

  11. Select DNS Servers, then select Add DNS server.

  12. Enter one or more DNS servers for name resolution. When you are finished adding DNS servers, press Esc to go back to the main menu.

  13. Select NTP servers.

  14. In Configure NTP servers, you’ll see that AppGate comes with Ubuntu NTP servers. You can modify these, remove them, or add your own if needed. When you are finished, press Esc to go back to the main menu.

  15. Select Administrator passwords, then select Password for “admin” user. This account has system administration privileges and is used to sign in to the web-based admin UI.

  16. Enter the password twice, then press Esc to go back to the main menu.

  17. If you plan to enable Protection Profile mode, select Protection Profile and then select Yes. Otherwise, leave at its default setting. Press Esc to go back to the main menu.

  18. Select Apply configuration, then Yes to continue.

  19. Select Yes to continue.

When registration completes, the Registration completed window appears with the sign-in URL. You can now sign in to the Controller as admin with the password you configured.


Signing in to the Controller UI

To sign in to the Controller:

  1. Navigate to the URL provided during configuration.

  2. Add https:// at the beginning and :8443 at the end of the URL. Example: https://newcontroller.com:8443

NOTE

You must accept the built-in, self-signed certificate for initial setup. Because the certificate is not issued by a trusted authority, your browser or operating system will not recognize it. In production you will use a trusted, CA-signed certificate.

Sign-in credentials

On the sign-in screen, enter the following:

  • Identity Provider. Select local.

  • Username. Enter admin.

  • Password. Enter the password you created during configuration.

After signing in, the Dashboard is displayed. From here, you can begin configuring the AppGate ZTNA system.


Enabling the Gateway

After you have configured the first Controller, you will enable Gateway functionality on that same appliance.

Configure the Controller to act as a Gateway

Perform the following steps to enable Gateway functionality on the existing Controller appliance:

  1. Go to System > Appliances.

  2. Select the name of your Controller appliance to open the Edit Appliance page.

  3. Open the Functions tab.

  4. Under Appliance Functions, select Gateway.

  5. From the Appliance Site list, select the default Site.

  6. In Secure Tunnel Settings, select + Add next to Client Tunneling – Allowed Destinations.

  7. In the Target window, enter eth0 in the Network Interface field and select Done.

  8. Select Save.

The new settings are applied immediately.

Verify Gateway status

Return to System > Appliances and confirm the following:

  • Gateway is displayed in the Function column for the appliance.

  • The appliance status is Healthy.

The Controller is now successfully operating as both a Controller and a Gateway.