Backup¶

Usage¶

Usage information can be obtained using mas backup --help

usage: mas backup [-i MAS_INSTANCE_ID] [--backup-version BACKUP_VERSION]
                  [--backup-storage-size BACKUP_STORAGE_SIZE] [--backup-storage-class BACKUP_STORAGE_CLASS]
                  [--backup-storage-access-mode BACKUP_STORAGE_ACCESS_MODE]
                  [--clean-backup] [--no-clean-backup] [--upload-backup] [--aws-access-key-id AWS_ACCESS_KEY_ID]
                  [--aws-secret-access-key AWS_SECRET_ACCESS_KEY] [--s3-bucket-name S3_BUCKET_NAME] [--s3-region S3_REGION]
                  [--artifactory-url ARTIFACTORY_URL] [--artifactory-repository ARTIFACTORY_REPOSITORY]
                  [--backup-manage-app] [--manage-workspace-id MANAGE_WORKSPACE_ID] [--backup-manage-db]
                  [--manage-db2-namespace MANAGE_DB2_NAMESPACE] [--manage-db2-instance-name MANAGE_DB2_INSTANCE_NAME]
                  [--manage-db2-backup-type {offline,online}] [--include-sls] [--exclude-sls] [--include-mongo] [--exclude-mongo]
                  [--mongodb-namespace MONGODB_NAMESPACE] [--mongodb-instance-name MONGODB_INSTANCE_NAME]
                  [--mongodb-provider {community}] [--sls-namespace SLS_NAMESPACE] [--cert-manager-provider {redhat,ibm}]
                  [--artifactory-username ARTIFACTORY_USERNAME] [--artifactory-token ARTIFACTORY_TOKEN] [--dev-mode] [--no-confirm]
                  [--skip-pre-check] [-h]

IBM Maximo Application Suite Admin CLI v18.10.0
Backup a MAS instance by configuring and launching the MAS Backup Tekton Pipeline.

Interactive Mode:
Omitting the --instance-id option will trigger an interactive prompt

MAS Instance:
  -i, --instance-id MAS_INSTANCE_ID
                        MAS Instance ID to backup

Backup Configuration:
  --backup-version BACKUP_VERSION
                        Version/timestamp for the backup (auto-generated if not provided)
  --backup-storage-class BACKUP_STORAGE_CLASS
                        Storage class for backup-pvc PVC storage
  --backup-storage-size BACKUP_STORAGE_SIZE
                        Size of the backup PVC storage (default: 20Gi)
  --backup-storage-access-mode BACKUP_STORAGE_ACCESS_MODE
                        Access mode for backup PVC storage (ReadWriteOnce or ReadWriteMany)
  --clean-backup        Clean backup and config workspaces after completion (default: true)
  --no-clean-backup     Do not clean backup and config workspaces after completion

Upload Configuration:
  --upload-backup       Upload the backup archive after completion
  --aws-access-key-id AWS_ACCESS_KEY_ID
                        AWS Access Key ID for S3 upload
  --aws-secret-access-key AWS_SECRET_ACCESS_KEY
                        AWS Secret Access Key for S3 upload
  --s3-bucket-name S3_BUCKET_NAME
                        S3 bucket name for backup upload
  --s3-region S3_REGION
                        AWS region for S3 bucket
  --artifactory-url ARTIFACTORY_URL
                        Artifactory URL for backup upload (dev-mode only)
  --artifactory-repository ARTIFACTORY_REPOSITORY
                        Artifactory repository for backup upload (dev-mode only)

Manage Application Backup:
  --backup-manage-app   Backup the Manage application
  --manage-workspace-id MANAGE_WORKSPACE_ID
                        Manage workspace ID
  --backup-manage-db    Backup the Manage application database (Db2)
  --manage-db2-namespace MANAGE_DB2_NAMESPACE
                        Manage Db2 namespace (default: db2u)
  --manage-db2-instance-name MANAGE_DB2_INSTANCE_NAME
                        Manage Db2 instance name
  --manage-db2-backup-type {offline,online}
                        Manage Db2 backup type: offline (database unavailable) or online (database remains available)

