Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Backup and Restoration

Updated on 2024-12-18 GMT+08:00

Context

After an on-premises cluster is registered with UCS, you can back up the certificates, encryption and decryption materials, and etcd data on the three master nodes to ensure cluster high availability and prevent data loss when the cluster is faulty. These backups can be used to restore data.

Constraints

The node IP addresses must remain unchanged regardless of whether a single master node or master nodes are faulty.

Cluster Backup

Local backup

  1. Create a path for storing the backup file package.
  2. Run the following backup command:
    ./ucs-ctl backup {Cluster name}  --path {Backup path} --type local

    Example:

    ./ucs-ctl backup gpu-test --path /home/ggz/gpu-test --type local

    After the command is executed successfully, a backup file package in the format of {Cluster name}-backup-{Timestamp}.tar.gz is generated in the specified backup path.

    The package stores the ha.yaml file and the etcd-snapshot and crt directories. The etcd-snapshot directory contains etcd data, and the crt directory contains certificates and encryption and decryption materials.

Remote backup

  1. Create a path for storing the backup file package on the remote host over SFTP.
  2. Run the following backup command:
    ./ucs-ctl backup {Cluster name} --path {Backup path} --type sftp --ip {IP address of the remote host} --user {Username of the remote host}

    Example:

    ./ucs-ctl backup gpu-test --path /home/ggz/gpu-test --type sftp --ip 100.95.142.93 --user root
    NOTICE:
    • If you perform remote backup for the first time, enter the password of the remote host after "please input sftp password:" is displayed.
    • The backup path in the backup command must be valid. Otherwise, the backup file generated on the remote host after the command is executed may be incorrect.

    After the command is executed successfully, a backup file package in the format of {Cluster name}-backup-{Timestamp}.tar.gz is generated in the specified backup path on the remote host. The package stores the ha.yaml file and the etcd-snapshot and crt directories. The etcd-snapshot directory contains etcd data, and the crt directory contains certificates and encryption and decryption materials.

Periodic backup

Run the crontab -e command to compile a crontab expression so that the backup command is executed periodically.

Run the following command to execute the periodic local backup of the cluster at 16:40 every day:

40 16 * * * <ucs-ctl-path> backup <cluster-name> --path <backup-path> --type <local>

Example command:

40 16 * * * /root/cluster/ucs-ctl backup cluster-redhat --path /root/cluster/backup --type local  

During periodic remote backup, you do not need to specify the password in the crontab expression after entering the password of the remote host for the first time.

To prevent the number of backup files from increasing, compile the crontab expression on the remote host to periodically execute the backup file aging script. The following is an example of the backup file aging script:

#!/bin/bash  
backup_dir=${1}                                            # Path for storing backup files
keep_days=${2}                                             # Retention days of backup files
if [ ! -d ""$backup_dir"" ]; then                          # Check whether the log path exists.              
  echo "There is no backup file path."
  exit 1 
fi  
find "$backup_dir" -type f -mtime +$keep_days -exec rm {} \;       # Delete legacy logs.
echo "Expired backup files have been deleted!"

Data Restoration

Restoring etcd Data

  1. Prepare an etcd data backup package in the format of {Cluster name}-backup-{Timestamp}.tar.gz.

    Upload the package to each master/etcd node of the cluster.

  2. Stop the etcd service.

    Run the following command on the node:

    mv /var/paas/kubernetes/manifests/etcd*.manifest /var/paas/kubernetes/

    Wait until the service is stopped.

    crictl ps | grep etcd

    If no etcd container is found, the service has been stopped.

  3. (Optional) Back up the etcd data on a node.
    mv /var/paas/run/etcd/data /var/paas/run/etcd/data-bak 
    mv /var/paas/run/etcd-event/data /var/paas/run/etcd-event/data-bak
  4. Run the restoration command on the node where the etcd database resides.
    ./ucs-ctl restore etcd {Path of the etcd data backup package}

    Example:

    ./ucs-ctl restore etcd /home/ggz/gpu-test/backup-file-20230625164904.tar.gz

    The etcd data is restored if the following command output is displayed:

    Restore the etcd snapshot successfully.
  5. Restart the etcd service on the node. The restart takes several minutes.
    mv /var/paas/kubernetes/etcd*.manifest /var/paas/kubernetes/manifests

    Wait for the service to restart.

    crictl ps | grep etcd

    If the etcd containers are found, the service has been restarted and the etcd data is restored on the node.

    NOTE:

    To restore etcd data, perform steps 1 to 5 on each node where the etcd database resides.

Restoring a single master node

  1. Run the single-node fault recovery command on the executor:

    ./ucs-ctl restore node {IP address of the node} --name {Cluster name}
    {IP address of the node} indicates the IP address of the faulty node. The following is an example:
    ./ucs-ctl restore node 192.168.0.87 --name gpu-test
    The fault on the single master node is rectified if the following command output is displayed:
    restore node 192.168.0.87 successfully.

  2. Restore etcd data on the node where etcd is located. For details about the commands, see 1 to 5.

Restoring master nodes

  1. Clear the data on all master nodes. Copy the uninstallation script in the executor directory to the master nodes and execute the script on each master node. (The script path is /var/paas/.ucs-package/ucs-onpremise/scripts/uninstall_node.sh.)

    scp -r /var/paas/.ucs-package/ucs-onpremise/scripts/uninstall_node.sh root@{IP address of the target node}:/root
    sudo bash /root/uninstall_node.sh

  2. Run the cluster fault recovery command on the executor:

    ./ucs-ctl restore cluster {Cluster name} -b {Path of the backup file package}

    Example command:

    ./ucs-ctl restore cluster gpu-test -b /home/ggz/gpu-test/backup-file-20230625164904.tar.gz
    The faults on the master nodes are rectified if the following command output is displayed:
    restore cluster successfully.

  3. Restore etcd data on each node where etcd is located. For details about the commands, see 1 to 5.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback