-
Notifications
You must be signed in to change notification settings - Fork 129
Add documentation on KBOSS #664
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JoaoJandre
wants to merge
5
commits into
apache:main
Choose a base branch
from
JoaoJandre:add-kboss-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+295
−2
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,283 @@ | ||
| .. Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information# | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
|
|
||
| .. _KBOSS Backup and Recovery Plugin: | ||
|
|
||
| KBOSS Backup and Recovery Plugin | ||
| ================================ | ||
|
|
||
| About the KBOSS Backup and Recovery Plugin | ||
| ------------------------------------------ | ||
|
|
||
| The KVM Backup on Secondary Storage Backup and Recovery Plugin provider was designed to provide a complete B&R experience for KVM. It uses already validated methods | ||
| to create incremental backups of VMs. Its main characteristics are: | ||
| - Full or incremental backups, configured by the user. | ||
| - Support for backup compression. | ||
| - Support for backup validation. | ||
| - Support for "quick restore", inspired by Veeam's Instant Recovery. | ||
| - Compatible with incremental disk-only VM snapshots (see :ref:`Disk-only-File-based-Storage-Instance-Snapshots-on-KVM`). | ||
| - Backups are stored in the secondary storage. | ||
|
|
||
| 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. | ||
|
|
||
| Currently, only the backup of VMs consuming NFS, File-based Shared Mountpoint, and/or Local Storage is supported. | ||
|
|
||
| Since the KBOSS plugin is fully implemented by ACS, and does not depend on any external provider, the **importBackupOffering** API is not used. | ||
| Instead, the **createBackupOffering** is used to allow users to configure KBOSS features they want. These backup offerings can then | ||
| be assigned to KVM instances to perform B&R actions and operations. | ||
|
|
||
|
|
||
| Using the KBOSS Backup and Recovery Plugin | ||
| ------------------------------------------ | ||
| To use the KBOSS Backup and Recovery Plugin, the Backup and Recovery framework needs to be enabled first. Then, 'kboss' needs to be configured as the backup provider | ||
| on either the global or zone settings. | ||
|
|
||
| ================================= ======================== | ||
| Configuration Value | ||
| ================================= ======================== | ||
| backup.framework.enabled true | ||
| backup.framework.provider.plugin kboss | ||
| ================================= ======================== | ||
|
|
||
| Once the two configurations above are set, restart the cloudstack-management service. | ||
|
|
||
| After enabling the plugin, we can create the first backup offering. Navigate to the Service Offerings -> Backup Offerings tab, click on 'Create Backup Offering', and fill the wizard. | ||
|
|
||
| =============================== ======================== | ||
| Field Value | ||
| =============================== ======================== | ||
| Name A suitable name to represent the Backup Offering. | ||
| Description A suitable description to represent the Backup Offering. | ||
| Zone Zone in which this backup offering will be available. | ||
| Allow User driven backups Whether to allow backups from the ACS API. If this value is false, you will not be able to create backups using KBOSS. **It must be set as true**. | ||
| Public Whether the offering is public or dedicated to a domain. | ||
| Domain Domain to dedicate the offering, only shown when 'Public' is false. | ||
| Compress Whether the backups should be compressed after creation. | ||
| Compression library Which compression library to use, only shown when 'Compress' is true. | ||
| Validate Whether to validate backups after creation. | ||
| Validation steps Which validation steps should be executed. | ||
| Allow extract file Whether backups created with this offering should allow file extraction. This feature will be implemented in a future version. | ||
| Allow quick restore Whether backups created with this offering should allow quick restore. | ||
| Backup chain size The backup chain size of the incremental backups. This value overwrites what is set in `backup.chain.size`. | ||
| =============================== ======================== | ||
|
|
||
| .. image:: /_static/images/create-backup-offering.png | ||
| :align: center | ||
| :alt: KBOSS backup offering creation wizard | ||
|
|
||
|
|
||
| After creating the backup offering, you can assign it to any Instance and start to perform ad-hoc backups or schedule them. | ||
|
|
||
| Quiesce (Filesystem Freeze and Thaw) | ||
| ------------------------------------ | ||
|
|
||
| Users can set quiesce to true while creating a backup or a backup schedule. | ||
| When a backup is initiated with quiesce enabled, CloudStack uses the QEMU guest agent | ||
| to freeze the filesystem before starting the backup. This operation flushes all dirty | ||
| filesystem buffers to disk and quiesces new writes. The filesystem is then thawed | ||
| immediately after the backup process starts, keeping the freezing window very short. | ||
|
|
||
|
JoaoJandre marked this conversation as resolved.
|
||
| |NASB&R-quiesceInstance.png| | ||
|
|
||
| This feature makes the KBOSS backups closer to application-consistent backups, rather than crash-consistent backups. | ||
|
|
||
| Points to note: | ||
|
|
||
| #. The feature requires QEMU Guest Agent to be installed and running on the guest instance. | ||
| #. This method does not capture the memory state of the guest. Any data held in application memory | ||
| that hasn’t been flushed to disk prior to the filesystem freeze will not be captured. | ||
| #. For fully application-consistent backups, guest applications must implement pre-freeze hooks | ||
| to flush their internal state to disk before the filesystem is frozen. | ||
|
|
||
| Backup Chain Management | ||
|
JoaoJandre marked this conversation as resolved.
|
||
| ----------------------- | ||
|
|
||
| The size of the incremental backup chain is determined by the `backup.chain.size` zone-wide configuration; furthermore, it may be overridden on the | ||
| offering level. Once the backup chain reaches the configured size, the next backup will be a full backup and a new chain will start. Moreover, the backup chains | ||
| are currently separated by schedule ID, with manual backups having their own backup chain. Thus, if a user has a VM with two backup schedules, and also takes manual backups of the VM, it will have three | ||
| concurrent backup chains. | ||
|
|
||
| If users wish to finalize the backup chain early, the **finishBackupChain** API may be used. It is also available through the VM instance interface on the GUI. | ||
| Additionally, this API can also be used when the VM is in the `BackupError` state to normalize it. Most times ACS is able to normalize it; however, the VM may be unable to be recovered | ||
| automatically for a number of reasons, for example if the storage is unavailable. | ||
|
JoaoJandre marked this conversation as resolved.
|
||
|
|
||
| Isolated backups | ||
| ---------------- | ||
|
|
||
| If you want to create a backup that does not depend on, nor affects any backup chain, you may inform the `isolated` flag when creating a backup, or a backup schedule. | ||
| When set, the created backup will be a full backup, with no dependencies on other backups, and no future backups will depend on it. | ||
|
|
||
| Quick restore | ||
| ------------- | ||
|
|
||
| If the backup was created using an offering with `allowQuickRestore` set, the user will be able to restore it using the `quickRestore` flag. | ||
| When this is done, CloudStack creates new deltas on primary storage that have the backup on secondary storage as their backing files. Then, the VM is automatically started and the volume consolidation process starts. During consolidation, the VM is already available to use. | ||
|
|
||
| While this process is ongoing, the VM should not be stopped (from inside the VM), otherwise, it will fail to consolidate the volume. The benefit of using quick restore | ||
| is that the VM is up and running in a very short time; however, the time to finish the consolidation process is bigger than normal restore. During | ||
| the consolidation process, the VM's disk might have their performance slowed, when the process is done, the performance should go back to normal. | ||
|
|
||
| Compression | ||
| ----------- | ||
|
|
||
| The backup compression process is executed asynchronously after the backup is created, for VMs using backup offerings that support it. | ||
| There are several configurations that affect the backup compression task and process: | ||
|
|
||
| .. list-table:: Compression Configurations | ||
| :widths: 20 60 20 | ||
| :header-rows: 1 | ||
|
|
||
| * - Configuration | ||
| - Description | ||
| - Default value | ||
| * - `backup.compression.task.enabled` | ||
| - Determines whether the task responsible for scheduling compression jobs is active. If not, compression jobs will not run | ||
| - true | ||
| * - `backup.compression.max.concurrent.operations.per.host` | ||
| - Maximum number of concurrent compression jobs. Values lower than 1 disable the limit. | ||
| - 5 | ||
| * - `backup.compression.max.concurrent.operations` | ||
| - Maximum number of compression jobs that can be executed at the same time in the zone. Values lower than 1 disable the limit. | ||
| - 10 | ||
| * - `backup.compression.max.job.retries` | ||
| - Maximum number of attempts for executing compression jobs | ||
| - 2 | ||
| * - `backup.compression.retry.interval` | ||
| - Interval, in minutes, between attempts to run compression jobs | ||
| - 60 | ||
| * - `backup.compression.timeout` | ||
| - Timeout, in seconds, for running compression jobs | ||
| - 28800 | ||
| * - `backup.compression.minimum.free.storage` | ||
| - Minimum required available storage to start the backup compression process. | ||
| This setting accepts a real number that is multiplied by the total size of the backup to determine the necessary available space. | ||
| By default, the storage must have the same amount of available space as the space occupied by the backup. This is checked by the host | ||
| when trying to start the process. | ||
| - 1 | ||
| * - `backup.compression.coroutines` | ||
| - Number of coroutines used for the compression process, each coroutine has its own thread | ||
| - 1 | ||
| * - `backup.compression.rate.limit` | ||
| - Compression rate limit, in MB/s. Values less than 1 disable the limit | ||
| - 0 | ||
|
|
||
| To check information about compression jobs, the **listBackupServiceJobs** API may be used. | ||
|
|
||
| Validation | ||
| ---------- | ||
|
|
||
| The backup validation process is executed asynchronously after the backup is created, for VMs using backup offerings that support it. Most backup validation steps are dependant on the guest VM having the QEMU Guest Agent installed and configured to run on start. To perform the validation, a temporary dummy | ||
| VM is created using the backup being validated and a few configurable validation steps are executed. After the first successful validation, a Hash of the backup is taken. | ||
| A new Hash is taken periodically and compared with the original to make sure the backup is still valid. | ||
|
|
||
| There are three validation steps that can be configured currently: | ||
|
|
||
| .. list-table:: Validation steps | ||
| :widths: 20 60 20 | ||
| :header-rows: 1 | ||
|
|
||
| * - Step | ||
| - Description | ||
| - Needs QEMU Guest Agent? | ||
| * - `wait_for_boot` | ||
| - Waits during a configurable timeout for the validation VM to boot. | ||
| - Yes | ||
| * - `execute_command` | ||
| - Executes a configurable command inside the VM using the QEMU Guest Agent, and compares the result with a configurable expected result. | ||
| - Yes | ||
| * - `screenshot` | ||
| - Takes a screenshot of the VM's window after a configurable time. The screenshot can then be downloaded via `downloadValidationScreenshot` API. | ||
| - No | ||
|
|
||
| More validation steps may be added in the future. | ||
|
|
||
| The configurations related to backup validation are detailed below: | ||
|
|
||
| .. list-table:: Validation configurations | ||
| :widths: 10 70 10 10 | ||
| :header-rows: 1 | ||
|
|
||
| * - Configuration | ||
| - Description | ||
| - Default value | ||
| - Scope | ||
| * - `backup.validation.task.enabled` | ||
| - Determines whether the task responsible for scheduling validation jobs is active. If it is not active, validation jobs will not run. | ||
| - `true` | ||
| - Account | ||
| * - `backup.validation.interval` | ||
| - Interval, in hours, between two validations of the same backup. | ||
| - `24` | ||
| - Account | ||
| * - `backup.validation.max.concurrent.operations` | ||
| - Maximum number of validation jobs that can be executed at the same time in the zone. Values lower than 1 disable the limit. | ||
| - `10` | ||
| - Zone | ||
| * - `backup.validation.max.concurrent.operations.per.host` | ||
| - Maximum number of validation jobs that can be executed at the same time on each host. Values lower than 1 disable the limit. | ||
| - `1` | ||
| - Cluster | ||
| * - `backup.validation.boot.default.timeout` | ||
| - Default timeout, in seconds, for the boot validation step | ||
| - `240` | ||
| - Account | ||
| * - `backup.validation.script.default.timeout` | ||
| - Default timeout, in seconds, for the script validation step | ||
| - `60` | ||
| - Account | ||
| * - `backup.validation.screenshot.default.wait` | ||
| - Default waiting time, in seconds, before executing the VM screenshot | ||
| - `60` | ||
| - Account | ||
| * - `backup.validation.end.chain.on.fail` | ||
| - If true, ends the current backup chain if backup validation fails and the backup belongs to that chain. | ||
| - `true` | ||
| - Account | ||
| * - `enforce.resource.limit.on.backup.validation.vm` | ||
| - If true, the creation of validation VMs is bound by the account/domain resource limits. | ||
| - `false` | ||
| - Account | ||
|
|
||
| To allow configuring the validation steps on a VM basis, new VM settings were created. Most of them are available to end-users by default, except the timeouts. The availability of | ||
| these settings to User accounts may be configured by the `user.vm.readonly.details` global configuration. It is expected that users utilize these settings to configure the validation | ||
| process, especially the `execute_command` step, which will not run when not configured using the VM settings. Below, is a table of the VM settings pertaining to the backup | ||
| validation process: | ||
|
|
||
| .. list-table:: Validation VM settings | ||
| :widths: 20 80 | ||
| :header-rows: 1 | ||
|
|
||
| * - Setting | ||
| - Description | ||
| * - `backupValidationCommand` | ||
| - Command to be executed during the execute_command 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 execute_command step | ||
| * - `backupValidationCommandExpectedResult` | ||
| - Expected output of the command's 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 execute_command step. Overrides the global configuration | ||
| * - `backupValidationScreenshotWait` | ||
| - Waiting time before executing the screenshot during the screenshot 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 used. | ||
|
|
||
|
|
||
| .. |NASB&R-quiesceInstance.png| image:: /_static/images/NASB&R-quiesceInstance.png | ||
| :alt: Quiesce option while creating backups. | ||
| :width: 400 px | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you are a root admin, you're able to create backups even if this was set to false, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No.