mirror of
https://github.com/tiredofit/docker-db-backup.git
synced 2025-12-22 05:33:53 +01:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
accb1acff3 | ||
|
|
a183fcd16d |
@@ -1 +0,0 @@
|
|||||||
examples/
|
|
||||||
2
.gitattributes
vendored
2
.gitattributes
vendored
@@ -1,2 +0,0 @@
|
|||||||
# Declare files that will always have LF line endings on checkout.
|
|
||||||
*.* text eol=lf
|
|
||||||
1
.github/config.yml
vendored
1
.github/config.yml
vendored
@@ -1 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
7
.github/dependabot.yml
vendored
7
.github/dependabot.yml
vendored
@@ -1,7 +0,0 @@
|
|||||||
version: 2
|
|
||||||
updates:
|
|
||||||
# Maintain dependencies for GitHub Actions
|
|
||||||
- package-ecosystem: "github-actions"
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: "daily"
|
|
||||||
114
.github/workflows/main.yml
vendored
114
.github/workflows/main.yml
vendored
@@ -1,14 +1,110 @@
|
|||||||
name: "build_image"
|
### Application Level Image CI
|
||||||
|
### Dave Conroy <dave at tiredofit dot ca>
|
||||||
|
|
||||||
|
name: 'build'
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths:
|
paths:
|
||||||
- "**"
|
- '**'
|
||||||
- "!README.md"
|
- '!README.md'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
docker:
|
||||||
uses: tiredofit/github_actions/.github/workflows/default_amd64_armv7_arm64.yml@main
|
runs-on: ubuntu-latest
|
||||||
#uses: tiredofit/github_actions/.github/workflows/default_amd64.yml@main
|
steps:
|
||||||
#uses: tiredofit/github_actions/.github/workflows/default_amd64_arm64.yml@main
|
- name: Checkout
|
||||||
secrets: inherit
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
id: prep
|
||||||
|
run: |
|
||||||
|
DOCKER_IMAGE=${GITHUB_REPOSITORY/docker-/}
|
||||||
|
set -x
|
||||||
|
if [[ $GITHUB_REF == refs/heads/* ]]; then
|
||||||
|
if [[ $GITHUB_REF == refs/heads/*/* ]] ; then
|
||||||
|
BRANCH="${DOCKER_IMAGE}:$(echo $GITHUB_REF | sed "s|refs/heads/||g" | sed "s|/|-|g")"
|
||||||
|
else
|
||||||
|
BRANCH=${GITHUB_REF#refs/heads/}
|
||||||
|
fi
|
||||||
|
|
||||||
|
case ${BRANCH} in
|
||||||
|
"main" | "master" )
|
||||||
|
BRANCHTAG="${DOCKER_IMAGE}:latest"
|
||||||
|
;;
|
||||||
|
"develop" )
|
||||||
|
BRANCHTAG="${DOCKER_IMAGE}:develop"
|
||||||
|
;;
|
||||||
|
* )
|
||||||
|
if [ -n "${{ secrets.LATEST }}" ] ; then
|
||||||
|
if [ "${BRANCHTAG}" = "${{ secrets.LATEST }}" ]; then
|
||||||
|
BRANCHTAG="${DOCKER_IMAGE}:${BRANCH},${DOCKER_IMAGE}:${BRANCH}-latest,${DOCKER_IMAGE}:latest"
|
||||||
|
else
|
||||||
|
BRANCHTAG="${DOCKER_IMAGE}:${BRANCH},${DOCKER_IMAGE}:${BRANCH}-latest"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
BRANCHTAG="${DOCKER_IMAGE}:${BRANCH},${DOCKER_IMAGE}:${BRANCH}-latest"
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
if [[ $GITHUB_REF == refs/tags/* ]]; then
|
||||||
|
GITTAG="${DOCKER_IMAGE}:$(echo $GITHUB_REF | sed 's|refs/tags/||g')"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "${BRANCHTAG}" ] && [ -n "${GITTAG}" ]; then
|
||||||
|
TAGS=${BRANCHTAG},${GITTAG}
|
||||||
|
else
|
||||||
|
TAGS="${BRANCHTAG}${GITTAG}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ::set-output name=tags::${TAGS}
|
||||||
|
echo ::set-output name=docker_image::${DOCKER_IMAGE}
|
||||||
|
|
||||||
|
- name: Set up QEMU
|
||||||
|
uses: docker/setup-qemu-action@v1
|
||||||
|
with:
|
||||||
|
platforms: all
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
id: buildx
|
||||||
|
uses: docker/setup-buildx-action@v1
|
||||||
|
|
||||||
|
- name: Login to DockerHub
|
||||||
|
if: github.event_name != 'pull_request'
|
||||||
|
uses: docker/login-action@v1
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
|
|
||||||
|
- name: Label
|
||||||
|
id: Label
|
||||||
|
run: |
|
||||||
|
if [ -f "Dockerfile" ] ; then
|
||||||
|
sed -i "/FROM .*/a LABEL tiredofit.image.git_repository=\"https://github.com/${GITHUB_REPOSITORY}\"" Dockerfile
|
||||||
|
sed -i "/FROM .*/a LABEL tiredofit.image.git_commit=\"${GITHUB_SHA}\"" Dockerfile
|
||||||
|
sed -i "/FROM .*/a LABEL tiredofit.image.git_committed_by=\"${GITHUB_ACTOR}\"" Dockerfile
|
||||||
|
sed -i "/FROM .*/a LABEL tiredofit.image.image_build_date=\"$(date +'%Y-%m-%d %H:%M:%S')\"" Dockerfile
|
||||||
|
if [ -f "CHANGELOG.md" ] ; then
|
||||||
|
sed -i "/FROM .*/a LABEL tiredofit.image.git_changelog_version=\"$(head -n1 ./CHANGELOG.md | awk '{print $2}')\"" Dockerfile
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ $GITHUB_REF == refs/tags/* ]]; then
|
||||||
|
sed -i "/FROM .*/a LABEL tiredofit.image.git_tag=\"${GITHUB_REF#refs/tags/v}\"" Dockerfile
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ $GITHUB_REF == refs/heads/* ]]; then
|
||||||
|
sed -i "/FROM .*/a LABEL tiredofit.image.git_branch=\"${GITHUB_REF#refs/heads/}\"" Dockerfile
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
uses: docker/build-push-action@v2
|
||||||
|
with:
|
||||||
|
builder: ${{ steps.buildx.outputs.name }}
|
||||||
|
context: .
|
||||||
|
file: ./Dockerfile
|
||||||
|
platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.prep.outputs.tags }}
|
||||||
|
|||||||
15
.github/workflows/manual.yml
vendored
15
.github/workflows/manual.yml
vendored
@@ -1,15 +0,0 @@
|
|||||||
name: "manual_build_image"
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
Manual Build:
|
|
||||||
description: 'Manual Build'
|
|
||||||
required: false
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
uses: tiredofit/github_actions/.github/workflows/default_amd64_armv7_arm64.yml@main
|
|
||||||
#uses: tiredofit/github_actions/.github/workflows/default_amd64.yml@main
|
|
||||||
#uses: tiredofit/github_actions/.github/workflows/default_amd64_arm64.yml@main
|
|
||||||
secrets: inherit
|
|
||||||
1117
CHANGELOG.md
1117
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
143
Dockerfile
143
Dockerfile
@@ -1,88 +1,47 @@
|
|||||||
ARG DISTRO=alpine
|
FROM tiredofit/alpine:3.13
|
||||||
ARG DISTRO_VARIANT=edge
|
|
||||||
|
|
||||||
FROM docker.io/tiredofit/${DISTRO}:${DISTRO_VARIANT}
|
|
||||||
LABEL maintainer="Dave Conroy (github.com/tiredofit)"
|
|
||||||
|
|
||||||
### Set Environment Variables
|
### Set Environment Variables
|
||||||
ENV INFLUX1_CLIENT_VERSION=1.8.0 \
|
ENV MSSQL_VERSION=17.5.2.1-1 \
|
||||||
INFLUX2_CLIENT_VERSION=2.7.3 \
|
ENABLE_CRON=FALSE \
|
||||||
MSODBC_VERSION=18.3.2.1-1 \
|
ENABLE_SMTP=FALSE \
|
||||||
MSSQL_VERSION=18.3.1.1-1 \
|
ENABLE_ZABBIX=TRUE \
|
||||||
AWS_CLI_VERSION=1.29.78 \
|
ZABBIX_HOSTNAME=db-backup
|
||||||
CONTAINER_ENABLE_MESSAGING=FALSE \
|
|
||||||
CONTAINER_ENABLE_MONITORING=TRUE \
|
|
||||||
IMAGE_NAME="tiredofit/db-backup" \
|
|
||||||
IMAGE_REPO_URL="https://github.com/tiredofit/docker-db-backup/"
|
|
||||||
|
|
||||||
### Dependencies
|
### Dependencies
|
||||||
RUN source /assets/functions/00-container && \
|
RUN set -ex && \
|
||||||
set -ex && \
|
apk update && \
|
||||||
addgroup -S -g 10000 dbbackup && \
|
apk upgrade && \
|
||||||
adduser -S -D -H -u 10000 -G dbbackup -g "Tired of I.T! DB Backup" dbbackup && \
|
apk add -t .db-backup-build-deps \
|
||||||
|
build-base \
|
||||||
|
bzip2-dev \
|
||||||
|
git \
|
||||||
|
libarchive-dev \
|
||||||
|
xz-dev \
|
||||||
|
&& \
|
||||||
\
|
\
|
||||||
package update && \
|
apk add --no-cache -t .db-backup-run-deps \
|
||||||
package upgrade && \
|
bzip2 \
|
||||||
package install .db-backup-build-deps \
|
influxdb \
|
||||||
build-base \
|
libarchive \
|
||||||
bzip2-dev \
|
mariadb-client \
|
||||||
cargo \
|
mongodb-tools \
|
||||||
git \
|
libressl \
|
||||||
go \
|
pigz \
|
||||||
libarchive-dev \
|
postgresql \
|
||||||
openssl-dev \
|
postgresql-client \
|
||||||
libffi-dev \
|
redis \
|
||||||
python3-dev \
|
sqlite \
|
||||||
py3-pip \
|
xz \
|
||||||
xz-dev \
|
zstd \
|
||||||
&& \
|
&& \
|
||||||
\
|
\
|
||||||
package install .db-backup-run-deps \
|
cd /usr/src && \
|
||||||
bzip2 \
|
|
||||||
coreutils \
|
|
||||||
gpg \
|
|
||||||
gpg-agent \
|
|
||||||
groff \
|
|
||||||
libarchive \
|
|
||||||
mariadb-client \
|
|
||||||
mariadb-connector-c \
|
|
||||||
mongodb-tools \
|
|
||||||
openssl \
|
|
||||||
pigz \
|
|
||||||
postgresql16 \
|
|
||||||
postgresql16-client \
|
|
||||||
pv \
|
|
||||||
py3-botocore \
|
|
||||||
py3-colorama \
|
|
||||||
py3-cryptography \
|
|
||||||
py3-docutils \
|
|
||||||
py3-jmespath \
|
|
||||||
py3-rsa \
|
|
||||||
py3-setuptools \
|
|
||||||
py3-s3transfer \
|
|
||||||
py3-yaml \
|
|
||||||
python3 \
|
|
||||||
redis \
|
|
||||||
sqlite \
|
|
||||||
xz \
|
|
||||||
zip \
|
|
||||||
zstd \
|
|
||||||
&& \
|
|
||||||
\
|
\
|
||||||
apkArch="$(uname -m)"; \
|
apkArch="$(apk --print-arch)"; \
|
||||||
case "$apkArch" in \
|
case "$apkArch" in \
|
||||||
x86_64) mssql=true ; mssql_arch=amd64; influx2=true ; influx_arch=amd64; ;; \
|
x86_64) mssql=true ; curl -O https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MSSQL_VERSION}_amd64.apk ; curl -O https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/mssql-tools_${MSSQL_VERSION}_amd64.apk ; echo y | apk add --allow-untrusted msodbcsql17_${MSSQL_VERSION}_amd64.apk mssql-tools_${MSSQL_VERSION}_amd64.apk ;; \
|
||||||
arm64 ) mssql=true ; mssql_arch=amd64; influx2=true ; influx_arch=arm64 ;; \
|
*) echo >&2 "Detected non x86_64 build variant, skipping MSSQL installation" ;; \
|
||||||
*) sleep 0.1 ;; \
|
|
||||||
esac; \
|
esac; \
|
||||||
\
|
|
||||||
if [ $mssql = "true" ] ; then curl -O https://download.microsoft.com/download/3/5/5/355d7943-a338-41a7-858d-53b259ea33f5/msodbcsql18_${MSODBC_VERSION}_${mssql_arch}.apk ; curl -O https://download.microsoft.com/download/3/5/5/355d7943-a338-41a7-858d-53b259ea33f5/mssql-tools18_${MSSQL_VERSION}_${mssql_arch}.apk ; ls -l ; echo y | apk add --allow-untrusted msodbcsql18_${MSODBC_VERSION}_${mssql_arch}.apk mssql-tools18_${MSSQL_VERSION}_${mssql_arch}.apk ; else echo >&2 "Detected non x86_64 or ARM64 build variant, skipping MSSQL installation" ; fi; \
|
|
||||||
if [ $influx2 = "true" ] ; then curl -sSL https://dl.influxdata.com/influxdb/releases/influxdb2-client-${INFLUX2_CLIENT_VERSION}-linux-${influx_arch}.tar.gz | tar xvfz - --strip=1 -C /usr/src/ ; chmod +x /usr/src/influx ; mv /usr/src/influx /usr/sbin/ ; else echo >&2 "Unable to build Influx 2 on this system" ; fi ; \
|
|
||||||
clone_git_repo https://github.com/aws/aws-cli "${AWS_CLI_VERSION}" && \
|
|
||||||
python3 setup.py install --prefix=/usr && \
|
|
||||||
clone_git_repo https://github.com/influxdata/influxdb "${INFLUX1_CLIENT_VERSION}" && \
|
|
||||||
go build -o /usr/sbin/influxd ./cmd/influxd && \
|
|
||||||
strip /usr/sbin/influxd && \
|
|
||||||
mkdir -p /usr/src/pbzip2 && \
|
mkdir -p /usr/src/pbzip2 && \
|
||||||
curl -sSL https://launchpad.net/pbzip2/1.1/1.1.13/+download/pbzip2-1.1.13.tar.gz | tar xvfz - --strip=1 -C /usr/src/pbzip2 && \
|
curl -sSL https://launchpad.net/pbzip2/1.1/1.1.13/+download/pbzip2-1.1.13.tar.gz | tar xvfz - --strip=1 -C /usr/src/pbzip2 && \
|
||||||
cd /usr/src/pbzip2 && \
|
cd /usr/src/pbzip2 && \
|
||||||
@@ -96,19 +55,19 @@ RUN source /assets/functions/00-container && \
|
|||||||
--sysconfdir=/etc \
|
--sysconfdir=/etc \
|
||||||
--localstatedir=/var \
|
--localstatedir=/var \
|
||||||
&& \
|
&& \
|
||||||
make && \
|
make && \
|
||||||
make install && \
|
make install && \
|
||||||
\
|
\
|
||||||
pip3 install --break-system-packages blobxfer && \
|
### Cleanup
|
||||||
\
|
apk del .db-backup-build-deps && \
|
||||||
package remove .db-backup-build-deps && \
|
rm -rf /usr/src/* && \
|
||||||
package cleanup && \
|
rm -rf /tmp/* /var/cache/apk/*
|
||||||
rm -rf \
|
|
||||||
/*.apk \
|
|
||||||
/etc/logrotate.d/* \
|
|
||||||
/root/.cache \
|
|
||||||
/root/go \
|
|
||||||
/tmp/* \
|
|
||||||
/usr/src/*
|
|
||||||
|
|
||||||
COPY install /
|
RUN apk add --no-cache \
|
||||||
|
python3 \
|
||||||
|
py3-pip \
|
||||||
|
&& pip3 install --upgrade pip \
|
||||||
|
&& pip3 install awscli
|
||||||
|
|
||||||
|
### S6 Setup
|
||||||
|
ADD install /
|
||||||
|
|||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2023 Dave Conroy
|
Copyright (c) 2020 Dave Conroy
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
819
README.md
819
README.md
@@ -1,36 +1,29 @@
|
|||||||
# github.com/tiredofit/docker-db-backup
|
# github.com/tiredofit/docker-db-backup
|
||||||
|
|
||||||
[](https://github.com/tiredofit/docker-db-backup/releases/latest)
|
[](https://github.com/tiredofit/docker-db-backup/releases/latest)
|
||||||
[](https://github.com/tiredofit/docker-db-backup/actions)
|
[](https://github.com/tiredofit/docker-db-backup/actions?query=workflow%3Abuild)
|
||||||
[](https://hub.docker.com/r/tiredofit/db-backup/)
|
[](https://hub.docker.com/r/tiredofit/db-backup/)
|
||||||
[](https://hub.docker.com/r/tiredofit/db-backup/)
|
[](https://hub.docker.com/r/tiredofit/db-backup/)
|
||||||
[](https://www.tiredofit.ca/sponsor)
|
[](https://github.com/sponsors/tiredofit)
|
||||||
[](https://www.paypal.me/tiredofit)
|
[](https://www.paypal.me/tiredofit)
|
||||||
|
|
||||||
---
|
* * *
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
This will build a container for backing up multiple types of DB Servers
|
This will build a container for backing up multiple types of DB Servers
|
||||||
|
|
||||||
Backs up CouchDB, InfluxDB, MySQL/MariaDB, Microsoft SQL, MongoDB, Postgres, Redis servers.
|
Currently backs up CouchDB, InfluxDB, MySQL, MongoDB, Postgres, Redis servers.
|
||||||
|
|
||||||
- dump to local filesystem or backup to S3 Compatible services, and Azure.
|
* dump to local filesystem or backup to S3 Compatible services
|
||||||
- multiple backup job support
|
* select database user and password
|
||||||
- selectable when to start the first dump, whether time of day or relative to container start time
|
* backup all databases
|
||||||
- selectable interval
|
* choose to have an MD5 sum after backup for verification
|
||||||
- selectable omit scheduling during periods of time
|
* delete old backups after specific amount of time
|
||||||
- selectable database user and password
|
* choose compression type (none, gz, bz, xz, zstd)
|
||||||
- selectable cleanup and archive capabilities
|
* connect to any container running on the same system
|
||||||
- selectable database name support - all databases, single, or multiple databases
|
* select how often to run a dump
|
||||||
- backup all to separate files or one singular file
|
* select when to start the first dump, whether time of day or relative to container start time
|
||||||
- checksum support choose to have an MD5 or SHA1 hash generated after backup for verification
|
* Execute script after backup for monitoring/alerting purposes
|
||||||
- compression support (none, gz, bz, xz, zstd)
|
|
||||||
- encryption support (passphrase and public key)
|
|
||||||
- notify upon job failure to email, matrix, mattermost, rocketchat, custom script
|
|
||||||
- zabbix metrics support
|
|
||||||
- hooks to execute pre and post backup job for customization purposes
|
|
||||||
- companion script to aid in restores
|
|
||||||
|
|
||||||
## Maintainer
|
## Maintainer
|
||||||
|
|
||||||
@@ -45,64 +38,16 @@ Backs up CouchDB, InfluxDB, MySQL/MariaDB, Microsoft SQL, MongoDB, Postgres, Red
|
|||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Build from Source](#build-from-source)
|
- [Build from Source](#build-from-source)
|
||||||
- [Prebuilt Images](#prebuilt-images)
|
- [Prebuilt Images](#prebuilt-images)
|
||||||
- [Multi Architecture](#multi-architecture)
|
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Quick Start](#quick-start)
|
- [Quick Start](#quick-start)
|
||||||
- [Persistent Storage](#persistent-storage)
|
- [Persistent Storage](#persistent-storage)
|
||||||
- [Environment Variables](#environment-variables)
|
- [Environment Variables](#environment-variables)
|
||||||
- [Base Images used](#base-images-used)
|
- [Base Images used](#base-images-used)
|
||||||
- [Container Options](#container-options)
|
- [Backing Up to S3 Compatible Services](#backing-up-to-s3-compatible-services)
|
||||||
- [Job Defaults](#job-defaults)
|
|
||||||
- [Compression Options](#compression-options)
|
|
||||||
- [Encryption Options](#encryption-options)
|
|
||||||
- [Scheduling Options](#scheduling-options)
|
|
||||||
- [Default Database Options](#default-database-options)
|
|
||||||
- [CouchDB](#couchdb)
|
|
||||||
- [InfluxDB](#influxdb)
|
|
||||||
- [MariaDB/MySQL](#mariadbmysql)
|
|
||||||
- [Microsoft SQL](#microsoft-sql)
|
|
||||||
- [MongoDB](#mongodb)
|
|
||||||
- [Postgresql](#postgresql)
|
|
||||||
- [Redis](#redis)
|
|
||||||
- [Default Storage Options](#default-storage-options)
|
|
||||||
- [Filesystem](#filesystem)
|
|
||||||
- [S3](#s3)
|
|
||||||
- [Azure](#azure)
|
|
||||||
- [Hooks](#hooks)
|
|
||||||
- [Path Options](#path-options)
|
|
||||||
- [Pre Backup](#pre-backup)
|
|
||||||
- [Post backup](#post-backup)
|
|
||||||
- [Job Backup Options](#job-backup-options)
|
|
||||||
- [Compression Options](#compression-options-1)
|
|
||||||
- [Encryption Options](#encryption-options-1)
|
|
||||||
- [Scheduling Options](#scheduling-options-1)
|
|
||||||
- [Specific Database Options](#specific-database-options)
|
|
||||||
- [CouchDB](#couchdb-1)
|
|
||||||
- [InfluxDB](#influxdb-1)
|
|
||||||
- [MariaDB/MySQL](#mariadbmysql-1)
|
|
||||||
- [Microsoft SQL](#microsoft-sql-1)
|
|
||||||
- [MongoDB](#mongodb-1)
|
|
||||||
- [Postgresql](#postgresql-1)
|
|
||||||
- [Redis](#redis-1)
|
|
||||||
- [SQLite](#sqlite)
|
|
||||||
- [Specific Storage Options](#specific-storage-options)
|
|
||||||
- [Filesystem](#filesystem-1)
|
|
||||||
- [S3](#s3-1)
|
|
||||||
- [Azure](#azure-1)
|
|
||||||
- [Hooks](#hooks-1)
|
|
||||||
- [Path Options](#path-options-1)
|
|
||||||
- [Pre Backup](#pre-backup-1)
|
|
||||||
- [Post backup](#post-backup-1)
|
|
||||||
- [Notifications](#notifications)
|
|
||||||
- [Custom Notifications](#custom-notifications)
|
|
||||||
- [Email Notifications](#email-notifications)
|
|
||||||
- [Matrix Notifications](#matrix-notifications)
|
|
||||||
- [Mattermost Notifications](#mattermost-notifications)
|
|
||||||
- [Rocketchat Notifications](#rocketchat-notifications)
|
|
||||||
- [Maintenance](#maintenance)
|
- [Maintenance](#maintenance)
|
||||||
- [Shell Access](#shell-access)
|
- [Shell Access](#shell-access)
|
||||||
- [Manual Backups](#manual-backups)
|
- [Manual Backups](#manual-backups)
|
||||||
- [Restoring Databases](#restoring-databases)
|
- [Custom Scripts](#custom-scripts)
|
||||||
- [Support](#support)
|
- [Support](#support)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Bugfixes](#bugfixes)
|
- [Bugfixes](#bugfixes)
|
||||||
@@ -112,62 +57,50 @@ Backs up CouchDB, InfluxDB, MySQL/MariaDB, Microsoft SQL, MongoDB, Postgres, Red
|
|||||||
|
|
||||||
## Prerequisites and Assumptions
|
## Prerequisites and Assumptions
|
||||||
|
|
||||||
- You must have a working connection to one of the supported DB Servers and appropriate credentials
|
You must have a working DB server or container available for this to work properly, it does not provide server functionality!
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Build from Source
|
### Build from Source
|
||||||
|
Clone this repository and build the image with `docker build -t (imagename) .`
|
||||||
Clone this repository and build the image with `docker build <arguments> (imagename) .`
|
|
||||||
|
|
||||||
### Prebuilt Images
|
### Prebuilt Images
|
||||||
|
Builds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/db-backup) and is the recommended method of installation.
|
||||||
Builds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/db-backup)
|
|
||||||
|
|
||||||
Builds of the image are also available on the [Github Container Registry](https://github.com/tiredofit/docker-db-backup/pkgs/container/docker-db-backup)
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull ghcr.io/tiredofit/docker-db-backup:(imagetag)
|
docker pull tiredofit/db-backup:(imagetag)
|
||||||
```
|
```
|
||||||
|
|
||||||
The following image tags are available along with their tagged release based on what's written in the [Changelog](CHANGELOG.md):
|
The following image tags are available along with their tagged release based on what's written in the [Changelog](CHANGELOG.md):
|
||||||
|
|
||||||
| Alpine Base | Tag |
|
| Container OS | Tag |
|
||||||
| ----------- | --------- |
|
| ------------ | --------- |
|
||||||
| latest | `:latest` |
|
| Alpine | `:latest` |
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull docker.io/tiredofit/db-backup:(imagetag)
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Multi Architecture
|
|
||||||
|
|
||||||
Images are built primarily for `amd64` architecture, and may also include builds for `arm/v7`, `arm64` and others. These variants are all unsupported. Consider [sponsoring](https://www.tiredofit.ca/sponsor) my work so that I can work with various hardware. To see if this image supports multiple architectures, type `docker manifest (image):(tag)`
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### Quick Start
|
### Quick Start
|
||||||
|
|
||||||
- The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a series of example compose.yml that can be modified for development or production use.
|
* The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [docker-compose.yml](examples/docker-compose.yml) that can be modified for development or production use.
|
||||||
|
|
||||||
- Set various [environment variables](#environment-variables) to understand the capabilities of this image.
|
* Set various [environment variables](#environment-variables) to understand the capabiltiies of this image.
|
||||||
- Map [persistent storage](#data-volumes) for access to configuration and data files for backup.
|
* Map [persistent storage](#data-volumes) for access to configuration and data files for backup.
|
||||||
|
|
||||||
|
> **NOTE**: If you are using this with a docker-compose file along with a seperate SQL container, take care not to set the variables to backup immediately, more so have it delay execution for a minute, otherwise you will get a failed first backup.
|
||||||
### Persistent Storage
|
### Persistent Storage
|
||||||
|
|
||||||
The following directories are used for configuration and can be mapped for persistent storage.
|
The following directories are used for configuration and can be mapped for persistent storage.
|
||||||
| Directory | Description |
|
|
||||||
| ---------------------- | ----------------------------------------------------------------------------------- |
|
|
||||||
| `/backup` | Backups |
|
|
||||||
| `/assets/scripts/pre` | _Optional_ Put custom scripts in this directory to execute before backup operations |
|
|
||||||
| `/assets/scripts/post` | _Optional_ Put custom scripts in this directory to execute after backup operations |
|
|
||||||
| `/logs` | _Optional_ Logfiles for backup jobs |
|
|
||||||
|
|
||||||
|
| Directory | Description |
|
||||||
|
| ------------------------ | ---------------------------------------------------------------------------------- |
|
||||||
|
| `/backup` | Backups |
|
||||||
|
| `/assets/custom-scripts` | *Optional* Put custom scripts in this directory to execute after backup operations |
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
||||||
#### Base Images used
|
#### Base Images used
|
||||||
|
|
||||||
This image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handled via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`, `nano`.
|
This image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`, `nano`,`vim`.
|
||||||
|
|
||||||
Be sure to view the following repositories to understand all the customizable options:
|
Be sure to view the following repositories to understand all the customizable options:
|
||||||
|
|
||||||
@@ -175,514 +108,67 @@ Be sure to view the following repositories to understand all the customizable op
|
|||||||
| ------------------------------------------------------ | -------------------------------------- |
|
| ------------------------------------------------------ | -------------------------------------- |
|
||||||
| [OS Base](https://github.com/tiredofit/docker-alpine/) | Customized Image based on Alpine Linux |
|
| [OS Base](https://github.com/tiredofit/docker-alpine/) | Customized Image based on Alpine Linux |
|
||||||
|
|
||||||
#### Container Options
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
| Parameter | Description |
|
||||||
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | --------------- |
|
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `MODE` | `AUTO` mode to use internal scheduling routines or `MANUAL` to simply use this as manual backups only executed by your own means | `AUTO` |
|
| `BACKUP_LOCATION` | Backup to `FILESYSTEM` or `S3` compatible services like S3, Minio, Wasabi - Default `FILESYSTEM` |
|
||||||
| `USER_DBBACKUP` | The uid that the image should read and write files as (username is `dbbackup`) | `10000` |
|
| `COMPRESSION` | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, ZSTD `ZSTD` or none `NONE` - Default `GZ` |
|
||||||
| `GROUP_DBBACKUP` | The gid that the image should read and write files as (groupname is `dbbackup`) | `10000` |
|
| `COMPRESSION_LEVEL` | Numberical value of what level of compression to use, most allow `1` to `9` except for `ZSTD` which allows for `1` to `19` - Default `3` |
|
||||||
| `LOG_PATH` | Path to log files | `/logs` |
|
| `DB_AUTH` | (Mongo Only - Optional) Authentication Database |
|
||||||
| `TEMP_PATH` | Perform Backups and Compression in this temporary directory | `/tmp/backups/` |
|
| `DB_TYPE` | Type of DB Server to backup `couch` `influx` `mysql` `pgsql` `mongo` `redis` `sqlite3` |
|
||||||
| `MANUAL_RUN_FOREVER` | `TRUE` or `FALSE` if you wish to try to make the container exit after the backup | `TRUE` |
|
| `DB_HOST` | Server Hostname e.g. `mariadb`. For `sqlite3`, full path to DB file e.g. `/backup/db.sqlite3` |
|
||||||
| `DEBUG_MODE` | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed. | `FALSE` |
|
| `DB_NAME` | Schema Name e.g. `database` |
|
||||||
| `BACKUP_JOB_CONCURRENCY` | How many backup jobs to run concurrently | `1` |
|
| `DB_USER` | username for the database - use `root` to backup all MySQL of them. |
|
||||||
|
| `DB_PASS` | (optional if DB doesn't require it) password for the database |
|
||||||
|
| `DB_PORT` | (optional) Set port to connect to DB_HOST. Defaults are provided |
|
||||||
|
| `DB_DUMP_FREQ` | How often to do a dump, in minutes. Defaults to 1440 minutes, or once per day. |
|
||||||
|
| `DB_DUMP_BEGIN` | What time to do the first dump. Defaults to immediate. Must be in one of two formats |
|
||||||
|
| | Absolute HHMM, e.g. `2330` or `0415` |
|
||||||
|
| | Relative +MM, i.e. how many minutes after starting the container, e.g. `+0` (immediate), `+10` (in 10 minutes), or `+90` in an hour and a half |
|
||||||
|
| `DB_CLEANUP_TIME` | Value in minutes to delete old backups (only fired when dump freqency fires). 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. |
|
||||||
|
| `DEBUG_MODE` | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed. |
|
||||||
|
| `EXTRA_OPTS` | If you need to pass extra arguments to the backup command, add them here e.g. "--extra-command" |
|
||||||
|
| `MD5` | Generate MD5 Sum in Directory, `TRUE` or `FALSE` - Default `TRUE` |
|
||||||
|
| `PARALLEL_COMPRESSION` | Use multiple cores when compressing backups `TRUE` or `FALSE` - Default `TRUE` |
|
||||||
|
| `POST_SCRIPT` | Fill this variable in with a command to execute post the script backing up | |
|
||||||
|
| `SPLIT_DB` | If using root as username and multiple DBs on system, set to TRUE to create Seperate DB Backups instead of all in one. - Default `FALSE` |
|
||||||
|
|
||||||
#### Job Defaults
|
When using compression with MongoDB, only `GZ` compression is possible.
|
||||||
If these are set and no other defaults or variables are set explicitly, they will be added to any of the backup jobs.
|
|
||||||
|
|
||||||
| Variable | Description | Default |
|
#### Backing Up to S3 Compatible Services
|
||||||
| --------------------------------- | ------------------------------------------------------------------------------------- | ------------ |
|
|
||||||
| `DEFAULT_BACKUP_LOCATION` | Backup to `FILESYSTEM`, `blobxfer` or `S3` compatible services like S3, Minio, Wasabi | `FILESYSTEM` |
|
|
||||||
| `DEFAULT_CHECKSUM` | Either `MD5` or `SHA1` or `NONE` | `MD5` |
|
|
||||||
| `DEFAULT_LOG_LEVEL` | Log output on screen and in files `INFO` `NOTICE` `ERROR` `WARN` `DEBUG` | `notice` |
|
|
||||||
| `DEFAULT_RESOURCE_OPTIMIZED` | Perform operations at a lower priority to the CPU and IO scheduler | `FALSE` |
|
|
||||||
| `DEFAULT_SKIP_AVAILABILITY_CHECK` | Before backing up - skip connectivity check | `FALSE` |
|
|
||||||
|
|
||||||
##### Compression Options
|
If `BACKUP_LOCATION` = `S3` then the following options are used.
|
||||||
|
|
||||||
| Variable | Description | Default |
|
| Parameter | Description |
|
||||||
| -------------------------------------- | ---------------------------------------------------------------------------------------------- | -------------- |
|
| --------------- | --------------------------------------------------------------------------------------- |
|
||||||
| `DEFAULT_COMPRESSION` | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, ZSTD `ZSTD` or none `NONE` | `ZSTD` |
|
| `S3_BUCKET` | S3 Bucket name e.g. 'mybucket' |
|
||||||
| `DEFAULT_COMPRESSION_LEVEL` | Numerical value of what level of compression to use, most allow `1` to `9` | `3` |
|
| `S3_HOST` | Hostname of S3 Server e.g "s3.amazonaws.com" - You can also include a port if necessary |
|
||||||
| | except for `ZSTD` which allows for `1` to `19` | |
|
| `S3_KEY_ID` | S3 Key ID |
|
||||||
| `DEFAULT_GZ_RSYNCABLE` | Use `--rsyncable` (gzip only) for faster rsync transfers and incremental backup deduplication. | `FALSE` |
|
| `S3_KEY_SECRET` | S3 Key Secret |
|
||||||
| `DEFAULT_ENABLE_PARALLEL_COMPRESSION` | Use multiple cores when compressing backups `TRUE` or `FALSE` | `TRUE` |
|
| `S3_PATH` | S3 Pathname to save to e.g. '`backup`' |
|
||||||
| `DEFAULT_PARALLEL_COMPRESSION_THREADS` | Maximum amount of threads to use when compressing - Integer value e.g. `8` | `autodetected` |
|
| `S3_PROTOCOL` | Use either `http` or `https` to access service - Default `https` |
|
||||||
|
| `S3_URI_STYLE` | Choose either `VIRTUALHOST` or `PATH` style - Default `VIRTUALHOST` |
|
||||||
|
|
||||||
##### Encryption Options
|
|
||||||
|
|
||||||
Encryption occurs after compression and the encrypted filename will have a `.gpg` suffix
|
## Maintenance
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ----------------------------- | -------------------------------------------- | ------- | ------- |
|
|
||||||
| `DEFAULT_ENCRYPT` | Encrypt file after backing up with GPG | `FALSE` | |
|
|
||||||
| `DEFAULT_ENCRYPT_PASSPHRASE` | Passphrase to encrypt file with GPG | | x |
|
|
||||||
| *or* | | | |
|
|
||||||
| `DEFAULT_ENCRYPT_PUBLIC_KEY` | Path of public key to encrypt file with GPG | | x |
|
|
||||||
| `DEFAULT_ENCRYPT_PRIVATE_KEY` | Path of private key to encrypt file with GPG | | x |
|
|
||||||
|
|
||||||
##### Scheduling Options
|
### Shell Access
|
||||||
|
|
||||||
| Variable | Description | Default |
|
For debugging and maintenance purposes you may want access the containers shell.
|
||||||
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| `DEFAULT_BACKUP_INTERVAL` | How often to do a backup, in minutes after the first backup. Defaults to 1440 minutes, or once per day. | `1440` |
|
|
||||||
| `DEFAULT_BACKUP_BEGIN` | What time to do the initial backup. Defaults to immediate. (`+1`) | `+0` |
|
|
||||||
| | Must be in one of four formats: | |
|
|
||||||
| | Absolute HHMM, e.g. `2330` or `0415` | |
|
|
||||||
| | Relative +MM, i.e. how many minutes after starting the container, e.g. `+0` (immediate), `+10` (in 10 minutes), or `+90` in an hour and a half | |
|
|
||||||
| | Full datestamp e.g. `2023-12-21 23:30:00` | |
|
|
||||||
| | Cron expression e.g. `30 23 * * *` [Understand the format](https://en.wikipedia.org/wiki/Cron) - *BACKUP_INTERVAL is ignored* | |
|
|
||||||
| `DEFAULT_CLEANUP_TIME` | Value in minutes to delete old backups (only fired when backup interval executes) | `FALSE` |
|
|
||||||
| | 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. | |
|
|
||||||
| `DEFAULT_ARCHIVE_TIME` | Value in minutes to move all files files older than (x) from | |
|
|
||||||
| `DEFAULT_BACKUP_BLACKOUT_BEGIN` | Use `HHMM` notation to start a blackout period where no backups occur eg `0420` | |
|
|
||||||
| `DEFAULT_BACKUP_BLACKOUT_END` | Use `HHMM` notation to set the end period where no backups occur eg `0430` | |
|
|
||||||
|
|
||||||
> You may need to wrap your `DEFAULT_BACKUP_BEGIN` value in quotes for it to properly parse. There have been reports of backups that start with a `0` get converted into a different format which will not allow the timer to start at the correct time.
|
``bash
|
||||||
|
docker exec -it (whatever your container name is) bash
|
||||||
|
``
|
||||||
|
### Manual Backups
|
||||||
|
Manual Backups can be performed by entering the container and typing `backup-now`
|
||||||
|
|
||||||
|
|
||||||
##### Default Database Options
|
### Custom Scripts
|
||||||
|
|
||||||
###### CouchDB
|
If you want to execute a custom script at the end of backup, you can drop bash scripts with the extension of `.sh` in this directory. See the following example to utilize:
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
````bash
|
||||||
| -------------- | ------------ | ------- | ------- |
|
|
||||||
| `DEFAULT_PORT` | CouchDB Port | `5984` | x |
|
|
||||||
|
|
||||||
###### InfluxDB
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ------------------------ | ------------------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DEFAULT_PORT` | InfluxDB Port | | x |
|
|
||||||
| | Version 1.x | `8088` | |
|
|
||||||
| | Version 2.x | `8086` | |
|
|
||||||
| `DEFAULT_INFLUX_VERSION` | What Version of Influx are you backing up from `1`.x or `2` series - amd64 and aarch/armv8 only for `2` | `2` | |
|
|
||||||
|
|
||||||
###### MariaDB/MySQL
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ---------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------- | ------- |
|
|
||||||
| `DEFAULT_PORT` | MySQL / MariaDB Port | `3306` | x |
|
|
||||||
| `DEFAULT_EXTRA_BACKUP_OPTS` | Pass extra arguments to the backup command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DEFAULT_EXTRA_ENUMERATION_OPTS` | Pass extra arguments to the database enumeration command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DEFAULT_EXTRA_OPTS` | Pass extra arguments to the backup and database enumeration command, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DEFAULT_MYSQL_EVENTS` | Backup Events | `TRUE` | |
|
|
||||||
| `DEFAULT_MYSQL_MAX_ALLOWED_PACKET` | Max allowed packet | `512M` | |
|
|
||||||
| `DEFAULT_MYSQL_SINGLE_TRANSACTION` | Backup in a single transaction | `TRUE` | |
|
|
||||||
| `DEFAULT_MYSQL_STORED_PROCEDURES` | Backup stored procedures | `TRUE` | |
|
|
||||||
| `DEFAULT_MYSQL_ENABLE_TLS` | Enable TLS functionality | `FALSE` | |
|
|
||||||
| `DEFAULT_MYSQL_TLS_VERIFY` | (optional) If using TLS (by means of MYSQL_TLS_* variables) verify remote host | `FALSE` | |
|
|
||||||
| `DEFAULT_MYSQL_TLS_VERSION` | What TLS `v1.1` `v1.2` `v1.3` version to utilize | `TLSv1.1,TLSv1.2,TLSv1.3` | |
|
|
||||||
| `DEFAULT_MYSQL_TLS_CA_FILE` | Filename to load custom CA certificate for connecting via TLS | `/etc/ssl/cert.pem` | x |
|
|
||||||
| `DEFAULT_MYSQL_TLS_CERT_FILE` | Filename to load client certificate for connecting via TLS | | x |
|
|
||||||
| `DEFAULT_MYSQL_TLS_KEY_FILE` | Filename to load client key for connecting via TLS | | x |
|
|
||||||
|
|
||||||
|
|
||||||
###### Microsoft SQL
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| -------------------- | --------------------------------------- | ---------- | ------- |
|
|
||||||
| `DEFAULT_PORT` | Microsoft SQL Port | `1433` | x |
|
|
||||||
| `DEFAULT_MSSQL_MODE` | Backup `DATABASE` or `TRANSACTION` logs | `DATABASE` |
|
|
||||||
|
|
||||||
###### MongoDB
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------- |
|
|
||||||
| `DEFAULT_AUTH` | (Optional) Authentication Database | | x |
|
|
||||||
| `DEFAULT_PORT` | MongoDB Port | `27017` | x |
|
|
||||||
| `MONGO_CUSTOM_URI` | If you wish to override the MongoDB Connection string enter it here e.g. `mongodb+srv://username:password@cluster.id.mongodb.net` | | x |
|
|
||||||
| | This environment variable will be parsed and populate the `DB_NAME` and `DB_HOST` variables to properly build your backup filenames. | | |
|
|
||||||
| | You can override them by making your own entries | | |
|
|
||||||
|
|
||||||
###### Postgresql
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| -------------------------------- | --------------------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DEFAULT_AUTH` | (Optional) Authentication Database | | x |
|
|
||||||
| `DEFAULT_BACKUP_GLOBALS` | Backup Globals as part of backup procedure | | |
|
|
||||||
| `DEFAULT_EXTRA_BACKUP_OPTS` | Pass extra arguments to the backup command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DEFAULT_EXTRA_ENUMERATION_OPTS` | Pass extra arguments to the database enumeration command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DEFAULT_EXTRA_OPTS` | Pass extra arguments to the backup and database enumeration command, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DEFAULT_PORT` | PostgreSQL Port | `5432` | x |
|
|
||||||
|
|
||||||
###### Redis
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| -------------------------------- | --------------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DEFAULT_PORT` | Default Redis Port | `6379` | x |
|
|
||||||
| `DEFAULT_EXTRA_ENUMERATION_OPTS` | Pass extra arguments to the database enumeration command only, add them here e.g. `--extra-command` | | |
|
|
||||||
|
|
||||||
|
|
||||||
##### Default Storage Options
|
|
||||||
|
|
||||||
Options that are related to the value of `DEFAULT_BACKUP_LOCATION`
|
|
||||||
|
|
||||||
###### Filesystem
|
|
||||||
|
|
||||||
If `DEFAULT_BACKUP_LOCTION` = `FILESYSTEM` then the following options are used:
|
|
||||||
|
|
||||||
| Variable | Description | Default |
|
|
||||||
| ------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------------------------------- |
|
|
||||||
| `DEFAULT_CREATE_LATEST_SYMLINK` | Create a symbolic link pointing to last backup in this format: `latest-(DB_TYPE)-(DB_NAME)-(DB_HOST)` | `TRUE` |
|
|
||||||
| `DEFAULT_FILESYSTEM_PATH` | Directory where the database dumps are kept. | `/backup` |
|
|
||||||
| `DEFAULT_FILESYSTEM_PATH_PERMISSION` | Permissions to apply to backup directory | `700` |
|
|
||||||
| `DEFAULT_FILESYSTEM_ARCHIVE_PATH` | Optional Directory where the database dumps archives are kept | `${DEFAULT_FILESYSTEM_PATH}/archive/` |
|
|
||||||
| `DEFAULT_FILESYSTEM_PERMISSION` | Permissions to apply to files. | `600` |
|
|
||||||
|
|
||||||
###### S3
|
|
||||||
|
|
||||||
If `DEFAULT_BACKUP_LOCATION` = `S3` then the following options are used:
|
|
||||||
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| ----------------------------- | ----------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DEFAULT_S3_BUCKET` | S3 Bucket name e.g. `mybucket` | | x |
|
|
||||||
| `DEFAULT_S3_KEY_ID` | S3 Key ID (Optional) | | x |
|
|
||||||
| `DEFAULT_S3_KEY_SECRET` | S3 Key Secret (Optional) | | x |
|
|
||||||
| `DEFAULT_S3_PATH` | S3 Pathname to save to (must NOT end in a trailing slash e.g. '`backup`') | | x |
|
|
||||||
| `DEFAULT_S3_REGION` | Define region in which bucket is defined. Example: `ap-northeast-2` | | x |
|
|
||||||
| `DEFAULT_S3_HOST` | Hostname (and port) of S3-compatible service, e.g. `minio:8080`. Defaults to AWS. | | x |
|
|
||||||
| `DEFAULT_S3_PROTOCOL` | Protocol to connect to `DEFAULT_S3_HOST`. Either `http` or `https`. Defaults to `https`. | `https` | x |
|
|
||||||
| `DEFAULT_S3_EXTRA_OPTS` | Add any extra options to the end of the `aws-cli` process execution | | x |
|
|
||||||
| `DEFAULT_S3_CERT_CA_FILE` | Map a volume and point to your custom CA Bundle for verification e.g. `/certs/bundle.pem` | | x |
|
|
||||||
| _*OR*_ | | | |
|
|
||||||
| `DEFAULT_S3_CERT_SKIP_VERIFY` | Skip verifying self signed certificates when connecting | `TRUE` | |
|
|
||||||
|
|
||||||
- When `DEFAULT_S3_KEY_ID` and/or `DEFAULT_S3_KEY_SECRET` is not set, will try to use IAM role assigned (if any) for uploading the backup files to S3 bucket.
|
|
||||||
|
|
||||||
###### Azure
|
|
||||||
|
|
||||||
If `DEFAULT_BACKUP_LOCATION` = `blobxfer` then the following options are used:.
|
|
||||||
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| -------------------------------------- | ------------------------------------------- | ------------------- | ------- |
|
|
||||||
| `DEFAULT_BLOBXFER_STORAGE_ACCOUNT` | Microsoft Azure Cloud storage account name. | | x |
|
|
||||||
| `DEFAULT_BLOBXFER_STORAGE_ACCOUNT_KEY` | Microsoft Azure Cloud storage account key. | | x |
|
|
||||||
| `DEFAULT_BLOBXFER_REMOTE_PATH` | Remote Azure path | `/docker-db-backup` | x |
|
|
||||||
|
|
||||||
> This service uploads files from backup targed directory `DEFAULT_FILESYSTEM_PATH`.
|
|
||||||
> If the a cleanup configuration in `DEFAULT_CLEANUP_TIME` is defined, the remote directory on Azure storage will also be cleaned automatically.
|
|
||||||
|
|
||||||
##### Hooks
|
|
||||||
|
|
||||||
###### Path Options
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
|
||||||
| ------------------------------ | --------------------------------------------------------------------------- | ----------------------- |
|
|
||||||
| `DEFAULT_SCRIPT_LOCATION_PRE` | Location on filesystem inside container to execute bash scripts pre backup | `/assets/scripts/pre/` |
|
|
||||||
| `DEFAULT_SCRIPT_LOCATION_POST` | Location on filesystem inside container to execute bash scripts post backup | `/assets/scripts/post/` |
|
|
||||||
| `DEFAULT_PRE_SCRIPT` | Fill this variable in with a command to execute pre backing up | |
|
|
||||||
| `DEFAULT_POST_SCRIPT` | Fill this variable in with a command to execute post backing up | |
|
|
||||||
|
|
||||||
###### Pre Backup
|
|
||||||
|
|
||||||
If you want to execute a custom script before a backup starts, you can drop bash scripts with the extension of `.sh` in the location defined in `DB01_SCRIPT_LOCATION_PRE`. See the following example to utilize:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ cat pre-script.sh
|
|
||||||
##!/bin/bash
|
|
||||||
|
|
||||||
# #### Example Pre Script
|
|
||||||
# #### $1=DBXX_TYPE (Type of Backup)
|
|
||||||
# #### $2=DBXX_HOST (Backup Host)
|
|
||||||
# #### $3=DBXX_NAME (Name of Database backed up
|
|
||||||
# #### $4=BACKUP START TIME (Seconds since Epoch)
|
|
||||||
# #### $5=BACKUP FILENAME (Filename)
|
|
||||||
|
|
||||||
echo "${1} Backup Starting on ${2} for ${3} at ${4}. Filename: ${5}"
|
|
||||||
```
|
|
||||||
|
|
||||||
## script DBXX_TYPE DBXX_HOST DBXX_NAME STARTEPOCH BACKUP_FILENAME
|
|
||||||
${f} "${backup_job_db_type}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${backup_job_file}"
|
|
||||||
|
|
||||||
Outputs the following on the console:
|
|
||||||
|
|
||||||
`mysql Backup Starting on example-db for example at 1647370800. Filename: mysql_example_example-db_202200315-000000.sql.bz2`
|
|
||||||
|
|
||||||
###### Post backup
|
|
||||||
|
|
||||||
If you want to execute a custom script at the end of a backup, you can drop bash scripts with the extension of `.sh` in the location defined in `DB01_SCRIPT_LOCATION_POST`. Also to support legacy users `/assets/custom-scripts` is also scanned and executed.See the following example to utilize:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ cat post-script.sh
|
|
||||||
##!/bin/bash
|
|
||||||
|
|
||||||
# #### Example Post Script
|
|
||||||
# #### $1=EXIT_CODE (After running backup routine)
|
|
||||||
# #### $2=DBXX_TYPE (Type of Backup)
|
|
||||||
# #### $3=DBXX_HOST (Backup Host)
|
|
||||||
# #### #4=DBXX_NAME (Name of Database backed up
|
|
||||||
# #### $5=BACKUP START TIME (Seconds since Epoch)
|
|
||||||
# #### $6=BACKUP FINISH TIME (Seconds since Epoch)
|
|
||||||
# #### $7=BACKUP TOTAL TIME (Seconds between Start and Finish)
|
|
||||||
# #### $8=BACKUP FILENAME (Filename)
|
|
||||||
# #### $9=BACKUP FILESIZE
|
|
||||||
# #### $10=HASH (If CHECKSUM enabled)
|
|
||||||
# #### $11=MOVE_EXIT_CODE
|
|
||||||
|
|
||||||
echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ending ${6} for a duration of ${7} seconds. Filename: ${8} Size: ${9} bytes MD5: ${10}"
|
|
||||||
```
|
|
||||||
|
|
||||||
## script EXIT_CODE DB_TYPE DB_HOST DB_NAME STARTEPOCH FINISHEPOCH DURATIONEPOCH BACKUP_FILENAME FILESIZE CHECKSUMVALUE
|
|
||||||
${f} "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${backup_routines_finish_time}" "${backup_routines_total_time}" "${backup_job_file}" "${filesize}" "${checksum_value}" "${move_exit_code}
|
|
||||||
|
|
||||||
Outputs the following on the console:
|
|
||||||
|
|
||||||
`0 mysql Backup Completed on example-db for example on 1647370800 ending 1647370920 for a duration of 120 seconds. Filename: mysql_example_example-db_202200315-000000.sql.bz2 Size: 7795 bytes Hash: 952fbaafa30437494fdf3989a662cd40 0`
|
|
||||||
|
|
||||||
If you wish to change the size value from bytes to megabytes set environment variable `DB01_SIZE_VALUE=megabytes`
|
|
||||||
|
|
||||||
You must make your scripts executable otherwise there is an internal check that will skip trying to run it otherwise.
|
|
||||||
If for some reason your filesystem or host is not detecting it right, use the environment variable `DB01_POST_SCRIPT_SKIP_X_VERIFY=TRUE` to bypass.
|
|
||||||
|
|
||||||
|
|
||||||
#### Job Backup Options
|
|
||||||
|
|
||||||
If `DEFAULT_` variables are set and you do not wish for the settings to carry over into your jobs, you can set the appropriate environment variable with the value of `unset`.
|
|
||||||
Otherwise, override them per backup job. Additional backup jobs can be scheduled by using `DB02_`,`DB03_`,`DB04_` ... prefixes. See [Specific Database Options](#specific-database-options) which may overrule this list.
|
|
||||||
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| ----------- | ---------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DB01_TYPE` | Type of DB Server to backup `couch` `influx` `mysql` `mssql` `pgsql` `mongo` `redis` `sqlite3` | | |
|
|
||||||
| `DB01_HOST` | Server Hostname e.g. `mariadb`. For `sqlite3`, full path to DB file e.g. `/backup/db.sqlite3` | | x |
|
|
||||||
| `DB01_NAME` | Schema Name e.g. `database` | | x |
|
|
||||||
| `DB01_USER` | username for the database(s) - Can use `root` for MySQL | | x |
|
|
||||||
| `DB01_PASS` | (optional if DB doesn't require it) password for the database | | x |
|
|
||||||
|
|
||||||
|
|
||||||
| Variable | Description | Default |
|
|
||||||
| ------------------------------ | --------------------------------------------------------------------------------------------------------- | ------------ |
|
|
||||||
| `DB01_BACKUP_LOCATION` | Backup to `FILESYSTEM`, `blobxfer` or `S3` compatible services like S3, Minio, Wasabi | `FILESYSTEM` |
|
|
||||||
| `DB01_CHECKSUM` | Either `MD5` or `SHA1` or `NONE` | `MD5` |
|
|
||||||
| `DB01_EXTRA_BACKUP_OPTS` | Pass extra arguments to the backup command only, add them here e.g. `--extra-command` | |
|
|
||||||
| `DB01_EXTRA_ENUMERATION_OPTS` | Pass extra arguments to the database enumeration command only, add them here e.g. `--extra-command` | |
|
|
||||||
| `DB01_EXTRA_OPTS` | Pass extra arguments to the backup and database enumeration command, add them here e.g. `--extra-command` | |
|
|
||||||
| `DB01_LOG_LEVEL` | Log output on screen and in files `INFO` `NOTICE` `ERROR` `WARN` `DEBUG` | `debug` |
|
|
||||||
| `DB01_RESOURCE_OPTIMIZED` | Perform operations at a lower priority to the CPU and IO scheduler | `FALSE` |
|
|
||||||
| `DB01_SKIP_AVAILABILITY_CHECK` | Before backing up - skip connectivity check | `FALSE` |
|
|
||||||
|
|
||||||
##### Compression Options
|
|
||||||
|
|
||||||
| Variable | Description | Default |
|
|
||||||
| ----------------------------------- | ---------------------------------------------------------------------------------------------- | -------------- |
|
|
||||||
| `DB01_COMPRESSION` | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, ZSTD `ZSTD` or none `NONE` | `ZSTD` |
|
|
||||||
| `DB01_COMPRESSION_LEVEL` | Numerical value of what level of compression to use, most allow `1` to `9` | `3` |
|
|
||||||
| | except for `ZSTD` which allows for `1` to `19` | |
|
|
||||||
| `DB01_GZ_RSYNCABLE` | Use `--rsyncable` (gzip only) for faster rsync transfers and incremental backup deduplication. | `FALSE` |
|
|
||||||
| `DB01_ENABLE_PARALLEL_COMPRESSION` | Use multiple cores when compressing backups `TRUE` or `FALSE` | `TRUE` |
|
|
||||||
| `DB01_PARALLEL_COMPRESSION_THREADS` | Maximum amount of threads to use when compressing - Integer value e.g. `8` | `autodetected` |
|
|
||||||
|
|
||||||
##### Encryption Options
|
|
||||||
|
|
||||||
Encryption will occur after compression and the resulting filename will have a `.gpg` suffix
|
|
||||||
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| -------------------------- | -------------------------------------------- | ------- | ------- |
|
|
||||||
| `DB01_ENCRYPT` | Encrypt file after backing up with GPG | `FALSE` | |
|
|
||||||
| `DB01_ENCRYPT_PASSPHRASE` | Passphrase to encrypt file with GPG | | x |
|
|
||||||
| *or* | | | |
|
|
||||||
| `DB01_ENCRYPT_PUBLIC_KEY` | Path of public key to encrypt file with GPG | | x |
|
|
||||||
| `DB01_ENCRYPT_PRIVATE_KEY` | Path of private key to encrypt file with GPG | | x |
|
|
||||||
|
|
||||||
##### Scheduling Options
|
|
||||||
|
|
||||||
| Variable | Description | Default |
|
|
||||||
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| `DB01_BACKUP_INTERVAL` | How often to do a backup, in minutes after the first backup. Defaults to 1440 minutes, or once per day. | `1440` |
|
|
||||||
| `DB01_BACKUP_BEGIN` | What time to do the initial backup. Defaults to immediate. (`+1`) | `+0` |
|
|
||||||
| | Must be in one of four formats: | |
|
|
||||||
| | Absolute HHMM, e.g. `2330` or `0415` | |
|
|
||||||
| | Relative +MM, i.e. how many minutes after starting the container, e.g. `+0` (immediate), `+10` (in 10 minutes), or `+90` in an hour and a half | |
|
|
||||||
| | Full datestamp e.g. `2023-12-21 23:30:00` | |
|
|
||||||
| | Cron expression e.g. `30 23 * * *` [Understand the format](https://en.wikipedia.org/wiki/Cron) - *BACKUP_INTERVAL is ignored* | |
|
|
||||||
| `DB01_CLEANUP_TIME` | Value in minutes to delete old backups (only fired when backup interval executes) | `FALSE` |
|
|
||||||
| | 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. | |
|
|
||||||
| `DB01_ARCHIVE_TIME` | Value in minutes to move all files files older than (x) from `DB01_BACKUP_FILESYSTEM_PATH` | |
|
|
||||||
| | to `DB01_BACKUP_FILESYSTEM_ARCHIVE_PATH` - which is useful when pairing against an external backup system. | |
|
|
||||||
| `DB01_BACKUP_BLACKOUT_BEGIN` | Use `HHMM` notation to start a blackout period where no backups occur eg `0420` | |
|
|
||||||
| `DB01_BACKUP_BLACKOUT_END` | Use `HHMM` notation to set the end period where no backups occur eg `0430` | |
|
|
||||||
|
|
||||||
##### Specific Database Options
|
|
||||||
|
|
||||||
###### CouchDB
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ----------- | ------------ | ------- | ------- |
|
|
||||||
| `DB01_PORT` | CouchDB Port | `5984` | x |
|
|
||||||
|
|
||||||
###### InfluxDB
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| --------------------- | ------------------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DB01_PORT` | InfluxDB Port | | x |
|
|
||||||
| | Version 1.x | `8088` | |
|
|
||||||
| | Version 2.x | `8086` | |
|
|
||||||
| `DB01_INFLUX_VERSION` | What Version of Influx are you backing up from `1`.x or `2` series - amd64 and aarch/armv8 only for `2` | `2` | |
|
|
||||||
|
|
||||||
> Your Organization will be mapped to `DB_USER` and your root token will need to be mapped to `DB_PASS`.
|
|
||||||
> You may use `DB_NAME=ALL` to backup the entire set of databases.
|
|
||||||
> For `DB_HOST` use syntax of `http(s)://db-name`
|
|
||||||
|
|
||||||
|
|
||||||
###### MariaDB/MySQL
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------- | ------- |
|
|
||||||
| `DB01_EXTRA_OPTS` | Pass extra arguments to the backup and database enumeration command, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_EXTRA_BACKUP_OPTS` | Pass extra arguments to the backup command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_EXTRA_ENUMERATION_OPTS` | Pass extra arguments to the database enumeration command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_NAME` | Schema Name e.g. `database` or `ALL` to backup all databases the user has access to. | | |
|
|
||||||
| | Backup multiple by separating with commas eg `db1,db2` | | x |
|
|
||||||
| `DB01_NAME_EXCLUDE` | If using `ALL` - use this as to exclude databases separated via commas from being backed up | | x |
|
|
||||||
| `DB01_PORT` | MySQL / MariaDB Port | `3306` | x |
|
|
||||||
| `DB01_MYSQL_EVENTS` | Backup Events for | `TRUE` | |
|
|
||||||
| `DB01_MYSQL_MAX_ALLOWED_PACKET` | Max allowed packet | `512M` | |
|
|
||||||
| `DB01_MYSQL_SINGLE_TRANSACTION` | Backup in a single transaction | `TRUE` | |
|
|
||||||
| `DB01_MYSQL_STORED_PROCEDURES` | Backup stored procedures | `TRUE` | |
|
|
||||||
| `DB01_MYSQL_ENABLE_TLS` | Enable TLS functionality | `FALSE` | |
|
|
||||||
| `DB01_MYSQL_TLS_VERIFY` | (optional) If using TLS (by means of MYSQL_TLS_* variables) verify remote host | `FALSE` | |
|
|
||||||
| `DB01_MYSQL_TLS_VERSION` | What TLS `v1.1` `v1.2` `v1.3` version to utilize | `TLSv1.1,TLSv1.2,TLSv1.3` | |
|
|
||||||
| `DB01_MYSQL_TLS_CA_FILE` | Filename to load custom CA certificate for connecting via TLS | `/etc/ssl/cert.pem` | x |
|
|
||||||
| `DB01_MYSQL_TLS_CERT_FILE` | Filename to load client certificate for connecting via TLS | | x |
|
|
||||||
| `DB01_MYSQL_TLS_KEY_FILE` | Filename to load client key for connecting via TLS | | x |
|
|
||||||
|
|
||||||
|
|
||||||
###### Microsoft SQL
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ----------------- | --------------------------------------- | ---------- | ------- |
|
|
||||||
| `DB01_PORT` | Microsoft SQL Port | `1433` | x |
|
|
||||||
| `DB01_MSSQL_MODE` | Backup `DATABASE` or `TRANSACTION` logs | `DATABASE` |
|
|
||||||
|
|
||||||
###### MongoDB
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------- |
|
|
||||||
| `DB01_AUTH` | (Optional) Authentication Database | | |
|
|
||||||
| `DB01_PORT` | MongoDB Port | `27017` | x |
|
|
||||||
| `DB01_MONGO_CUSTOM_URI` | If you wish to override the MongoDB Connection string enter it here e.g. `mongodb+srv://username:password@cluster.id.mongodb.net` | | x |
|
|
||||||
| | This environment variable will be parsed and populate the `DB_NAME` and `DB_HOST` variables to properly build your backup filenames. | | |
|
|
||||||
| | You can override them by making your own entries | | |
|
|
||||||
|
|
||||||
###### Postgresql
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ----------------------------- | --------------------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DB01_AUTH` | (Optional) Authentication Database | | |
|
|
||||||
| `DB01_BACKUP_GLOBALS` | Backup Globals after backing up database (forces `TRUE` if `_NAME=ALL``) | `FALSE` | |
|
|
||||||
| `DB01_EXTRA_OPTS` | Pass extra arguments to the backup and database enumeration command, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_EXTRA_BACKUP_OPTS` | Pass extra arguments to the backup command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_EXTRA_ENUMERATION_OPTS` | Pass extra arguments to the database enumeration command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_NAME` | Schema Name e.g. `database` or `ALL` to backup all databases the user has access to. | | |
|
|
||||||
| | Backup multiple by separating with commas eg `db1,db2` | | x |
|
|
||||||
| `DB01_PORT` | PostgreSQL Port | `5432` | x |
|
|
||||||
|
|
||||||
###### Redis
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ------------------------ | --------------------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DB01_EXTRA_OPTS` | Pass extra arguments to the backup and database enumeration command, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_EXTRA_BACKUP_OPTS` | Pass extra arguments to the backup command only, add them here e.g. `--extra-command` | | |
|
|
||||||
| `DB01_PORT` | Redis Port | `6379` | x |
|
|
||||||
|
|
||||||
###### SQLite
|
|
||||||
|
|
||||||
| Variable | Description | Default | `_FILE` |
|
|
||||||
| ----------- | -------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DB01_HOST` | Enter the full path to DB file e.g. `/backup/db.sqlite3` | | x |
|
|
||||||
|
|
||||||
##### Specific Storage Options
|
|
||||||
|
|
||||||
Options that are related to the value of `DB01_BACKUP_LOCATION`
|
|
||||||
|
|
||||||
###### Filesystem
|
|
||||||
|
|
||||||
If `DB01_BACKUP_LOCTION` = `FILESYSTEM` then the following options are used:
|
|
||||||
|
|
||||||
| Variable | Description | Default |
|
|
||||||
| --------------------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------- |
|
|
||||||
| `DB01_CREATE_LATEST_SYMLINK` | Create a symbolic link pointing to last backup in this format: `latest-(DB_TYPE)-(DB_NAME)-(DB_HOST)` | `TRUE` |
|
|
||||||
| `DB01_FILESYSTEM_PATH` | Directory where the database dumps are kept. | `/backup` |
|
|
||||||
| `DB01_FILESYSTEM_PATH_PERMISSION` | Permissions to apply to backup directory | `700` |
|
|
||||||
| `DB01_FILESYSTEM_ARCHIVE_PATH` | Optional Directory where the database dumps archives are kept | `${DB01_FILESYSTEM_PATH/archive/` |
|
|
||||||
| `DB01_FILESYSTEM_PERMISSION` | Directory and File permissions to apply to files. | `600` |
|
|
||||||
|
|
||||||
###### S3
|
|
||||||
|
|
||||||
If `DB01_BACKUP_LOCATION` = `S3` then the following options are used:
|
|
||||||
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| -------------------------- | ----------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `DB01_S3_BUCKET` | S3 Bucket name e.g. `mybucket` | | x |
|
|
||||||
| `DB01_S3_KEY_ID` | S3 Key ID (Optional) | | x |
|
|
||||||
| `DB01_S3_KEY_SECRET` | S3 Key Secret (Optional) | | x |
|
|
||||||
| `DB01_S3_PATH` | S3 Pathname to save to (must NOT end in a trailing slash e.g. '`backup`') | | x |
|
|
||||||
| `DB01_S3_REGION` | Define region in which bucket is defined. Example: `ap-northeast-2` | | x |
|
|
||||||
| `DB01_S3_HOST` | Hostname (and port) of S3-compatible service, e.g. `minio:8080`. Defaults to AWS. | | x |
|
|
||||||
| `DB01_S3_PROTOCOL` | Protocol to connect to `DB01_S3_HOST`. Either `http` or `https`. Defaults to `https`. | `https` | x |
|
|
||||||
| `DB01_S3_EXTRA_OPTS` | Add any extra options to the end of the `aws-cli` process execution | | x |
|
|
||||||
| `DB01_S3_CERT_CA_FILE` | Map a volume and point to your custom CA Bundle for verification e.g. `/certs/bundle.pem` | | x |
|
|
||||||
| _*OR*_ | | | |
|
|
||||||
| `DB01_S3_CERT_SKIP_VERIFY` | Skip verifying self signed certificates when connecting | `TRUE` | |
|
|
||||||
|
|
||||||
> When `DB01_S3_KEY_ID` and/or `DB01_S3_KEY_SECRET` is not set, will try to use IAM role assigned (if any) for uploading the backup files to S3 bucket.
|
|
||||||
|
|
||||||
###### Azure
|
|
||||||
|
|
||||||
If `DB01_BACKUP_LOCATION` = `blobxfer` then the following options are used:.
|
|
||||||
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| ----------------------------------- | ------------------------------------------- | ------------------- | ------- |
|
|
||||||
| `DB01_BLOBXFER_STORAGE_ACCOUNT` | Microsoft Azure Cloud storage account name. | | x |
|
|
||||||
| `DB01_BLOBXFER_STORAGE_ACCOUNT_KEY` | Microsoft Azure Cloud storage account key. | | x |
|
|
||||||
| `DB01_BLOBXFER_REMOTE_PATH` | Remote Azure path | `/docker-db-backup` | x |
|
|
||||||
|
|
||||||
> This service uploads files from backup directory `DB01_BACKUP_FILESYSTEM_PATH`.
|
|
||||||
> If the a cleanup configuration in `DB01_CLEANUP_TIME` is defined, the remote directory on Azure storage will also be cleaned automatically.
|
|
||||||
|
|
||||||
##### Hooks
|
|
||||||
|
|
||||||
###### Path Options
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
|
||||||
| --------------------------- | --------------------------------------------------------------------------- | ----------------------- |
|
|
||||||
| `DB01_SCRIPT_LOCATION_PRE` | Location on filesystem inside container to execute bash scripts pre backup | `/assets/scripts/pre/` |
|
|
||||||
| `DB01_SCRIPT_LOCATION_POST` | Location on filesystem inside container to execute bash scripts post backup | `/assets/scripts/post/` |
|
|
||||||
| `DB01_PRE_SCRIPT` | Fill this variable in with a command to execute pre backing up | |
|
|
||||||
| `DB01_POST_SCRIPT` | Fill this variable in with a command to execute post backing up | |
|
|
||||||
|
|
||||||
###### Pre Backup
|
|
||||||
|
|
||||||
If you want to execute a custom script before a backup starts, you can drop bash scripts with the extension of `.sh` in the location defined in `DB01_SCRIPT_LOCATION_PRE`. See the following example to utilize:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ cat pre-script.sh
|
|
||||||
##!/bin/bash
|
|
||||||
|
|
||||||
# #### Example Pre Script
|
|
||||||
# #### $1=DB01_TYPE (Type of Backup)
|
|
||||||
# #### $2=DB01_HOST (Backup Host)
|
|
||||||
# #### $3=DB01_NAME (Name of Database backed up
|
|
||||||
# #### $4=BACKUP START TIME (Seconds since Epoch)
|
|
||||||
# #### $5=BACKUP FILENAME (Filename)
|
|
||||||
|
|
||||||
echo "${1} Backup Starting on ${2} for ${3} at ${4}. Filename: ${5}"
|
|
||||||
```
|
|
||||||
|
|
||||||
## script DB01_TYPE DB01_HOST DB01_NAME STARTEPOCH BACKUP_FILENAME
|
|
||||||
${f} "${backup_job_db_type}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${backup_job_filename}"
|
|
||||||
|
|
||||||
Outputs the following on the console:
|
|
||||||
|
|
||||||
`mysql Backup Starting on example-db for example at 1647370800. Filename: mysql_example_example-db_202200315-000000.sql.bz2`
|
|
||||||
|
|
||||||
###### Post backup
|
|
||||||
|
|
||||||
If you want to execute a custom script at the end of a backup, you can drop bash scripts with the extension of `.sh` in the location defined in `DB01_SCRIPT_LOCATION_POST`. Also to support legacy users `/assets/custom-scripts` is also scanned and executed.See the following example to utilize:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ cat post-script.sh
|
$ cat post-script.sh
|
||||||
##!/bin/bash
|
##!/bin/bash
|
||||||
|
|
||||||
@@ -691,162 +177,37 @@ $ cat post-script.sh
|
|||||||
# #### $2=DB_TYPE (Type of Backup)
|
# #### $2=DB_TYPE (Type of Backup)
|
||||||
# #### $3=DB_HOST (Backup Host)
|
# #### $3=DB_HOST (Backup Host)
|
||||||
# #### #4=DB_NAME (Name of Database backed up
|
# #### #4=DB_NAME (Name of Database backed up
|
||||||
# #### $5=BACKUP START TIME (Seconds since Epoch)
|
# #### $5=DATE (Date of Backup)
|
||||||
# #### $6=BACKUP FINISH TIME (Seconds since Epoch)
|
# #### $6=TIME (Time of Backup)
|
||||||
# #### $7=BACKUP TOTAL TIME (Seconds between Start and Finish)
|
# #### $7=BACKUP_FILENAME (Filename of Backup)
|
||||||
# #### $8=BACKUP FILENAME (Filename)
|
# #### $8=FILESIZE (Filesize of backup)
|
||||||
# #### $9=BACKUP FILESIZE
|
# #### $9=MD5_RESULT (MD5Sum if enabled)
|
||||||
# #### $10=HASH (If CHECKSUM enabled)
|
|
||||||
# #### $11=MOVE_EXIT_CODE
|
|
||||||
|
|
||||||
echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ending ${6} for a duration of ${7} seconds. Filename: ${8} Size: ${9} bytes MD5: ${10}"
|
echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ${6}. Filename: ${7} Size: ${8} bytes MD5: ${9}"
|
||||||
```
|
````
|
||||||
|
|
||||||
## script EXIT_CODE DB_TYPE DB_HOST DB_NAME STARTEPOCH FINISHEPOCH DURATIONEPOCH BACKUP_FILENAME FILESIZE CHECKSUMVALUE
|
|
||||||
${f} "${exit_code}" "${dbtype}" "${dbhost}" "${dbname}" "${backup_routines_start_time}" "${backup_routines_finish_time}" "${backup_routines_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}
|
|
||||||
|
|
||||||
Outputs the following on the console:
|
Outputs the following on the console:
|
||||||
|
|
||||||
`0 mysql Backup Completed on example-db for example on 1647370800 ending 1647370920 for a duration of 120 seconds. Filename: mysql_example_example-db_202200315-000000.sql.bz2 Size: 7795 bytes Hash: 952fbaafa30437494fdf3989a662cd40 0`
|
`0 mysql Backup Completed on example-db for example on 2020-04-22 05:19:10. Filename: mysql_example_example-db_20200422-051910.sql.bz2 Size: 7795 bytes MD5: 952fbaafa30437494fdf3989a662cd40`
|
||||||
|
|
||||||
If you wish to change the size value from bytes to megabytes set environment variable `DB01_SIZE_VALUE=megabytes`
|
|
||||||
|
|
||||||
You must make your scripts executable otherwise there is an internal check that will skip trying to run it otherwise.
|
|
||||||
If for some reason your filesystem or host is not detecting it right, use the environment variable `DB01_POST_SCRIPT_SKIP_X_VERIFY=TRUE` to bypass.
|
|
||||||
|
|
||||||
|
|
||||||
#### Notifications
|
|
||||||
|
|
||||||
This image has capabilities on sending notifications via a handful of services when a backup job fails. This is a global option that cannot be individually set per backup job.
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
|
||||||
| ---------------------- | --------------------------------------------------------------------------------- | ------- |
|
|
||||||
| `ENABLE_NOTIFICATIONS` | Enable Notifications | `FALSE` |
|
|
||||||
| `NOTIFICATION_TYPE` | `CUSTOM` `EMAIL` `MATRIX` `MATTERMOST` `ROCKETCHAT` - Seperate Multiple by commas | |
|
|
||||||
|
|
||||||
##### Custom Notifications
|
|
||||||
|
|
||||||
The following is sent to the custom script. Use how you wish:
|
|
||||||
|
|
||||||
````
|
|
||||||
$1 unix timestamp
|
|
||||||
$2 logfile
|
|
||||||
$3 errorcode
|
|
||||||
$4 subject
|
|
||||||
$5 body/error message
|
|
||||||
````
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
|
||||||
| ---------------------------- | ------------------------------------------------------- | ------- |
|
|
||||||
| `NOTIFICATION_CUSTOM_SCRIPT` | Path and name of custom script to execute notification. | |
|
|
||||||
|
|
||||||
|
|
||||||
##### Email Notifications
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| ----------- | ----------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `MAIL_FROM` | What email address to send mail from for errors | | |
|
|
||||||
| `MAIL_TO` | What email address to send mail to for errors. Send to multiple by seperating with comma. | | |
|
|
||||||
| `SMTP_HOST` | What SMTP server to use for sending mail | | x |
|
|
||||||
| `SMTP_PORT` | What SMTP port to use for sending mail | | x |
|
|
||||||
|
|
||||||
##### Matrix Notifications
|
|
||||||
|
|
||||||
Fetch a `MATRIX_ACCESS_TOKEN`:
|
|
||||||
|
|
||||||
````
|
|
||||||
curl -XPOST -d '{"type":"m.login.password", "user":"myuserid", "password":"mypass"}' "https://matrix.org/_matrix/client/r0/login"
|
|
||||||
````
|
|
||||||
|
|
||||||
Copy the JSON response `access_token` that will look something like this:
|
|
||||||
|
|
||||||
````
|
|
||||||
{"access_token":"MDAxO...blahblah","refresh_token":"MDAxO...blahblah","home_server":"matrix.org","user_id":"@myuserid:matrix.org"}
|
|
||||||
````
|
|
||||||
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| --------------------- | ---------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `MATRIX_HOST` | URL (https://matrix.example.com) of Matrix Homeserver | | x |
|
|
||||||
| `MATRIX_ROOM` | Room ID eg `\!abcdef:example.com` to send to. Send to multiple by seperating with comma. | | x |
|
|
||||||
| `MATRIX_ACCESS_TOKEN` | Access token of user authorized to send to room | | x |
|
|
||||||
|
|
||||||
##### Mattermost Notifications
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| ------------------------ | -------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `MATTERMOST_WEBHOOK_URL` | Full URL to send webhook notifications to | | x |
|
|
||||||
| `MATTERMOST_RECIPIENT` | Channel or User to send Webhook notifications to. Send to multiple by seperating with comma. | | x |
|
|
||||||
| `MATTERMOST_USERNAME` | Username to send as eg `tiredofit` | | x |
|
|
||||||
|
|
||||||
##### Rocketchat Notifications
|
|
||||||
| Parameter | Description | Default | `_FILE` |
|
|
||||||
| ------------------------ | -------------------------------------------------------------------------------------------- | ------- | ------- |
|
|
||||||
| `ROCKETCHAT_WEBHOOK_URL` | Full URL to send webhook notifications to | | x |
|
|
||||||
| `ROCKETCHAT_RECIPIENT` | Channel or User to send Webhook notifications to. Send to multiple by seperating with comma. | | x |
|
|
||||||
| `ROCKETCHAT_USERNAME` | Username to send as eg `tiredofit` | | x |
|
|
||||||
|
|
||||||
## Maintenance
|
|
||||||
|
|
||||||
### Shell Access
|
|
||||||
|
|
||||||
For debugging and maintenance purposes you may want access the containers shell.
|
|
||||||
|
|
||||||
`bash
|
|
||||||
docker exec -it (whatever your container name is) bash
|
|
||||||
`
|
|
||||||
|
|
||||||
### Manual Backups
|
|
||||||
|
|
||||||
Manual Backups can be performed by entering the container and typing `backup-now`. This will execute all the backup tasks that are scheduled by means of the `BACKUPXX_` variables. Alternatively if you wanted to execute a job on its own you could simply type `backup01-now` (or whatever your number would be). There is no concurrency, and jobs will be executed sequentially.
|
|
||||||
|
|
||||||
- Recently there was a request to have the container work with Kubernetes cron scheduling. This can theoretically be accomplished by setting the container `MODE=MANUAL` and then setting `MANUAL_RUN_FOREVER=FALSE` - You would also want to disable a few features from the upstream base images specifically `CONTAINER_ENABLE_SCHEDULING` and `CONTAINER_ENABLE_MONITORING`. This should allow the container to start, execute a backup by executing and then exit cleanly. An alternative way to running the script is to execute `/etc/services.available/10-db-backup/run`.
|
|
||||||
|
|
||||||
### Restoring Databases
|
|
||||||
|
|
||||||
Entering in the container and executing `restore` will execute a menu based script to restore your backups - MariaDB, Postgres, and Mongo supported.
|
|
||||||
|
|
||||||
You will be presented with a series of menus allowing you to choose:
|
|
||||||
|
|
||||||
- What file to restore
|
|
||||||
- What type of DB Backup
|
|
||||||
- What Host to restore to
|
|
||||||
- What Database Name to restore to
|
|
||||||
- What Database User to use
|
|
||||||
- What Database Password to use
|
|
||||||
- What Database Port to use
|
|
||||||
|
|
||||||
The image will try to do auto detection based on the filename for the type, hostname, and database name.
|
|
||||||
The image will also allow you to use environment variables or Docker secrets used to backup the images
|
|
||||||
|
|
||||||
The script can also be executed skipping the interactive mode by using the following syntax/
|
|
||||||
|
|
||||||
`restore <filename> <db_type> <db_hostname> <db_name> <db_user> <db_pass> <db_port>`
|
|
||||||
|
|
||||||
If you only enter some of the arguments you will be prompted to fill them in.
|
|
||||||
|
|
||||||
|
|
||||||
|
If you wish to change the size value from bytes to megabytes set environment variable `SIZE_VALUE=megabytes`
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
|
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.
|
- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.
|
||||||
- [Sponsor me](https://www.tiredofit.ca/sponsor) for personalized support
|
- Consider [sponsoring me](https://github.com/sponsors/tiredofit) personalized support.
|
||||||
|
|
||||||
### Bugfixes
|
### Bugfixes
|
||||||
|
|
||||||
- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.
|
- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.
|
||||||
|
|
||||||
### Feature Requests
|
### Feature Requests
|
||||||
|
|
||||||
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
|
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
|
||||||
- [Sponsor me](https://www.tiredofit.ca/sponsor) regarding development of features.
|
- Consider [sponsoring me](https://github.com/sponsors/tiredofit) regarding development of features.
|
||||||
|
|
||||||
### Updates
|
### Updates
|
||||||
|
|
||||||
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
|
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
|
||||||
- [Sponsor me](https://www.tiredofit.ca/sponsor) for up to date releases.
|
- Consider [sponsoring me](https://github.com/sponsors/tiredofit) for up to date releases.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT. See [LICENSE](LICENSE) for more details.
|
MIT. See [LICENSE](LICENSE) for more details.
|
||||||
|
|||||||
5
examples/.gitignore
vendored
5
examples/.gitignore
vendored
@@ -1,5 +0,0 @@
|
|||||||
# See http://help.github.com/ignore-files/ for more about ignoring files.
|
|
||||||
|
|
||||||
# Example container mounted folders
|
|
||||||
**/backups/
|
|
||||||
**/db/
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
services:
|
|
||||||
example-db:
|
|
||||||
hostname: example-db-host
|
|
||||||
container_name: example-db
|
|
||||||
image: tiredofit/mariadb:10.11
|
|
||||||
ports:
|
|
||||||
- 3306:3306
|
|
||||||
volumes:
|
|
||||||
- ./db:/var/lib/mysql
|
|
||||||
environment:
|
|
||||||
- ROOT_PASS=examplerootpassword
|
|
||||||
- DB_NAME=example
|
|
||||||
- DB_USER=example
|
|
||||||
- DB_PASS=examplepassword
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
- example-db-network
|
|
||||||
|
|
||||||
example-db-backup:
|
|
||||||
container_name: example-db-backup
|
|
||||||
image: tiredofit/db-backup
|
|
||||||
volumes:
|
|
||||||
- ./backups:/backup
|
|
||||||
#- ./post-script.sh:/assets/custom-scripts/post-script.sh
|
|
||||||
environment:
|
|
||||||
- TIMEZONE=America/Vancouver
|
|
||||||
- CONTAINER_NAME=example-db-backup
|
|
||||||
- CONTAINER_ENABLE_MONITORING=FALSE
|
|
||||||
# - DEBUG_MODE=TRUE
|
|
||||||
|
|
||||||
- BACKUP_JOB_CONCURRENCY=1 # Only run one job at a time
|
|
||||||
- DEFAULT_CHECKSUM=NONE # Don't create checksums
|
|
||||||
- DEFAULT_COMPRESSION=ZSTD # Compress all with ZSTD
|
|
||||||
- DEFAULT_DUMP_INTERVAL=1440 # Backup every 1440 minutes
|
|
||||||
- DEFAULT_DUMP_BEGIN=0000 # Start backing up at midnight
|
|
||||||
- DEFAULT_CLEANUP_TIME=8640 # Cleanup backups after a week
|
|
||||||
|
|
||||||
- DB01_TYPE=mariadb
|
|
||||||
- DB01_HOST=example-db-host
|
|
||||||
- DB01_NAME=example
|
|
||||||
- DB01_USER=example
|
|
||||||
- DB01_PASS=examplepassword
|
|
||||||
- DB01_DUMP_INTERVAL=30 # (override) Backup every 30 minutes
|
|
||||||
- DB01_DUMP_BEGIN=+1 # (override) Backup starts immediately
|
|
||||||
- DB01_CLEANUP_TIME=180 # (override) Cleanup backups they are older than 180 minutes
|
|
||||||
- DB01_CHECKSUM=SHA1 # (override) Create a SHA1 checksum
|
|
||||||
- DB01_COMPRESSION=GZ # (override) Compress with GZIP
|
|
||||||
|
|
||||||
#- DB02_TYPE=postgres
|
|
||||||
#- DB02_HOST=example-postgres-host
|
|
||||||
#- DB02_NAME=example
|
|
||||||
#- DB02_USER=example
|
|
||||||
#- DB02_PASS=examplepassword
|
|
||||||
#- DB02_DUMP_INTERVAL=60 # (override) Backup every 60 minutes
|
|
||||||
#- DB02_DUMP_BEGIN=+10 # (override) Backup starts in ten minutes
|
|
||||||
#- DB02_CLEANUP_TIME=240 # (override) Cleanup backups they are older than 240 minutes
|
|
||||||
#- DB02_CHECKSUM=MD5 # (override) Create a SHA1 checksum
|
|
||||||
#- DB02_COMPRESSION=BZ # (override) Compress with BZIP
|
|
||||||
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
- example-db-network
|
|
||||||
|
|
||||||
networks:
|
|
||||||
example-db-network:
|
|
||||||
name: example-db-network
|
|
||||||
|
|
||||||
38
examples/docker-compose.yml
Executable file
38
examples/docker-compose.yml
Executable file
@@ -0,0 +1,38 @@
|
|||||||
|
version: '2'
|
||||||
|
|
||||||
|
services:
|
||||||
|
example-db:
|
||||||
|
container_name: example-db
|
||||||
|
image: mariadb:latest
|
||||||
|
volumes:
|
||||||
|
- ./db:/var/lib/mysql
|
||||||
|
environment:
|
||||||
|
- MYSQL_ROOT_PASSWORD=examplerootpassword
|
||||||
|
- MYSQL_DATABASE=example
|
||||||
|
- MYSQL_USER=example
|
||||||
|
- MYSQL_PASSWORD=examplepassword
|
||||||
|
restart: always
|
||||||
|
|
||||||
|
example-db-backup:
|
||||||
|
container_name: example-db-backup
|
||||||
|
image: tiredofit/db-backup
|
||||||
|
links:
|
||||||
|
- example-db
|
||||||
|
volumes:
|
||||||
|
- ./backups:/backup
|
||||||
|
- ./post-script.sh:/assets/custom-scripts/post-script.sh
|
||||||
|
environment:
|
||||||
|
- DB_TYPE=mariadb
|
||||||
|
- DB_HOST=example-db
|
||||||
|
- DB_NAME=example
|
||||||
|
- DB_USER=example
|
||||||
|
- DB_PASS="examplepassword"
|
||||||
|
- DB_DUMP_FREQ=1440
|
||||||
|
- DB_DUMP_BEGIN=0000
|
||||||
|
- DB_CLEANUP_TIME=8640
|
||||||
|
- MD5=TRUE
|
||||||
|
- COMPRESSION=XZ
|
||||||
|
- SPLIT_DB=FALSE
|
||||||
|
restart: always
|
||||||
|
|
||||||
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
#
|
|
||||||
# Example for Microsoft SQL Server
|
|
||||||
# upload with blobxfer to azure storage
|
|
||||||
#
|
|
||||||
|
|
||||||
services:
|
|
||||||
example-mssql-s3-db:
|
|
||||||
hostname: example-db-host
|
|
||||||
image: mcr.microsoft.com/mssql/server:2019-latest
|
|
||||||
container_name: example-mssql-s3-db
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- "127.0.0.1:11433:1433"
|
|
||||||
networks:
|
|
||||||
example-mssql-blobxfer-net:
|
|
||||||
volumes:
|
|
||||||
- ./tmp/backups:/tmp/backups # shared tmp backup directory
|
|
||||||
environment:
|
|
||||||
ACCEPT_EULA: Y
|
|
||||||
MSSQL_SA_PASSWORD: 5hQa0utRFBpIY3yhoIyE
|
|
||||||
MSSQL_PID: Express
|
|
||||||
|
|
||||||
example-mssql-blobxfer-db-backup:
|
|
||||||
container_name: example-mssql-blobxfer-db-backup
|
|
||||||
# if you want to build and use image from current source
|
|
||||||
# execute in terminal --> docker build -t tiredofit/db-backup-mssql-blobxfer .
|
|
||||||
# replace --> image: tiredofit/db-backup-mssql
|
|
||||||
# image: tiredofit/db-backup
|
|
||||||
image: tiredofit/db-backup
|
|
||||||
links:
|
|
||||||
- example-mssql-s3-db
|
|
||||||
volumes:
|
|
||||||
- ./backups:/backup
|
|
||||||
- ./tmp/backups:/tmp/backups # shared tmp backup directory
|
|
||||||
#- ./post-script.sh:/assets/custom-scripts/post-script.sh
|
|
||||||
environment:
|
|
||||||
- TIMEZONE=America/Vancouver
|
|
||||||
- CONTAINER_ENABLE_MONITORING=FALSE
|
|
||||||
- CONTAINER_NAME=example-mssql-blobxfer-db-backup
|
|
||||||
# - DEBUG_MODE=TRUE
|
|
||||||
- DB01_TYPE=mssql
|
|
||||||
- DB01_HOST=example-db-host
|
|
||||||
# - DB01_PORT=1488
|
|
||||||
# create database with name `test1` manually first
|
|
||||||
- DB01_NAME=test1 # Create this database
|
|
||||||
- DB01_USER=sa
|
|
||||||
- DB01_PASS=5hQa0utRFBpIY3yhoIyE
|
|
||||||
- DB01_DUMP_INTERVAL=5 # backup every 5 minute
|
|
||||||
# - DB01_DUMP_BEGIN=0000 # backup starts at midnight vs not set immediately
|
|
||||||
- DB01_CLEANUP_TIME=60 # clean backups they are older than 60 minutes
|
|
||||||
- DB01_CHECKSUM=SHA1 # Set Checksum to be SHA1
|
|
||||||
- DB01_COMPRESSION=GZ # Set compression to use GZIP
|
|
||||||
|
|
||||||
|
|
||||||
# === S3 Blobxfer ===
|
|
||||||
- DB01_BACKUP_LOCATION=blobxfer
|
|
||||||
# Add here azure storage account
|
|
||||||
- DB01_BLOBXFER_STORAGE_ACCOUNT={TODO Add Storage Name}
|
|
||||||
# Add here azure storage account key
|
|
||||||
- SB01_BLOBXFER_STORAGE_ACCOUNT_KEY={TODO Add Key}
|
|
||||||
- DB01_BLOBXFER_REMOTE_PATH=docker-db-backup
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
example-mssql-blobxfer-net:
|
|
||||||
|
|
||||||
networks:
|
|
||||||
example-mssql-blobxfer-net:
|
|
||||||
name: example-mssql-blobxfer-net
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
#
|
|
||||||
# Example for Microsoft SQL Server
|
|
||||||
#
|
|
||||||
|
|
||||||
services:
|
|
||||||
example-mssql-db:
|
|
||||||
hostname: example-db-host
|
|
||||||
image: mcr.microsoft.com/mssql/server:2019-latest
|
|
||||||
container_name: example-mssql-db
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- "127.0.0.1:11433:1433"
|
|
||||||
networks:
|
|
||||||
example-mssql-net:
|
|
||||||
volumes:
|
|
||||||
- ./tmp/backups:/tmp/backups # shared tmp backup directory
|
|
||||||
environment:
|
|
||||||
ACCEPT_EULA: Y
|
|
||||||
MSSQL_SA_PASSWORD: 5hQa0utRFBpIY3yhoIyE
|
|
||||||
MSSQL_PID: Express
|
|
||||||
|
|
||||||
example-mssql-db-backup:
|
|
||||||
container_name: example-mssql-db-backup
|
|
||||||
# if you want to build and use image from current source
|
|
||||||
# execute in terminal --> docker build -t tiredofit/db-backup-mssql .
|
|
||||||
# replace --> image: tiredofit/db-backup-mssql
|
|
||||||
# image: tiredofit/db-backup
|
|
||||||
image: tiredofit/db-backup
|
|
||||||
links:
|
|
||||||
- example-mssql-db
|
|
||||||
volumes:
|
|
||||||
- ./backups:/backup
|
|
||||||
- ./tmp/backups:/tmp/backups # shared tmp backup directory
|
|
||||||
#- ./post-script.sh:/assets/custom-scripts/post-script.sh
|
|
||||||
environment:
|
|
||||||
- TIMEZONE=America/Vancouver
|
|
||||||
- CONTAINER_ENABLE_MONITORING=FALSE
|
|
||||||
- CONTAINER_NAME=example-mssql-blobxfer-db-backup
|
|
||||||
|
|
||||||
# - DEBUG_MODE=TRUE
|
|
||||||
- DB01_TYPE=mssql
|
|
||||||
- DB01_HOST=example-db-host
|
|
||||||
# - DB_PORT=1488
|
|
||||||
# - DB_NAME=ALL # [ALL] not working on sql server.
|
|
||||||
# create database with name `test1` manually first
|
|
||||||
- DB01_NAME=test1
|
|
||||||
- DB01_USER=sa
|
|
||||||
- DB01_PASS=5hQa0utRFBpIY3yhoIyE
|
|
||||||
- DB01_DUMP_INTERVAL=1 # backup every minute
|
|
||||||
# - DB01_DUMP_BEGIN=0000 # backup starts at midnight vs unset immediately
|
|
||||||
- DB01_CLEANUP_TIME=5 # clean backups they are older than 5 minute
|
|
||||||
- DB01_CHECKSUM=NONE
|
|
||||||
- DB01_COMPRESSION=GZ
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
example-mssql-net:
|
|
||||||
|
|
||||||
networks:
|
|
||||||
example-mssql-net:
|
|
||||||
name: example-mssql-net
|
|
||||||
23
examples/post-script.sh
Normal file → Executable file
23
examples/post-script.sh
Normal file → Executable file
@@ -1,15 +1,14 @@
|
|||||||
##!/bin/bash
|
##!/bin/bash
|
||||||
|
|
||||||
# #### Example Post Script
|
## Example Post Script
|
||||||
# #### $1=EXIT_CODE (After running backup routine)
|
## $1=EXIT_CODE (After running backup routine)
|
||||||
# #### $2=DB_TYPE (Type of Backup)
|
## $2=DB_TYPE (Type of Backup)
|
||||||
# #### $3=DB_HOST (Backup Host)
|
## $3=DB_HOST (Backup Host)
|
||||||
# #### #4=DB_NAME (Name of Database backed up)
|
## #4=DB_NAME (Name of Database backed up
|
||||||
# #### $5=BACKUP START TIME (Seconds since Epoch)
|
## $5=DATE (Date of Backup)
|
||||||
# #### $6=BACKUP FINISH TIME (Seconds since Epoch)
|
## $6=TIME (Time of Backup)
|
||||||
# #### $7=BACKUP TOTAL TIME (Seconds between Start and Finish)
|
## $7=BACKUP_FILENAME (Filename of Backup)
|
||||||
# #### $8=BACKUP FILENAME (Filename)
|
## $8=FILESIZE (Filesize of backup)
|
||||||
# #### $9=BACKUP FILESIZE
|
## $9=MD5_RESULT (MD5Sum if enabled)
|
||||||
# #### $10=HASH (If CHECKSUM enabled)
|
|
||||||
|
|
||||||
echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ending ${6} for a duration of ${7} seconds. Filename: ${8} Size: ${9} bytes MD5: ${10}"
|
echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ${6}. Filename: ${7} Size: ${8} bytes MD5: ${9}"
|
||||||
|
|||||||
@@ -1,110 +0,0 @@
|
|||||||
#!/command/with-contenv bash
|
|
||||||
|
|
||||||
source /assets/functions/00-container
|
|
||||||
PROCESS_NAME="db-backup{{BACKUP_NUMBER}}-scheduler"
|
|
||||||
check_container_initialized
|
|
||||||
check_service_initialized init 10-db-backup
|
|
||||||
source /assets/functions/10-db-backup
|
|
||||||
source /assets/defaults/10-db-backup
|
|
||||||
bootstrap_variables backup_init {{BACKUP_NUMBER}}
|
|
||||||
bootstrap_variables parse_variables {{BACKUP_NUMBER}}
|
|
||||||
if [ -z "${backup_job_db_name}" ]; then
|
|
||||||
PROCESS_NAME="{{BACKUP_NUMBER}}${backup_job_db_host//\//_}"
|
|
||||||
else
|
|
||||||
PROCESS_NAME="{{BACKUP_NUMBER}}-${backup_job_db_host//\//_}__${backup_job_db_name}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
trap ctrl_c INT
|
|
||||||
|
|
||||||
if [[ "${MODE,,}" =~ "standalone" ]] || [ "${1,,}" = "manual" ] || [ "${1,,}" = "now" ]; then
|
|
||||||
print_debug "Detected Manual Mode"
|
|
||||||
persist=false
|
|
||||||
backup_job_backup_begin=+0
|
|
||||||
else
|
|
||||||
silent sleep {{BACKUP_NUMBER}}
|
|
||||||
time_last_run=0
|
|
||||||
time_current=$(date +'%s')
|
|
||||||
|
|
||||||
if [[ "${backup_job_backup_begin}" =~ ^\+(.*)$ ]]; then
|
|
||||||
print_debug "BACKUP_BEGIN is a jump of minute starting with +"
|
|
||||||
timer plusvalue
|
|
||||||
elif [[ "${backup_job_backup_begin}" =~ ^[0-9]{4}$ ]]; then
|
|
||||||
print_debug "BACKUP_BEGIN is a HHMM value"
|
|
||||||
timer time
|
|
||||||
elif [[ "${backup_job_backup_begin}" =~ ([0-9]{4})-([0-9]{2})-([0-9]{2})[[:space:]]([0-9]{2}):([0-9]{2}):([0-9]{2}) ]]; then
|
|
||||||
print_debug "BACKUP_BEGIN is a full date timestamp"
|
|
||||||
timer datetime
|
|
||||||
elif echo "${backup_job_backup_begin//\*/#}" | grep -qP "^(((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|#) ?){5}$" ; then
|
|
||||||
print_debug "BACKUP_BEGIN is a cron expression"
|
|
||||||
time_last_run=$(date +"%s")
|
|
||||||
timer cron "${backup_job_backup_begin}" "${time_current}" "${time_last_run}"
|
|
||||||
else
|
|
||||||
print_error "_BACKUP_BEGIN is invalid - Unable to perform scheduling"
|
|
||||||
cat <<EOF
|
|
||||||
|
|
||||||
Valid Methods:
|
|
||||||
+(number) - Start in however many minutes
|
|
||||||
HHMM - Start at hour (00-24) and minute (00-59)
|
|
||||||
YYYY-MM-DD HH:mm:ss - Start at a specific date and time
|
|
||||||
0 23 * * * - Cron expression
|
|
||||||
|
|
||||||
EOF
|
|
||||||
print_error "Stopping backup_scheduler {{BACKUP_NUMBER}} due to detected errors. Fix and restart container."
|
|
||||||
stop_scheduler_backup=true
|
|
||||||
s6-svc -d /var/run/s6/legacy-services/dbbackup-{{BACKUP_NUMBER}}
|
|
||||||
fi
|
|
||||||
|
|
||||||
print_debug "Wait Time: ${time_wait} Future execution time: ${time_future} Current Time: ${time_current}"
|
|
||||||
print_info "Next Backup at $(date -d @"${time_future}" +'%Y-%m-%d %T %Z')"
|
|
||||||
silent sleep "${time_wait}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
while true; do
|
|
||||||
if [ -n "${backup_job_blackout_start}" ] && [ -n "${backup_job_blackout_finish}" ] ; then
|
|
||||||
time_current_hour_minute=$(date +%H%M)
|
|
||||||
if [[ "${time_current_hour_minute}" > "${backup_job_blackout_start}" ]] && [[ "${time_current_hour_minute}" < "${backup_job_blackout_finish}" ]] ; then
|
|
||||||
blackout=true
|
|
||||||
else
|
|
||||||
blackout=false
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if var_true "${blackout}" ; then
|
|
||||||
print_notice "Detected Blackout Period - Not performing backup operations"
|
|
||||||
else
|
|
||||||
timer job start
|
|
||||||
process_limiter
|
|
||||||
echo "{{BACKUP_NUMBER}}" >> /tmp/.container/db-backup-backups
|
|
||||||
print_debug "Backup {{BACKUP_NUMBER}} routines started time: $(date +'%Y-%m-%d %T %Z')"
|
|
||||||
bootstrap_filesystem
|
|
||||||
check_availability
|
|
||||||
backup_"${dbtype,,}"
|
|
||||||
timer job stop
|
|
||||||
if [ -z "${exitcode_backup}" ] ; then exitcode_backup="0" ; fi
|
|
||||||
print_info "Backup {{BACKUP_NUMBER}} routines finish time: $(date -d @"${backup_job_finish_time}" +'%Y-%m-%d %T %Z') with exit code ${exitcode_backup}"
|
|
||||||
print_notice "Backup {{BACKUP_NUMBER}} routines time taken: $(echo "${backup_job_total_time}" | awk '{printf "Hours: %d Minutes: %02d Seconds: %02d", $1/3600, ($1/60)%60, $1%60}')"
|
|
||||||
sed -i "/^{{BACKUP_NUMBER}}/d" /tmp/.container/db-backup-backups
|
|
||||||
fi
|
|
||||||
|
|
||||||
symlink_log
|
|
||||||
|
|
||||||
if var_false "${persist}" ; then
|
|
||||||
print_debug "Exiting due to manual mode"
|
|
||||||
exit "${exitcode_backup}";
|
|
||||||
else
|
|
||||||
if var_true "${stop_scheduler_backup}" ; then
|
|
||||||
print_error "Stopping backup_scheduler {{BACKUP_NUMBER}} due to detected errors. Fix and restart container."
|
|
||||||
s6-svc -d /var/run/s6/legacy-services/dbbackup-{{BACKUP_NUMBER}}
|
|
||||||
else
|
|
||||||
if [ ! "${time_cron}" = "true" ]; then
|
|
||||||
print_notice "Sleeping for another $(($backup_job_backup_interval*60-backup_job_total_time)) seconds. Waking up at $(date -d@"$(( $(date +%s)+$(($backup_job_backup_interval*60-backup_job_total_time))))" +'%Y-%m-%d %T %Z') "
|
|
||||||
silent sleep $(($backup_job_backup_interval*60-backup_job_total_time))
|
|
||||||
else
|
|
||||||
time_last_run=$(date +"%s")
|
|
||||||
timer cron "${backup_job_backup_begin}" "${time_current}" "${time_last_run}"
|
|
||||||
print_notice "Sleeping for another ${time_wait} seconds. Waking up at $(date -d@"${time_future}" +'%Y-%m-%d %T %Z') "
|
|
||||||
silent sleep "${time_wait}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
#!/command/with-contenv bash
|
|
||||||
|
|
||||||
BACKUP_JOB_CONCURRENCY=${BACKUP_JOB_CONCURRENCY:-"1"}
|
|
||||||
DBBACKUP_USER=${DBBACKUP_USER:-"dbbackup"}
|
|
||||||
DBBACKUP_GROUP=${DBBACKUP_GROUP:-"${DBBACKUP_USER}"} # Must go after DBBACKUP_USER
|
|
||||||
DEFAULT_BACKUP_BEGIN=${DEFAULT_BACKUP_BEGIN:-+0}
|
|
||||||
DEFAULT_BACKUP_INTERVAL=${DEFAULT_BACKUP_INTERVAL:-1440}
|
|
||||||
DEFAULT_BACKUP_INTERVAL=${DEFAULT_BACKUP_INTERVAL:-1440}
|
|
||||||
DEFAULT_BACKUP_LOCATION=${DEFAULT_BACKUP_LOCATION:-"FILESYSTEM"}
|
|
||||||
DEFAULT_BLOBXFER_REMOTE_PATH=${DEFAULT_BLOBXFER_REMOTE_PATH:-"/docker-db-backup"}
|
|
||||||
DEFAULT_CHECKSUM=${DEFAULT_CHECKSUM:-"MD5"}
|
|
||||||
DEFAULT_COMPRESSION=${DEFAULT_COMPRESSION:-"ZSTD"}
|
|
||||||
DEFAULT_COMPRESSION_LEVEL=${DEFAULT_COMPRESSION_LEVEL:-"3"}
|
|
||||||
DEFAULT_CREATE_LATEST_SYMLINK=${DEFAULT_CREATE_LATEST_SYMLINK:-"TRUE"}
|
|
||||||
DEFAULT_ENABLE_PARALLEL_COMPRESSION=${DEFAULT_ENABLE_PARALLEL_COMPRESSION:-"TRUE"}
|
|
||||||
DEFAULT_ENCRYPT=${DEFAULT_ENCRYPT:-"FALSE"}
|
|
||||||
DEFAULT_FILESYSTEM_PATH=${DEFAULT_FILESYSTEM_PATH:-"/backup"}
|
|
||||||
DEFAULT_FILESYSTEM_PATH_PERMISSION=${DEFAULT_FILESYSTEM_PATH_PERMISSION:-"700"}
|
|
||||||
DEFAULT_FILESYSTEM_PERMISSION=${DEFAULT_FILESYSTEM_PERMISSION:-"600"}
|
|
||||||
DEFAULT_FILESYSTEM_ARCHIVE_PATH=${DEFAULT_FILESYSTEM_ARCHIVE_PATH:-"${DEFAULT_FILESYSTEM_PATH}/archive/"}
|
|
||||||
DEFAULT_LOG_LEVEL=${DEFAULT_LOG_LEVEL:-"notice"}
|
|
||||||
DEFAULT_MYSQL_ENABLE_TLS=${DEFAULT_MYSQL_ENABLE_TLS:-"FALSE"}
|
|
||||||
DEFAULT_MYSQL_EVENTS=${DEFAULT_MYSQL_EVENTS:-"TRUE"}
|
|
||||||
DEFAULT_MYSQL_MAX_ALLOWED_PACKET=${DEFAULT_MYSQL_MAX_ALLOWED_PACKET:-"512M"}
|
|
||||||
DEFAULT_MYSQL_SINGLE_TRANSACTION=${DEFAULT_MYSQL_SINGLE_TRANSACTION:-"TRUE"}
|
|
||||||
DEFAULT_MYSQL_STORED_PROCEDURES=${DEFAULT_MYSQL_STORED_PROCEDURES:-"TRUE"}
|
|
||||||
DEFAULT_MYSQL_TLS_CA_FILE=${DEFAULT_MYSQL_TLS_CA_FILE:-"/etc/ssl/cert.pem"}
|
|
||||||
DEFAULT_MYSQL_TLS_VERIFY=${DEFAULT_MYSQL_TLS_VERIFY:-"FALSE"}
|
|
||||||
DEFAULT_MYSQL_TLS_VERSION=${DEFAULT_MYSQL_TLS_VERSION:-"TLSv1.1,TLSv1.2,TLSv1.3"}
|
|
||||||
DEFAULT_MSSQL_MODE=${DEFAULT_MSSQL_MODE:-"database"}
|
|
||||||
DEFAULT_PARALLEL_COMPRESSION_THREADS=${DEFAULT_PARALLEL_COMPRESSION_THREADS:-"$(nproc)"}
|
|
||||||
DEFAULT_RESOURCE_OPTIMIZED=${DEFAULT_RESOURCE_OPTIMIZED:-"FALSE"}
|
|
||||||
DEFAULT_S3_CERT_SKIP_VERIFY=${DEFAULT_S3_CERT_SKIP_VERIFY:-"TRUE"}
|
|
||||||
DEFAULT_S3_PROTOCOL=${DEFAULT_S3_PROTOCOL:-"https"}
|
|
||||||
DEFAULT_SCRIPT_LOCATION_PRE=${DEFAULT_SCRIPT_LOCATION_PRE:-"/assets/scripts/pre/"}
|
|
||||||
DEFAULT_SCRIPT_LOCATION_POST=${DEFAULT_SCRIPT_LOCATION_POST:-"/assets/scripts/post/"}
|
|
||||||
DEFAULT_SIZE_VALUE=${DEFAULT_SIZE_VALUE:-"bytes"}
|
|
||||||
DEFAULT_SKIP_AVAILABILITY_CHECK=${DEFAULT_SKIP_AVAILABILITY_CHECK:-"FALSE"}
|
|
||||||
DEFAULT_SPLIT_DB=${DEFAULT_SPLIT_DB:-"TRUE"}
|
|
||||||
LOG_PATH=${LOG_PATH:-"/logs"}
|
|
||||||
MANUAL_RUN_FOREVER=${MANUAL_RUN_FOREVER:-"TRUE"}
|
|
||||||
MODE=${MODE:-"AUTO"}
|
|
||||||
|
|
||||||
TEMP_PATH=${TEMP_PATH:-"/tmp/backups"}
|
|
||||||
if [ -n "${TEMP_LOCATION}" ] ; then TEMP_PATH=${TEMP_LOCATION:-"/tmp/backups"} ; fi # To be removed 4.3.0
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
4
install/etc/cont-finish.d/10-db-backup
Executable file
4
install/etc/cont-finish.d/10-db-backup
Executable file
@@ -0,0 +1,4 @@
|
|||||||
|
#!/usr/bin/with-contenv bash
|
||||||
|
|
||||||
|
pkill bash
|
||||||
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
#!/command/with-contenv bash
|
|
||||||
|
|
||||||
source /assets/functions/00-container
|
|
||||||
prepare_service single
|
|
||||||
prepare_service 03-monitoring
|
|
||||||
PROCESS_NAME="db-backup"
|
|
||||||
output_off
|
|
||||||
|
|
||||||
setup_mode
|
|
||||||
db_backup_container_init
|
|
||||||
create_schedulers backup
|
|
||||||
create_zabbix dbbackup4
|
|
||||||
|
|
||||||
liftoff
|
|
||||||
535
install/etc/services.available/10-db-backup/run
Executable file
535
install/etc/services.available/10-db-backup/run
Executable file
@@ -0,0 +1,535 @@
|
|||||||
|
#!/usr/bin/with-contenv bash
|
||||||
|
|
||||||
|
source /assets/functions/00-container
|
||||||
|
|
||||||
|
PROCESS_NAME="db-backup"
|
||||||
|
|
||||||
|
date >/dev/null
|
||||||
|
|
||||||
|
if [ "$1" != "NOW" ]; then
|
||||||
|
sleep 10
|
||||||
|
fi
|
||||||
|
|
||||||
|
### Sanity Test
|
||||||
|
sanity_var DB_TYPE "Database Type"
|
||||||
|
sanity_var DB_HOST "Database Host"
|
||||||
|
|
||||||
|
### Set the Database Type
|
||||||
|
dbtype=${DB_TYPE}
|
||||||
|
|
||||||
|
case "$dbtype" in
|
||||||
|
"couch" | "couchdb" | "COUCH" | "COUCHDB" )
|
||||||
|
dbtype=couch
|
||||||
|
dbport=${DB_PORT:-5984}
|
||||||
|
file_env 'DB_USER'
|
||||||
|
file_env 'DB_PASS'
|
||||||
|
;;
|
||||||
|
"influx" | "influxdb" | "INFLUX" | "INFLUXDB" )
|
||||||
|
dbtype=influx
|
||||||
|
dbport=${DB_PORT:-8088}
|
||||||
|
file_env 'DB_USER'
|
||||||
|
file_env 'DB_PASS'
|
||||||
|
;;
|
||||||
|
"mongo" | "mongodb" | "MONGO" | "MONGODB" )
|
||||||
|
dbtype=mongo
|
||||||
|
dbport=${DB_PORT:-27017}
|
||||||
|
[[ ( -n "${DB_USER}" ) || ( -n "${DB_USER_FILE}" ) ]] && file_env 'DB_USER'
|
||||||
|
[[ ( -n "${DB_PASS}" ) || ( -n "${DB_PASS_FILE}" ) ]] && file_env 'DB_PASS'
|
||||||
|
"mysql" | "MYSQL" | "mariadb" | "MARIADB")
|
||||||
|
dbtype=mysql
|
||||||
|
dbport=${DB_PORT:-3306}
|
||||||
|
[[ ( -n "${DB_PASS}" ) || ( -n "${DB_PASS_FILE}" ) ]] && file_env 'DB_PASS'
|
||||||
|
;;
|
||||||
|
"mssql" | "MSSQL" | "microsoftsql" | "MICROSOFTSQL")
|
||||||
|
apkArch="$(apk --print-arch)"; \
|
||||||
|
case "$apkArch" in
|
||||||
|
x86_64) mssql=true ;;
|
||||||
|
*) print_error "MSSQL cannot operate on $apkArch processor!" ; exit 1 ;;
|
||||||
|
esac
|
||||||
|
dbtype=mssql
|
||||||
|
dbport=${DB_PORT:-1433}
|
||||||
|
;;
|
||||||
|
"postgres" | "postgresql" | "pgsql" | "POSTGRES" | "POSTGRESQL" | "PGSQL" )
|
||||||
|
dbtype=pgsql
|
||||||
|
dbport=${DB_PORT:-5432}
|
||||||
|
[[ ( -n "${DB_PASS}" ) || ( -n "${DB_PASS_FILE}" ) ]] && file_env 'DB_PASS'
|
||||||
|
;;
|
||||||
|
"redis" | "REDIS" )
|
||||||
|
dbtype=redis
|
||||||
|
dbport=${DB_PORT:-6379}
|
||||||
|
[[ ( -n "${DB_PASS}" || ( -n "${DB_PASS_FILE}" ) ) ]] && file_env 'DB_PASS'
|
||||||
|
;;
|
||||||
|
"sqlite" | "sqlite3" | "SQLITE" | "SQLITE3" )
|
||||||
|
dbtype=sqlite3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
### Set Defaults
|
||||||
|
BACKUP_LOCATION=${BACKUP_LOCATION:-"FILESYSTEM"}
|
||||||
|
COMPRESSION=${COMPRESSION:-GZ}
|
||||||
|
COMPRESSION_LEVEL=${COMPRESSION_LEVEL:-"3"}
|
||||||
|
DB_DUMP_BEGIN=${DB_DUMP_BEGIN:-+0}
|
||||||
|
DB_DUMP_FREQ=${DB_DUMP_FREQ:-1440}
|
||||||
|
DB_DUMP_TARGET=${DB_DUMP_TARGET:-/backup}
|
||||||
|
dbhost=${DB_HOST}
|
||||||
|
dbname=${DB_NAME}
|
||||||
|
dbpass=${DB_PASS}
|
||||||
|
dbuser=${DB_USER}
|
||||||
|
MD5=${MD5:-TRUE}
|
||||||
|
PARALLEL_COMPRESSION=${PARALLEL_COMPRESSION:-TRUE}
|
||||||
|
SIZE_VALUE=${SIZE_VALUE:-"bytes"}
|
||||||
|
SPLIT_DB=${SPLIT_DB:-FALSE}
|
||||||
|
tmpdir=/tmp/backups
|
||||||
|
|
||||||
|
if [ "$BACKUP_TYPE" = "S3" ] || [ "$BACKUP_TYPE" = "s3" ] || [ "$BACKUP_TYPE" = "MINIO" ] || [ "$BACKUP_TYPE" = "minio" ] ; then
|
||||||
|
S3_PROTOCOL=${S3_PROTOCOL:-"https"}
|
||||||
|
sanity_var S3_HOST "S3 Host"
|
||||||
|
sanity_var S3_BUCKET "S3 Bucket"
|
||||||
|
sanity_var S3_KEY_ID "S3 Key ID"
|
||||||
|
sanity_var S3_KEY_SECRET "S3 Key Secret"
|
||||||
|
sanity_var S3_URI_STYLE "S3 URI Style (Virtualhost or Path)"
|
||||||
|
sanity_var S3_PATH "S3 Path"
|
||||||
|
file_env 'S3_KEY_ID'
|
||||||
|
file_env 'S3_KEY_SECRET'
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$1" = "NOW" ]; then
|
||||||
|
DB_DUMP_BEGIN=+0
|
||||||
|
MANUAL=TRUE
|
||||||
|
fi
|
||||||
|
|
||||||
|
### Set Compression Options
|
||||||
|
if var_true "$PARALLEL_COMPRESSION" ; then
|
||||||
|
bzip="pbzip2 -${COMPRESSION_LEVEL}"
|
||||||
|
gzip="pigz -${COMPRESSION_LEVEL}"
|
||||||
|
xzip="pixz -${COMPRESSION_LEVEL}"
|
||||||
|
zstd="zstd --rm -${COMPRESSION_LEVEL}"
|
||||||
|
else
|
||||||
|
bzip="bzip2 -${COMPRESSION_LEVEL}"
|
||||||
|
gzip="gzip -${COMPRESSION_LEVEL}"
|
||||||
|
xzip="xz -${COMPRESSION_LEVEL} "
|
||||||
|
zstd="zstd --rm -${COMPRESSION_LEVEL}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
### Set the Database Authentication Details
|
||||||
|
case "$dbtype" in
|
||||||
|
"mongo" )
|
||||||
|
[[ ( -n "${DB_USER}" ) ]] && MONGO_USER_STR=" --username ${dbuser}"
|
||||||
|
[[ ( -n "${DB_PASS}" ) ]] && MONGO_PASS_STR=" --password ${dbpass}"
|
||||||
|
[[ ( -n "${DB_NAME}" ) ]] && MONGO_DB_STR=" --db ${dbname}"
|
||||||
|
[[ ( -n "${DB_AUTH}" ) ]] && MONGO_AUTH_STR=" --authenticationDatabase ${DB_AUTH}"
|
||||||
|
;;
|
||||||
|
"mysql" )
|
||||||
|
[[ ( -n "${DB_PASS}" ) ]] && export MYSQL_PWD=${dbpass}
|
||||||
|
;;
|
||||||
|
"postgres" )
|
||||||
|
[[ ( -n "${DB_PASS}" ) ]] && POSTGRES_PASS_STR="PGPASSWORD=${dbpass}"
|
||||||
|
;;
|
||||||
|
"redis" )
|
||||||
|
[[ ( -n "${DB_PASS}" ) ]] && REDIS_PASS_STR=" -a ${dbpass}"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
### Functions
|
||||||
|
backup_couch() {
|
||||||
|
target=couch_${dbname}_${dbhost}_${now}.txt
|
||||||
|
compression
|
||||||
|
curl -X GET http://${dbhost}:${dbport}/${dbname}/_all_docs?include_docs=true ${dumpoutput} | $dumpoutput > ${tmpdir}/${target}
|
||||||
|
exit_code=$?
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
}
|
||||||
|
|
||||||
|
backup_influx() {
|
||||||
|
if [ "${COMPRESSION}" = "NONE" ] || [ "${COMPRESSION}" = "none" ] || [ "${COMPRESSION}" = "FALSE" ] || [ "${COMPRESSION}" = "false" ] ; then
|
||||||
|
:
|
||||||
|
else
|
||||||
|
print_notice "Compressing InfluxDB backup with gzip"
|
||||||
|
influx_compression="-portable"
|
||||||
|
fi
|
||||||
|
for DB in $DB_NAME; do
|
||||||
|
target=influx_${DB}_${dbhost}_${now}
|
||||||
|
influxd backup ${influx_compression} -database $DB -host ${dbhost}:${dbport} ${tmpdir}/${target}
|
||||||
|
exit_code=$?
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
backup_mongo() {
|
||||||
|
if [ "${COMPRESSION}" = "NONE" ] || [ "${COMPRESSION}" = "none" ] || [ "${COMPRESSION}" = "FALSE" ] || [ "${COMPRESSION}" = "false" ] ; then
|
||||||
|
target=${dbtype}_${dbname}_${dbhost}_${now}.archive
|
||||||
|
else
|
||||||
|
print_notice "Compressing MongoDB backup with gzip"
|
||||||
|
target=${dbtype}_${dbname}_${dbhost}_${now}.archivegz
|
||||||
|
mongo_compression="--gzip"
|
||||||
|
fi
|
||||||
|
mongodump --archive=${tmpdir}/${target} ${mongo_compression} --host ${dbhost} --port ${dbport} ${MONGO_USER_STR}${MONGO_PASS_STR}${MONGO_AUTH_STR}${MONGO_DB_STR} ${EXTRA_OPTS}
|
||||||
|
exit_code=$?
|
||||||
|
cd ${tmpdir}
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
}
|
||||||
|
|
||||||
|
backup_mssql() {
|
||||||
|
target=mssql_${dbname}_${dbhost}_${now}.bak
|
||||||
|
/opt/mssql-tools/bin/sqlcmd -E -C -S ${dbhost}\,${dbport} -U ${dbuser} -P ${dbpass} –Q "BACKUP DATABASE \[${dbname}\] TO DISK = N'${tmpdir}/${target}' WITH NOFORMAT, NOINIT, NAME = '${dbname}-full', SKIP, NOREWIND, NOUNLOAD, STATS = 10"
|
||||||
|
}
|
||||||
|
|
||||||
|
backup_mysql() {
|
||||||
|
if var_true "$SPLIT_DB" ; then
|
||||||
|
DATABASES=$(mysql -h ${dbhost} -P $dbport -u$dbuser --batch -e "SHOW DATABASES;" | grep -v Database|grep -v schema)
|
||||||
|
|
||||||
|
for db in $DATABASES; do
|
||||||
|
if [[ "$db" != "information_schema" ]] && [[ "$db" != _* ]] ; then
|
||||||
|
print_notice "Dumping MariaDB database: $db"
|
||||||
|
target=mysql_${db}_${dbhost}_${now}.sql
|
||||||
|
compression
|
||||||
|
mysqldump --max-allowed-packet=512M -h $dbhost -P $dbport -u$dbuser ${EXTRA_OPTS} --databases $db | $dumpoutput > ${tmpdir}/${target}
|
||||||
|
exit_code=$?
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
else
|
||||||
|
compression
|
||||||
|
mysqldump --max-allowed-packet=512M -A -h $dbhost -P $dbport -u$dbuser ${EXTRA_OPTS} | $dumpoutput > ${tmpdir}/${target}
|
||||||
|
exit_code=$?
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
backup_pgsql() {
|
||||||
|
if var_true $SPLIT_DB ; then
|
||||||
|
export PGPASSWORD=${dbpass}
|
||||||
|
authdb=${DB_USER}
|
||||||
|
[ -n "${DB_NAME}" ] && authdb=${DB_NAME}
|
||||||
|
DATABASES=$(psql -h $dbhost -U $dbuser -p ${dbport} -d ${authdb} -c 'COPY (SELECT datname FROM pg_database WHERE datistemplate = false) TO STDOUT;' )
|
||||||
|
for db in $DATABASES; do
|
||||||
|
print_info "Dumping database: $db"
|
||||||
|
target=pgsql_${db}_${dbhost}_${now}.sql
|
||||||
|
compression
|
||||||
|
pg_dump -h ${dbhost} -p ${dbport} -U ${dbuser} $db ${EXTRA_OPTS} | $dumpoutput > ${tmpdir}/${target}
|
||||||
|
exit_code=$?
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
done
|
||||||
|
else
|
||||||
|
export PGPASSWORD=${dbpass}
|
||||||
|
compression
|
||||||
|
pg_dump -h ${dbhost} -U ${dbuser} -p ${dbport} ${dbname} ${EXTRA_OPTS} | $dumpoutput > ${tmpdir}/${target}
|
||||||
|
exit_code=$?
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
backup_redis() {
|
||||||
|
target=redis_${db}_${dbhost}_${now}.rdb
|
||||||
|
echo bgsave | redis-cli -h ${dbhost} -p ${dbport} ${REDIS_PASS_STR} --rdb ${tmpdir}/${target} ${EXTRA_OPTS}
|
||||||
|
print_info "Dumping Redis - Flushing Redis Cache First"
|
||||||
|
sleep 10
|
||||||
|
try=5
|
||||||
|
while [ $try -gt 0 ] ; do
|
||||||
|
saved=$(echo 'info Persistence' | redis-cli -h ${dbhost} -p ${dbport} ${REDIS_PASS_STR} | awk '/rdb_bgsave_in_progress:0/{print "saved"}')
|
||||||
|
ok=$(echo 'info Persistence' | redis-cli -h ${dbhost} -p ${dbport} ${REDIS_PASS_STR} | awk '/rdb_last_bgsave_status:ok/{print "ok"}')
|
||||||
|
if [[ "$saved" = "saved" ]] && [[ "$ok" = "ok" ]]; then
|
||||||
|
print_info "Redis Backup Complete"
|
||||||
|
fi
|
||||||
|
try=$((try - 1))
|
||||||
|
print_info "Redis Busy - Waiting and retrying in 5 seconds"
|
||||||
|
sleep 5
|
||||||
|
done
|
||||||
|
generate_md5
|
||||||
|
compression
|
||||||
|
move_backup
|
||||||
|
}
|
||||||
|
|
||||||
|
backup_sqlite3() {
|
||||||
|
db=$(basename "$dbhost")
|
||||||
|
db="${db%.*}"
|
||||||
|
target=sqlite3_${db}_${now}.sqlite3
|
||||||
|
compression
|
||||||
|
|
||||||
|
print_info "Dumping sqlite3 database: ${dbhost}"
|
||||||
|
sqlite3 "${dbhost}" ".backup '${tmpdir}/backup.sqlite3'"
|
||||||
|
exit_code=$?
|
||||||
|
|
||||||
|
cat "${tmpdir}/backup.sqlite3" | $dumpoutput > "${tmpdir}/${target}"
|
||||||
|
|
||||||
|
generate_md5
|
||||||
|
move_backup
|
||||||
|
}
|
||||||
|
|
||||||
|
check_availability() {
|
||||||
|
### Set the Database Type
|
||||||
|
case "$dbtype" in
|
||||||
|
"couch" )
|
||||||
|
COUNTER=0
|
||||||
|
while ! (nc -z ${dbhost} ${dbport}) ; do
|
||||||
|
sleep 5
|
||||||
|
(( COUNTER+=5 ))
|
||||||
|
print_warn "CouchDB Host '${dbhost}' is not accessible, retrying.. ($COUNTER seconds so far)"
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
"influx" )
|
||||||
|
COUNTER=0
|
||||||
|
while ! (nc -z ${dbhost} ${dbport}) ; do
|
||||||
|
sleep 5
|
||||||
|
(( COUNTER+=5 ))
|
||||||
|
print_warn "InfluxDB Host '${dbhost}' is not accessible, retrying.. ($COUNTER seconds so far)"
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
"mongo" )
|
||||||
|
COUNTER=0
|
||||||
|
while ! (nc -z ${dbhost} ${dbport}) ; do
|
||||||
|
sleep 5
|
||||||
|
(( COUNTER+=5 ))
|
||||||
|
print_warn "Mongo Host '${dbhost}' is not accessible, retrying.. ($COUNTER seconds so far)"
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
"mysql" )
|
||||||
|
COUNTER=0
|
||||||
|
while true; do
|
||||||
|
mysqlcmd='mysql -u'${dbuser}' -P '${dbport}' -h '${dbhost}' -p'${dbpass}
|
||||||
|
out="$($mysqlcmd -e "SELECT COUNT(*) FROM information_schema.FILES;" 2>&1)"
|
||||||
|
echo "$out" | grep -E "COUNT|Enter" 2>&1 > /dev/null
|
||||||
|
if [ $? -eq 0 ]; then
|
||||||
|
:
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
print_warn "MySQL/MariaDB Server '${dbhost}' is not accessible, retrying.. ($COUNTER seconds so far)"
|
||||||
|
sleep 5
|
||||||
|
(( COUNTER+=5 ))
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
"mssql" )
|
||||||
|
COUNTER=0
|
||||||
|
while ! (nc -z ${dbhost} ${dbport}) ; do
|
||||||
|
sleep 5
|
||||||
|
(( COUNTER+=5 ))
|
||||||
|
print_warn "MSSQL Host '${dbhost}' is not accessible, retrying.. ($COUNTER seconds so far)"
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
"pgsql" )
|
||||||
|
COUNTER=0
|
||||||
|
export PGPASSWORD=${dbpass}
|
||||||
|
until pg_isready --dbname=${dbname} --host=${dbhost} --port=${dbport} --username=${dbuser} -q
|
||||||
|
do
|
||||||
|
sleep 5
|
||||||
|
(( COUNTER+=5 ))
|
||||||
|
print_warn "Postgres Host '${dbhost}' is not accessible, retrying.. ($COUNTER seconds so far)"
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
"redis" )
|
||||||
|
COUNTER=0
|
||||||
|
while ! (nc -z "${dbhost}" "${dbport}") ; do
|
||||||
|
sleep 5
|
||||||
|
(( COUNTER+=5 ))
|
||||||
|
print_warn "Redis Host '${dbhost}' is not accessible, retrying.. ($COUNTER seconds so far)"
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
"sqlite3" )
|
||||||
|
if [[ ! -e "${dbhost}" ]]; then
|
||||||
|
print_error "File '${dbhost}' does not exist."
|
||||||
|
exit_code=2
|
||||||
|
exit $exit_code
|
||||||
|
elif [[ ! -f "${dbhost}" ]]; then
|
||||||
|
print_error "File '${dbhost}' is not a file."
|
||||||
|
exit_code=2
|
||||||
|
exit $exit_code
|
||||||
|
elif [[ ! -r "${dbhost}" ]]; then
|
||||||
|
print_error "File '${dbhost}' is not readable."
|
||||||
|
exit_code=2
|
||||||
|
exit $exit_code
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
compression() {
|
||||||
|
case "$COMPRESSION" in
|
||||||
|
"GZ" | "gz" | "gzip" | "GZIP")
|
||||||
|
print_notice "Compressing backup with gzip"
|
||||||
|
target=${target}.gz
|
||||||
|
dumpoutput="$gzip "
|
||||||
|
;;
|
||||||
|
"BZ" | "bz" | "bzip2" | "BZIP2" | "bzip" | "BZIP" | "bz2" | "BZ2")
|
||||||
|
print_notice "Compressing backup with bzip2"
|
||||||
|
target=${target}.bz2
|
||||||
|
dumpoutput="$bzip "
|
||||||
|
;;
|
||||||
|
"XZ" | "xz" | "XZIP" | "xzip" )
|
||||||
|
print_notice "Compressing backup with xzip"
|
||||||
|
target=${target}.xz
|
||||||
|
dumpoutput="$xzip "
|
||||||
|
;;
|
||||||
|
"ZSTD" | "zstd" | "ZST" | "zst" )
|
||||||
|
print_notice "Compressing backup with zstd"
|
||||||
|
target=${target}.zst
|
||||||
|
dumpoutput="$zstd "
|
||||||
|
;;
|
||||||
|
"NONE" | "none" | "FALSE" | "false")
|
||||||
|
dumpoutput="cat "
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
generate_md5() {
|
||||||
|
if var_true "$MD5" ; then
|
||||||
|
print_notice "Generating MD5 for ${target}"
|
||||||
|
cd $tmpdir
|
||||||
|
md5sum "${target}" > "${target}".md5
|
||||||
|
MD5VALUE=$(md5sum "${target}" | awk '{ print $1}')
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
move_backup() {
|
||||||
|
case "$SIZE_VALUE" in
|
||||||
|
"b" | "bytes" )
|
||||||
|
SIZE_VALUE=1
|
||||||
|
|
||||||
|
;;
|
||||||
|
"[kK]" | "[kK][bB]" | "kilobytes" | "[mM]" | "[mM][bB]" | "megabytes" )
|
||||||
|
SIZE_VALUE="-h"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
SIZE_VALUE=1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
if [ "$SIZE_VALUE" = "1" ] ; then
|
||||||
|
FILESIZE=$(stat -c%s "${tmpdir}/${target}")
|
||||||
|
print_notice "Backup of ${target} created with the size of ${FILESIZE} bytes"
|
||||||
|
else
|
||||||
|
FILESIZE=$(du -h "${tmpdir}/${target}" | awk '{ print $1}')
|
||||||
|
print_notice "Backup of ${target} created with the size of ${FILESIZE}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
case "${BACKUP_LOCATION}" in
|
||||||
|
"FILE" | "file" | "filesystem" | "FILESYSTEM" )
|
||||||
|
mkdir -p "${DB_DUMP_TARGET}"
|
||||||
|
mv ${tmpdir}/*.md5 "${DB_DUMP_TARGET}"/
|
||||||
|
mv ${tmpdir}/"${target}" "${DB_DUMP_TARGET}"/"${target}"
|
||||||
|
;;
|
||||||
|
"S3" | "s3" | "MINIO" | "minio" )
|
||||||
|
export AWS_ACCESS_KEY_ID=${S3_KEY_ID}
|
||||||
|
export AWS_SECRET_ACCESS_KEY=${S3_KEY_SECRET}
|
||||||
|
export AWS_DEFAULT_REGION=ap-northeast-2
|
||||||
|
aws s3 cp ${tmpdir}/${target} s3://${S3_BUCKET}/${S3_PATH}/${target}
|
||||||
|
|
||||||
|
rm -rf ${tmpdir}/*.md5
|
||||||
|
rm -rf ${tmpdir}/"${target}"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
### Container Startup
|
||||||
|
print_debug "Backup routines Initialized on $(date)"
|
||||||
|
|
||||||
|
### Wait for Next time to start backup
|
||||||
|
if [ "$1" != "NOW" ]; then
|
||||||
|
current_time=$(date +"%s")
|
||||||
|
today=$(date +"%Y%m%d")
|
||||||
|
|
||||||
|
if [[ $DB_DUMP_BEGIN =~ ^\+(.*)$ ]]; then
|
||||||
|
waittime=$(( ${BASH_REMATCH[1]} * 60 ))
|
||||||
|
else
|
||||||
|
target_time=$(date --date="${today}${DB_DUMP_BEGIN}" +"%s")
|
||||||
|
if [[ "$target_time" < "$current_time" ]]; then
|
||||||
|
target_time=$(($target_time + 24*60*60))
|
||||||
|
fi
|
||||||
|
waittime=$(($target_time - $current_time))
|
||||||
|
fi
|
||||||
|
|
||||||
|
print_notice "Next Backup at $(date -d @${target_time} +"%Y-%m-%d %T %Z")"
|
||||||
|
sleep $waittime
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
### Commence Backup
|
||||||
|
while true; do
|
||||||
|
# make sure the directory exists
|
||||||
|
mkdir -p $tmpdir
|
||||||
|
|
||||||
|
### Define Target name
|
||||||
|
now=$(date +"%Y%m%d-%H%M%S")
|
||||||
|
now_time=$(date +"%H:%M:%S")
|
||||||
|
now_date=$(date +"%Y-%m-%d")
|
||||||
|
target=${dbtype}_${dbname}_${dbhost}_${now}.sql
|
||||||
|
|
||||||
|
### Take a Dump
|
||||||
|
case "$dbtype" in
|
||||||
|
"couch" )
|
||||||
|
check_availability
|
||||||
|
backup_couch
|
||||||
|
;;
|
||||||
|
"influx" )
|
||||||
|
check_availability
|
||||||
|
backup_influx
|
||||||
|
;;
|
||||||
|
"mssql" )
|
||||||
|
check_availability
|
||||||
|
backup_mssql
|
||||||
|
;;
|
||||||
|
"mysql" )
|
||||||
|
check_availability
|
||||||
|
backup_mysql
|
||||||
|
;;
|
||||||
|
"mongo" )
|
||||||
|
check_availability
|
||||||
|
backup_mongo
|
||||||
|
;;
|
||||||
|
"pgsql" )
|
||||||
|
check_availability
|
||||||
|
backup_pgsql
|
||||||
|
;;
|
||||||
|
"redis" )
|
||||||
|
check_availability
|
||||||
|
backup_redis
|
||||||
|
;;
|
||||||
|
"sqlite3" )
|
||||||
|
check_availability
|
||||||
|
backup_sqlite3
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
### Zabbix
|
||||||
|
if var_true "$ENABLE_ZABBIX" ; then
|
||||||
|
print_notice "Sending Backup Statistics to Zabbix"
|
||||||
|
silent zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -k dbbackup.size -o "$(stat -c%s "${DB_DUMP_TARGET}"/"${target}")"
|
||||||
|
silent zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -k dbbackup.datetime -o "$(date -r "${DB_DUMP_TARGET}"/"${target}" +'%s')"
|
||||||
|
fi
|
||||||
|
|
||||||
|
### Automatic Cleanup
|
||||||
|
if [[ -n "$DB_CLEANUP_TIME" ]]; then
|
||||||
|
print_notice "Cleaning up old backups"
|
||||||
|
find "${DB_DUMP_TARGET}"/ -mmin +"${DB_CLEANUP_TIME}" -iname "*" -exec rm {} \;
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$POST_SCRIPT" ] ; then
|
||||||
|
print_notice "Found POST_SCRIPT environment variable. Executing"
|
||||||
|
eval "${POST_SCRIPT}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
### Post Backup Custom Script Support
|
||||||
|
if [ -d /assets/custom-scripts/ ] ; then
|
||||||
|
print_notice "Found Custom Filesystem Scripts to Execute"
|
||||||
|
for f in $(find /assets/custom-scripts/ -name \*.sh -type f); do
|
||||||
|
print_notice "Running Script ${f}"
|
||||||
|
## script EXIT_CODE DB_TYPE DB_HOST DB_NAME DATE BACKUP_FILENAME FILESIZE MD5_VALUE
|
||||||
|
chmod +x "${f}"
|
||||||
|
${f} "${exit_code}" "${dbtype}" "${dbhost}" "${dbname}" "${now_date}" "${now_time}" "${target}" "${FILESIZE}" "${MD5VALUE}"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
### Go back to Sleep until next Backup time
|
||||||
|
if var_true $MANUAL ; then
|
||||||
|
exit 1;
|
||||||
|
else
|
||||||
|
sleep $(($DB_DUMP_FREQ*60))
|
||||||
|
fi
|
||||||
|
|
||||||
|
done
|
||||||
|
fi
|
||||||
4
install/usr/local/bin/backup-now
Executable file
4
install/usr/local/bin/backup-now
Executable file
@@ -0,0 +1,4 @@
|
|||||||
|
#!/usr/bin/with-contenv bash
|
||||||
|
|
||||||
|
echo '** Performing Manual Backup'
|
||||||
|
/etc/services.available/10-db-backup/run NOW
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
#!/command/with-contenv bash
|
|
||||||
|
|
||||||
source /assets/functions/00-container
|
|
||||||
source /assets/defaults/05-logging
|
|
||||||
source /assets/defaults/10-db-backup
|
|
||||||
|
|
||||||
## Compress each log 2 days old
|
|
||||||
timestamp_2dayold_unixtime="$(stat -c %Y "${LOG_PATH}"/"$(date --date='2 days ago' +'%Y%m%d')")"
|
|
||||||
for logfile in "${LOG_PATH}"/"$(date --date='2 days ago' +'%Y%m%d')"/"$(date --date='2 days ago' +'%Y%m%d')"_*.log ; do
|
|
||||||
sudo -u restic zstd --rm --rsyncable "${logfile}"
|
|
||||||
done
|
|
||||||
touch -t $(date -d"@${timestamp_2dayold_unixtime}" +'%Y%m%d%H%m.%S') "${LOG_PATH}"/"$(date --date='2 days ago' +'%Y%m%d')"
|
|
||||||
|
|
||||||
# Look fook files older than certain day and delete
|
|
||||||
if [ -n "${LOG_PATH}" ] && [ -d "${LOG_PATH}" ] ; then
|
|
||||||
find "${LOG_PATH}" -mtime +"${LOGROTATE_RETAIN_DAYS}" -type d -exec rm -rf {} +
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Look for stale symbolic links and delete accordingly
|
|
||||||
for symbolic_link in "${LOG_PATH}"/latest*.log ; do
|
|
||||||
if [ ! -e "${symbolic_link}" ] ; then
|
|
||||||
rm -rf "${symbolic_link}"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,316 +0,0 @@
|
|||||||
{
|
|
||||||
"zabbix_export": {
|
|
||||||
"version": "6.4",
|
|
||||||
"template_groups": [
|
|
||||||
{
|
|
||||||
"uuid": "10b88d2b3a3a4c72b43bdce9310e1162",
|
|
||||||
"name": "DB/Backup"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "748ad4d098d447d492bb935c907f652f",
|
|
||||||
"name": "Templates/Databases"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"templates": [
|
|
||||||
{
|
|
||||||
"uuid": "5a16c1bd694145389eed5ee803d954cc",
|
|
||||||
"template": "DB Backup4",
|
|
||||||
"name": "DB Backup4",
|
|
||||||
"description": "Template for Docker DB Backup Image\n\nMeant for use specifically with https://github.com/tiredofit/docker-db-backup Version > 4.0.0\n\nSupports auto discovery of backup jobs and creates graphs and triggers",
|
|
||||||
"groups": [
|
|
||||||
{
|
|
||||||
"name": "DB/Backup"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Templates/Databases"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"discovery_rules": [
|
|
||||||
{
|
|
||||||
"uuid": "94bb6f862e1841f8b2834b04c41c1d86",
|
|
||||||
"name": "Backup",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup",
|
|
||||||
"delay": "0",
|
|
||||||
"item_prototypes": [
|
|
||||||
{
|
|
||||||
"uuid": "5a2c4d1cacf844829bc1fbf912e071c5",
|
|
||||||
"name": "[{#NAME}] Checksum - Duration",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.checksum.duration.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "7d",
|
|
||||||
"units": "uptime",
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "6e49769ec07344a4974b13dab00c3539",
|
|
||||||
"name": "[{#NAME}] Checksum - Hash",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.checksum.hash.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "30d",
|
|
||||||
"trends": "0",
|
|
||||||
"value_type": "TEXT",
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "bb6472e30bff4d9c908b1d34b893e622",
|
|
||||||
"name": "[{#NAME}] Backup - Last Backup",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.datetime.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "7d",
|
|
||||||
"units": "unixtime",
|
|
||||||
"description": "Datestamp of last database backup",
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"trigger_prototypes": [
|
|
||||||
{
|
|
||||||
"uuid": "3681b56bb882466fb304a48b4beb15f0",
|
|
||||||
"expression": "fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],172800s)=0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],259200s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],345600s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],432800s)<>0",
|
|
||||||
"name": "[{#NAME}] No backups detected in 2 days",
|
|
||||||
"priority": "HIGH",
|
|
||||||
"manual_close": "YES"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "6c70136c84994197b6396a143b4e956f",
|
|
||||||
"expression": "fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],172800s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],259200s)=0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],345600s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],432800s)<>0",
|
|
||||||
"name": "[{#NAME}] No backups detected in 3 days",
|
|
||||||
"priority": "DISASTER",
|
|
||||||
"manual_close": "YES"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "d2038025cab643019cb9610c301f0cb9",
|
|
||||||
"expression": "fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],172800s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],259200s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],345600s)=0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],432800s)<>0",
|
|
||||||
"name": "[{#NAME}] No backups detected in 4 days",
|
|
||||||
"priority": "DISASTER",
|
|
||||||
"manual_close": "YES"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "ea85f02d032c4a1dbc1b6e91a3b2b37b",
|
|
||||||
"expression": "fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],172800s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],259200s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],345600s)<>0 and fuzzytime(/DB Backup4/dbbackup.backup.datetime.[{#NAME}],432800s)=0",
|
|
||||||
"name": "[{#NAME}] No backups detected in 5 days",
|
|
||||||
"priority": "DISASTER",
|
|
||||||
"manual_close": "YES"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "8ec2b2f44ddf4f36b3dbb2aa15e3a32f",
|
|
||||||
"name": "[{#NAME}] Backup - Duration",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.duration.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "7d",
|
|
||||||
"units": "uptime",
|
|
||||||
"description": "How long the DB Backup job took",
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "3f0dc3c75261447c93482815c3d69524",
|
|
||||||
"name": "[{#NAME}] Encrypt - Duration",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.encrypt.duration.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "7d",
|
|
||||||
"units": "uptime",
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "c3d5ad0789c443859d6a673e03db9cec",
|
|
||||||
"name": "[{#NAME}] Backup - Filename",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.filename.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "30d",
|
|
||||||
"trends": "0",
|
|
||||||
"value_type": "TEXT",
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "43b700c03897465eb7e49bbfe8fc9fc5",
|
|
||||||
"name": "[{#NAME}] Backup - Size",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.size.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "7d",
|
|
||||||
"description": "Backup Size",
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"trigger_prototypes": [
|
|
||||||
{
|
|
||||||
"uuid": "849f8660bee04427aff55af47b6f509c",
|
|
||||||
"expression": "last(/DB Backup4/dbbackup.backup.size.[{#NAME}])/last(/DB Backup4/dbbackup.backup.size.[{#NAME}],#2)>1.2",
|
|
||||||
"name": "[{#NAME}] Backup 20% Greater in size",
|
|
||||||
"priority": "WARNING",
|
|
||||||
"manual_close": "YES"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "74d16a7680544c65af22cc568ce3d59d",
|
|
||||||
"expression": "last(/DB Backup4/dbbackup.backup.size.[{#NAME}])/last(/DB Backup4/dbbackup.backup.size.[{#NAME}],#2)<0.2",
|
|
||||||
"name": "[{#NAME}] Backup 20% Smaller in Size",
|
|
||||||
"priority": "WARNING",
|
|
||||||
"manual_close": "YES"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "5595d769c73f4eaeadda95c84c2c0f17",
|
|
||||||
"expression": "last(/DB Backup4/dbbackup.backup.size.[{#NAME}])<1K",
|
|
||||||
"name": "[{#NAME}] Backup Empty",
|
|
||||||
"priority": "HIGH",
|
|
||||||
"manual_close": "YES"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "a6fc542a565c4baba8429ed9ab31b5ae",
|
|
||||||
"name": "[{#NAME}] Backup - Status",
|
|
||||||
"type": "TRAP",
|
|
||||||
"key": "dbbackup.backup.status.[{#NAME}]",
|
|
||||||
"delay": "0",
|
|
||||||
"history": "7d",
|
|
||||||
"description": "Maps exit code by DB Backup procedure",
|
|
||||||
"valuemap": {
|
|
||||||
"name": "Backup Status"
|
|
||||||
},
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Application",
|
|
||||||
"value": "DB Backup"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"trigger_prototypes": [
|
|
||||||
{
|
|
||||||
"uuid": "74b91e28453b4c2a84743f5e371495c1",
|
|
||||||
"expression": "last(/DB Backup4/dbbackup.backup.status.[{#NAME}])=1",
|
|
||||||
"name": "[{#NAME}] Backup - Failed with errors",
|
|
||||||
"priority": "WARNING",
|
|
||||||
"manual_close": "YES"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"graph_prototypes": [
|
|
||||||
{
|
|
||||||
"uuid": "b5e8e9fe0c474fedba2b06366234afdf",
|
|
||||||
"name": "[{#NAME}] Backup Duration",
|
|
||||||
"graph_items": [
|
|
||||||
{
|
|
||||||
"color": "199C0D",
|
|
||||||
"calc_fnc": "ALL",
|
|
||||||
"item": {
|
|
||||||
"host": "DB Backup4",
|
|
||||||
"key": "dbbackup.backup.duration.[{#NAME}]"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "99b5deb4e28f40059c50846c7be2ef26",
|
|
||||||
"name": "[{#NAME}] Backup Size",
|
|
||||||
"graph_items": [
|
|
||||||
{
|
|
||||||
"color": "199C0D",
|
|
||||||
"calc_fnc": "ALL",
|
|
||||||
"item": {
|
|
||||||
"host": "DB Backup4",
|
|
||||||
"key": "dbbackup.backup.size.[{#NAME}]"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "8c641e33659e4c8b866da64e252cfc2a",
|
|
||||||
"name": "[{#NAME}] Checksum Duration",
|
|
||||||
"graph_items": [
|
|
||||||
{
|
|
||||||
"color": "199C0D",
|
|
||||||
"calc_fnc": "ALL",
|
|
||||||
"item": {
|
|
||||||
"host": "DB Backup4",
|
|
||||||
"key": "dbbackup.backup.checksum.duration.[{#NAME}]"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uuid": "65b8770f71ed4cff9111b82c42b17571",
|
|
||||||
"name": "[{#NAME}] Encrypt Duration",
|
|
||||||
"graph_items": [
|
|
||||||
{
|
|
||||||
"color": "199C0D",
|
|
||||||
"calc_fnc": "ALL",
|
|
||||||
"item": {
|
|
||||||
"host": "DB Backup4",
|
|
||||||
"key": "dbbackup.backup.encrypt.duration.[{#NAME}]"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"tags": [
|
|
||||||
{
|
|
||||||
"tag": "Service",
|
|
||||||
"value": "Backup"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"tag": "Service",
|
|
||||||
"value": "Database"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"valuemaps": [
|
|
||||||
{
|
|
||||||
"uuid": "92a87279388b4fd1ac51c1e417e1776e",
|
|
||||||
"name": "Backup Status",
|
|
||||||
"mappings": [
|
|
||||||
{
|
|
||||||
"value": "0",
|
|
||||||
"newvalue": "OK"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "GREATER_OR_EQUAL",
|
|
||||||
"value": "1",
|
|
||||||
"newvalue": "FAIL"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
270
zabbix_templates/service_dbbackup.xml
Normal file
270
zabbix_templates/service_dbbackup.xml
Normal file
@@ -0,0 +1,270 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<zabbix_export>
|
||||||
|
<version>3.4</version>
|
||||||
|
<date>2018-02-02T19:03:49Z</date>
|
||||||
|
<groups>
|
||||||
|
<group>
|
||||||
|
<name>DB - Backup</name>
|
||||||
|
</group>
|
||||||
|
<group>
|
||||||
|
<name>Templates</name>
|
||||||
|
</group>
|
||||||
|
</groups>
|
||||||
|
<templates>
|
||||||
|
<template>
|
||||||
|
<template>Service - DB Backup</template>
|
||||||
|
<name>Service - DB Backup</name>
|
||||||
|
<description/>
|
||||||
|
<groups>
|
||||||
|
<group>
|
||||||
|
<name>DB - Backup</name>
|
||||||
|
</group>
|
||||||
|
<group>
|
||||||
|
<name>Templates</name>
|
||||||
|
</group>
|
||||||
|
</groups>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>DB Backup</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<items>
|
||||||
|
<item>
|
||||||
|
<name>Backup Time</name>
|
||||||
|
<type>2</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>dbbackup.datetime</key>
|
||||||
|
<delay>0</delay>
|
||||||
|
<history>365d</history>
|
||||||
|
<trends>365d</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>3</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units>unixtime</units>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>DB Backup</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<name>Backup Size</name>
|
||||||
|
<type>2</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>dbbackup.size</key>
|
||||||
|
<delay>0</delay>
|
||||||
|
<history>365d</history>
|
||||||
|
<trends>365d</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>3</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units>byte</units>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>DB Backup</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
</items>
|
||||||
|
<discovery_rules/>
|
||||||
|
<httptests/>
|
||||||
|
<macros/>
|
||||||
|
<templates/>
|
||||||
|
<screens/>
|
||||||
|
</template>
|
||||||
|
</templates>
|
||||||
|
<triggers>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - DB Backup:dbbackup.size.change()}>20</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>DB Backup is 20% Greater in Size</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>2</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>1</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - DB Backup:dbbackup.size.change()}<20</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>DB Backup is 20% Smaller in Size</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>2</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>1</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - DB Backup:dbbackup.size.last()}<1K</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>DB Backup is empty</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>4</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - DB Backup:dbbackup.datetime.fuzzytime(172800)}=0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(259200)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(345600)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(432800)}<>0</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>No Backups occurred in 2 days</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>3</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - DB Backup:dbbackup.datetime.fuzzytime(172800)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(259200)}=0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(345600)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(432800)}<>0</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>No Backups occurred in 3 days</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>3</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - DB Backup:dbbackup.datetime.fuzzytime(172800)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(259200)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(345600)}=0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(432800)}<>0</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>No Backups occurred in 4 days</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>3</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - DB Backup:dbbackup.datetime.fuzzytime(172800)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(259200)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(345600)}<>0 and {Service - DB Backup:dbbackup.datetime.fuzzytime(432800)}=0</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>No Backups occurred in 5 days or more</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>4</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
</triggers>
|
||||||
|
<graphs>
|
||||||
|
<graph>
|
||||||
|
<name>Backup Size</name>
|
||||||
|
<width>900</width>
|
||||||
|
<height>200</height>
|
||||||
|
<yaxismin>0.0000</yaxismin>
|
||||||
|
<yaxismax>100.0000</yaxismax>
|
||||||
|
<show_work_period>1</show_work_period>
|
||||||
|
<show_triggers>1</show_triggers>
|
||||||
|
<type>1</type>
|
||||||
|
<show_legend>1</show_legend>
|
||||||
|
<show_3d>0</show_3d>
|
||||||
|
<percent_left>0.0000</percent_left>
|
||||||
|
<percent_right>0.0000</percent_right>
|
||||||
|
<ymin_type_1>0</ymin_type_1>
|
||||||
|
<ymax_type_1>0</ymax_type_1>
|
||||||
|
<ymin_item_1>0</ymin_item_1>
|
||||||
|
<ymax_item_1>0</ymax_item_1>
|
||||||
|
<graph_items>
|
||||||
|
<graph_item>
|
||||||
|
<sortorder>0</sortorder>
|
||||||
|
<drawtype>0</drawtype>
|
||||||
|
<color>1A7C11</color>
|
||||||
|
<yaxisside>0</yaxisside>
|
||||||
|
<calc_fnc>2</calc_fnc>
|
||||||
|
<type>0</type>
|
||||||
|
<item>
|
||||||
|
<host>Service - DB Backup</host>
|
||||||
|
<key>dbbackup.size</key>
|
||||||
|
</item>
|
||||||
|
</graph_item>
|
||||||
|
</graph_items>
|
||||||
|
</graph>
|
||||||
|
</graphs>
|
||||||
|
</zabbix_export>
|
||||||
515
zabbix_templates/zabbix_agent_container.xml
Normal file
515
zabbix_templates/zabbix_agent_container.xml
Normal file
@@ -0,0 +1,515 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<zabbix_export>
|
||||||
|
<version>3.4</version>
|
||||||
|
<date>2018-02-02T19:04:27Z</date>
|
||||||
|
<groups>
|
||||||
|
<group>
|
||||||
|
<name>Discovered Containers</name>
|
||||||
|
</group>
|
||||||
|
<group>
|
||||||
|
<name>Templates</name>
|
||||||
|
</group>
|
||||||
|
</groups>
|
||||||
|
<templates>
|
||||||
|
<template>
|
||||||
|
<template>Service - ICMP</template>
|
||||||
|
<name>Service - ICMP (Ping)</name>
|
||||||
|
<description/>
|
||||||
|
<groups>
|
||||||
|
<group>
|
||||||
|
<name>Templates</name>
|
||||||
|
</group>
|
||||||
|
</groups>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>ICMP</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<items>
|
||||||
|
<item>
|
||||||
|
<name>ICMP ping</name>
|
||||||
|
<type>3</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>icmpping</key>
|
||||||
|
<delay>1m</delay>
|
||||||
|
<history>1w</history>
|
||||||
|
<trends>365d</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>3</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units/>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>ICMP</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap>
|
||||||
|
<name>Service state</name>
|
||||||
|
</valuemap>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<name>ICMP loss</name>
|
||||||
|
<type>3</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>icmppingloss</key>
|
||||||
|
<delay>1m</delay>
|
||||||
|
<history>1w</history>
|
||||||
|
<trends>365d</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>0</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units>%</units>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>ICMP</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<name>ICMP response time</name>
|
||||||
|
<type>3</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>icmppingsec</key>
|
||||||
|
<delay>1m</delay>
|
||||||
|
<history>1w</history>
|
||||||
|
<trends>365d</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>0</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units>s</units>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>ICMP</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
</items>
|
||||||
|
<discovery_rules/>
|
||||||
|
<httptests/>
|
||||||
|
<macros/>
|
||||||
|
<templates/>
|
||||||
|
<screens/>
|
||||||
|
</template>
|
||||||
|
<template>
|
||||||
|
<template>Zabbix - Container Agent</template>
|
||||||
|
<name>Zabbix - Container Agent</name>
|
||||||
|
<description/>
|
||||||
|
<groups>
|
||||||
|
<group>
|
||||||
|
<name>Discovered Containers</name>
|
||||||
|
</group>
|
||||||
|
<group>
|
||||||
|
<name>Templates</name>
|
||||||
|
</group>
|
||||||
|
</groups>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>Packages</name>
|
||||||
|
</application>
|
||||||
|
<application>
|
||||||
|
<name>Zabbix agent</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<items>
|
||||||
|
<item>
|
||||||
|
<name>Hostname of Container</name>
|
||||||
|
<type>0</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>agent.hostname</key>
|
||||||
|
<delay>1h</delay>
|
||||||
|
<history>1w</history>
|
||||||
|
<trends>0</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>1</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units/>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>3</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>Zabbix agent</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<name>Contaner OS</name>
|
||||||
|
<type>0</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>agent.os</key>
|
||||||
|
<delay>6h</delay>
|
||||||
|
<history>30d</history>
|
||||||
|
<trends>0</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>1</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units/>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>5</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>Zabbix agent</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<name>Zabbix Agent ping</name>
|
||||||
|
<type>0</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>agent.ping</key>
|
||||||
|
<delay>1m</delay>
|
||||||
|
<history>1w</history>
|
||||||
|
<trends>365d</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>3</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units/>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description>The agent always returns 1 for this item. It could be used in combination with nodata() for availability check.</description>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>Zabbix agent</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap>
|
||||||
|
<name>Zabbix agent ping status</name>
|
||||||
|
</valuemap>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<name>Zabbix Agent Version</name>
|
||||||
|
<type>0</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>agent.version</key>
|
||||||
|
<delay>1h</delay>
|
||||||
|
<history>1w</history>
|
||||||
|
<trends>0</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>1</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units/>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>Zabbix agent</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<name>Upgradable Packages</name>
|
||||||
|
<type>0</type>
|
||||||
|
<snmp_community/>
|
||||||
|
<snmp_oid/>
|
||||||
|
<key>packages.upgradable</key>
|
||||||
|
<delay>6h</delay>
|
||||||
|
<history>90d</history>
|
||||||
|
<trends>365d</trends>
|
||||||
|
<status>0</status>
|
||||||
|
<value_type>3</value_type>
|
||||||
|
<allowed_hosts/>
|
||||||
|
<units/>
|
||||||
|
<snmpv3_contextname/>
|
||||||
|
<snmpv3_securityname/>
|
||||||
|
<snmpv3_securitylevel>0</snmpv3_securitylevel>
|
||||||
|
<snmpv3_authprotocol>0</snmpv3_authprotocol>
|
||||||
|
<snmpv3_authpassphrase/>
|
||||||
|
<snmpv3_privprotocol>0</snmpv3_privprotocol>
|
||||||
|
<snmpv3_privpassphrase/>
|
||||||
|
<params/>
|
||||||
|
<ipmi_sensor/>
|
||||||
|
<authtype>0</authtype>
|
||||||
|
<username/>
|
||||||
|
<password/>
|
||||||
|
<publickey/>
|
||||||
|
<privatekey/>
|
||||||
|
<port/>
|
||||||
|
<description/>
|
||||||
|
<inventory_link>0</inventory_link>
|
||||||
|
<applications>
|
||||||
|
<application>
|
||||||
|
<name>Packages</name>
|
||||||
|
</application>
|
||||||
|
</applications>
|
||||||
|
<valuemap/>
|
||||||
|
<logtimefmt/>
|
||||||
|
<preprocessing/>
|
||||||
|
<jmx_endpoint/>
|
||||||
|
<master_item/>
|
||||||
|
</item>
|
||||||
|
</items>
|
||||||
|
<discovery_rules/>
|
||||||
|
<httptests/>
|
||||||
|
<macros/>
|
||||||
|
<templates/>
|
||||||
|
<screens/>
|
||||||
|
</template>
|
||||||
|
</templates>
|
||||||
|
<triggers>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - ICMP:icmpping.max(3m)}=3</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>Cannot be pinged</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>5</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - ICMP:icmppingloss.min(10m)}>50</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>Ping loss is too high</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>4</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<name>Cannot be pinged</name>
|
||||||
|
<expression>{Service - ICMP:icmpping.max(3m)}=3</expression>
|
||||||
|
<recovery_expression/>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Service - ICMP:icmppingsec.avg(2m)}>100</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>Ping Response time is too high</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>4</priority>
|
||||||
|
<description/>
|
||||||
|
<type>1</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<name>Cannot be pinged</name>
|
||||||
|
<expression>{Service - ICMP:icmpping.max(3m)}=3</expression>
|
||||||
|
<recovery_expression/>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Zabbix - Container Agent:packages.upgradable.last()}>0</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>Upgraded Packages in Container Available</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>1</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
<trigger>
|
||||||
|
<expression>{Zabbix - Container Agent:agent.ping.nodata(3m)}=1</expression>
|
||||||
|
<recovery_mode>0</recovery_mode>
|
||||||
|
<recovery_expression/>
|
||||||
|
<name>Zabbix agent is unreachable</name>
|
||||||
|
<correlation_mode>0</correlation_mode>
|
||||||
|
<correlation_tag/>
|
||||||
|
<url/>
|
||||||
|
<status>0</status>
|
||||||
|
<priority>5</priority>
|
||||||
|
<description/>
|
||||||
|
<type>0</type>
|
||||||
|
<manual_close>0</manual_close>
|
||||||
|
<dependencies/>
|
||||||
|
<tags/>
|
||||||
|
</trigger>
|
||||||
|
</triggers>
|
||||||
|
<value_maps>
|
||||||
|
<value_map>
|
||||||
|
<name>Service state</name>
|
||||||
|
<mappings>
|
||||||
|
<mapping>
|
||||||
|
<value>0</value>
|
||||||
|
<newvalue>Down</newvalue>
|
||||||
|
</mapping>
|
||||||
|
<mapping>
|
||||||
|
<value>1</value>
|
||||||
|
<newvalue>Up</newvalue>
|
||||||
|
</mapping>
|
||||||
|
</mappings>
|
||||||
|
</value_map>
|
||||||
|
<value_map>
|
||||||
|
<name>Zabbix agent ping status</name>
|
||||||
|
<mappings>
|
||||||
|
<mapping>
|
||||||
|
<value>1</value>
|
||||||
|
<newvalue>Up</newvalue>
|
||||||
|
</mapping>
|
||||||
|
</mappings>
|
||||||
|
</value_map>
|
||||||
|
</value_maps>
|
||||||
|
</zabbix_export>
|
||||||
Reference in New Issue
Block a user