Skip to main content
Version: 2.9

Portworx Backup Documentation

You are currently viewing the documentation for Portworx Backup version 2.9.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

What's New

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

Concepts

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.

Installation Prerequisites

Learn about the minimum system requirements needed for a stable and supported Portworx Backup deployment.

Install Portworx Backup

Support Matrices

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

Configure Prometheus

This guide explains how to configure Prometheus to monitor Portworx Backup metrics in an on-premises environment.

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.

Apply Licenses

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

Upgrade Portworx Backup

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

Uninstall Portworx Backup

This guide provides instructions to safely uninstall Portworx Backup in Kubernetes environments.

Configure Portworx Backup

Configure Stork for Proxy

Configure Stork for network proxies for authenticated and unauthenticated proxies.

Configure Access to Web Console

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

Configure User Management

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

Configure Email Alerts

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

Configure Rest API

Configure the REST API to expose Portworx Backup operations via Swagger UI, allowing secure integration and token-based access for automated workflows.

Configure kdmp-config ConfigMap

Update the kdmp-config ConfigMap to optimize KDMP backup and restore operations, including managing large PVCs, memory limits, and file exclusions

Operate Portworx Backup

Add Cloud Accounts

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

Add Backup Locations

Link Portworx Backup to target locations—object storage or NFS shares—to offload and store your backups externally.

Add Schedule Policies

Automate schedule policies—locked or unlocked—to run regular, retention-aware backup jobs for Kubernetes namespaces or VMs.

Add Backup Rules

Define pre- and post-backup rules in Portworx Backup to ensure application-consistent backups.

Manage Clusters

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

Create and Restore Backups

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

Share Resources

Share both RBAC and non‑RBAC resources with users or groups to enable secure collaboration and prevent redundant backups.

Delete Stranded Resources

Identify and delete stranded resources (clusters, backups, restores, schedules) left behind to free up storage.

Portworx Backup Reference

REST API

Explore Portworx Backup’s REST API to programmatically manage clusters, backups, restores, schedules, rules, and configuration settings.

Helm Chart

Install or upgrade Portworx Backu on-prem using the Helm chart with configurable settings.

PXB Ansible Module

Automate Portworx Backup tasks using the PXB Ansible Collection for consistent, reliable operations.

Glossary

Reference glossary defining key Portworx Backup concepts—like clusters, schedules, rules, and backup types—for clear understanding.