Skip to content
Open
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
18 changes: 1 addition & 17 deletions docs/en/configure/backup/application/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,4 @@ title: Application Backup and Restore

# Application Backup and Restore

As a cluster administrator, you can back up and restore applications running on Alauda Container Platform by using Velero.

For an overview of application backup components and installation instructions, see [Application backup and restore](../overview.mdx#application-backup-and-restore).

## Backup

- [Configure backup repository](./repository.mdx)
- [Create application backups](./backup-app.mdx)

## Restore

- [Restore applications](./restore-app.mdx)
- [Image registry replacement](./restore-imagesync.mdx)

## Hooks

- [Configure hooks](./hooks.mdx)
<Overview overviewHeaders={[]} />
2 changes: 1 addition & 1 deletion docs/en/configure/backup/application/restore-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You can quickly restore the application to the target namespace by performing an
| **Recovery Target Configuration** | **Namespaces**: The namespace where data recovery is performed and the source namespace of the backup data. The optional range is the namespace set in the backup policy. The system restores backup data to the same namespace based on your selection. **Tip**: To restore to other namespaces in the cluster, configure **Advanced Recovery Target Settings**. |
| **Advanced Recovery Target Settings** | Restore backup data originally scheduled for the source namespace to any namespace in the cluster (existing or newly created). **Source Namespace**: The selected namespace. **Target Namespace**: The namespace where data recovery is performed; either an existing namespace or a new one created by entering a non-existent name. **Tip**: If **Backup Kubernetes Resources and Persistent Volume Claims** was selected as the application backup resource type, ensure that the target cluster **StorageClass** name matches the source. If not, configure the source and target storage class names in the advanced options; the platform stores data using the new storage class. |

6. Click **YAML** in the upper-right corner to switch to YAML editing mode. Refer to [Configuring Hooks](./hooks.mdx) to configure commands that run during recovery.
6. Click **YAML** in the upper-right corner to switch to YAML editing mode. To configure commands that run during recovery, see [Configuring Hooks](./hooks.mdx).

**Caution**: By default, the backup file is compared with resources in the target namespace. Only data that exists in the backup file but is missing in the namespace is restored. Resources with the same name or incremental resources (existing in the namespace but missing in the backup file) are not overwritten.

Expand Down
17 changes: 9 additions & 8 deletions docs/en/configure/backup/etcd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,25 @@ title: "etcd Backup and Restore"
weight: 10
---

# etcd Backup and Restore

The etcd service on the cluster is a distributed key-value store responsible for storing cluster configuration information. etcd is deployed on all control plane nodes of the cluster.

After installing the Alauda Container Platform Cluster Enhancer plugin, an EtcdBackupConfiguration resource is automatically created for the cluster configuration. The EtcdBackupConfiguration contains information about backup data sources (control nodes, backup paths), backup data storage locations, backup methods, and more. Each backup execution based on the policy generates a new backup record, enabling you to back up cluster configurations on-demand or automatically on a periodic basis.
After installing the <Term name="product" /> Cluster Enhancer plugin, an `EtcdBackupConfiguration` resource is automatically created for the cluster configuration. The `EtcdBackupConfiguration` contains backup data sources, control plane node paths, backup data storage locations, and backup methods. Each backup execution based on the policy generates a new backup record, enabling on-demand and scheduled cluster-configuration backups.

## Prerequisites

To enable etcd backup:

1. Download **Alauda Container Platform Cluster Enhancer** from the <Term name="company" /> Customer Portal.
1. Download **<Term name="product" /> Cluster Enhancer** from the <Term name="company" /> Customer Portal.
2. [Upload the package](/extend/upload_package.mdx) to the platform.
3. [Install the plugin](/extend/cluster_plugin.mdx) on your cluster.

After installation, an EtcdBackupConfiguration resource is automatically created.

## How it works

- etcd backup is provided by **Alauda Container Platform Cluster Enhancer**
- etcd backup is provided by **<Term name="product" /> Cluster Enhancer**.
- Supports both local storage and S3-compatible object storage. By default, backups are stored locally in `/cpaas`. Configuring S3 storage creates an additional copy in the S3 bucket; local backups continue to be generated.
- For clusters running on Immutable OS, S3 storage is **required** (local storage is not supported)

Expand Down Expand Up @@ -83,7 +84,7 @@ To enable S3 storage for etcd backups, follow these steps:

### Prerequisites

- Alauda Container Platform Cluster Enhancer is installed on the cluster.
- <Term name="product" /> Cluster Enhancer is installed on the cluster.

### Step 1: Create S3 Secret

Expand Down Expand Up @@ -136,16 +137,16 @@ After the backup completes, verify that backup files exist in your S3 bucket.

> **Warning:**
>
> * This operation performs a disastrous recovery of the etcd cluster. It will overwrite the existing data. Ensure you have a valid backup snapshot before proceeding.
> * This procedure entails significant risks. If you are unsure about the operation, please contact technical support.
> * This operation performs a destructive recovery of the etcd cluster. It will overwrite the existing data. Ensure you have a valid backup snapshot before proceeding.
> * This procedure entails significant risks. If you are unsure about the operation, contact technical support.
> * During the recovery process, the Kubernetes API Server will be unavailable.

### Prerequisites

- The Kubernetes cluster is deployed using hostnames (`kubectl get node` shows hostnames as node names).
- An etcd backup snapshot is available.
- The cluster is malfunctioning due to the failure of etcd nodes (e.g., more than half of the control plane nodes are down).
- This recovery procedure is specifically designed for a **3-node control plane** cluster. If your cluster has 5 or more control plane nodes, please contact technical support for assistance.
- This recovery procedure is specifically designed for a **3-node control plane** cluster. If your cluster has 5 or more control plane nodes, contact technical support for assistance.

### Step 1: Backup Original Data and Modify etcd Configuration

Expand Down Expand Up @@ -184,7 +185,7 @@ Copy the latest etcd backup snapshot to the `/tmp` directory on the **first cont

Execute the following script on the **first control plane node** to restore the snapshot.

> **Note:** The following script assumes a 3-node control plane cluster. If your cluster has 5 or more nodes, please contact technical support.
> **Note:** The following script assumes a 3-node control plane cluster. If your cluster has 5 or more nodes, contact technical support.

```bash
#!/usr/bin/env bash
Expand Down
5 changes: 2 additions & 3 deletions docs/en/configure/backup/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
weight: 55
title: Backup and Recovery
title: Backup and Restore
---

# Backup and Recovery
# Backup and Restore

<Overview />


16 changes: 7 additions & 9 deletions docs/en/configure/backup/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
weight: 1
title: Overview
---

# Overview

Alauda Container Platform provides two types of backup and restore operations:
<Term name="product" /> provides two types of backup and restore operations:

- **Cluster backup and restore**: Backs up and restores control plane data, including etcd, registry, logging, and monitoring data.
- **Application backup and restore**: Backs up and restores applications and their persistent volumes based on Velero.
Expand All @@ -16,13 +15,13 @@ Cluster backup protects the control plane state and platform data.

### etcd backup and restore

etcd is the key-value store for Alauda Container Platform, which persists the state of all resource objects. An etcd backup plays a crucial role in disaster recovery.
etcd is the key-value store for <Term name="productShort" /> and persists the state of resource objects. etcd backups are required for control-plane state recovery scenarios.

For detailed instructions, see [etcd Backup and Restore](./etcd.mdx).

### Registry backup and restore

For registry backup and restore, see [Alauda Container Platform Registry Data Backup and Recovery](/developer/registry/how_to/registry_data_restore.mdx).
For registry backup and restore, see [Registry Data Backup and Recovery](/configure/registry/backup_and_restore.mdx).

### Logging backup and restore

Expand All @@ -34,20 +33,20 @@ For monitoring backup and restore, see [VictoriaMetrics Backup and Recovery](/ob

## Application backup and restore \{#application-backup-and-restore}

As a cluster administrator, you can back up and restore applications running on Alauda Container Platform by using Velero.
As a cluster administrator, you can back up and restore applications running on <Term name="productShort" /> by using Velero.

### Architecture

Application backup and restore consists of two components:

- **Alauda Container Platform Data Backup Essentials**: Provides the UI and is installed on the global cluster.
- **Alauda Container Platform Data Backup for Velero**: Provides Velero and is installed on workload clusters.
- **<Term name="product" /> Data Backup Essentials**: Provides the UI and is installed on the global cluster.
- **<Term name="product" /> Data Backup for Velero**: Provides Velero and is installed on workload clusters.

### Application installation \{#application-installation}

To enable application backup and restore:

1. Download **Alauda Container Platform Data Backup Essentials** and **Alauda Container Platform Data Backup for Velero** from the <Term name="company" /> Customer Portal.
1. Download **<Term name="product" /> Data Backup Essentials** and **<Term name="product" /> Data Backup for Velero** from the <Term name="company" /> Customer Portal.
2. [Upload the packages](/extend/upload_package.mdx) to the platform.
3. [Install Data Backup Essentials](/extend/cluster_plugin.mdx) on the global cluster.
4. [Install Data Backup for Velero](/extend/cluster_plugin.mdx) on workload clusters.
Expand Down Expand Up @@ -102,4 +101,3 @@ Common scenarios include:
- Maintain consistent network modes to avoid resource restoration issues
- If subnets differ, pod IPs will change after recovery
- Assess whether image migration is required before restoring data

10 changes: 0 additions & 10 deletions docs/en/configure/clusters/about-hcp.mdx

This file was deleted.

Loading