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
46 changes: 45 additions & 1 deletion docs/commands/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ usage: mas backup [-i MAS_INSTANCE_ID] [--backup-version BACKUP_VERSION]
[--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]
[--manage-db2-backup-type {offline,online}]
[--backup-facilities-app] [--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]
[--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]
Expand Down Expand Up @@ -69,6 +73,20 @@ Manage Application Backup:
--manage-db2-backup-type {offline,online}
Manage Db2 backup type: offline (database unavailable) or online (database remains available)

Facilities Application Backup:
--backup-facilities-app
Backup the Facilities application
--facilities-workspace-id FACILITIES_WORKSPACE_ID
Facilities workspace ID
--backup-facilities-db
Backup the Facilities application database (Db2)
--facilities-db2-namespace FACILITIES_DB2_NAMESPACE
Facilities Db2 namespace (default: db2u)
--facilities-db2-instance-name FACILITIES_DB2_INSTANCE_NAME
Facilities Db2 instance name
--facilities-db2-backup-type {offline,online}
Facilities 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)
Expand Down Expand Up @@ -248,6 +266,32 @@ mas backup \
--no-confirm
```

### Backup with Facilities Application
Backup MAS instance including the Facilities application and its database:

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

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

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

Notes
-------------------------------------------------------------------------------

Expand Down
78 changes: 78 additions & 0 deletions docs/commands/restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ usage: mas restore [-i MAS_INSTANCE_ID] [--restore-version RESTORE_VERSION]
[--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]
[--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]
[--artifactory-username ARTIFACTORY_USERNAME] [--artifactory-token ARTIFACTORY_TOKEN] [--dev-mode] [--no-confirm] [--skip-pre-check] [-h]

IBM Maximo Application Suite Admin CLI
Expand Down Expand Up @@ -132,6 +136,24 @@ Manage Application Restore:
--manage-db-storage-class-rwo MANAGE_DB_STORAGE_CLASS_RWO
Db2 ReadWriteOnce storage class name

Facilities Application Restore:
--restore-facilities-app
Restore the Facilities application including namespace resources and persistent volume data
--restore-facilities-db
Restore the Facilities incluster Db2 database
--override-facilities-app-storageclass
Override storage class for Facilities application persistent volumes
--facilities-app-storage-class-rwx FACILITIES_APP_STORAGE_CLASS_RWX
Facilities Application ReadWriteMany storage class name
--facilities-app-storage-class-rwo FACILITIES_APP_STORAGE_CLASS_RWO
Facilities Application ReadWriteOnce storage class name
--override-facilities-db-storageclass
Override storage class for Facilities Db2 database persistent volumes
--facilities-db-storage-class-rwx FACILITIES_DB_STORAGE_CLASS_RWX
Facilities Db2 ReadWriteMany storage class name
--facilities-db-storage-class-rwo FACILITIES_DB_STORAGE_CLASS_RWO
Facilities Db2 ReadWriteOnce storage class name

More:
--artifactory-username ARTIFACTORY_USERNAME
Username for access to development builds on Artifactory
Expand Down Expand Up @@ -362,6 +384,47 @@ mas restore \
--no-confirm
```

### Restore with Facilities Application
Restore the Facilities application including namespace resources and persistent volume data:

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

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

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

### Restore Facilities with Custom Storage Classes
Restore Facilities application and database with custom storage class overrides:

```bash
mas restore \
--instance-id inst1 \
--restore-version 20260117-191701 \
--restore-facilities-app \
--restore-facilities-db \
--override-facilities-app-storageclass \
--facilities-app-storage-class-rwx custom-rwx-storage \
--facilities-app-storage-class-rwo custom-rwo-storage \
--override-facilities-db-storageclass \
--facilities-db-storage-class-rwx custom-rwx-storage \
--facilities-db-storage-class-rwo custom-rwo-storage \
--no-confirm
```

### Restore Skipping Pre-Check
Skip the pre-restore validation check (use with caution):

Expand Down Expand Up @@ -499,6 +562,21 @@ The restore process can now restore the Manage application in addition to the MA
- 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 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`
- Use `--override-facilities-db-storageclass` to override Db2 database storage classes, then specify `--facilities-db-storage-class-rwx` and `--facilities-db-storage-class-rwo`

!!! 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
- 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)

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

Expand Down
Loading
Loading