Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

...

To create Kyvos resources for creating an AWS CloudFormation template for use in automated deployment, perform the following steps.

...

Area

Parameter/Field

Remarks/Description

Use Graviton Instances

 

Select this option to deploy the Kyvos Services (like BI Server, Query Engines, Kyvos Manager on Graviton instances

EC2 instance(s) for BI Server

Number of Node(s)

Provide the number of EC2 instances that you want to create for BI Server nodes.

Instance Type

Select the EC2 instance type to be used for BI Server nodes.

Installation Disk

Select the type and size of the installation disk to be used for BI Server nodes.

EC2 instance(s) for Query Engine

Number of Node(s)

Provide the number of EC2 instances that you want to create for query engine nodes.

Instance Type

Select the EC2 instance type to be used for query engine nodes.

Installation Disk

Select the type and size of the installation disk to be used for query engine nodes.

EBS Volume

Select the number and size of the disk to be used for query engine nodes.

NOTE: Installation disk size must be 100 GB and the cuboid replication disk size must be in the multiplier of 50 or 100.

Disk Type

Select the disk type to be used as EBS Volume.

Web portal high availability 

 

Select to enable Kyvos web portal high availability.

If you select this, you need to provide the following:

  • Number of nodes

  • Instance Type

  • Subnet for Load Balancer - select Public or Private.

NOTE: To use the Web portal high availability, you must select the EC2 instance for Kyvos Manager checkbox.

EC2 instance for Kyvos Manager 

Instance Type

Clear the check box for wizard-based installation.

Deploy as Tenant

When using a multi-tenant environment, you can use the Deploy as Tenant checkbox to define a tenant.

NOTE: This is displayed only for multi-tenant environment.

Repository 

Select one of the following repository types from the Repository list.

  • Bundled Postgres: To select Postgres as a repository for Kyvos Manager.

  • Create New RDS: To create a new external repository for Kyvos Manager.

  • Existing RDS: To use the existing RDS of Kyvos Manager.

Repository Instance Type

Select the size of the instance type from the  Repository Instance Type. 

Repository 

Instance Type

Select this option and specify the instance type to create a PostgreSQL-based repository using the Amazon RDS. Otherwise, the pre-bundled PostgreSQL-based Kyvos repository will be used.

Output S3 Storage 

Bucket Name Prefix

Select this option and specify the bucket name prefix to create an S3 storage bucket for Kyvos output.

Compute Cluster

Compute Cluster Type

Select the Kyvos Native option.
The Kyvos Native Type list is displayed. Select one of the following options:

  • Shared Query Engines

  • Kubernetes: If you select this option from the list, the Kubernetes Cluster list is displayed. Select one of the following options:

    • Create New: A new Kubernetes cluster will be created for deployment.

    • Use Existing: The existing cluster will be used for deployment.

NOTE: You can create a new Kubernetes cluster or use an existing cluster.

Kubernetes Configurations
(creating with new K8s cluster)

NodeInstanceType

Enter EC2 instance type for the worker nodes.
NOTE: If the value of the node Instance is less than the recommended value, you must set the following value in the HELIX_PARTICIPANT_MAX_CONCURRENT_TASKS Kyvos property through Kyvos Manager.

MinPodCount

Enter number of Pod count.

MaxWorkerNodeCount

Enter maximum desired number of worker nodes

Kubernetes Configurations
(Using existing K8s cluster)

Name of the Existing Kubernetes Cluster

Enter the name of the Existing Kubernetes Cluster.

Name of the Existing Node Group

Enter the name of the Existing Node Group name.

Name of the Existing IAM Role attached to Add-On's of Kubernetes Cluster

Enter the name of the existing IAM Role attached to Add-On's of Kubernetes Cluster.

Name of the Existing IAM Role attached to the NodeGroup

Enter the name of the existing IAM Role attached to the NodeGroup.

Count of the minimum worker

Specify the number of minimum worker nodes.

NOTE: Value of this parameter cannot be 0 and larger than the value of parameter MaxWorkerNodeCountExisting.

Count of the maximum worker

Specify the number of maximum worker nodes.

NOTE: If the values of MinPodCount and MaxWorkerNodeCount are the same, then scaling will be disabled.

Type of NodeGroup

Select one of the following options:

  • Dedicated

  • Shared

NOTE: If parameter KubernetesClusterType is Dedicated then the value of this parameter should be dedicated.

Compute Pod NameSpace

Name of namespace for compute pod. If parameter KubernetesClusterType is Shared then the provided namespace should already exists, if parameter KubernetesClusterType is Dedicated then we will create the specified namespace.

Use custom image

 

Select this option to use a custom image of your environment for deploying the Kyvos cluster. Custom images can be used to bootstrap deployment tasks like preloading applications, application configurations, and other configurations. 

You will have to provide the following information  at the time of deploying the cluster through the CloudFormation.

  • AmiDefaultUserName: Enter the AMI default logged in Linux user.

  • AmiId: Enter the AMI ID to be used for launching Kyvos Instances.

NOTE:

  • From Kyvos 2025.1 onwards, the Custom image-based deployments with Kubernetes (create new or using existing K8s cluster) is supported.

  • If you select the Use Graviton Instances checkbox, the Use Custom Image checkbox is displayeddisabled.

  • To use your custom image, templates named oe _custom.jsonqe_custom.jsonkm_custom.json, and  base_custom.json must be available at the $KYVOS_MANAGER_HOME/cloud/aws/templates/ location. 

...