Skip to content
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

doc:add backup dir and add backup introduce #405

Merged
merged 3 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/content/en/docs/fleet-manager/backup/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: "Unified Backup, Restore, and Migration"
linkTitle: "Unified Backup"
weight: 40
description: >
The easiest way to manage multi cluster Unified Backup, Restore, and Migration with Fleet.
---

Kurator provides a unified solution for backup, restore, and migration of applications and their related cluster resources across multiple Fleet clusters.
This approach addresses the challenges of managing these tasks across various environments, ensuring clarity and consistency for users.

Through its integration with [Velero](https://velero.io/), Kurator delivers a one-click solution with a unified status view. This empowers users with efficient management and clear visibility into application backups, restores, and migrations across Fleet clusters.

The following are the main benefits of this feature.
Xieql marked this conversation as resolved.
Show resolved Hide resolved

- **Simplified Multi-cluster Operations**: Streamlining management and operational tasks across various clusters for easier resource handling.

- **Backup Support with Scheduled and Immediate Options**: Automate regular backups for data protection and compliance, along with immediate backup options for on-demand needs.

- **One-stop, Flexible Disaster Recovery Solution**: Providing a robust and flexible solution for disaster recovery, allowing tailored recovery of specific resources in specific clusters to ensure operational continuity in adverse scenarios.

- **Effortless Cluster Resource Migration**: Facilitating smooth migration of resources across multiple clusters for workload balancing or transitions to new environments.

- **Unified Status View**: Offering a clear, unified view of resources and backup statuses across clusters, enhancing visibility and control.

## Architecture

Below is the architecture diagram of the Kurator Fleet Backup feature.

{{< image width="100%"
link="./image/backup-arch.svg"
>}}

### Key Components Overview

- **Kurator Fleet Manager**: The core management component, responsible for managing fleet and backup engines.

- **Backup Engine**: This component handles the backup and restore processes.

- **Object Storage**: The external storage solutions, such as Minio or cloud providers, where the backups are stored.


To use Kurator for backup, restore, and migration scenarios, you must first configure and install the necessary backup engine plugin.
Please refer to the subsequent sections for detailed guidance on plugin configuration and instructions for each specific operation.
Original file line number Diff line number Diff line change
@@ -1,30 +1,13 @@
---
title: "Kurator Fleet Backup Plugin Configuration Guide"
linkTitle: "Kurator Fleet Backup Plugin Configuration Guide"
weight: 40
title: "Install Backup Plugin"
linkTitle: "Install Backup Plugin"
weight: 10
description: >
The easiest way to manage multi cluster backup plugin with fleet.
Configure backup plugin for Fleet to enable Kurator's capabilities.
---

To support Kurator's unified backup, restore, and migration features, it's imperative to first configure the backup plugin for [Fleet](https://kurator.dev/docs/references/fleet-api/#fleet). This guide will walk you through configuring the [Velero](https://velero.io/)-based backup plugin for Fleet, laying the groundwork for Kurator's unified backup, restore, and migration capabilities.

## Architecture

Before diving into the specifics, let's take a moment to understand the overall architecture and how various components interact with each other. Below is the architecture diagram of the Kurator Fleet Backup Plugin.

{{< image width="100%"
link="./image/backup-arch.svg"
>}}

The diagram illustrates:

- **Fleet Manager**: The central management entity, responsible for orchestrating the operations.
- **Velero Integration**: How the backup and restore processes are handled using Velero.
- **Object Storage**: The external storage solutions, such as Minio or cloud providers, where the backups are stored.
- **Interactions**: The arrows depict the flow of data and interactions between various components.

With this architectural view in mind, let's proceed with the essential setup steps and configurations required to implement this architecture.

## Prerequisites

### 1. Fleet Manager Setup
Expand Down
Loading