Components:
  --include-mongo       Include Mongo in backup (default: true)
  --exclude-mongo       Exclude Mongo from backup (use if Mongo is external)
  --include-sls         Include SLS in backup (default: true)
  --exclude-sls         Exclude SLS from backup (use if SLS is external)

Dependencies Configuration:
  --mongodb-namespace MONGODB_NAMESPACE
                        MongoDB namespace (default: mongoce)
  --mongodb-instance-name MONGODB_INSTANCE_NAME
                        MongoDB instance name to backup (default: mas-mongo-ce)
  --mongodb-provider {community}
                        MongoDB provider (only community is supported for backup)
  --sls-namespace SLS_NAMESPACE
                        SLS namespace (default: ibm-sls)
  --cert-manager-provider {redhat}
                        Certificate manager provider (default: redhat)

More:
  --artifactory-username ARTIFACTORY_USERNAME
                        Username for access to development builds on Artifactory (dev-mode only)
  --artifactory-token ARTIFACTORY_TOKEN
                        API Token for access to development builds on Artifactory (dev-mode only)
  --dev-mode            Configure backup for development mode
  --no-confirm          Launch the backup without prompting for confirmation
  --skip-pre-check      Skips the 'pre-backup-check' task in the backup pipeline
  -h, --help            Show this help message and exit

Examples¶

Interactive Backup¶

Launch an interactive backup session that will prompt you for all required configuration:

mas backup

Non-Interactive Backup with Minimal Configuration¶

Backup a specific MAS instance with default settings:

mas backup --instance-id inst1 --no-confirm

Backup with Custom Storage Size¶

Specify a custom storage size for the backup PVC:

mas backup --instance-id inst1 --backup-storage-size 50Gi --no-confirm

Backup with Custom Version¶

Set a custom backup version identifier:

mas backup --instance-id inst1 --backup-version 1.0.0 --no-confirm

Backup with S3 Upload¶

Create a backup and automatically upload it to an S3 bucket:

mas backup \
  --instance-id inst1 \
  --upload-backup \
  --aws-access-key-id AKIAIOSFODNN7EXAMPLE \ #pragma: allowlist secret
  --aws-secret-access-key wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \ #pragma: allowlist secret
  --s3-bucket-name my-mas-backups \
  --s3-region us-east-1 \
  --no-confirm

Backup Excluding SLS¶

Create a backup without including Suite License Service (useful when SLS is external):

mas backup --instance-id inst1 --exclude-sls --no-confirm

Backup Excluding MongoDB¶

Create a backup without including MongoDB (useful when MongoDB is externally hosted):

mas backup --instance-id inst1 --exclude-mongo --no-confirm

Note

Use --exclude-mongo when using external MongoDB providers such as IBM Cloud Databases for MongoDB, MongoDB Atlas, or other managed MongoDB services. You must back up your MongoDB database separately using your provider's native backup tools.

Backup with Custom MongoDB Configuration¶

Specify custom MongoDB settings:

mas backup \
  --instance-id inst1 \
  --mongodb-namespace my-mongo \
  --mongodb-instance-name my-mongo-instance \
  --mongodb-provider community \
  --no-confirm

Backup with Custom SLS Configuration¶

Specify a custom SLS namespace:

mas backup \
  --instance-id inst1 \
  --sls-namespace my-sls \
  --no-confirm

Backup Skipping Pre-Check¶

Skip the pre-backup validation check (use with caution):

mas backup --instance-id inst1 --skip-pre-check --no-confirm

Backup Without Workspace Cleanup¶

Keep backup and config workspace contents after completion (useful for troubleshooting):

mas backup --instance-id inst1 --no-clean-backup --no-confirm

