Manual VA Updates
Limited Availability
Functionality available to select customers upon customer inquiry. Visit SailPoint Product News for more information.
Important
Opting out of automatic Virtual Appliance (VA) updates from SailPoint requires that your organization sign additional legal documents, including an addendum, acknowledging assumption of increased liability and responsibility. Contact your Customer Success Manager for information.
Additionally, this updated Documentation supersedes and governs any previously incorporated Documentation agreed to by you or your organization with respect to updating the VA and associated support, maintenance, and other responsibilities.
Updates to the VA generally include any security fixes, bug fixes, patches, releases,enhancements, configurations, and new features for the following:
-
Flatcar Linux VA operating system as configured by SailPoint
-
SailPoint-developed software applications that run on the VA
As a general best practice, SailPoint recommends implementing automatic VA updates. Upon your organization's election, SailPoint provides the option to forego automatic VA updates and instead apply updates manually, as described further below. This option may be suitable for organizations that are required to comply with security practices that include anticipating, vetting, and mitigating risks of changes made to their network infrastructure that is outside their control.
Caution
By choosing to disable automatic VA updates, and enable manual updates only, organizations acknowledge and agree to assume significant risks and responsibilities to the same, and agree that falling behind certain updates may limit access to SailPoint support for the VA, as further described below.
Manual VA Update Risks and Responsibilities
Organizations choosing to manually update their VAs will have the ability to control whether and when updates provided by SailPoint get deployed to the VA. You can choose to delay or decline updates, but your organization will be subject to limits or exclusions on SailPoint’s obligations if you are no longer on a supported version. For organizations electing manual update, the following applies with respect to support for the VA (including both the Flatcar Linux operating system as configured by SailPoint and SailPoint software applications running on the VA):
- SailPoint provides standard support for N-2 major releases of the Flatcar Linux operating system configured by SailPoint and any SailPoint software applications running on the VA (including all minor releases falling under a supported major release). The version numbering scheme is {Major}.{Minor}. For example, 1.5 indicates version 1 as the major release, and version 5 as the minor release. If the current release were version 4.5, SailPoint would support versions 4.0-4.5, 3.0-3.n, and 2.0-2.n. Anything from version 1 (including 1.0, 1.1, 1.2, etc.) would be deemed out of support.
- By choosing manual updates you acknowledge that VA updates will NOT be managed or automatically applied by SailPoint to the VA, the Flatcar Linux operating system, or SailPoint software applications on the VA and will be solely your responsibility.
- Any update designated as a “security fix” in release notes or the UI must be applied immediately. If your organization does not apply security fixes, you will not be eligible for support, warranty, indemnity, or other liability coverage in the event of a security incident or breach that could have been prevented or mitigated by automatic updates of such security fixes.
Configuring Manual VA Update Settings
Important
Opting out of automatic Virtual Appliance (VA) updates from SailPoint requires that your organization sign additional legal documents, including an addendum, acknowledging assumption of increased liability and responsibility. Contact your Customer Success Manager for information.
Additionally, this updated Documentation supersedes and governs any previously incorporated Documentation agreed to by you or your organization with respect to updating the VA and associated support, maintenance, and other responsibilities.
To configure manual VA updates:
- Go to Admin > Connections > Virtual Appliances.
-
On the card for the cluster you want to manually update, select Menu > Update Settings.
-
On the cluster's Update Settings page, select Manual for Virtual Appliance Updates.
- Enter an email address to receive update notifications.
- Select Save.
It can take several hours for the new update settings to synchronize and save successfully.
Monitoring VA Cluster Update Status
The cluster cards on the Virtual Appliance Clusters page display version information, update methods, and the following informational badges relating to update status:
| Badge Text | Information |
|---|---|
| Updates Available | A VA update is available to apply. |
| Critical Update | You are required to immediately apply critical updates to your virtual appliances. |
| Out of Support | Your virtual appliances have fallen behind more than 2 update versions and are no longer supported by SailPoint. Please apply updates as soon as possible. |
Manually Applying VA Updates
To manually apply a VA update:
- Go to Admin > Connections > Virtual Appliances.
- On the card for the cluster you want to manually update, select Apply Updates.
-
On the Apply Updates page review the displayed version and component information.
-
Select Confirm when you are ready to apply the update. A message displays confirming that the virtual appliance updates are being applied. This may take several hours.
VA Update Notifications
Virtual Appliance Updates Available Email Template
The Virtual Appliance Updates Available email is sent when a new virtual appliance (VA) update bundle is available.
Name: Virtual Appliance Updates Available
Subject: $PRODUCT_NAME Notification: Virtual appliance updates are available for the $clusterName cluster.
Body:
<p>Dear recipient,</p>
<p>The following updates are available for your virtual appliance cluster:</p><br/>
<p>Cluster Name: $clusterName</p>
<p>Update Type: $releaseType</p>
<p>Update Version: $releaseVersion</p><br/>
<p>$releaseData<br/></p>
<p>Please sign in to ${PRODUCT_NAME} for more information.</p>
<p>Thank you,<br>The $PRODUCT_NAME Team</p>
Attributes
This email template uses version 1 global variables and the following template-specific attributes:
| Name | Type | Description |
|---|---|---|
| clusterName | String | The name of the cluster for which release bundles are available. |
| releaseType | String | Type of new release. Example: SOFTWARE/OS |
| releaseVersion | String | The version of new available release. |
| releaseData | Map |
Information about available updates. |
Virtual Appliance Updates Failed Email Template
The Virtual Appliance Update Failed email is sent when virtual appliance updates failed to be applied to a cluster.
Name: Virtual Appliance Updates Failed
Subject: $PRODUCT_NAME Notification: Virtual appliance updates failed to be applied to the $clusterName cluster
Body:
<p>Dear recipient,</p>
<p>Some virtual appliance updates failed to be applied to the $clusterName cluster.</p>
<p>Try restarting the cluster in $PRODUCT_NAME. If the problem persists, please contact Support<br/></p>
<p>Thank you,<br>The $PRODUCT_NAME Team</p>
Attributes
This email template uses version 1 global variables and the following template-specific attributes:
| Name | Type | Description |
|---|---|---|
| clusterName | String | The name of the cluster for which updates failed. |
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.