Application Backup

Application backups are a simplified backup that has been normalized for restoration across multiple application run methods. This includes a direct install on a host, ran with docker and ran with kubernetes. This play will create a backup of the specified application to a single encrypted tar file and copy locally.

job tag application

Playbook AWX / Ansible Automation Platform Template Import

This playbook includes the AWX feature where it imports the playbook as job templates in to AWX / Ansible Automation Platform. The following job templates that will be created:

Backup/Application Backup an application with the specified extra_vars
Backup/Inventory Conduct a backup using variables from inventory to select what to backup

On import to AWX / Ansible Automation Platform a credential type will also be created, playbook/mariadb/login that can be used to supply the required secrets to logon to the MariaDB Database.

Play workflow

The playbook follows the following flow when conducting a container backup.

Creates temp directory to store the backup data
Backs up each path to the temp location in a sub-directory named the same as the final directory in the path
Conducts backup of all databases to sub-directory database-dump in the temp location, using database as filename.
encrypts the data within a tar archive
copies the backup file locally

Backing up multiple items will have the workflow above start again from step two.

Info

On error during any stage of the workflow, prior to the play stopping all files related to the workflow, included any created (i.e. extracting contents of archive) will be removed so there are no traces on the remote host.

Variables

Required variables.

backup:
  directory: /opt/backup          # Mandatory, String. Path to save downloaded archive(s) to.
  encryption_algorithm: aes256    # Encryption algorithm
  applications: []                # Mandatory, List of dict. List of applications to backup

Backup

There are different varaible requirements depending on the application type. Select the appropriate tab to view the definition.

DockerHostKubernetes

Application variable required to backup a Docker container.

- name: glpi              # Mandatory, String. Name of the Application
  type: docker            # Mandatory. choice=docker|kube. Container engine type
  container: glpi         # Mandatory. String. Name of the container to backup.
  excludes: []            # Optional, List of String.  paths to exclude. Relative to the backup directory temp structure
  path: []                # Mandatory*. List of String. Mandatory to backup files. Path within the container to backup
  databases: []           # Mandatory*. List of dict. Required only if backing up database

Host application definition

- name: k3s               # Mandatory, String. Name of the Application
  type: host              # Mandatory. choice=docker|kube. Container engine type
  excludes: []            # Optional, List of String.  paths to exclude. Relative to the backup directory temp structure
  path:  []               # Mandatory*. List of String. Mandatory to backup files. Path within the container to backup
  databases: []           # Mandatory*. List of dict. Required only if backing up database

Application variable required to backup a Kubernetes container.

- name: glpi              # Mandatory, String. Name of the Application
  type: kube              # Mandatory. choice=docker|kube. Container engine type
  pod: postgres-0         # Mandatory, String. the name of the pod to backup
  container: backup       # Optional. String. Name of the container to connect to.
  namespace: postgres     # Mandatory. String. Namespace name where the pod belongs
  excludes: []            # Optional, List of String.  paths to exclude. Relative to the backup directory temp structure
  path:  []               # Mandatory*. List of String. Mandatory to backup files. Path within the container to backup
  databases: []           # Mandatory*. List of dict. Required only if backing up database

Paths

Path item definition. This list of items is at location backup.application[x].path

- /var/www/html/marketplace
- /var/www/html/plugins

When files are copied to the backup staging directory, each source path is truncated to the last folder name in the path. i.e. A path of /opt/mydata/the_folder would be added to the staging directory called the_folder. It's important to remember this, as the last directory of all paths to be backed up must be unique. If they are not, the contents of multiple source paths will be merged.

Tip

If you find that the archive directory name conflicts, i.e. two or more directories have the same name, go up one directory and use exclude patterns to ensure the directories are unique.

Exclusion of files from the backup is done after the files are staged. The exclusion pattern is what is a path relative to the staging directory. i.e. start with the directory name then the path to exclude, directory_name/path/to/exclude/filename.txt, directory_name/path/to/exclude/a_directory/.

Database

Database Backup definition is as follows.

MariaDB / MySQLPostgres

- names:                                   # Mandatory. List of String. name(s) of database to backup
    - glpi
  type: mariadb                            # Mandatory, choice=mariadb|mysql|postgres
  method: docker                           # Optional, choice=docker|direct. default=direct specify the method to backup the database
  encrypt: false                           # Optional, Boolean. default=true. Encrypt the database backup
  host:
    name:                                  # Mandatory*. String. Database host DNS or IP Address.
    port:                                  # Optional, Integer. port of database host to connect to.
    socket: /var/run/mysqld/mysqld.sock    # Mandatory*. String. Path to the MySQL socket.
  delegate: localhost                      # Optional,choice=localhost. who should connect to the database

- names:                                          # Mandatory. List of String. name(s) of database to backup
    - glpi
  type: postgres                                  # Mandatory, choice=mariadb|mysql|postgres
  method: docker                                  # Optional, choice=docker|direct. default=direct specify the method to backup the
                                                  #                                                database
  encrypt: false                                  # Optional, Boolean. default=true. Encrypt the database backup
  host: 
    name: main-postgresql-ha-pgpool.postgres.svc    # Mandatory. String. Database host DNS or IP Address.
    port:
    socket:
  delegate: localhost                             # Optional,choice=localhost. who should connect to the database

As part of the backup archive a metadata file is created metadata.yaml. This is a yaml file containing the details of the files within the backup. The metadata file is a yaml formated list of dicts.

metadata file contents example

- checksum:
    algo: "sha256"
    value: "c545cb6a1682beee488ac6b03b7356e459812515939e564cd0c79d3ddf2e2286"
  gid: 100
  mode: "0644"
  name: "plugins/glpiinventory/lib/lazy.js-0.5.1/.travis.yml"
  uid: 0

About:

This page forms part of our Project Ansible Playbooks.

Page Metadata

Version: ToDo: place files short git commit here
Date Created: 2024-01-13
Date Edited: 2024-01-15

Contribution:

Would You like to contribute to our Ansible Playbooks project? You can assist in the following ways:

Edit This Page If there is a mistake or a way you can improve it.
Add a Page to the Manual if you would like to add an item to our manual
Raise an Issue if there is something about this page you would like to improve, and git is unfamiliar to you.

ToDo: Add the page list of contributors