JoaoJandre commented on code in PR #664: URL: https://github.com/apache/cloudstack-documentation/pull/664#discussion_r3589409963
########## source/adminguide/kboss_plugin.rst: ########## @@ -0,0 +1,281 @@ +.. 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. + - Incremental disk-only VM snapshot compatible (see :ref:`Disk-only-File-based-Storage-Instance-Snapshots-on-KVM`). + - Backups are stored in the secondary storage. + +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. + +Since the KBOSS plugin is fully implemented by ACS, and does not depend on any outside provider, the **importBackupOffering** API is not used. +Instead, use the **createBackupOffering**, which allows users to configure KBOSS features they want to use. These backup offerings are then +assigned and used with KVM instances to perform support 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 the backup plugin 'kboss' needs to be enabled +on either the global or zone settings. + +================================= ======================== +Configuration Value +================================= ======================== +backup.framework.enabled true +backup.framework.provider.plugin kboss +================================= ======================== + +Once the above two configurations are set, restart the cloudstack-management service. +After, we can create the first backup offering. Navigate to the Service Offerings -> Backup Offerings tab. Click on 'Create Backup Offering' and fill the form. + +=============================== ======================== +Field Value +=============================== ======================== +Name A suitable name to represent the Backup Offering. +Description A suitable description to represent the Backup Offering. +Zone Zone UUID for the backup offering. +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**. Review Comment: No. <img width="1578" height="463" alt="Image" src="https://github.com/user-attachments/assets/7c761151-e905-40fc-af17-c24ade6297eb"; /> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