Note

By default, workspaces are cleaned after backup completion to free up storage. Use --no-clean-backup only when you need to inspect the workspace contents for troubleshooting purposes.

Complete Non-Interactive Backup Example¶

A comprehensive example with all major options configured:

mas backup \
  --instance-id inst1 \
  --backup-version 20240315-prod \
  --backup-storage-size 100Gi \
  --include-sls \
  --mongodb-namespace mongoce \
  --mongodb-instance-name mas-mongo-ce \
  --mongodb-provider community \
  --sls-namespace ibm-sls \
  --cert-manager-provider redhat \
  --upload-backup \
  --aws-access-key-id AKIAIOSFODNN7EXAMPLE \ #pragma: allowlist secret
  --aws-secret-access-key wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \ #pragma: allowlist secret
  --s3-bucket-name my-mas-backups \
  --s3-region us-east-1 \
  --no-confirm

Backup with Manage Application¶

Backup MAS instance including the Manage application and its database:

mas backup \
  --instance-id inst1 \
  --backup-manage-app \
  --manage-workspace-id masdev \
  --backup-manage-db \
  --manage-db2-namespace db2u \
  --manage-db2-instance-name mas-inst1-masdev-manage \
  --manage-db2-backup-type offline \
  --no-confirm

Backup with Manage Application Only (No Database)¶

Backup the Manage application without backing up its database:

mas backup \
  --instance-id inst1 \
  --backup-manage-app \
  --manage-workspace-id masdev \
  --no-confirm

Notes¶

Backup Process¶

The backup command performs the following operations:

Validates the target cluster - Ensures OpenShift cluster connectivity and checks for MAS instances
Prepares the pipeline namespace - Creates or updates the mas-{instance-id}-pipelines namespace
Installs OpenShift Pipelines - Validates or installs the OpenShift Pipelines Operator
Creates backup PVC - Provisions persistent storage for the backup data
Launches the backup pipeline - Submits a Tekton PipelineRun to perform the backup
Optionally uploads the backup - If configured, uploads the backup archive to S3 or Artifactory

Default Values¶

If not specified, the following defaults are used:

Backup Storage Size: 20Gi
Backup Version: Auto-generated timestamp in format YYYYMMDD-HHMMSS
Clean Workspaces: true (workspaces are cleaned after completion)
MongoDB Namespace: mongoce
MongoDB Instance Name: mas-mongo-ce
MongoDB Provider: community
SLS Namespace: ibm-sls
Certificate Manager Provider: redhat
Include MongoDB: true
Include SLS: true

Storage Requirements¶

Ensure sufficient storage is available for the backup PVC. The required size depends on:

Size of MAS configuration data
Size of MongoDB database
Size of SLS data (if included)
Any additional application data

Upload Destinations¶

Two upload destinations are supported:

S3: Standard AWS S3 bucket upload (available in all modes)
Artifactory: Artifactory repository upload (requires --dev-mode)

Manage Application Backup¶

The backup command can optionally include the Manage application and its Db2 database:

Manage Application: Backs up the Manage namespace resources and persistent volume data
Manage Database: Backs up the Db2 database associated with the Manage workspace
Offline backup: Database is unavailable during backup (required for circular logging)
Online backup: Database remains available during backup (requires archive logging)

Note

If your Db2 instance uses circular logging (default), you must use offline backup type.

Interactive Mode¶

When running without --instance-id, the command enters interactive mode and will prompt for:

Target OpenShift cluster connection
MAS instance selection (if multiple instances exist)
Backup storage size
Backup version (or auto-generate)
Workspace cleanup preference
Manage application backup configuration (optional)
Upload configuration (optional)

Example Interactive Mode Output¶

Pipeline Monitoring¶

After launching the backup, a URL to the Tekton PipelineRun will be displayed. Use this URL to monitor the backup progress in the OpenShift Console.