Citrix ADC VPX on the AWS Cloud
Quick Start Reference Deployment
November 2019
Citrix Systems, Inc.
AWS Quick Start team
| Visit our GitHub repository for source files and to post feedback, report bugs, or submit feature ideas for this Quick Start. |
This Quick Start was created by Citrix Systems, Inc. in collaboration with Amazon Web Services (AWS). Quick Starts are automated reference deployments that use AWS CloudFormation templates to deploy key technologies on AWS, following AWS best practices.
Overview
This Quick Start reference deployment guide provides step-by-step instructions for deploying the Citrix ADC VPX for high availability (HA) on the AWS Cloud.
This Quick Start is for users who want to build and test a proof of concept or to create a production-ready solution with a highly available deployment of Citrix ADC VPX as a front end for their web applications.
| Amazon may share user-deployment information with the AWS Partner that collaborated with AWS on the Quick Start. |
Citrix ADC VPX on AWS
Citrix Application Delivery Controller (ADC) VPX is an all-in-one application delivery controller. It provides advanced Layer 4 (L4) load balancing, Layer 7 (L7) traffic management, global server load balancing, server offload, application acceleration, application security, and other essential application delivery capabilities for business needs.
Deploying Citrix ADC VPX on AWS enables customers to use AWS Cloud computing capabilities. It is available as an Amazon Machine Image (AMI) via the AWS Marketplace.
An HA deployment of Citrix ADC VPX consists of two instances in two different subnets or in two different AWS Availability Zones. The instances are set up as an active-passive pair in Independent Network Configuration (INC) mode to provide uninterrupted operation in any transaction. One appliance is configured as the primary node; the other, as the secondary node. The primary node accepts connections and manages servers while the secondary node monitors the primary node. If, for any reason, the primary node is unable to accept connections, the secondary node takes over seamlessly without any traffic disruption.
You can customize this Quick Start by changing the configuration parameters. The Quick Start deploys a full working stack that you can inspect and use as a reference.
AWS costs
You are responsible for the cost of the AWS services and any third-party licenses used while running this Quick Start. There is no additional cost for using the Quick Start.
The AWS CloudFormation templates for Quick Starts include configuration parameters that you can customize. Some of the settings, such as the instance type, affect the cost of deployment. For cost estimates, see the pricing pages for each AWS service you use. Prices are subject to change.
| After you deploy the Quick Start, create AWS Cost and Usage Reports to deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. These reports provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information, see What are AWS Cost and Usage Reports? |
Software licenses
You can choose an Amazon Machine Image (AMI) based on the licensing model, throughput, and bundling options.
-
License model: Pay as You Go (PAYG, for the production licenses) or Bring Your Own License (BYOL, for the Customer Licensed AMI)
-
Throughput: 10 Mbps, 200 Mbps, 1000 Mbps, 3 Gbps, or 5 Gbps
-
Bundle: Express, or Standard, Advanced, or Premium
If you don’t want to purchase a license file at this time, the Quick Start requires a subscription to the Citrix ADC VPX – Customer Licensed AMI, which allows 21 days of free usage and is available from AWS Marketplace. Additional pricing, terms, and conditions may apply.
For instructions, see step 2 in the deployment section.
To upgrade to a production license, see the Licensing section on the Citrix website.
Architecture
Deploying this Quick Start for a new virtual private cloud (VPC) with default parameters builds the following Citrix ADC VPX environment in the AWS Cloud.
As shown in Figure 1, the Quick Start sets up the following:
-
A highly available architecture that spans two Availability Zones.*
-
A VPC configured with public and private subnets, according to AWS best practices, to provide you with your own virtual network on AWS.*
-
Three security groups, one for each network interface (Management, Client, Server), that act as virtual firewalls to control the traffic for their associated instances.
-
In the public subnets:
-
Managed network address translation (NAT) gateways to allow outbound internet access for resources in the private subnets.*
-
A Linux bastion host in an Auto Scaling group to allow inbound Secure Shell (SSH) access to EC2 instances in public and private subnets.*
-
-
In the private subnets, a network interface with a private IP address for the Management (NSIP) and a network interface with a private IP address for the back-end Server subnet (SNIP).
-
An AWS Lambda function to handle Citrix ADC VPX high availability and load balancing configuration.
-
An AWS Identity and Access Management (IAM) role to securely control access to AWS services and resources for your users.
* The template that deploys the Quick Start into an existing VPC skips the components marked by asterisks and prompts you for your existing VPC configuration.
Planning the deployment
Specialized knowledge
This deployment requires a moderate level of familiarity with AWS services. If you’re new to AWS, see Getting Started Resource Center and AWS Training and Certification. These sites provide materials for learning how to design, deploy, and operate your infrastructure and applications on the AWS Cloud.
This Quick Start assumes familiarity with basic networking concepts, and the Citrix Application Delivery Controller (ADC VPX) product.
AWS account
If you don’t already have an AWS account, create one at https://aws.amazon.com by following the on-screen instructions. Part of the sign-up process involves receiving a phone call and entering a PIN using the phone keypad.
Your AWS account is automatically signed up for all AWS services. You are charged only for the services you use.
Technical requirements
Before you launch the Quick Start, review the following information and ensure that your account is properly configured. Otherwise, deployment might fail.
Resource quotas
If necessary, request service quota increases for the following resources. You might need to request increases if your existing deployment currently uses these resources and if this Quick Start deployment could result in exceeding the default quotas. The Service Quotas console displays your usage and quotas for some aspects of some services. For more information, see What is Service Quotas? and AWS service quotas.
| Resource | This deployment uses |
|---|---|
VPCs |
1 |
Elastic IP addresses |
4 |
IAM security groups |
3 |
IAM roles |
1 |
Subnets |
6 (3/Availability Zone) |
Internet gateway |
1 |
Route tables |
2 |
ADC VPX instances |
2 |
Bastion host |
1/2 |
NAT gateway |
2 |
Supported Regions
Citrix ADC VPX isn’t currently supported in all AWS Regions. For a current list of supported Regions, see the Citrix Products on AWS Marketplace page on GitHub.
| Certain Regions are available on an opt-in basis. For more information, see Managing AWS Regions. |
EC2 key pairs
Make sure that at least one Amazon EC2 key pair exists in your AWS account in the Region where you plan to deploy the Quick Start. Make note of the key pair name. You need it during deployment. To create a key pair, see Amazon EC2 key pairs and Linux instances.
For testing or proof-of-concept purposes, we recommend creating a new key pair instead of using one that’s already being used by a production instance.
IAM permissions
Before launching the Quick Start, you must sign in to the AWS Management Console with IAM permissions for the resources that the templates deploy. The AdministratorAccess managed policy within IAM provides sufficient permissions, although your organization may choose to use a custom policy with more restrictions. For more information, see AWS managed policies for job functions.
If you want to securely control access to AWS services and resources for your users, you need to create an IAM user account. The IAM role must have the permissions for the following actions:
ec2:DescribeInstances
ec2:DescribeNetworkInterfaces
ec2:DetachNetworkInterface
ec2:AttachNetworkInterface
ec2:StartInstances
ec2:StopInstances
ec2:RebootInstances
ec2:DescribeAddresses
ec2:AssociateAddress
ec2:DisassociateAddress
iam:SimulatePrincipalPolicy
iam:GetRole
autoscaling:*
sns:*
sqs:*Deployment options
This Quick Start provides two deployment options:
-
Deploy Citrix ADC VPX into a new VPC. This option builds a new AWS environment consisting of the VPC, subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components. It then deploys Citrix ADC VPX into this new VPC.
-
Deploy Citrix ADC VPX into an existing VPC. This option provisions Citrix ADC VPX in your existing AWS infrastructure.
The Quick Start provides separate templates for these options. It also lets you configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and Citrix ADC VPX settings, as discussed later in this guide.
Deployment steps
Sign in to your AWS account
-
Sign in to your AWS account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For details, see Planning the deployment earlier in this guide.
-
Make sure that your AWS account is configured correctly, as discussed in the Technical requirements section.
Subscribe to the Citrix ADC VPX AMI
This Quick Start requires a subscription to the AMI for Citrix ADC VPX in AWS Marketplace.
-
Sign in to your AWS account.
-
Open the AWS Marketplace page for the Citrix ADC (formerly NetScaler) VPX offering by choosing one of the links in the following table.
Citrix ADC VPX isn’t currently supported in all AWS Regions. Check the supported Regions of the AMI that you choose. For a current list of supported Regions for all Citrix ADC VPX AMIs, see the Citrix Products on AWS Marketplace page on GitHub. -
On the AMI page, choose Continue to Subscribe.
-
Review the terms and conditions for software usage, and then choose Accept Terms.
A confirmation page loads, and an email confirmation is sent to the account owner. For detailed subscription instructions, see the AWS Marketplace documentation. -
When the subscription process is complete, exit out of AWS Marketplace without further action. Do not provision the software from AWS Marketplace—the Quick Start deploys the AMI for you.
Launch the Quick Start
| If you’re deploying Citrix ADC VPX into an existing VPC, make sure that your VPC has two private subnets in different Availability Zones for the workload instances and that the subnets aren’t shared. This Quick Start doesn’t support shared subnets. These subnets require NAT gateways in their route tables to allow the instances to download packages and software without exposing them to the internet. Also make sure that the domain name option in the DHCP options is configured as explained in DHCP options sets. You provide your VPC settings when you launch the Quick Start. |
Each deployment takes about 15 minutes to complete.
-
Sign in to your AWS account, and choose one of the following options to launch the AWS CloudFormation template. For help with choosing an option, see Deployment options earlier in this guide.
-
Check the AWS Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where the network infrastructure for Citrix ADC VPX is built. The template is launched in the us-east-2 Region by default. For other choices, see Supported Regions earlier in this guide.
-
On the Create stack page, keep the default setting for the template URL, and then choose Next.
-
On the Specify stack details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. For details on each parameter, see the Parameter reference section of this guide. When you finish reviewing and customizing the parameters, choose Next.
-
On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you’re finished, choose Next.
-
On the Review page, review and confirm the template settings. Under Capabilities, select the two check boxes to acknowledge that the template creates IAM resources and might require the ability to automatically expand macros.
-
Choose Create stack to deploy the stack.
-
Monitor the status of the stack. When the status is CREATE_COMPLETE, the Citrix ADC VPX deployment is ready.
-
To view the created resources, see the values displayed in the Outputs tab for the stack.
Test the deployment
We refer to the instances in this deployment as primary and secondary. Each instance has different IP addresses associated with it. When the Quick Start has been deployed successfully, traffic goes through the primary Citrix ADC VPX instance configured in Availability Zone 1. During failover conditions, when the primary instance does not respond to client requests, the secondary ADC VPX instance takes over.
The Elastic IP address of the virtual IP address of the primary instance migrates to the secondary instance, which takes over as the new primary instance.
In the failover process, Citrix ADC VPX does the following:
-
Checks the virtual servers that have IPSets attached to them.
-
Finds the IP address that has an associated public IP address from the two IP addresses that the vserver is listening on. One that is directly attached to the vserver, and one that is attached through the IP set.
-
Re-associates the public Elastic IP address to the private IP address that belongs to the new primary virtual IP address.
To test the deployment, connect to the primary instance and trigger Force Failover. Then check whether the secondary instance takes over.
Connect to Citrix HA pair using bastion host
As you cannot access the Citrix ADC VPX instance from outside the VPC, you must use a Linux bastion host to connect to it.
-
In the AWS CloudFormation console, choose the parent stack, and on the Outputs tab, find the value of LinuxBastionHostEIP1.
-
PrivateManagementPrivateNSIP and PrimaryADCInstanceID key’s value to be used in the later steps to SSH into the ADC.
Figure 2. Citrix ADC VPX HA pair deployment resources -
Choose Services.
-
On the Compute tab, select EC2.
-
Under Resources, choose Running Instances.
-
On the Description tab of the primary ADC VPX instance, note the IPv4 public IP address. You will need that IP address to construct the SSH command.
Figure 3. Amazon EC2 console with primary instance description -
To store the key in your keychain, run the command
ssh-add -K <your-key-pair>.pemOn Linux, you might need to omit the -K flag. -
Log in to the bastion host using the following command, using the value for LinuxBastionHostEIP1 that you noted in step 1.
ssh -A ubuntu@<LinuxBastionHostEIP1> -
From the bastion host, you can connect to the primary ADC VPX instance by using SSH.
ssh nsroot@<Primary Management Private NSIP> Password: <Primary ADC Instance ID>
Figure 4. Connecting to the primary Citrix ADC VPX instanceNow you are connected to the primary Citrix ADC VPX instance. To see the available commands, you can run the help command. To view the current HA configuration, you can run the show HA node command.
-
To test failover, run the
force ha failovercommand. When prompted to proceed for failover, pressYand then press Enter to initiate the failover condition.
Figure 5. Initiating force failover test -
Upon failover, the Master State of the primary instance changes to secondary. The status of the instances can be observed by running the
show HA nodecommand:
Figure 6. Primary state changes to secondary -
In the Amazon EC2 console, it can be observed that after failover, the Elastic IP address assigned to the primary ADC VPX instance gets allocated to the secondary instance.
Figure 7. Secondary node description
Best practices for using Citrix ADC VPX on AWS
For deploying a Citrix ADC VPX instance on AWS, certain limitations and usage information must be adhered to. For details, see the Usage Guidelines on the Citrix website.
For information about configuration details that apply to ADC VPX HA Pair, see Ahttps://docs.citrix.com/en-us/citrix-adc/13/deploying-vpx/deploy-aws/high-availability-different-zones.html#how-high-availability-across-aws-availability-zones-works[DC HA Deployment across Availability Zones User’s Guide^] on Citrix website. Add any best practices for using the software.
FAQ
Q. I encountered a CREATE_FAILED error when I launched the Quick Start.
A. If AWS CloudFormation fails to create the stack, we recommend that you relaunch the template with Rollback on failure set to Disabled. (This setting is under Advanced in the AWS CloudFormation console, Options page.) With this setting, the stack’s state is retained and the instance is left running, so you can troubleshoot the issue. (For Windows, look at the log files in %ProgramFiles%\Amazon\EC2ConfigService and C:\cfn\log.)
| When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Please make sure to delete the stack when you finish troubleshooting. |
For additional information, see Troubleshooting AWS CloudFormation on the AWS website.
Q. I encountered a size limitation error when I deployed the AWS CloudFormation templates.
A. We recommend that you launch the Quick Start templates from the links in this guide or from another S3 bucket. If you deploy the templates from a local copy on your computer or from a location other than an S3 bucket, you might encounter template size limitations. For more information about AWS CloudFormation quotas, see the AWS documentation.
Q. The vserver (sample_lb_vserver) is showing as down.
A. This might be because no backend servers have been deployed. We recommend configuring service and service groups and binding them with the load-balancing virtual servers (LB vservers). For more information, see Configure service groups.
Q. While testing in my environment, the backend servers in the remote Availability Zone show as down.
A. Try one of the following options:
-
Add a static route to the remote Availability Zone server subnet by specifying the subnet IP address (SNIP) as the next hop. For more information, see Configuring static routes.
-
Change the subnet mask so that subnets in both Availability Zones are accommodated.
To post feedback, submit feature ideas, or report bugs, use the Issues section of the GitHub repository for this Quick Start. If you’d like to submit code, please review the Quick Start Contributor’s Guide.
Additional resources
AWS resources
AWS services
Citrix ADC VPX documentation
Parameter reference
| Unless you are customizing the Quick Start templates for your own deployment projects, keep the default settings for the parameters labeled Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. Changing these parameter settings automatically updates code references to point to a new Quick Start location. For more information, see the AWS Quick Start Contributor’s Guide. |
Parameters for launching into a new VPC
| Parameter label (name) | Default value | Description |
|---|---|---|
Primary Availability Zone
( |
|
Availability Zone for primary Citrix ADC deployment. |
Secondary Availability Zone
( |
|
Availability Zone for secondary Citrix ADC deployment. |
VPC CIDR
( |
|
CIDR block for the VPC. Must be a valid IP CIDR range of the form x.x.x.x/x. |
Restricted web app CIDR
( |
|
CIDR block that is allowed to access the web apps behind ADC on TCP ports 80, 443. We recommend that you use a constrained CIDR range to reduce the potential of inbound attacks from unknown IP addresses. Using 0.0.0.0/0 enables all IP addresses to access your instance using SSH. |
Restricted SSH CIDR
( |
|
CIDR block that is allowed to access the bastion host (if present) or ADC management interface on port 22. We recommend that you use a constrained CIDR range to reduce the potential of inbound attacks from unknown IP addresses. Note: Since the ADC management interface is deployed in a private subnet, initiate the SSH connection from a host with network connectivity to this private subnet, like bastion host or on-premises host with AWS Direct Connect. |
Primary management private subnet CIDR
( |
|
CIDR block for the primary management private subnet located in the primary Availability Zone. |
Primary client public subnet CIDR
( |
|
CIDR block for the primary client public subnet located in the primary Availability Zone. |
Primary server private subnet CIDR
( |
|
CIDR block for the primary server private subnet located in the primary Availability Zone. |
Secondary management private subnet CIDR
( |
|
CIDR block for the secondary management private subnet located in the secondary Availability Zone. |
Secondary client public subnet CIDR
( |
|
CIDR block for the secondary client public subnet located in the secondary Availability Zone. |
Secondary server private subnet CIDR
( |
|
CIDR block for the secondary server private subnet located in the secondary Availability Zone. |
Do you want the QuickStart to associate a NAT-Gateway to Server subnets?
( |
|
Select Yes to associate NAT-Gateway to server subnets |
Primary management private IP (NSIP)
( |
|
(Optional) Private IP address of the primary Citrix ADC instance’s management network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the primary management subnet CIDR. |
Primary client private IP (VIP)
( |
|
(Optional) Private IP address of the primary Citrix ADC instance’s client network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the primary client subnet CIDR. |
Primary server private IP (SNIP)
( |
|
(Optional) Private IP address of the primary Citrix ADC instance’s server network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the primary server subnet CIDR. |
Secondary management private IP (NSIP)
( |
|
(Optional) Private IP address of the secondary Citrix ADC instance’s management network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the secondary management subnet CIDR. |
Secondary client private IP (VIP)
( |
|
(Optional) Private IP address of the secondary Citrix ADC instance’s client network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the secondary client subnet CIDR. |
Secondary server private IP (SNIP)
( |
|
(Optional) Private IP address of the secondary Citrix ADC instance’s server network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the secondary server subnet CIDR. |
VPC tenancy attribute
( |
|
Allowed tenancy of instances launched into the VPC. To launch EC2 instances dedicated to a single customer, choose dedicated. See InstanceTenancy at https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html. |
| Parameter label (name) | Default value | Description |
|---|---|---|
Create bastion host
( |
|
Choose No if you do not want Bastion Host. This deploys a Linux bastion host in the public subnet with an Elastic IP address that gives you access to the components in the private and public subnets. |
| Parameter label (name) | Default value | Description |
|---|---|---|
Citrix ADC Product Name
( |
|
|
Citrix ADC Product Version
( |
|
|
Citrix ADC AMI ID
( |
|
(Optional) AMI ID of the Citrix ADC to be provisioned. If you are opting for a pooled license from ADM, enter the latest BYOL AMI ID. If opting for a PAYG subscription license, enter the AMI ID of the Citrix ADC to be provisioned. If you keep this box blank, the latest AMI associated to the above Citrix ADC Product Name and Version is provisioned by default. |
Citrix ADC login Password
( |
|
Strong password recommended. |
Key pair name
( |
|
Name of an existing public/private key pair. If you do not have one in this AWS Region, create it before continuing. |
Citrix ADC instance type
( |
|
EC2 instance type to use for the ADC instances. Choose an instance type that’s available in the AWS Marketplace for the Region of deployment. |
Citrix ADC IAM role
( |
|
(Optional) If you want to use an existing role or create a new one, ensure that it has the required permissions, and then enter the name of the role. Otherwise, keep this box blank, and the deployment creates the required IAM role. See https://docs.citrix.com/en-us/citrix-adc/13/deploying-vpx/deploy-aws/prerequisites.html. |
Assign Elastic IP address to Management NSIP
( |
|
Choose Yes to assign management Elastic IP addresses during quickstart deployment |
Assign Elastic IP address to client VIP
( |
|
Choose No to assign client Elastic IP address manually after the deployment. |
Do you want the QuickStart to configure a sample LB Vserver?
( |
|
Choose Yes to create a LBVserver as part of quickstart |
| Parameter label (name) | Default value | Description |
|---|---|---|
Pooled license from ADM
( |
|
If choosing BYOL option for licensing, choose Yes. This would allow you to upload your already purchased licenses. Before choosing Yes, configure Citrix ADM as a license server for the Citrix ADC pooled capacity. Refer to https://docs.citrix.com/en-us/citrix-application-delivery-management-software/13/license-server/adc-pooled-capacity/configuring-adc-pooled-capacity.html#configure-citrix-adm-as-a-license-server for details. |
Citrix ADM IP address
( |
|
(Optional) IP address of the Citrix ADM (deployed either on-premises or as an agent in cloud) reachable from the ADC instances. If using pool licensing, enter an IP address. Otherwise, keep this box blank. |
Licensing mode
( |
|
(Optional) By default, Citrix Web App Firewall (ADC) - 200 Mbps Version 13.0-52.24 (https://aws.amazon.com/marketplace/pp/B08286P96W) is provisioned. If you are opting for the BYOL license from ADM, choose Yes for PooledLicense, enter the latest BYOL AMI ID in the CitrixADCImageID box, and choose one of the three licensing modes: Pooled-Licensing, CICO-Licensing (check-in-check-out), CPU-Licensing. |
License bandwidth in Mbps
( |
|
(Optional) Specify only if the licensing mode is Pooled-Licensing. It allocates an initial bandwidth of the license in Mbps to be allocated after BYOL ADCs are created. If using, enter a multiple of 10 Mbps. |
Pooled edition
( |
|
(Optional) License edition for pooled capacity licensing mode. This is used only if licensing mode is Pooled-Licensing. |
Appliance platform type
( |
|
(Optional) Appliance platform type for vCPU licensing mode. If licensing mode is CICO-Licensing, choose VPX-200, VPX-1000, VPX-3000, or VPX-5000. |
vCPU Edition
( |
|
(Optional) License edition for vCPU licensing mode. This is needed only if licensing mode is CPU-Licensing. |
| Parameter label (name) | Default value | Description |
|---|---|---|
Quick Start S3 bucket name
( |
|
S3 bucket that you created for your copy of Quick Start assets. Use this if you decide to customize the Quick Start. This bucket name can include numbers, lowercase letters, uppercase letters, and hyphens but should not start or end with a hyphen. |
Quick Start S3 bucket Region
( |
|
AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value. |
Quick Start S3 key prefix
( |
|
S3 key name prefix that is used to simulate a folder for your copy of Quick Start assets. Use this if you decide to customize the Quick Start. This prefix can include numbers, lowercase letters, uppercase letters, hyphens, and forward slashes. See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html. |
Parameters for launching into an existing VPC
| Parameter label (name) | Default value | Description |
|---|---|---|
VPC ID
( |
|
ID of your existing VPC (e.g., vpc-0343606e). |
Bastion security group ID
( |
|
(Optional) Security group ID associated with the bastion host, if present. This is used to allow access from the bastion hosts to the interfaces belonging to the security groups that will be created for the Citrix ADC HA pair. Effectively, the bastion hosts can open connections to all ADC interfaces (management, client, and server). |
Restricted SSH CIDR
( |
|
CIDR block that is allowed to access the bastion host (if present) or ADC management interface on port 22. We recommend that you use a constrained CIDR range to reduce the potential of inbound attacks from unknown IP addresses. Note: Since the ADC management interface is deployed in a private subnet, initiate the SSH connection from a host with network connectivity to this private subnet, like bastion host or on-premises host with AWS Direct Connect. |
Restricted web app CIDR
( |
|
CIDR block that is allowed to access the web apps behind ADC on TCP ports 80, 443. We recommend that you use a constrained CIDR range to reduce the potential of inbound attacks from unknown IP addresses. Using 0.0.0.0/0 enables all IP addresses to access your instance using SSH. |
Primary management private subnet ID
( |
|
Private subnet ID of an existing subnet dedicated for primary management network interface. |
Primary client public subnet ID
( |
|
Public subnet ID of an existing subnet dedicated for primary client network interface. |
Primary server private subnet ID
( |
|
Private subnet ID of an existing subnet dedicated for primary server network interface. |
Secondary management private subnet ID
( |
|
Private subnet ID of an existing subnet dedicated for secondary management network interface. |
Secondary client public subnet ID
( |
|
Public subnet ID of an existing subnet dedicated for secondary client network interface. |
Secondary server private subnet ID
( |
|
Private subnet ID of an existing subnet dedicated for secondary server network interface. |
Primary management private IP (NSIP)
( |
|
(Optional) Private IP address of the primary Citrix ADC instance’s management network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the primary management subnet CIDR. |
Primary client private IP (VIP)
( |
|
(Optional) Private IP address of the primary Citrix ADC instance’s client network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the primary client subnet CIDR. |
Primary server private IP (SNIP)
( |
|
(Optional) Private IP address of the primary Citrix ADC instance’s server network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the primary server subnet CIDR. |
Secondary management private IP (NSIP)
( |
|
(Optional) Private IP address of the secondary Citrix ADC instance’s management network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the secondary management subnet CIDR. |
Secondary client private IP (VIP)
( |
|
(Optional) Private IP address of the secondary Citrix ADC instance’s client network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the secondary client subnet CIDR. |
Secondary server private IP (SNIP)
( |
|
(Optional) Private IP address of the secondary Citrix ADC instance’s server network interface. If you want to provide your own IP address, enter a number between 5 and 254 for the last octet. Otherwise, keep this box blank, and an IP address is automatically assigned from the secondary server subnet CIDR. |
VPC tenancy attribute
( |
|
Allowed tenancy of instances launched into the VPC. To launch EC2 instances dedicated to a single customer, choose dedicated. See InstanceTenancy at https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html. |
| Parameter label (name) | Default value | Description |
|---|---|---|
Citrix ADC Product Name
( |
|
|
Citrix ADC Product Version
( |
|
|
Citrix ADC AMI ID
( |
|
(Optional) AMI ID of the Citrix ADC to be provisioned. If you are opting for a pooled license from ADM, enter the latest BYOL AMI ID. If opting for a PAYG subscription license, enter the AMI ID of the Citrix ADC to be provisioned. If you keep this box blank, the latest AMI associated to the above Citrix ADC Product Name and Version is provisioned by default. |
Citrix ADC login Password
( |
|
Strong password recommended. |
Key pair name
( |
|
Name of an existing public/private key pair. If you do not have one in this AWS Region, create it before continuing. |
Citrix ADC instance type
( |
|
EC2 instance type to use for the ADC instances. Choose an instance type that’s available in the AWS Marketplace for the Region of deployment. |
Citrix ADC IAM role
( |
|
(Optional) If you want to use an existing role or create a new one, ensure that it has the required permissions, and then enter the name of the role. Otherwise, keep this box blank, and the deployment creates the required IAM role. See https://docs.citrix.com/en-us/citrix-adc/13/deploying-vpx/deploy-aws/prerequisites.html. |
Assign Elastic IP addresses to both Primary and Secondary Management NSIPs
( |
|
Choose Yes to assign management Elastic IP addresses during quickstart deployment |
Assign Elastic IP address to client VIP
( |
|
Choose No to assign client Elastic IP address manually after the deployment. |
Do you want the QuickStart to configure a sample LB Vserver?
( |
|
Choose Yes to create a LBVserver as part of quickstart |
| Parameter label (name) | Default value | Description |
|---|---|---|
Pooled license from ADM
( |
|
If choosing BYOL option for licensing, choose Yes. This would allow you to upload your already purchased licenses. Before choosing Yes, configure Citrix ADM as a license server for the Citrix ADC pooled capacity. Refer to https://docs.citrix.com/en-us/citrix-application-delivery-management-software/13/license-server/adc-pooled-capacity/configuring-adc-pooled-capacity.html#configure-citrix-adm-as-a-license-server for details. |
Citrix ADM IP address
( |
|
(Optional) IP address of the Citrix ADM (deployed either on-premises or as an agent in cloud) reachable from the ADC instances. If using pool licensing, enter an IP address. Otherwise, keep this box blank. |
Licensing mode
( |
|
(Optional) By default, Citrix Web App Firewall (ADC) - 200 Mbps Version 13.0-52.24 (https://aws.amazon.com/marketplace/pp/B08286P96W) is provisioned. If you are opting for the BYOL license from ADM, choose Yes for PooledLicense, enter the latest BYOL AMI ID in the CitrixADCImageID box, and choose one of the three licensing modes: Pooled-Licensing, CICO-Licensing (check-in-check-out), CPU-Licensing. |
License bandwidth in Mbps
( |
|
(Optional) Specify only if the licensing mode is Pooled-Licensing. It allocates an initial bandwidth of the license in Mbps to be allocated after BYOL ADCs are created. If using, enter a multiple of 10 Mbps. |
Pooled edition
( |
|
(Optional) License edition for pooled capacity licensing mode. This is used only if licensing mode is Pooled-Licensing. |
Appliance platform type
( |
|
(Optional) Appliance platform type for vCPU licensing mode. If licensing mode is CICO-Licensing, choose VPX-200, VPX-1000, VPX-3000, or VPX-5000. |
vCPU Edition
( |
|
(Optional) License edition for vCPU licensing mode. This is needed only if licensing mode is CPU-Licensing. |
| Parameter label (name) | Default value | Description |
|---|---|---|
Quick Start S3 bucket name
( |
|
S3 bucket that you created for your copy of Quick Start assets. Use this if you decide to customize the Quick Start. This bucket name can include numbers, lowercase letters, uppercase letters, and hyphens but should not start or end with a hyphen. |
Quick Start S3 bucket region
( |
|
AWS Region where the Quick Start S3 bucket (QSS3BucketName) is hosted. When using your own bucket, you must specify this value. |
Quick Start S3 key prefix
( |
|
S3 key name prefix that is used to simulate a folder for your copy of Quick Start assets. Use this if you decide to customize the Quick Start. This prefix can include numbers, lowercase letters, uppercase letters, hyphens, and forward slashes. See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html. |
Send us feedback
To post feedback, submit feature ideas, or report bugs, use the Issues section of the GitHub repository for this Quick Start. To submit code, see the Quick Start Contributor’s Guide.
Quick Start reference deployments
See the AWS Quick Start home page.
GitHub repository
Visit our GitHub repository to download the templates and scripts for this Quick Start, to post your comments, and to share your customizations with others.
Notices
This document is provided for informational purposes only. It represents AWS’s current product offerings and practices as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS’s products or services, each of which is provided “as is” without warranty of any kind, whether expressed or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.
The software included with this paper is licensed under the Apache License, version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://aws.amazon.com/apache2.0/ or in the accompanying "license" file. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for specific language governing permissions and limitations.