Document toolboxDocument toolbox

Deploying Kyvos Free on AWS Marketplace

Owned by Sarabjeet Kaur
Last updated: Feb 16, 2024
6 min read

To deploy Kyvos Free using the AWS Marketplace, perform the following steps.

  1. Log in to your AWS Portal, with the user having sufficient permissions and information as mentioned in the prerequisites.

  2. On the Home page, use the search box to search for AWS Marketplace. 

  3. In the AWS Marketplace section, click Discover Products.

  4. In the AWS Marketplace Products section, type Kyvos Free in the search box. The Kyvos Free offer is displayed. 

  5. Click the Kyvos Free offer. This will take you to the Kyvos page, which contains information about the Product overview, Usage Information, Support, as well as Ratings and Reviews. You can also click on each tab to read the respective information. 

  6. In the Pricing Information section, select the Region in which you want to deploy Kyvos. You will also view the Kyvos pricing details for each Kyvos resources. Now, click Continue to Subscribe.

  7. Now, click Continue to Subscribe. This will take you to the Kyvos Terms and Conditions page. In the Action column, click Show Details to expand and view the pricing details of Kyvos resources. Similarly, you click Hide details to collapse the pricing details.

  8. Now, click Continue to Configuration. This will take you to the Configure this Software page.

  9. Select one of the following from the Fulfillment option:

    1. Kyvos (with existing VPC): Select this option if you want to deploy Kyvos using existing VPC.

    2. Kyvos (with VPC creation): Select this option if you want Kyvos to create VPC.

  10. Click Continue to Launch. This will take you to the Launch this Software page. On the page, you can do the following:

    1. Click the Usage instructions link and the following message is displayed.

    2. In the Choose Action list, select the Launch CloudFormation option.

    3. Click Launch. This will take you to the Create stack (Step 1) page.

Step 1: Specify template

  1. In this section, the template is auto-filled and you need not to modify the template manually.

  2. 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. 

If you have enabled 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:

Configuration 

Parameter 

Description/Remarks 

Configuration 

Parameter 

Description/Remarks 

VPC Configurations

(Using existing VPC)

Specify an IPv4 CIDR block of existing VPC.

Please enter the IP range (CIDR notation) for this VPC

 

Select the VPC in which EC2 instances will be launched

Select the VPC from the list.

 

Select the Private Subnets to be attached to EC2 instances

Select 2 private subnets, each from a different availability zone.

 

Select the Public Subnets to be attached to EC2 instances

Select 2 public subnets, each from a different availability zone.

VPC Configurations

(using new VPC)

Specify an IPv4 CIDR block for the VPC ?

Enter the IP range (CIDR notation) for this VPC.

EMR Configurations

Enter the number of Core EC2 Instances to be launched with EMR 

The number of Core EC2 Instances to be launched with EMR.

Recommended value: 2

Enter the minimum number of Core EC2 instances that should be kept running

The minimum number of core nodes that will keep running during scale-in operation.

Recommended value: 2

Enter the maximum number of Core EC2 instances that should be kept running

The maximum number of core nodes that can be used by the EMR during scale-out operation. Recommended value: 10

Enable In-transit encryption for EMR cluster 

Set the value of this parameter to true if you need in-transit encryption with TLS for the EMR cluster.

Enter the S3Object ARN where PEM based certificate is located 

Enter the S3Object Amazon Resource Name (ARN) of the KMS certificate.

NOTE: This is required only if you have enabled in-transit encryption for the EMR cluster.

RDS Configurations 

Postgres Password Kyvos

Specifies the value of the password used for Kyvos Repository. NOTE

The password can include any printable ASCII character except "/", """, "@" and single quote

Advanced Configurations

Name of IAM User to give permissions on KMS key

Specify the name of IAM User to give permissions on KMS key.
NOTE:
You must remove the default passed value of “kmsadmin”.

Enable Environment validation

Only the False value is displayed for this field and selected, by default.

Allowed IP Range

Provide the range of IP addresses allowed to access Kyvos Instances. Use 0.0.0.0/0 to allow all users access.

Email ID

You will receive Kyvos Application URLs and Cloudwatch Alarm Notifications on this email address.

Cloudwatch Alarms

Select true to receive Cloudwatch Alarm Notifications on the above email address if provided.

Password for Kyvos and Kyvos Manager.

Enter the Admin password for Kyvos and Kyvos Manager Web portal. Keep this admin username and password safe for future reference.

 

  1. 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.

  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. Stack failure options: You can specify roll back behavior for a stack failure. For more information, see AWS documentation.

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

Parameter 

Description/Remarks 

Parameter 

Description/Remarks 

Stack policy

Defines the resources that you want to protect from unintentional updates during a stack update. Kyvos does not allow any updates in the stack, so you can leave this blank.

Rollback configuration

Specify alarms for CloudFormation to monitor when creating and updating the stack. If the operation breaches an alarm threshold, CloudFormation rolls it back.

Monitoring time (optional): The number of minutes after the operation completes that CloudFormation should continue monitoring the specified alarms.

CloudWatch alarm (optional): Amazon Resource Name (ARN) of the alarm to monitor.

Notification options

Specify SNS topic ARN (optional).

Stack creation options

Rollback on failure: Specifies whether the stack should be rolled back if stack creation fails.

Timeout: The number of minutes before a stack creation times out.

Termination protection: Prevents the stack from being accidentally deleted. Once created, you can update this through stack actions.

  1. Click NEXT.

Step 4: Review

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

Warning

Please review the settings and information thoroughly. Once the stack is created, you CANNOT update any information. You will have to delete the stack and start over again.

Step 5: Create Stack

To proceed, select the I acknowledge checkbox and click Submit to create and deploy the Kyvos cluster on your AWS environment.

Stack creation starts and takes around 20-25 minutes. Once the cluster is deployed, you will receive an email with URL to access Kyvos Manager and Kyvos through which deployed Kyvos on AWS can be accessed.

Next: https://kyvosdocumentation.atlassian.net/wiki/spaces/KD20235/pages/29886263

Copyright Kyvos, Inc. All rights reserved.