Version: 2.11

Portworx Backup Documentation

You are currently viewing the documentation for Portworx Backup version 2.11.x. To access documentation for a previous version, use the version selector drop-down located in the top-left corner of the page.

Get Started with Portworx Backup

What's New

Learn more about what's new with the latest releases of Portworx Backup

Introduction to Portworx Backup

An overview about Portworx Backup and its components.

Quick Start Guide

A guide to learn the sequence of various steps of Portworx Backup deployment, configuration, and operation.

Deploy Portworx Backup

Installation Requirements

Learn about the minimum system requirements needed for Portworx Backup deployment.

Compatibility Matrix

Support Matrices offer a comprehensive guide of supported configurations, compatible versions, and feature support required for deploying Portworx Backup.

Install Portworx Backup

This guide provides step-by-step instructions to install Portworx Backup and Stork in an internet-connected and air-gapped Kubernetes environments.

Install from Cloud Marketplace

Deploy Portworx Backup from cloud marketplace offerings.

Upgrade

Follow this guide to upgrade your Portworx Backup and Stork deployment in internet-connected and air-gapped Kubernetes environments

Set up UI Access

Learn how to access the Portworx Backup web console after installation in different environments.

Configure Portworx Backup

Configure Licensing

Learn how to apply and manage backup licenses for Portworx Backup in an on-prem environment.

Configure Role-Based Access Control (RBAC)

Manage users and user groups access to Portworx Backup resources with RBAC and non-RBAC privileges.

Configure Optimisations Using ConfigMaps

Update the ConfigMaps to optimize backup and restore operations, including managing large PVCs, memory limits, and file exclusions

Configure Fault Monitoring

Configure SMTP server to send email alerts for critical system events and notify designated recipients automatically.

Configure Cloud Accounts and Backup Location

Learn how to add cloud credentials and backup locations to Portworx Backup.

Operate Portworx Backup

Connect Application Cluster

Add and manage Kubernetes clusters in Portworx Backup for backup and restore operations.

Set up Backup Policies

How to add schedule policies to schedule Backups for Kubernetes namespaces, VMs and resources in Portworx Backup.

Create and Restore Backups

Back up and restore Kubernetes namespaces or VMs across clusters using Portworx Backup with flexible user-friendly options.

Portworx Backup References

ConfigMaps Parameters

Reference documentation for ConfigMap parameters used to configure Portworx Backup.

Performance Metrics

Explore Portworx Backup performance metrics for monitoring and optimization.

Support Matrices