Skip to content
Merged
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
49 changes: 46 additions & 3 deletions docs/commands/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ usage: mas backup [-i MAS_INSTANCE_ID] [--backup-version BACKUP_VERSION]
[--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]
[--backup-manage-app] [--backup-manage-include-pvc] [--backup-manage-exclude-pvc] [--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}]
[--backup-facilities-app] [--facilities-workspace-id FACILITIES_WORKSPACE_ID] [--backup-facilities-db]
[--backup-facilities-app] [--backup-facilities-include-pvc] [--backup-facilities-exclude-pvc]
[--facilities-workspace-id FACILITIES_WORKSPACE_ID] [--backup-facilities-db]
[--facilities-db2-namespace FACILITIES_DB2_NAMESPACE] [--facilities-db2-instance-name FACILITIES_DB2_INSTANCE_NAME]
[--facilities-db2-backup-type {offline,online}]
[--include-sls] [--exclude-sls] [--include-mongo] [--exclude-mongo]
Expand Down Expand Up @@ -65,6 +66,10 @@ Manage Application Backup:
--backup-manage-app Backup the Manage application
--manage-workspace-id MANAGE_WORKSPACE_ID
Manage workspace ID
--backup-manage-include-pvc
Include PVC backup for Manage application
--backup-manage-exclude-pvc
Exclude PVC backup for Manage application
--backup-manage-db Backup the Manage application database (Db2)
--manage-db2-namespace MANAGE_DB2_NAMESPACE
Manage Db2 namespace (default: db2u)
Expand All @@ -78,6 +83,10 @@ Facilities Application Backup:
Backup the Facilities application
--facilities-workspace-id FACILITIES_WORKSPACE_ID
Facilities workspace ID
--backup-facilities-include-pvc
Include PVC backup for Facilities application
--backup-facilities-exclude-pvc
Exclude PVC backup for Facilities application
--backup-facilities-db
Backup the Facilities application database (Db2)
--facilities-db2-namespace FACILITIES_DB2_NAMESPACE
Expand Down Expand Up @@ -255,6 +264,18 @@ mas backup \
--no-confirm
```

### Backup with Manage Application excluding PVCs
Backup the Manage application including persistent volume data:

```bash
mas backup \
--instance-id inst1 \
--backup-manage-app \
--manage-workspace-id masdev \
--backup-manage-exclude-pvc \
--no-confirm
```

### Backup with Manage Application Only (No Database)
Backup the Manage application without backing up its database:

Expand All @@ -281,6 +302,18 @@ mas backup \
--no-confirm
```

### Backup with Facilities Application excluding PVCs
Backup the Facilities application including persistent volume data:

```bash
mas backup \
--instance-id inst1 \
--backup-facilities-app \
--facilities-workspace-id masdev \
--backup-facilities-exclude-pvc \
--no-confirm
```

### Backup with Facilities Application Only (No Database)
Backup the Facilities application without backing up its database:

Expand Down Expand Up @@ -336,14 +369,24 @@ Two upload destinations are supported:
### 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 Application**: Backs up the Manage namespace resources
- **Manage PVC Backup**: Use `--backup-manage-include-pvc` or `--backup-manage-exclude-pvc` to include/exclude persistent volume data in the backup
- **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.

### Facilities Application Backup
The backup command can optionally include the Facilities application and its Db2 database:

- **Facilities Application**: Backs up the Facilities namespace resources
- **Facilities PVC Backup**: Use `--backup-facilities-include-pvc` or `--backup-facilities-exclude-pvc` to include/exclude persistent volume data in the backup
- **Facilities Database**: Backs up the Db2 database associated with the Facilities workspace
- **Offline backup**: Database is unavailable during backup (required for circular logging)
- **Online backup**: Database remains available during backup (requires archive logging)

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

Expand Down
50 changes: 44 additions & 6 deletions docs/commands/restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@ usage: mas restore [-i MAS_INSTANCE_ID] [--restore-version RESTORE_VERSION]
[--sls-domain SLS_DOMAIN] [--ibm-entitlement-key IBM_ENTITLEMENT_KEY] [--contact-email DRO_CONTACT_EMAIL]
[--contact-firstname DRO_CONTACT_FIRSTNAME] [--contact-lastname DRO_CONTACT_LASTNAME]
[--dro-namespace DRO_NAMESPACE] [--override-mongodb-storageclass] [--mongodb-storageclass-name MONGODB_STORAGECLASS_NAME]
[--restore-manage-app] [--restore-manage-db] [--override-manage-app-storageclass]
[--restore-manage-app] [--restore-manage-include-pvc] [--restore-manage-exclude-pvc]
[--restore-manage-db] [--override-manage-app-storageclass]
[--manage-app-storage-class-rwx MANAGE_APP_STORAGE_CLASS_RWX] [--manage-app-storage-class-rwo MANAGE_APP_STORAGE_CLASS_RWO]
[--override-manage-db-storageclass]
[--manage-db-storage-class-rwx MANAGE_DB_STORAGE_CLASS_RWX] [--manage-db-storage-class-rwo MANAGE_DB_STORAGE_CLASS_RWO]
[--restore-facilities-app] [--restore-facilities-db] [--override-facilities-app-storageclass]
[--restore-facilities-app] [--restore-facilities-include-pvc] [--restore-facilities-exclude-pvc]
[--restore-facilities-db] [--override-facilities-app-storageclass]
[--facilities-app-storage-class-rwx FACILITIES_APP_STORAGE_CLASS_RWX] [--facilities-app-storage-class-rwo FACILITIES_APP_STORAGE_CLASS_RWO]
[--override-facilities-db-storageclass]
[--facilities-db-storage-class-rwx FACILITIES_DB_STORAGE_CLASS_RWX] [--facilities-db-storage-class-rwo FACILITIES_DB_STORAGE_CLASS_RWO]
Expand Down Expand Up @@ -121,7 +123,11 @@ MongoDB Storage Class Override:
MongoDB storage class name (ReadWriteOnce). If not specified, cluster default will be used.

