Applies to: 
Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace
...
Log in to your Azure Portal, with the user having sufficient permissions and information as mentioned in the prerequisites.
On the Home page, use the search box to search for Marketplace.
Click the Marketplace option. The Marketplace page is displayed.
On the My Marketplace page, type Kyvos in the search box. The Kyvos offer is displayed.
Click the Kyvos offer. This will take you to the Kyvos page, which contains information about the Overview, Plans and Pricing, Usage Information, Support, as well as Ratings and Reviews. You can also click on each tab to read the respective information.
Select the Plan ( Kyvos) from the list, and click Create.
The Create Kyvos wizard is displayed with the parameters required for deployment.
Click Next to navigate to the next tab. For example, if you complete the parameters for the Basic tab, you must click the Next button to navigate to the Networking tab.
Here, enter the details as:
Fields marked (*) are mandatory.
| Aura tab collection |
|---|
| params | JTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3hTaGFkb3clMjIlM0ElN0IlMjJzaGFkb3dzJTIyJTNBJTVCJTdCJTIyY29sb3IlMjIlM0ElMjJyZ2JhKDAlMkMlMjAwJTJDJTIwMCUyQyUyMDAuMDgpJTIyJTJDJTIyaXMlMjIlM0ElMjJkcm9wLXNoYWRvdyUyMiUyQyUyMnglMjIlM0EwJTJDJTIyeSUyMiUzQTAlMkMlMjJibHVyJTIyJTNBMSUyQyUyMnNwcmVhZCUyMiUzQTAlN0QlMkMlN0IlMjJjb2xvciUyMiUzQSUyMnJnYmEoMCUyQyUyMDAlMkMlMjAwJTJDJTIwMC4xNiklMjIlMkMlMjJ4JTIyJTNBMCUyQyUyMnklMjIlM0EzJTJDJTIyYmx1ciUyMiUzQTIlMkMlMjJzcHJlYWQlMjIlM0EtMiU3RCU1RCU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnN0eWxlJTIyJTNBJTIyc29saWQlMjIlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJ0b3AlMjIlM0F0cnVlJTJDJTIyYm90dG9tJTIyJTNBdHJ1ZSUyQyUyMmxlZnQlMjIlM0F0cnVlJTJDJTIycmlnaHQlMjIlM0F0cnVlJTJDJTIyY29sb3IlMjIlM0ElMjIlMjNmNGY1ZjclMjIlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlMkMlMjJzaXplJTIyJTNBJTdCJTIyaGVpZ2h0JTIyJTNBMTUwJTdEJTdEJTJDJTIyYWN0aXZlJTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2Y1ODIyNyUyMiU3RCU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE0JTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyMzAwMDAwMCUyMiU3RCUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIyYm9sZCUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2NjY2VjZiUyMiU3RCU3RCU3RCUyQyUyMmhvdmVyJTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNkZmUxZTYlMjIlN0QlMkMlMjJ0ZXh0JTIyJTNBJTdCJTIyZm9udFNpemUlMjIlM0ExNCUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMwMDAwMDAlMjIlN0QlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJ0b3AlMjIlM0F0cnVlJTJDJTIybGVmdCUyMiUzQXRydWUlMkMlMjJyaWdodCUyMiUzQXRydWUlMkMlMjJib3R0b20lMjIlM0F0cnVlJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIyc3R5bGUlMjIlM0ElMjJzb2xpZCUyMiUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTQlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTJDJTIyYm9yZGVyJTIyJTNBJTdCJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmxlZnQlMjIlM0F0cnVlJTJDJTIycmlnaHQlMjIlM0F0cnVlJTJDJTIyYm90dG9tJTIyJTNBdHJ1ZSUyQyUyMndpZHRoJTIyJTNBMSUyQyUyMnN0eWxlJTIyJTNBJTIyc29saWQlMjIlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzY2NjZWNmJTIyJTdEJTdEJTdEJTdE |
|---|
|
| Aura tab |
|---|
| summary | 1. Basics |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjIxLiUyMEJhc2ljcyUyMiU3RA== |
|---|
|
Enter details as: Area | Parameter | Description |
|---|
Project Details | Subscription* | Your account subscription.
NOTE: All resources in an Azure subscription are billed together. | Resource Group* | 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. | Kyvos and Kyvos Manager Credentials | 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. |
 After completing the information on the Basics tab, click Next. The Networking tab is displayed. Go to the Networking tab. | Aura tab |
|---|
| summary | 2. Networking |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjIyLiUyME5ldHdvcmtpbmclMjIlN0Q= |
|---|
|
Enter details as: Parameter | Description |
|---|
Deploy Kyvos in existing Virtual Network (VNet) | For the virtual network, the default settings are displayed. You can also modify the default settings by clicking 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.
Subnet for Kyvos Instances: Select the subnet(s) CIDR range between /16 to /26. Select No to deploy Kyvos using existing virtual Network, and complete the following parameters: To enable advanced network configurations, select the Enable Firewall on Storage Account checkbox to enable firewall rule on a storage account. Select Databricks Virtual Network: Select the virtual network attached to Databricks Workspace. Select Databricks private subnet: Select the private subnet of Databricks virtual network. Select Databricks public subnet: Select the public subnet of Databricks virtual network.
NOTE: If you deploy Kyvos using existing virtual network, firewall on functions and storage account will not be enabled. |
 After completing the information on the Networking tab, click Next. The Databricks Configurations tab is displayed. Go to the Databricks Configurations tab. | Aura tab |
|---|
| summary | 3. Databricks Configurations |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjIzLiUyMERhdGFicmlja3MlMjBDb25maWd1cmF0aW9ucyUyMiU3RA== |
|---|
|
Enter details as: 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. Re-enter object ID of the principal object.
NOTE: This maps to the ID inside the Active Directory. Service Principal Client Secret: Enter the client secret of the service principal. Re-enter Service Principal client secret.
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 the 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. |
 After completing the information on the Databricks Configurations tab, click Next. The Advance Configurations tab is displayed. Go to the Advance Configurations tab. | Aura tab |
|---|
| summary | 4. Advance Configurations |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjI0LiUyMEFkdmFuY2UlMjBDb25maWd1cmF0aW9ucyUyMiU3RA== |
|---|
|
| Panel |
|---|
| panelIconId | atlassian-note |
|---|
| panelIcon | :note: |
|---|
| bgColor | #DEEBFF |
|---|
| Note This is an optional configuration. If you want to add a prefix to your Kyvos resources, you can specify using the parameters displayed in the Advanced Configurations section. |
Enter details as: Area | Parameter | Description |
|---|
Prefix for Azure Resources | Storage Account | Enter the value to add a prefix to the name of your Kyvos Storage Account. | | 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. |
 After completing the information on the Advance Configurations tab, click Next. The Tags tab is displayed. Go to the Tags tab. | Aura tab |
|---|
| summary | 5. Tags |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjI1LiUyMFRhZ3MlMjIlN0Q= |
|---|
|
| Panel |
|---|
| panelIconId | atlassian-note |
|---|
| panelIcon | :note: |
|---|
| bgColor | #DEEBFF |
|---|
| Note This is an optional configuration. If you want to add a tag to your Kyvos resources, you can specify using the parameters displayed in the Tags section. |
Enter details as: 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 256 characters. | Resource | Select the resources on which you want to add tags. |
 |
...
