Document toolboxDocument toolbox

Deployment Parameters for Azure Marketplace

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

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


The Create Kyvos wizard displays the following parameters required for deployment.

*marked configurations are mandatory.

Basics

Area 

Parameter

Description

Area 

Parameter

Description

Project Details 

Subscription*

Your account subscription.
NOTE: All resources in an Azure subscription are billed together.  

Resource Group*

  • Select the name of your resource group.

  • You can also create a new resource group using the Create new option.

NOTE: You must add this role Managed Application Contributor Role at the subscription level if you want to add a new Resource Group. 

Instance details 

Region* 

Select the same region as of Resource group. 

Kyvos Application Name*

Enter a unique name that you want to provide for the Kyvos Application. 

Email Address*

Enter your email address where you will receive Kyvos Application URLs.

High Availability for BI Server and Web Server

Select the checkbox to enable High Availability for BI Server and Web Server. 

BI Server Instance Size* 

Select the size of the BI Server instance(s).

NOTE: By default, the 1x Standard D4s v4 BI Server instance size is displayed. When you select the High Availability for BI Server and Web Server checkbox, the 2x Standard D4s v4 BI Server instance size is displayed.Click the Change Size link to select the required VM size. Select the Virtual Machine size and click Select. 

Username* 

The Admin user name for Kyvos and Kyvos Manager Web portal. 

Password* 

Enter the Admin password for Kyvos and Kyvos Manager Web portal. 
NOTE: You must keep this Admin Password safe for future reference. 

Confirm Password*

Renter to confirm the Admin password for Kyvos and Kyvos Manager Web portal. 

Query Engines Configurations

Instance Size*  

Select the size of Query Engine instances.

NOTE: By default, the 1x Standard E4ds v4 Query Engine instance size is displayed. Click the Change Size link to select the required VM size. Select the Virtual Machine size and click Select. 

Instance Count

Enter the number of Query Engine instances that you want to create in the Kyvos Cluster. or You can use the Instance Count slider to increase or decrease the Query Engine instance count. 

NOTE: You can select a minimum of 3 Query Engine instances and a maximum of 30 Query Engine instances.

Disk Size* 

Select the disk size applicable for each Query Engine Instance.

Managed Application Details

Managed Resource Group* 

Provide a name for your application's managed group.

NOTE: The resources group holds all the resources that are required by the managed application. For example, this resource group contains virtual machines, storage accounts, and virtual networks for the solution. 

Networking Configurations 

Area 

Parameter

Description

Area 

Parameter

Description

Configure virtual networks 

Virtual Network*  

Click the Create New link. This will open the Create Virtual Network dialog box, where you can do the following:

  • Change the name of the Virtual Network. 

  • Configure the address range of the Virtual Network. 

  • Change the name of the Subnet. 

  • Configure the address range of the Subnet.
    This must be contained by the address space of the Virtual Network.

NOTE: You cannot select an existing Virtual Network.



Subnet*

You can change the name of the subnet using the Create new link available in the Virtual Network tab.

Databricks Configurations

Parameter

Description

Parameter

Description

Workspace URL*

Enter the Databricks Workspace URL where the cluster to be used for data processing by Kyvos is present or will be created.

Personal Access Token* 

Enter the access token for connecting to the Databricks cluster. 

Create New Databricks Cluster*

  • Select  Yes  to create a new Databricks Cluster in the workspace (provided above), and complete the following parameters: 

    • Service Principal Client ID: Enter the Client ID of the Service Principal.

    • Service Principal Object ID: Enter the Object ID assigned to the Service Principal. This maps to the ID inside the Active Directory.

    • Service Principal Client Secret: Enter the Client Secret of the Service Principal.

  • Select  No  to configure your own Databricks cluster, and complete the following parameters: 

    • Cluster ID: Enter the cluster ID of the existing Databricks cluster. 

    • Runtime Version :  Select the Runtime Version of the existing Databricks cluster.
      NOTE: If the version of your existing Databricks cluster is not listed here, to create a new choose No in Use Existing Cluster option.

    • Service Principal Object ID: Enter the object ID assigned to the Service Principal. This maps to the ID inside the Active Directory. 

To find more information about how to  create a new Databricks or to use your own/existing Databricks cluster, see the Prerequisites to Deploy Kyvos on Azure Marketplace page, and navigate to the Databricks Configurations section.  

Advance Configurations

Area 

Parameter

Description

Area 

Parameter

Description

Prefix for Azure Resources

Key Vault

Enter the value to add a prefix to the name of your Kyvos Key Vault. 

Virtual Machines

Enter the value to add a prefix to the name of your Kyvos Virtual Machines. 

Virtual Machine Scale Set

Enter the value to add a prefix to the name of your Kyvos Virtual Machines scale set. 

Network Security Group

Enter the value to add a prefix to the name of your Kyvos Network Security group. 

Tags 

Parameter

Description

Parameter

Description

Name

Enter a tag name. Tags are case-sensitive and are limited to 512 characters. 
Tags are name/value pairs that enable you to categorize resources and view consolidated billing by applying the same tag to multiple resources and resource groups. Refer to Microsoft documentation to learn more about tags.

NOTE: If you create tags and then change resource settings on other tabs, your tags will be automatically updated.

Value

Enter a tag value. Tags values are case-sensitive and are limited to 512 characters. 

Resource

Enter the custom prefix that you want to append before the name of the Network Security Group in case a new group is created for use with Kyvos.



Copyright Kyvos, Inc. All rights reserved.