Skip to content
  1. Home
  2. Docs
  3. Xcalar Cloud Deployment Guide for AWS
  4. Configuring a stack to deploy Xcalar in a new AWS VPC

Configuring a stack to deploy Xcalar in a new AWS VPC

This section describes how to configure your AWS resources as a stack for your Xcalar instance in a new AWS Virtual Private Cloud (AWS VPC).

A stack is a collection of AWS resources that are managed as a single unit and are defined in a CloudFormation template.

A CloudFormation template, known as the Xcalar stack configuration template, creates a Xcalar instance, and if required, a S3 bucket. It also configures Xcalar instance resources, such as access permissions, security connections and protocols, instance type, size, and event management details.

Once created, the Xcalar stack enables the monitoring and management of your Xcalar instance, instance resources, and instance events from AWS CloudFormation. For example, you can reconfigure your instance settings, stop and restart your Xcalar instance, and apply template updates. For more information, see Managing your Xcalar instance.

NOTE: The following assumes that you have completed the prerequisite tasks, that you have logged into the AWS Management Console, and that you have selected a Xcalar supported region.

Choosing the Xcalar stack configuration template

The input you provide in the Create stack page selects the Xcalar stack configuration template.

To choose the Xcalar stack configuration template:

  1. From the Prerequisite – Prepare template options, select Template is ready.
  2. In the Specify template section, do the following:
    1. From the Prepare template options, select Amazon S3 URL.
    2. In the Amazon S3 URL field, enter the Xcalar CloudFormation template URL that was provided by Xcalar support.
  3. Click Next.

Setting your Xcalar stack details

The input you provide in the Specifying stack details page, names and configures your AWS resources for the Xcalar stack.

TIP: Use the Information requirements table to record settings values that will be required later, such as the Administration user name and password, which are used to access Xcalar . For more information, see .

Naming your stack

To name your stack:

(Required) In the Stack name field, enter a name for the stack. Where the name is case sensitive, must contain either alphanumeric characters and hyphens, starts with an alphanumeric character, and contains a minimum of 7 characters and a maximum of 128 characters.

Configuring your stack parameters

You configure your user and access permissions, security, the cluster instance type, size, and connection details, and the network settings in the Parameters section. If you have an existing AWS Route 53 Hosted Zone, you can configure DNS names and TLS security access in the Advance settings section.

To configure your stack parameters:

  1. In the Xcalar Cloud Configuration section, do the following:
    1. (Required) In the Administration Username field, enter the name of the Xcalar administrator account used to access Xcalar. Where the name must contain a minimum of 7 characters and a maximum of 128 characters.
    2. (Required) In the Administration Password field, enter the password of the Xcalar administrator account used to access Xcalar.
    3. In the Notification Email field, enter your email address or the email address of the user who requires information about the stack events and updates, such as the user that manages your AWS resources and has administrative privileges.
  2. In the Security Configuration section, do the following:
    1. In the Allow Access from CIDR Range field, enter the Classless Inter-Domain Routing (CIDR) range that contains a block of IPv4 addresses that are allowed access to your Xcalar cluster.
      NOTE: If unknown, use 0.0.0.0/0, which enables access from anywhere. For a specific IP address, such as work or a home IP, use the 72.22.33.44/32 format.
    2. In the SSH Key Name field, enter the name of the AWS Key Pair that will be used to connect to your Xcalar virtual machine (VM). The key pair consists of a private and a public key and is a set of security credentials that you use to prove your identity. You use the private key instead of a password to securely access the virtual machine where Xcalar runs.
WARNING: An EC2 SSH key pair provides secure access between your AWS resources, your AWS S3 bucket data, and your Xcalar instance. Xcalar does not recommend leaving this value empty. For more information on how to create an AWS EC2 SSH Key pair, see:https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html

NOTE: Your key pair name is never revealed to Xcalar.
  1. In the Cluster Configuration section, do the following:
    1. From the EC2 Instance Type list, select the EC2 virtual machine type that best suits your resources.
      RECOMMENDATION: Xcalar recommends the r5d.4xlarge EC2 instance type.
    2. From the EC2 Instance Count list, select the number of EC2 virtual servers that you require for your Xcalar instance.
    3. In the Disk Size (GB) field, enter in gigabytes the required disk size for your root storage device.
  2. In the VPC/Network section, do nothing.
  3. In the Storage section, do the following:
    1. (Optional) To use an existing S3 bucket, in the Connect an existing S3 bucket field, enter the name of the existing S3 bucket using only the bucket’s name. For example, if your S3 bucket is s3://mybucket, the value is mybucket.
      NOTE: If you do not enter a value, CloudFormation will create a new S3 bucket for you.
    2. (Optional) To use an existing EFS share, in the Existing EFS share field, enter the Elastic File System (EFS) shared resource identifier of an existing AWS EFS.
      NOTE: If you do not enter a value, CloudFormation will create an EFS shared resource identifier for you.
    3. To set the EFS throughput mode, do one of the following:
      • To scale as your file system grows, from the Select throughput or provisioned mode list, select bursting.
      • To set your file system’s throughput independent of the amount of data stored in the data system, from the Select throughput or provisioned mode list, select provisioned and then in the For provisioned, set MB/s field, enter the maximum amount of capacity, in Mebibytes per second (MiB/s), that Xcalar can consume from your data. Valid values are between 1-1024, where the default value is 150.0.
    4. (Optional) To use a local IP address for your EFS share, in the Desired Local IP for EFS field, enter the local IP address of the EFS mount target.
      NOTE: If you do not enter a value, an auto generated IP address is used from your subnet CIDR range.
  4. The settings in the Advance Networking section simplify and secure access to your Xcalar cluster from your Xcalar users.

In the Advance Network Options section, do the following:

    1. Do one of the following:
      • If you require the cluster to be associated with a public IP address, from the Associate Public IP with Cluster list, select true.
      • If you do not require the cluster to be associated with a public IP address, from the Associate Public IP with Cluster list, select false.
        IMPORTANT: You must only set the value to true for Public subnets. If you set the value to true in a Private subnet, your Xcalar instance will not be reachable from your allocated IP address.
    2. (Optional) To distinguish your Xcalar instance with an existing AWS Route 53 hosted zone that contains your DNS service, do the following:
      1. In the Route53 Hosted Zone Domain Name field, enter the AWS Route 53 root domain name that you provided for your hosted zone. For example, mydomain.com.
        NOTE: This option assumes that your AWS account has a matching Route 53 Hosted Zone.
        NOTE: The HostedZoneName and CNAME values distinguish your Xcalar instance with an existing AWS Route 53 hosted zone that contains your DNS service.
      2. In the Name to register in the specified Hosted Zone field, enter the AWS Route 53 DNS name without the domain name, which you want to register in the specified Hosted Zone above, and is used to label and uniquely identify your Xcalar instance. Where the name must contain a minimum of 7 characters and a maximum of 128 characters.
        NOTE: The CNAME value maps the Xcalar instance to the root domain in your hosted zone. For example, if you require example.mydomain.com you would enter example.
    3. (Optional) In the SSL Certificate field, enter your server’s SSL certificate in PEM format exactly as provided without trailing spaces.
    4. (Optional) In the SSL Private Key field, enter your server’s SSL private key in PEM format exactly as provided without trailing spaces.
  1. If you received a Xcalar license key, in the License Key field enter the code exactly as provided without trailing spaces.
  2. Click Next.

Articles

Was this article helpful to you? Yes No

How can we help?