Applies to: Kyvos Enterprise
Kyvos Cloud (SaaS on AWS)
Kyvos AWS Marketplace
Kyvos Azure Marketplace
Kyvos GCP Marketplace
Kyvos Single Node Installation (Kyvos SNI)
To continue using Kyvos resources, you MUST have a valid license file. An expired license file cannot be reused. Contact Kyvos Support to get your renewed license file.
Important
Please note that once your license has expired, you must only recharge it with a valid license when your cluster runs in the grace period.
To know the license expiry date, refer to your license contract, see the Subscription Plan page, or check validity through Kyvos Manager.
You can also subscribe to notifications to get notified before the license expires. For credit-related notifications, you will receive notifications such as:
Your credits are exhausting. Please recharge.
Your credits are exhausted; hence the Kyvos cluster will shut down. Please recharge.
The validity period has expired. You still have remaining <100> credits. To use the remaining credits, please recharge.
If subscribed, you get credit-related email notifications depending upon the configured thresholds. You can configure the credit limit threshold from Manage Subscription.
Kyvos license management from Web Portal
Viewing Kyvos license
Viewing credit-based license details
The information about the purchased Kyvos credits is displayed on the Subscription Plan page (explained below) on the Kyvos Web portal. Depending on the details of your credit-based license, the rates for different Kyvos layers, such as Compute, Storage, and query engine, are displayed.
Based on the type of credit file (PAYU credits, Reserved credits, or containing both the credit types) you upload, the Kyvos Usage Dashboard displays the credit purchased details.
See the Monitoring Kyvos credits usage section for more details.
The details include:
The number of purchased credits for each Kyvos layer
The expiry date of Kyvos credits. It also displays the number of days remaining in the expiry date
The usage rates for different Kyvos layers
The usage rates for the Storage layers
Carry forward details of remaining credits
Deployment ID
Grace period
Kyvos credit model as PAYU/reserved
To view the credit details, perform the following steps.
From the Toolbox, click Setup > Subscription Plan.
The Subscription Plan page shows details of the purchased credits, validity period, and computation costs of different Kyvos layers. Depending on your license contract and deployment requirements, your license file can contain PAYU credits, Reserved credits, or both.For computation resources, you can view the hourly cost for BI Servers and Query Engines. Query layer rates are displayed per query engine. You can view the hourly cost of query engines according to the running capacity, such as zero, moderate, and full.
For storage resources, the per-month GB cost is displayed.
Click View Usage to view the details of consumed credits.
Viewing non-credit based license details
You can view the license details, including information on the available and maximum BI Servers and Query Engines.
To view BI Server and Query Engine information, perform the following steps.
From the Toolbox, click Setup, then click License.
You will see the maximum capacity supported by your license in the table headers—for example, 5 BI Servers.
The graph shows the number of used and unused portions up to the total capacity. Hover the cursor over the bars in the graphs to see additional details.
Uploading a new license
To upload a license while using Kyvos, perform the following steps.
From the Toolbox, click Setup, and then click License.
View the current license details, including the expiration date and the remaining days.
To upload a new license, click Browse, navigate to the license file and select it.
Click Upload.
Upon uploading the new license file, the credit details will be displayed on the Subscription Plan page. See the Monitoring Kyvos Usage section for more details.
For credits-based Kyvos license file
For a credit-based license, evaluation license files (Kyvos credits license file and Kyvos license file) are used to create the primary cluster, secondary, or tertiary for deployment. These license files do not contain a shared database name or deployment ID.
For the secondary or tertiary cluster deployment, you must use the evaluation license file (Kyvos license file).
Post-deployment of this primary or secondary cluster, you must replace the evaluation license files with valid Kyvos licenses.
See the Viewing Kyvos license details section for more details.
Points to remember
If your license contract contains PAYU credits for the primary cluster deployment, do the following:
Upload the Kyvos credits license file containing the purchased Kyvos credits, as explained below.
NOTE: This credits license file must be uploaded only when you deploy a primary cluster, as it contains credit consumption rate details for Kyvos resources shared across all deployments. And hence, do NOT upload this license file for further deployments, such as secondary or tertiary cluster deployment.After uploading the Kyvos credits license file, you must upload the Kyvos license file. It contains deployment-specific details; hence while deploying a secondary or tertiary cluster, you MUST upload this license file on each deployment.
If your license contract contains Reserved Instances for primary or secondary cluster deployment, you must upload the Kyvos credits license file as it contains a specific deployment ID.
You MUST restart the BI Server after uploading the credit load license file for the credit-based license to come into effect.
To upload the Kyvos credits license file for the primary deployment, refer to the Manage Credits section.
Kyvos license management from Kyvos Manager
Updating Kyvos license
Generating license request file
Uploading renewed license
Viewing Kyvos License information
For this, click the cluster name > License > Kyvos License on the navigation pane.
The Kyvos License page displays the current license information including the License Type, Start Date, End Date and the number of BI Server and Query Engine nodes available in the license.
Generating license request file
To get a new license, you will need a combined license file for all Kyvos nodes. The Kyvos Manager allows you to view, download, and generate the combined license file.
On the Kyvos License page, perform the following steps.
Click the generate and download license request file link to request a new license. The file downloads on your computer.
Email this file to support@kyvosinsights.com. The Kyvos Support team will share a new license with you.
If you already have a license, or once you receive the new license file, use the Change License link to select and upload the license file from your computer.
The license is uploaded at a temporary location. Click the Apply button and restart the BI Server to apply the new license.
Note
You MUST restart the BI Server for the new license to come into effect.
From Kyvos 2023.3 onwards, you can see the last operation details, including progress status and start time. To view more comprehensive details, simply click the View Details link, which will take you to the Operations page where you can view the operation information in detail.
Kyvos license for Conversational Analytics
Kyvos should control conversational analytics feature using license based on following scenarios
Feature is disabled from license.
Enabled for unlimited users in the system.
Enabled for limited number of users in the system. The limit here is a number.
As an Admin user, I should be able to see whether Conversational Analytics is enabled or not in the current system on the license Page.
As an Admin user, I should have the ability to select specific users who can use conversational analytics when the license is designed for a limited number of users. As a user, I should be able to use conversational analytics only if it's enabled for me.
In case this feature is disabled from license, then UI should not show any impression of conversational analytics feature. All the screen elements should be hidden accordingly.
To upload a license for Conversational Analytics while using Kyvos, perform the following steps.
From the Toolbox, click Setup, and then click License.
View the current license details, including the expiration date and the remaining days.
To upload a new license, click Browse, navigate to the license file and select it.
Click Upload.
Upon uploading the new license file, the credit details will be displayed on the Subscription Plan page. See the Monitoring Kyvos Usage section for more details.
Kyvos license types
This section provides information on how to view Kyvos license details.
The two types of Kyvos license files uploaded on Kyvos Manager are:
Kyvos license file: This file contains the count of BI Servers and Query Engines and the maximum node capacity where these services can run. This license file cannot be used for multiple deployments. You can upload this license file from Kyvos Manager on the Kyvos License page. See the Uploading license for Kyvos section for more details.
Kyvos credits license file: As the name suggests, this is applicable only for credit-based licenses. This file contains information about the purchased Kyvos credits. This license file can be used for multiple deployments. You can upload this license file from Kyvos Manager on the Manage Credits page.
See the Uploading renewed Kyvos license file section for more details.