Installing Using CloudFormation

Here we describe how to use CloudFormation to create a ZebClient cluster.

Installing from the Customer Portal

Starting Installation

We support the installation of our standard packages through our Customer Portal. Installing from here provides the easiest way to get going.
To do this, perform the following steps:
  1. 1.
    Select a ZebClient package in ZebClient Store and register for a Customer Portal account
  2. 2.
    Login to our Customer Portal
  3. 3.
    On the home screen, click the Deploy to AWS button located in the Subscriptions card
  4. 4.
    Ensure that prerequisites are fulfilled before installation starts
  5. 5.
    Click on the Install on CloudFormation button
Clicking this button will redirect you to the AWS Management Console. You will need to log in to the console using your standard login credentials if you are not logged in.

Creating the ZebClient Cluster

Once logged in you will be presented with the first screen of the CloudFormation template:
  1. 1.
    Confirm the details in Stack name and AllowSshFrom
  2. 2.
    Select the KeyPairName you want to use
  3. 3.
    Make sure you check I acknowledge that AWS CloudFormation might create IAM resources
  4. 4.
    Click Create Stack to begin the creation process
Further details on the CloudFormation process


You should make sure the parameters listed in the CloudFormation template are correct.
  • Stack Name: This will be used to name the various artifacts generated during the CloudFormation Stack formation. Change this if you would like a specific name used in the naming.
  • AllowSshFrom: This will be used to create a Security Rule in the VPC created by the VPC. This will default to the public IP address
  • KeyPairName: This should be set to an RSA key pair that you have created using the instructions here. The keys created in this process will give access to the Zebclient cluster after creation.
  • ZebClientLicense: This is where the ZebClient product key and license key are put. When taking this from the Customer Portal, this will already be filled in and should be left as default.

IAM User

When you have confirmed the defaults, you need to accept that the CloudFormation template will create IAM resources. These are used to provide access to, for example, the S3 buckets used to store Cold Layer data.

Following the Progress

While the stack is being created, you should see the following screen.

Completing Installation

It will take approximately 5-10 minutes before the stack is created. Once the stack is created, you should see the following screen.
  1. 1.
    Go to the Outputs tab and make a note of the Agent0PublicIpAddress
Further details on Installation Completion
Under the Outputs tab you will find the Agent0PublicIpAddress. This is the public IP of the Application node created by CloudFormation and you will use it to log in to your ZebClient cluster.


From here you can either check the installation or jump straight to running your first tests.