...
You can now deploy a patch on an existing Kyvos Manager and Kyvos version.
From Kyvos 2024.11 onwards, support is provided for single-click patch deployment using the patch bundle, which may or may not contain a Kyvos patch bundle. If the Kyvos patch bundle is included in the patch bundle, the Kyvos patch deployment will follow the Kyvos Manager patch deployment.
If you deploy a patch for Kyvos Manager, you must initiate the Kyvos patch deployment afterward, if applicable.
| Panel |
|---|
| panelIconId | atlassian-note |
|---|
| panelIcon | :note: |
|---|
| bgColor | #DEEBFF |
|---|
|
Note You need to manually restore the files uploaded from the Configuration Files page (if any), after the patch deployment of Kyvos. |
| Aura tab collection |
|---|
| params | JTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCU3RCU3RA== |
|---|
|
| Aura tab |
|---|
| summary | AWS |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjJBV1MlMjIlN0Q= |
|---|
|
On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. To deploy patch on an existing version, select one of the following from the Upgrade list: To deploy patch for Kyvos Manager and Kyvos, click All Components. This is selected by default. To deploy patch only for Kyvos, click Kyvos from the list. To deploy patch only for Kyvos Manager, click Kyvos Manager from the list.
In the Locate Bundle By, select any of the following options, and provide the corresponding details. Path: Provide the Kyvos bundle path on the node on which Kyvos Manager is running. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade.
Click the required Select Patch from a list of compatible versions. To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field | Description |
|---|
Create backup | Select this option to create a backup of the existing Kyvos environment before deploying the patch. Selecting this option will speed up patch deployment as no data backup will be performed. However, the currently deployed version can not be
restored using rollback | Create semantic model data backup | Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data. | Create logs backup | Select this option to create a backup of the existing logs of your Kyvos environment | Backup Path | Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the Actions menu (…). |
Click the Deploy Now button on the top-right of the page. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm upgrade deployment.
| Panel |
|---|
| panelIconId | atlassian-note |
|---|
| panelIcon | :note: |
|---|
| bgColor | #DEEBFF |
|---|
| Note You need to manually restore the files uploaded from the Configuration Files page (if any), after upgrading Kyvos. Before applying the Kyvos upgrade ensure that patch deployment, the IAM role attached to the Kyvos Manager node has must have the lambda:UpdateFunctionCode permission required for updating Lambda. |
 | Aura tab |
|---|
| summary | Azure |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMiU3RA== |
|---|
|
On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. To deploy patch on an existing version, select one of the following from the Upgrade list: To deploy patch for Kyvos Manager and Kyvos, click All Components. This is selected by default. To deploy patch only for Kyvos, click Kyvos from the list. To deploy patch only for Kyvos Manager, click Kyvos Manager from the list.
In the Locate Bundle By, select any of the following options, and provide the corresponding details. Path: Provide the Kyvos bundle path on the node on which Kyvos Manager is running. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade.
To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field | Description |
|---|
Create backup | Select this option to create a backup of the existing Kyvos environment before deploying the patch. Selecting this option If you clear this checkbox, it will speed up the patch deployment as no data backup will be performed. However, the currently deployed version can not cannot be
restored using rollback. | Create semantic model data backup | Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data. | Create logs backup | Select this option to create a backup of the existing logs of your Kyvos environment | Backup Path | Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu. |
Click the Deploy Now button on the top-right of the page. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm upgrade deployment.
 | Aura tab |
|---|
| summary | GCP |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjJHQ1AlMjAlMjIlN0Q= |
|---|
|
On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. To deploy patch on an existing version, select one of the following from the Upgrade list: To deploy patch for Kyvos Manager and Kyvos, click All Components. This is selected by default. To deploy patch only for Kyvos, click Kyvos from the list. To deploy patch only for Kyvos Manager, click Kyvos Manager from the list.
In the Locate Bundle By, select any of the following options, and provide the corresponding details. Path: Provide the Kyvos bundle path on the node on which Kyvos Manager is running. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade.
To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field | Description |
|---|
Create backup | Select this option to create a backup of the existing Kyvos environment before deploying the patch. Selecting this option If you clear this checkbox, it will speed up the patch deployment as no data backup will be performed. However, the currently deployed version cannot be restored using rollback. | Create semantic model data backup | Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data. | Create logs backup | Select this option to create a backup of the existing logs of your Kyvos environment | Backup Path | Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu. |
Click the Deploy Now button on the top-right of the page. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm upgrade deployment.
 | Aura tab |
