LogoLogo
Ops IntelligenceAsset IntelligenceObservabilityRobotic Data
  • Introduction
  • How it Works
  • Getting Started
  • Glossary
  • Implementer Guide
    • cfxDimensions Installation
      • Hardware and Software
      • cfxDimenions on VMware vSphere
        • Post cfxDimensions VM Installation
      • SSL Certificates Installation
      • cfxDimensions Setup & Install
        • Known Issues
      • cfxDimensions High Availability
        • GlusterFS Operations
        • Minio Operations
        • MariaDB Operations
      • cfxDimensions Start, Stop order
      • Macaw CLI
        • macaw CLI Installation
          • macaw CLI v2.1.17
        • macaw setup
        • macaw infra
        • macaw platform
        • macaw user
        • macaw application
        • macaw status
        • macaw services
        • macaw clambda
        • macaw techsupport
        • macaw backup
        • macaw restore
        • macaw reset
      • Release Notes
        • cfxDimensions v2.0.3
        • cfxDimensions v2.1.17
        • cfxDimensions v2.2.20
    • cfxDimensions Backup & Restore
    • cfxOIA Installation
    • cfxOIA Application Services
    • cfxOIA Release Notes
      • cfxOIA v5.1.5
      • cfxOIA v5.1.5.2
      • cfxOIA v5.1.5.3
      • cfxOIA v6.0.0
      • cfxOIA v6.1.0
  • KEY FEATURES GUIDE
    • Incident Management
      • Incidents Overview
      • Create Incident
      • Incident States
      • Accessing Incident
        • Stack
        • Alerts
        • Metrics & Logs
        • Insights
        • Collaboration
        • Diagnostics
        • Remediation
        • Attachments
        • Activities
      • Incident Actions
    • Alert Management
      • Alerts Overview
      • Alert Analytics
      • Alert States
      • Alert Sources
    • Advanced Alert Configuration
      • Alert Mappings
      • Alert Enrichment
      • Alert Correlation & Suppression
        • Creating and Updating Correlation Policies
        • Creating and Updating Suppression Policies
        • Correlation Recommendations
    • ML Driven Operations
    • Data Exploration
    • RDA (Robotic Data Automation)
      • Accessing UI
      • Sources Addition and Configuration
      • Check Connectivity
      • Proxy Settings
      • Explore
        • Bots
        • Pipelines
        • Schedules
        • Jobs
    • Analytics
  • UI & PORTAL FEATURES GUIDE
    • Filters Management
    • Customizing Table Views
    • Exporting Data
  • Administrator Guide
    • User Roles & RBAC
    • Collaboration
    • Projects
      • How to add Project
      • Configure Project
        • Stacks
        • Incidents
        • Alerts
        • Messages
          • Message Endpoints
            • Rest Data Consumer
            • Kafka Message Consumer
            • ServiceNow SaaS
            • Webhook with Basic Authentication
          • Message Mappings
        • Teams
        • Datasources
        • Resolution Codes
  • INTEGRATIONS GUIDE
    • Integrations Overview
    • Featured Integrations
      • AppDynamics
      • Dynatrace
      • Microsoft Teams
      • NetApp Cluster Mode
      • NetApp 7 Mode
      • Prometheus
      • ServiceNow
      • Slack
      • Splunk Enterprise
      • VMware vCenter
      • Zabbix
      • NodePing
      • Nagios XI
      • Check MK
      • VMware vRealize Operations
      • PRTG Network Monitor
      • Grafana
      • AWS Cloudwatch
      • ManageEngine OpManager
      • PagerDuty
Powered by GitBook
On this page
  1. Implementer Guide
  2. cfxDimensions Installation
  3. Macaw CLI

macaw backup

cfxDimensions Platform Backup Operations:

macaw backup command provides option allows cfxDimensions admin user to create backups for platform configuration and application data backup (MariaDB database and Minio data) on-demand or periodically using a cron job schedule.

macaw backup --help
usage: backup [--insecure] [-h] [--debug] --dest-dir BACKUP_DEST_DIR
              [--create-tar] [--service SERVICES]

Backup the Macaw platform

optional arguments:
  --insecure            Ignore SSL certificate issues when communicating with
                        various hosts
  -h, --help            show this help message and exit
  --debug               Enable debug logs for the CLI operations
  --dest-dir BACKUP_DEST_DIR
                        Directory into which the backup will be stored
  --create-tar          Creates a tar file for the backed up data
  --service SERVICES    Backup only the specified components

Note-1: One of the pre-requisite is to provide a network shared mount point (NFS) to both Platform and Infrastructure services nodes on which Gluster, MariaDB and Minio services are running. It is going to be used to store backup data of cfxDimensions platform.

Note-2: Though macaw CLI takes backup of platform's configuration and application data, it does not take backup of the OS (RHEL / CentOS) on which the cfxDimensions platform is deployed. It is recommended to use 3rd party tools like veeam, HP dataprotect, cohesity, netbackup etc. to take full VM level backup on periodic basis.

3rd party VM level backup need to be used to recover one of the cfxDimensions platform VMs if OS is unable to boot RHEL / CentOS.

Below command takes full backup of platform configuration and application data.

macaw backup --dest-dir <nfs-shared-mountpoint-dir>

Inside the backup directory, a folder is created with a date, for example:- ‘2021-07-17-1626586567.934014’ for each successfully completed backup. Inside this directory, the folder structure appears like below:

  • data (directory)

  • install-root (directory)

  • macaw-backup.cfg - Backup configuration file

  • platform.cfg - cfxDimensions platform's configuration file

The MariaDB database and Minio object storage data is stored under ‘data’ directory.

The other install-root directory contains all the necessary configuration files required for each platform and infrastructure services.

Backup Schedule:

To take cfxDimensions platform's and application configuration and data backup regularly, it can be scheduled using crond service. Below is one sample crontab schedule entry for the backup.

58 20 * * * /home/macaw/.local/bin/macaw backup --debug --dest-dir /cfx-nfs-backup >> /opt/macaw/shared/log/cfx-backup.log
Previousmacaw techsupportNextmacaw restore

Last updated 3 years ago