projectId

Enter the project Id.

NOTE: This project Id will be used for the Kyvos deployment.

region

Enter the region to deploy Kyvos resources.

existingVpcName

Enter name of existing VPC.

NOTE: If this field is left blank, a new VPC will be created.

existingvpcProjectId

Enter the project ID of the existing VPC.

existingSubnetworkName

Enter name of existing VPC subnet.

createNetworkFirewall

To create firewall rules, set the value of this parameter to true.

NOTE: If the value of createVPC is set to true, firewall rules will be created unconditionally. 

gkeSubnetName

Enter the name of an existing Subnet in which you want to deploy GKE Cluster. If left blank subnetwork name will be used.

secondaryRangeName1

Enter the Secondary IPv4 ranges name for GKE Cluster creation.

NOTE: This must be preconfigured if using an existing VPC.
The range should have a minimum masking of /22.

For more information, see Google documentation.

secondaryRangeName2

Enter the Secondary IPv4 ranges name for GKE Cluster creation.

NOTE: This must be preconfigured if using an existing VPC.
The range should have a minimum masking of /22.

For more information, see Google documentation.

secondaryRange1

Enter the Secondary IPv4 ranges for GKE Cluster creation in the case of existing VPC.

secondaryRange2

Enter the Secondary IPv4 ranges for GKE Cluster creation in the case of existing VPC.

customPrefixNameVPC

If the value of the existing VPC name is left blank, enter the prefix name to be used for VPC to be created.

customPrefixNameSubNetwork

If the value of the existing subnetwork name is left blank, enter the prefix name to be used for VPC to be created.

ipCidrRange

Enter the value of ipCidrRange if value of existing VPC name is left blank.

vpcConnectorName

Enter the name of the VPC Connector to be used with GCP functions. 

kmCount

The number of Kyvos Manager instances to be launched.

kmInstanceType

Instance type of Kyvos Manager (n4-standard-4 and n2-standard-4). 

kmVolumeSizeGB

Size of the disk to be attached to the Kyvos Manager.

kmVolumeType

Type of the disk for KM (pd-ssd).

Note: The hyperdisk-balanced disk type is supported for n4 instance type

hostNameBasedDeployment

Change the value to true to use the hostname for the cluster deployment.

createLoadBalancer

Set the value as true to create load balancer.

By default, the value is set as false.

enableWebServerHA

Set the value to true for enabling webserver High Availability.

By default, the value is set as false.

webServerInstanceType

Configure the Web Server instance type.

webServerVolumeSizeGB

Size of the disk to be attached for the Web Server.

webServerVolumeType

Type of the disk for the Web Server (pd-ssd).

Note: The hyperdisk-balanced disk type is supported for n4 instance type

qeCount

The number of instances to be used as query engines.

qeInstanceType

Instance type of query engine (n4-highmem-4 and n2-highmem-4).

qeDataVolumeSizeGB

Size of the disk to be attached with query engines.

qeCacheVolumeSizeGB

Size of the disk to be attached for the cache.

qeCacheVolumeCount

The number of disks to be attached to the cache.

qeCacheVolumeType

Type of the disk for the Web Server (pd-ssd).

Note: The hyperdisk-balanced disk type is supported for n4 instance type

biCount

Enter the number of instances to be used as the BI server.

biInstanceType

Instance type of BI Server (n4-standard-8 and n2-standard-8).

biVolumeCount

The number of disks to be attached to the BI Server.

biVolumeSizeGB

Size of the disk to be attached to the BI Server.

biVolumeType

Type of the disk for the Web Server (pd-ssd).

Note: The hyperdisk-balanced disk type is supported for n4 instance type

createGcpFunctions

Set the value as true to configure GCP Functions in Kyvos.

dataprocMetastoreURI

Enter the Metastore URI if you want to deploy Kyvos with no Spark configuration.

createGKE

Enter the value as True or False.

• True: To create Kubernetes cluster.

gkeWorkerInstancetype

Enter the worker node instance type for the Kubernetes cluster.

NOTE: n2-standard-16 is the minimum configuration. Instance type smaller than this aren't supported.

existingGkeClusterName 

Enter the name of existing GKE cluster.
Note: Set the value of createGKE' parameter to ‘false’

existingNodePoolName 

Enter the node pool name of existing GKEcluster.

sharedK8sNodePool

Select the value as true to use shared K8s node pool.

existingGKERange

Enter the secondary IP range used in the existing GKE cluster if the VPC used by the GKE cluster different from the one used for the deployment.

existingGKEserviceAccountName

Enter the name of service account used in the existing GKE cluster if the service account used by the GKE cluster differs from the one used for the deployment.

minPodCount

Enter minimum pod count. 

NOTE:

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

• The value of MinPodCount parameter cannot be greater than the value of MaxWorkerNodeCount parameter.

• If the value of minPodCount is less than maxWorkerNodeCount, then scaling will be enabled.

maxWorkerNodeCount

Enter the maximum worker node count.

kyvosComputeWorkerNamespace

Enter the name of the Kyvos Compute Worker namespace.

createDataProc

Enter the value as True or False.

• True: If you want to deploy Kyvos with Spark Configuration.

enableComponentGateway

Set the value of ‘enableComponentGateway’ to True to get publicly accessible URL for Dataproc.

sharedDataprocCluster