Manage Application Restore:
--restore-manage-app Restore the Manage application including namespace resources and persistent volume data
--restore-manage-app Restore the Manage application including namespace resources
--restore-manage-include-pvc
Include PVC restore for Manage application
--restore-manage-exclude-pvc
Exclude PVC restore for Manage application
--restore-manage-db Restore the Manage incluster Db2 database
--override-manage-app-storageclass
Override storage class for Manage application persistent volumes
Expand All @@ -138,7 +144,11 @@ Manage Application Restore:

Facilities Application Restore:
--restore-facilities-app
Restore the Facilities application including namespace resources and persistent volume data
Restore the Facilities application including namespace resources
--restore-facilities-include-pvc
Include PVC restore for Facilities application
--restore-facilities-exclude-pvc
Exclude PVC restore for Facilities application
--restore-facilities-db
Restore the Facilities incluster Db2 database
--override-facilities-app-storageclass
Expand Down Expand Up @@ -354,6 +364,18 @@ mas restore \
--no-confirm
```

### Restore with Manage Application Excluding PVCs
Restore the Manage application including persistent volume data:

```bash
mas restore \
--instance-id inst1 \
--restore-version 20260117-191701 \
--restore-manage-app \
--restore-manage-exclude-pvc \
--no-confirm
```

### Restore with Manage Application and Database
Restore both the Manage application and its incluster Db2 database:

Expand Down Expand Up @@ -395,6 +417,18 @@ mas restore \
--no-confirm
```

### Restore with Facilities Application Excluding PVCs
Restore the Facilities application including persistent volume data:

```bash
mas restore \
--instance-id inst1 \
--restore-version 20260117-191701 \
--restore-facilities-app \
--restore-facilities-exclude-pvc \
--no-confirm
```

### Restore with Facilities Application and Database
Restore both the Facilities application and its incluster Db2 database:

Expand Down Expand Up @@ -550,7 +584,8 @@ This is particularly useful for:
### Manage Application Restore
The restore process can now restore the Manage application in addition to the MAS Suite:

- **Manage Application**: Use `--restore-manage-app` to restore Manage namespace resources and persistent volume data
- **Manage Application**: Use `--restore-manage-app` to restore Manage namespace resources
- **Manage PVC Restore**: Use `--restore-manage-include-pvc` or `--restore-manage-exclude-pvc` to restore persistent volume data
- **Manage Database**: Use `--restore-manage-db` to restore the incluster Db2 database associated with the Manage workspace
- **Storage Class Overrides**:
- Use `--override-manage-app-storageclass` to override Manage application storage classes, then specify `--manage-app-storage-class-rwx` and `--manage-app-storage-class-rwo`
Expand All @@ -559,13 +594,15 @@ The restore process can now restore the Manage application in addition to the MA
!!! note
- Manage database restore is an offline operation - the Manage application will be unavailable during the restore
- The restore process handles both the application resources and the database data
- PVC restore is optional and controlled by the `--restore-manage-include-pvc` or `--restore-manage-exclude-pvc` flag
- Storage class overrides are useful when restoring to clusters with different storage infrastructure
- A single RWX and RWO storage class is applied across all Db2 persistent volumes (meta, data, backup, logs, temp)

### Facilities Application Restore
The restore process can restore the Facilities application in addition to the MAS Suite:

- **Facilities Application**: Use `--restore-facilities-app` to restore Facilities namespace resources and persistent volume data
- **Facilities Application**: Use `--restore-facilities-app` to restore Facilities namespace resources
- **Facilities PVC Restore**: Use `--restore-facilities-include-pvc` or `--restore-facilities-exclude-pvc` to restore persistent volume data
- **Facilities Database**: Use `--restore-facilities-db` to restore the incluster Db2 database associated with the Facilities workspace
- **Storage Class Overrides**:
- Use `--override-facilities-app-storageclass` to override Facilities application storage classes, then specify `--facilities-app-storage-class-rwx` and `--facilities-app-storage-class-rwo`
Expand All @@ -574,6 +611,7 @@ The restore process can restore the Facilities application in addition to the MA
!!! note
- Facilities database restore is an offline operation - the Facilities application will be unavailable during the restore
- The restore process handles both the application resources and the database data
- PVC restore is optional and controlled by the `--restore-facilities-include-pvc` or `--restore-facilities-exclude-pvc`flag
- Storage class overrides are useful when restoring to clusters with different storage infrastructure
- A single RWX and RWO storage class is applied across all Db2 persistent volumes (meta, data, backup, logs, temp)