|---|
| summary | On-Premises |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjJPbi1QcmVtaXNlcyUyMiU3RA== |
|---|
|
On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. To deploy patch on an existing version, select one of the following from the Upgrade list: To deploy patch for Kyvos Manager and Kyvos, click All Components. This is selected by default. To deploy patch only for Kyvos, click Kyvos from the list. To deploy patch only for Kyvos Manager, click Kyvos Manager from the list.
In the Locate Bundle By, select any of the following options, and provide the corresponding details. Path: Provide the Kyvos bundle path on the node on which Kyvos Manager is running. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade.
To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field | Description |
|---|
Create backup | Select this option to create a backup of the existing Kyvos environment before deploying the patch. If you clear this checkbox, it will speed up the patch deployment as no data backup will be performed. However, the currently deployed version cannot be restored using rollback. | Create semantic model data backup | Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data. | Create logs backup | Select this option to create a backup of the existing logs of your Kyvos environment | Backup Path | Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu. |
Click the Deploy Now button on the top-right of the page. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm upgrade deployment.
|
Kyvos Patch Deployment
To deploy a patch on an existing Kyvos version, perform the following steps.
| Aura tab collection |
|---|
| params | JTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCU3RCU3RA== |
|---|
|
| Aura tab |
|---|
| summary | AWS |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjJBV1MlMjIlN0Q= |
|---|
|
On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. Select Kyvos from the Upgrade list. In the Locate Bundle By, select any of the following options, and provide the corresponding details. Path: Provide the Kyvos Manager bundle path on the node on which Kyvos Manager is running. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade.Version:Enter the Access Key and Client Secret Key to access the bundle, and then click the Fetch Versions button. Select the required version from the Version list to which you want to upgrade. All future versions available for upgrading will be displayed.
Click the required Select Patch from a list of compatible versions. To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field | Description |
|---|
Create backup | Select this option to create a backup of the existing Kyvos environment before deploying the patch. Selecting this option If you clear this checkbox, it will speed up the patch deployment as no data backup will be performed. However, the currently deployed version can not cannot be
restored using rollback. | Create semantic model data backup | Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data. | Create logs backup | Select this option to create a backup of the existing logs of your Kyvos environment | Backup Path | Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu. |
Click the Deploy Now button on the top-right of the page. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm
upgrade patch deployment.
| Panel |
|---|
| panelIconId | atlassian-note |
|---|
| panelIcon | :note: |
|---|
| bgColor | #DEEBFF |
|---|
| Note You need to manually restore the files uploaded from the Configuration Files page (if any), after upgrading Kyvos. Before applying the Kyvos upgrade ensure that the IAM role attached to the Kyvos Manager node has the lambda:UpdateFunctionCode permission required for updating Lambda.
|
 | Aura tab |
|---|
| summary | Azure |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMiU3RA== |
|---|
|
On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. In the Locate Bundle By, select any of the following options, and provide the corresponding details. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade. Version:Select therequired Patch from the list.
Click the required Patch from a list of compatible versions. To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field | Description |
|---|
Create backup | Select this option to create a backup of the existing Kyvos environment before deploying the patch. Selecting this option If you clear this checkbox, it will speed up the patch deployment as no data backup will be performed. However, the currently deployed version can not cannot be
restored using rollback. | Create semantic model data backup | Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data. | Create logs backup | Select this option to create a backup of the existing logs of your Kyvos environment | Backup Path | Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu. |
Click the Deploy Now button on the top-right of the page. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm
upgrade patch deployment.
 | Aura tab |
|---|
| summary | GCP |
|---|
| params | JTdCJTIydGl0bGUlMjIlM0ElMjJHQ1AlMjAlMjIlN0Q= |
|---|
|
On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. In the Locate Bundle By, select any of the following options, and provide the corresponding details. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade. Version:Enter the Access Key and Client Secret Key to access the bundle, and then click the Fetch Versions button. Select the required version from the Version list to which you want to upgrade. All future versions available for upgrading will be displayed.
Click the required Select Patch from a list of compatible versions. To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field | Description |
|---|
Create backup | Select this option to create a backup of the existing Kyvos environment before deploying the patch. Selecting this option If you clear this checkbox, it will speed up the patch deployment as no data backup will be performed. However, the currently deployed version can not cannot be
restored using rollback. | Create semantic model data backup | Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data. | Create logs backup | Select this option to create a backup of the existing logs of your Kyvos environment | Backup Path | Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu. |
Click the Deploy Now button on the top-right of the page. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm
upgrade patch deployment.
 |
Kyvos Manager Patch Deployment
From Kyvos 2024.10 onwards, you can deploy patch for Kyvos Manager. The following steps are applicable to all cloud environments (AWS, Azure, and GCP). This also applies to on-premises environment.
To deploy patch for Kyvos Manager, perform the following steps.
On the Kyvos Manager, click Application Update > Patch.
The Patch page is displayed with the current version details of Kyvos.
Select Kyvos Manager from the Upgrade list.
In the Locate Bundle By, select any of the following options, and provide the corresponding details.
Path: Provide the Kyvos Manager bundle path on the node on which Kyvos Manager is running.
File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade.Version:Enter the Access Key and Client Secret Key to access the bundle, and then click the Fetch Versions button.
Select the required version from the Version list to which you want to upgrade. All future versions available for upgrading will be displayed.
Click the required Select Patch from a list of compatible versions.
Click the Deploy Now button on the top-right of the page.
On the displayed confirmation message box, enter your Kyvos Manager Password to confirm upgrade the patch deployment.
...
