Document toolboxDocument toolbox

Customizing Kyvos Cloud CFT Temaplate

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

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


This section provides a step-by-step guide for customizing an AWS CloudFormation Deployment Template to deploy a Kyvos365 cluster with reduced configuration. The document aims to assist users in understanding the process and requirements for deploying a scaled-down version of the Kyvos365 cluster on AWS. By following this document, users will be able to modify the CloudFormation template to meet their specific resource and configuration needs, enabling them to deploy a Kyvos365 cluster with optimized resources. 

Clone the Latest Deployment Scripts from Source Code Management: 

  1. Follow the provided path from the developers to clone the most recent deployment scripts from the source code management repository. 

  2. Ensure you have the necessary permissions to access the repository. 

 Reducing the Number of Query Engines: 

The deployment scripts are written in JSON. 

To reduce the number of Query Engines to be deployed, perform the following steps.

  1. Open the deployment script file in a text editor or integrated development environment (IDE). 

  2. Locate the section in the JSON file that corresponds to the Query Engines being deployed. 

  3. Search for the string ""QE2"" to find the QE2 section. 

  4. Remove the code blocks and resources associated with the Query Engines. 

  5. Remove the Outputs from the "Output" block for the Query Engines you want to reduce.

Change EC2 Instance Type

  1. Change the EC2 instance type for OE1 and OE2:

    1. Change the instance type from m5.4xlarge to m5.xlarge.

  2. Change the EC2 instance type for QE1 and QE4:

    1. Change the instance type from r5.4xlarge to r5.xlarge.

  3. Save the changes to the deployment script file(replace 4xlarge with xlarge) 

Modify Volume Configuration

  1. Change the volume configuration for V1OE1 and V1OE2: 

    1. Change the size from 300 GB to 125 GB. 

    2. Change the volume type from gp2 to st1. 

  2. Change the volume configuration for AppVolQE1 and AppVolQE: 

    1. Change the size from 100 GB to 125 GB. 

    2. Change the volume type from gp2 to st1. 

  3. Change the volume configuration for V1QE1, V1QE4, V2QE1, and V2QE4: 

    1. Change the volume type from gp2 to st1. 

    2. Modify the value retrieved from the mapping for "DiskSize": 

    3. Locate the code snippet referring to "DiskSize" in the AWS JSON CloudFormation template. 

    4. Change the size to 125 GB from 500 GB. 

  4. Save the changes to the deployment script file. 

Note
Disaster Recovery is enabled, we need to make same changes in DR template too. While modifying the deployment scripts ensure that you are following the correct syntax and structure of the JSON file. Additionally, always keep a backup of the original script and test the modified script in a non-production environment before deploying it in a production environment. 



Copyright Kyvos, Inc. All rights reserved.