Document toolboxDocument toolbox

Deploying Kyvos Cloud using CloudFormation Template

Owned by NIDHI BHANDARI
Dec 01, 2023
5 min read

Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

To deploy the Kyvos using the CloudFormation template, perform the following steps.

  1. Click the Create Stack  >  With New Resources (Standard)  option.

Click the image to see full-size view.
Click the image to see full-size view.

Warning

Please provide the information carefully, as you cannot edit the stack after creation.

Step 1: Specify template

  1. In the Prerequisite - Prepare template, select the Template is ready option.

  2. In the Specify template,  select the Upload a template file option to upload your CloudFormation template using the Choose File button.

  3. Click NEXT.

Step 2: Specify stack details

  1. Enter a Stack name. The Stack name can contain letters (A-Z and a-z), numbers (0-9), and dashes (-).

Note

The Kyvos cluster will be deployed in this name, and you cannot edit the name after deployment. 

For Web Portal High Availability, the stack name should not exceed 32 characters.

  1. The Parameters area displays the configurations defined in your template. It also allows you to enter custom values to create or update a stack.

  2. Enter details as:

    Click NEXT.

Step 3: Configure stack options

  1. Tags: You can specify tags (key-value pairs) to apply to resources in your stack. You can add up to 50 unique tags for each stack. 

Note

If deploying in a secure environment with Ranger deployed on AWS, then you MUST provide the tag as UsedBy=Kyvos

DO NOT use the UsedBy tag for any other deployments.

  1. Permissions: Choose an IAM role to explicitly define how CloudFormation can create, modify, or delete resources in the stack. If you don't choose a role, CloudFormation uses permissions based on your user credentials.

  2. Advanced options: Optionally, you can set additional options for your stack, like notification options and a stack policy. 
    Enter details as:

Step 4: Review

Review the settings selected so far. Click Previous if you need to change any configurations.

Step 5: Create Stack

  1. To proceed, click Create Stack to create and deploy the Kyvos cluster on your AWS environment.

  2. Stack creation starts and takes around 1 hour. Once the cluster is deployed, use the port forwarding method to access the Kyvos Manager portal. refer to the section SSH Port-forwarding to access Kyvos Manager.

  3. Use the KM Access URL and log into the Kyvos Manager using the credentials as admin/admin. You will be redirected to the Change Password page.

  4. Once you change the password (admin/admina), re-login to access the Kyvos Manager.

  5. Here you can view the status of Kyvos installation. Once the installation is done (usually takes 10 -15 minutes), you can access the Kyvos web portal.



Copyright Kyvos, Inc. All rights reserved.