Expand Down
3 changes: 1 addition & 2 deletions docs/guides/backup-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ This guide provides comprehensive information on backing up and restoring IBM Ma
**Supported MAS versions**

- MAS 9.1.x

Note: MAS 9.0.x (Not supported yet, its in testing)
- MAS 9.2.x

**User Permissions Required**

Expand Down
17 changes: 10 additions & 7 deletions docs/guides/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,27 +202,30 @@ The backup captures certificate configurations but not the actual certificates,

The backup process supports backing up MAS application resources and persistent volume data. Currently supported:

- **Manage Application** - Backs up Manage namespace resources and persistent volume data
- **Manage Application** - Backs up Manage namespace resources and optionally persistent volume data
- **Facilities Application** - Backs up Facilities namespace resources and optionally persistent volume data

When backing up a Manage application, the following resources are included:
When backing up a Manage or Facilities application, the following resources are included:

**Namespace Resources**:
- `ManageApp` custom resource
- `ManageWorkspace` custom resource
- Encryption secrets (dynamically determined from ManageWorkspace CR)
- Application custom resource (e.g., `ManageApp`, `FacilitiesApp`)
- Workspace custom resource (e.g., `ManageWorkspace`, `FacilitiesWorkspace`)
- Encryption secrets (dynamically determined from Workspace CR)
- Certificates with `mas.ibm.com/instanceId` label
- Subscription and OperatorGroup
- IBM entitlement secret
- All referenced secrets (auto-discovered)

**Persistent Volume Data** (if configured in ManageWorkspace CR):
**Persistent Volume Data** (optional, controlled by flags):
- Use `--backup-manage-include-pvc` to include Manage PVC data
- Use `--backup-facilities-include-pvc` to include Facilities PVC data
- All persistent volumes defined in `spec.settings.deployment.persistentVolumes`
- Data backed up as compressed tar.gz archives
- Each PVC's mount path archived separately
- Common PVCs include JMS server data, custom fonts, and attachments

!!! note
Application backup is optional and configured during the interactive backup process or via command-line parameters (`--backup-manage-app`, `--manage-workspace-id`).
Application backup is optional and configured during the interactive backup process or via command-line parameters (`--backup-manage-app`, `--manage-workspace-id`, `--backup-manage-include-pvc` for Manage; `--backup-facilities-app`, `--facilities-workspace-id`, `--backup-facilities-include-pvc` for Facilities).

### Db2 Database Backup

Expand Down
8 changes: 6 additions & 2 deletions docs/guides/restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ The restore process handles the following components:
- **Suite-level SLSCfg** - Restores or provides custom Suite-level SLS configuration with optional URL override
- **Suite-level BASCfg/DROCfg** - Restores or provides custom Suite-level DRO/BAS configuration with optional URL override
- **Manage Database** - Optionally restores incluster Db2 database associated with Manage workspace
- **Manage Application** - Optionally restores Manage application namespace resources and persistent volume data
- **Manage Application** - Optionally restores Manage application namespace resources and optionally persistent volume data
- **Facilities Database** - Optionally restores incluster Db2 database associated with Facilities workspace
- **Facilities Application** - Optionally restores Facilities application namespace resources and optionally persistent volume data
- **Grafana** - Optionally installs Grafana for monitoring (not part of backup)
- **Data Reporter Operator (DRO)** - Optionally installs DRO (not part of backup), when DRO is installed, an auto-generated Suite-level BASCfg CR will be applied automatically.

Expand Down Expand Up @@ -96,8 +98,10 @@ When downloading from S3 or Artifactory, the `download_backup_archive` role sele
| `include_sls_archive` | `false` | Download the SLS backup archive |
| `include_manage_db_archive` | `false` | Download the Manage Db2 database backup archive |
| `include_manage_app_archive` | `false` | Download the Manage application backup archive |
| `include_facilities_db_archive` | `false` | Download the Facilities Db2 database backup archive |
| `include_facilities_app_archive` | `false` | Download the Facilities application backup archive |

These parameters are automatically set by the restore pipeline based on the restore configuration (e.g. `--restore-manage-app`, `--restore-manage-db`, `--include-sls`), so you do not need to set them manually when using the `mas restore` command.
These parameters are automatically set by the restore pipeline based on the restore configuration (e.g. `--restore-manage-app`, `--restore-manage-db`, `--restore-facilities-app`, `--restore-facilities-db`, `--include-sls`), so you do not need to set them manually when using the `mas restore` command.

### Ansible DevOps Integration

Expand Down
Loading
Loading