Select true to use the shared Dataproc cluster. In this case, Kyvos will not manage the Dataproc cluster.Select false to use the on-demand Dataproc cluster. In this case, the Dataproc cluster will automatically start or stop.  

dataProcNetworkTags

Provide a list of comma-separated network tags to be added to the Dataproc cluster.

Example: dataProcNetworkTags : ["abc","xyz"]

enableSshFlag

Set the value to true to enable SSH to the Dataproc cluster.

enableLivy

Set the value of Livy to True if using Dataproc version 2.1.11-debian11 and 2.2.41-debian12

masterInstanceCount

The number of master nodes. For example, 1 

masterInstanceType

Instance type of master node (n2-highmem-4)

masterInstanceVolumeType

Type of the disk for master node (pd-ssd)

workerInstanceCount

The number of worker instances.

workerInstanceType

Instance type of worker node (n2-highmem-8)

workerInstanceVolumeType

Type of the disk for worker node (pd-ssd)

enableDataProcMetastore

Set the value as true to allow external Dataproc metastore.
NOTE: Existing metastore is not supported if the value of the createVPC is true

dataProcMetastoreProjectId

If enable DataProcMetastore is set as true, provide the name of the metastore project ID.

dataProcMetaStoreName

Provide the name of the metastore name.

dataProcVersion

Kyvos is certified with 2.1.11-debian11 and 2.2.41-debian12

enableAutoScaling

Set the value as true to enable the autoscaling of cluster nodes.

existingAutoScalingPolicyName

Provide the name of the existing autoscaling property, if any.
NOTE: Use this configuration only if enableAutoScaling is set as true.

secondaryWorkerMinInstanceCount

Specify the number of minimum worker instances to be kept running while scaling.
NOTE: Use this configuration only if enableAutoScaling is set as true.

secondaryWorkerMaxInstanceCount

Specify the number of maximum worker instances to be kept running while scaling.
NOTE: Use this configuration only if enableAutoScaling is set as true.

existingDataprocClusterName

Enter the name of the existing Dataproc cluster. 

NOTE: Use these Configurations if you want to use the existing Dataproc and set the value of the parameter (createDataProc) to false. 

sshPrivateKeyDataproc

The private key of existing Dataproc.

NOTE: The private key should be base64 encoded

dataprocUsername

Name of the user. 

dedicatedCompute

Set the value of a dedicated Compute cluster to true, if you want to create a new instance group.

The default value is set to false.

dedicatedComputeInstanceCount

Specify the number of Virtual Machines to be created in the instance group.

dedicatedComputeInstanceGroupVmType

Specify the required configuration.

However, the ‘n2-standard-16’ and ‘n4-standard-16’ is the minimum configuration.

dedicatedComputeInstanceVolumeSize

Enter the dedicated compute instance volume size.

dedicatedComputeInstanceVolumeType

Change the value of below parameter to use a different disk type. For more information regarding disk types, visit Google documentation.

createCloudSql

By default, the value is set to ‘false’. To create CloudSQL, set the value to ‘true'.

cloudSqlInstanceType

Enter the cloudSQL instance type.
The recommended instance type is “db-custom-2-4096”

kyvosManagerDbPassword

Enter the Kyvos Manager database password.
This parameter is mandatory if the ‘createCloudSql’ parameter is set to true.

kyvosDbPassword

Enter the Kyvos database password.
This parameter is mandatory if the ‘createCloudSql’ parameter is set to true.

createServiceAccount

 Change the value to false if you want to use the existing Service Account.

serviceAccountName

Enter the service account name to be attached to all Kyvos Virtual Machines. 

enableNodeScaling

Set the value to false to disable the addition of permission required for Node Scaling on Service Account.

createSecretManager

Set value of the parameter to true to create a new secret manager for Kyvos.
The Secret Manager will be explicitly created only when createCloudSql is set to true.

secretManagerName

Provide the name of the existing Secret Manager.

secretManagerProjectId

Provide the name of the Project ID in which the existing secret manager is created.

customPrefixNameDataproc

A prefix is to be added before the name of Dataproc.

customPrefixNameGKE

A prefix is to be added before GKE.

customPrefixNameBI

A prefix is to be added before the name of BI virtual machines.

customPrefixNameBIDisk

A prefix is to be added before the name of BI Disks.

customPrefixNameQE

A prefix is to be added before the name of Query Engine virtual machines.

customPrefixNameQEDisk

A prefix is to be added before the name of Query Engine disks.

customPrefixNameKM

A prefix is to be added before the name of the Kyvos Manager virtual machine. 

customPrefixNameKMDataDisk

A prefix is to be added before the name of the Kyvos Manager disk.

customPrefixNameProxySubNetwork,

A prefix is to be added before the name of proxy sub network.

customPrefixNameWebServer,

A prefix is to be added before the name of web server.

customPrefixNameWebDataDisk

A prefix is to be added before the name of web data disk.

enableEncryption

Set the value to true to enable encryption for the deployment. Encryption will be enabled for Secret Manager, google storage buckets, and disks.

cmkKeyRingName

If this field is left blank, a new CMK key ring will be created. If you want to use an existing key ring, make sure you Bring Your Own Key.

The key should be located in the same region as deployment.

NOTE: Bring Your Own Key: Enter the name of your key ring if encryption is set to true.