Add documentation on KBOSS#664
Open
JoaoJandre wants to merge 1 commit into
Open
Conversation
14 tasks
winterhazel
reviewed
Jul 14, 2026
winterhazel
left a comment
winterhazel
left a comment
Member
There was a problem hiding this comment.
@JoaoJandre I left some suggestions.
| - VMware with Veeam Backup and Recovery | ||
| - KVM with DELL EMC Networker | ||
| - KVM with NAS B&R Plugin (4.20 onwards) | ||
| - KVM with KBOSS Plugin |
Member
There was a problem hiding this comment.
Suggested change
| - KVM with KBOSS Plugin | |
| - KVM with KBOSS Plugin (4.23 onwards) |
| - Support for backup compression. | ||
| - Support for backup validation. | ||
| - Support for "quick restore", inspired by Veeam's Instant Recovery. | ||
| - Incremental disk-only VM snapshot compatible (see :ref:`Disk-only-File-based-Storage-Instance-Snapshots-on-KVM`). |
Member
There was a problem hiding this comment.
Suggested change
| - Incremental disk-only VM snapshot compatible (see :ref:`Disk-only-File-based-Storage-Instance-Snapshots-on-KVM`). | |
| - Compatible with incremental disk-only VM snapshots (see :ref:`Disk-only-File-based-Storage-Instance-Snapshots-on-KVM`). |
A little rewording. I think it reads better this way.
Comment on lines
+33
to
+34
| While by default the backups are stored in any secondary storage available, sharing the same space with templates, ISOs and snapshots, | ||
| using the :ref:`Direct resources to a specific secondary storage` feature, it is possible to create backup-exclusive secondary storages. |
Member
There was a problem hiding this comment.
Suggested change
| While by default the backups are stored in any secondary storage available, sharing the same space with templates, ISOs and snapshots, | |
| using the :ref:`Direct resources to a specific secondary storage` feature, it is possible to create backup-exclusive secondary storages. | |
| By default, the backups are stored in any secondary storage available, sharing the same space with templates, ISOs and snapshots. | |
| However, it is possible to create backup-exclusive secondary storages using the :ref:`Direct resources to a specific secondary storage` feature. |
| While by default the backups are stored in any secondary storage available, sharing the same space with templates, ISOs and snapshots, | ||
| using the :ref:`Direct resources to a specific secondary storage` feature, it is possible to create backup-exclusive secondary storages. | ||
|
|
||
| Currently, only backup of VMs from the NFS, File-based Shared Mountpoint and Local Storage based Primary Storage are supported. |
Member
There was a problem hiding this comment.
Suggested change
| Currently, only backup of VMs from the NFS, File-based Shared Mountpoint and Local Storage based Primary Storage are supported. | |
| Currently, only the backup of VMs consuming NFS, File-based Shared Mountpoint, and/or Local Storage is supported. |
|
|
||
| Currently, only backup of VMs from the NFS, File-based Shared Mountpoint and Local Storage based Primary Storage are supported. | ||
|
|
||
| Since the KBOSS plugin is fully implemented by ACS, and does not depend on any outside provider, the **importBackupOffering** API is not used. |
Member
There was a problem hiding this comment.
Suggested change
| Since the KBOSS plugin is fully implemented by ACS, and does not depend on any outside provider, the **importBackupOffering** API is not used. | |
| Since the KBOSS plugin is fully implemented by ACS, and does not depend on any external provider, the **importBackupOffering** API is not used. |
| * - Setting | ||
| - Description | ||
| * - `backupValidationCommand` | ||
| - Command to be executed during the command execution step. The step will not run if this configuration does not have a value |
Member
There was a problem hiding this comment.
Suggested change
| - Command to be executed during the command execution step. The step will not run if this configuration does not have a value | |
| - Command to be executed during the execute_command step. The step will not run if this configuration does not have a value |
| * - `backupValidationCommand` | ||
| - Command to be executed during the command execution step. The step will not run if this configuration does not have a value | ||
| * - `backupValidationCommandArguments` | ||
| - Arguments to be passed to the command executed during the command execution step |
Member
There was a problem hiding this comment.
Suggested change
| - Arguments to be passed to the command executed during the command execution step | |
| - Arguments to be passed to the command executed during the execute_command step |
| * - `backupValidationCommandArguments` | ||
| - Arguments to be passed to the command executed during the command execution step | ||
| * - `backupValidationCommandExpectedResult` | ||
| - Expected result of the command execution, coded in Base64. If not provided, the process exit code will be checked for value `0` |
Member
There was a problem hiding this comment.
Suggested change
| - Expected result of the command execution, coded in Base64. If not provided, the process exit code will be checked for value `0` | |
| - Expected output of the command's execution, coded in Base64. If not provided, the process exit code will be checked for value `0` |
| * - `backupValidationCommandExpectedResult` | ||
| - Expected result of the command execution, coded in Base64. If not provided, the process exit code will be checked for value `0` | ||
| * - `backupValidationCommandTimeout` | ||
| - Timeout for the command executed during the command execution step. Overrides the global configuration |
Member
There was a problem hiding this comment.
Suggested change
| - Timeout for the command executed during the command execution step. Overrides the global configuration | |
| - Timeout for the command executed during the execute_command step. Overrides the global configuration |
| * - `backupValidationBootTimeout` | ||
| - Timeout for the VM boot. Overrides the global configuration | ||
|
|
||
| To check information about validation jobs, the **listBackupServiceJobs** API may be added. |
Member
There was a problem hiding this comment.
Suggested change
| To check information about validation jobs, the **listBackupServiceJobs** API may be added. | |
| To allow checking the existing validation jobs, the **listBackupServiceJobs** API may be added in the future. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📚 Documentation preview 📚: https://cloudstack-documentation--664.org.readthedocs.build/en/664/