NetScaler ingress controller

AWS CloudFormation template for NetScaler VPX

NetScaler provides an AWS CloudFormation Template for NetScaler VPX. The CloudFormation template deploys a NetScaler VPX with one Elastic Network Interface (ENI). You can modify the CloudFormation template based on your production or testing requirements.

The CloudFormation template provisions the NSIP, VIP, and SNIP for the NetScaler VPX instance. The primary IP address of the NetScaler VPX EC2 instance is assigned as VIP so that multiple instances of NetScaler VPX can be deployed and load balanced using AWS ELB. The template also creates and attaches a security group to the ENI of the associated NetScaler VPX to allow all TCP traffic on port 22, 80, and 443. You can modify these port numbers based on your requirement.

Note:

The CloudFormation template includes AMI IDs of customer licensed BYOL (Bring your own License) variant and NetScaler VPX 12.1 version. For more information see, NetScaler VPX - Customer Licensed. If you want to use a different version of NetScaler VPX with the CloudFormation template, you need template and replace the AMI Ids.

Prerequisites

Ensure that you have:

  • Provided sufficient permission to the CloudFormation template for creating IAM roles. The permissions should be beyond normal EC2 full privileges.
  • Accepted the terms of AWS Marketplace products and subscribed to them.
  • Connected VPC to the internet gateway.
  • Configured one public subnet.

Parameters in the CloudFormation template

To use the CloudFormation template, you need to edit the template and provide values for the following parameters:

Parameter Description
VpcID The ID of the Virtual Private Cloud (VPC) where you want to deploy NetScaler VPX.
SubnetID The ID of the subnet in which you want to deploy NetScaler VPX.
VPXInstanceType The instance type to you want to use for the NetScaler VPX instance.
VPXTenancyType The tenancy type. It can be either Dedicated or Shared.
KeyName The SSH key name to access the NetScaler VPX instance using SSH.

How the CloudFormation template works?

When the CloudFormation template is used, it provisions a lambda function that initializes the NetScaler VPX instance with NSIP, VIP, and SNIP. The lambda function performs an initial configuration on the NetScaler VPX. The configurations include network interface, VIP, and features. You can further configure the NetScaler VPX instance either logging in to NetScaler VPX GUI or using SSH (the user name is nsroot and the password is same as InstanceIdNS).

The output of the CloudFormation template includes:

Output Description
InstanceIdNS Instance ID of the created NetScaler VPX instance. The instance ID is the default password to access the NetScaler VPX GUI or command-line
ManagementURL The HTTPS url to access the NetScaler VPX GUI. Use this URL to log on to the NetScaler VPX GUI using self-signed certificates.
ManagementURL2 The HTTP url to access the NetScaler VPX GUI. Use this URL to log on to the NetScaler VPX GUI if your browser has any problems with self-signed certificates.
PublicNSIp The public IP address to access the NetScaler VPX instance using SSH.
PublicIpVIP The public IP address to access the load balanced applications.
PrivateNSIP The private IP address used to manage NetScaler VPX. The IP address is mapped to public elastic IP address: PublicNSIp.
PrivateVIP The private IP address that is used as virtual IP address for hosting the application. The IP address is mapped to public elastic IP address: PublicIpVIP.
SNIP The private IP address used for back-end communication between EKS pods.
SecurityGroup The security group associated with the NetScaler VPX ENI.
AWS CloudFormation template for NetScaler VPX