What is this?
Backup tool for PowerDNS database (MySQL) to local or S3 storage in bind format. Open metrics are also computed on your feched zones.
PyPI
Deploy the pdnsbackup tool in your server with the pip command.
pip install pdnsbackup
Usage
After installation, you can execute the pdnsbackup to start-it.
$ pdnsbackup -h
usage: -c [-h] [-c C] [-e E] [-v]
options:
-h, --help show this help message and exit
-c C external config file
-e E env config file
-v debug mode
Configuration
This tool can be configurated with severals ways. See the default config file:
-
from external configuration file (
-c configargument) -
from environment variables (
-e env fileargument)
| Variables | Description |
|---|---|
| PDNSBACKUP_DEBUG | debug mode 1 or 0 |
| PDNSBACKUP_GMYSQL_ENABLED | set to 1 to enable gmysql backend, enabled by default |
| PDNSBACKUP_GMYSQL_HOST | mysql port, default is 127.0.0.1 |
| PDNSBACKUP_GMYSQL_PORT | mysql port, default is 3306 |
| PDNSBACKUP_GMYSQL_SSL | enable ssl, default is 0 |
| PDNSBACKUP_GMYSQL_DBNAME | mysql database name |
| PDNSBACKUP_GMYSQL_USER | mysql user |
| PDNSBACKUP_GMYSQL_PASSWORD | mysql password |
| PDNSBACKUP_FILE_ENABLED | set to 1 enable backup to file, enabled by default |
| PDNSBACKUP_FILE_PATH_BIND | zone bind path in named.conf |
| PDNSBACKUP_FILE_PATH_OUTPUT | output folder of the export |
| PDNSBACKUP_S3_ENABLED | set to 1 enable backup to S3 storage, disabled by default |
| PDNSBACKUP_S3_ENDPOINT_URL | your s3 url |
| PDNSBACKUP_S3_SSL_VERIFY | disable ssl verify |
| PDNSBACKUP_S3_ACCESS_KEY_ID | your access key |
| PDNSBACKUP_S3_SECRET_ACCESS_KEY | your secret access key |
| PDNSBACKUP_S3_BUCKET_NAME | bucket name |
| PDNSBACKUP_S3_BACKUP_FILE | backup file name |
| PDNSBACKUP_S3_BACKUP_DELETE_OLDER | delete backups older than xx days |
| PDNSBACKUP_METRICS_ENABLED | export open metrics |
| PDNSBACKUP_METRICS_PROM_FILE | write metrics to file path |
Metrics
This tool can be used to compute statistics on your DNS records.
| Variables | Description |
|---|---|
| pdnsbackup_status | Status of the backup process |
| pdnsbackup_zones_total | Total number of zones |
| pdnsbackup_zones_empty_total | Total number of empty zones |
| pdnsbackup_records_total | Total number of records per DNS zones |
| pdnsbackup_wildcards_total | Total number of DNS wilcards |
| pdnsbackup_delegations_total | Total number of DNS delegations |
| pdnsbackup_rrtypes_total | Total number of records per type (A, AAAA, CNAME, ...) |
Docker run
sudo docker run --rm --env-file ./.env --name=pdnsbackup dmachard/pdnsbackup:latest
Run from source
Create a .env file to populate your variable
Create a virtualenv
python -m venv venv
source venv/bin/activate
Install requirements and run-it
python3 -m pip install -r requirements.txt
python3 -c "import pdnsbackup; pdnsbackup.run();"
python3 -c "import pdnsbackup; pdnsbackup.run();" -c tests/config.yml
python3 -c "import pdnsbackup; pdnsbackup.run();" -e tests/.env
Build and run from docker image
sudo docker build . --file Dockerfile -t pdnsbackup
Run tests
Run all tests
python -m unittest discover -v tests/
Run one by one
python -m unittest -v tests.test_config
python -m unittest -v tests.test_parser
python -m unittest -v tests.test_import
python -m unittest -v tests.test_export_file
python -m unittest -v tests.test_export_metrics
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pdnsbackup-1.0.11.tar.gz.
File metadata
- Download URL: pdnsbackup-1.0.11.tar.gz
- Upload date:
- Size: 13.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e5baa565cae46f5dad5a388dc8d9e4a9b84bbdbd45b943a5376b2ff5a25a961d
|
|
| MD5 |
7ad39aae601807ff8418a20b3b3a4c50
|
|
| BLAKE2b-256 |
e32fe82ad65d4e6cede6a9e20d0cdb1478a5d5a5ccef15a8230de6b96d23e42f
|
Provenance
The following attestation bundles were made for pdnsbackup-1.0.11.tar.gz:
Publisher:
publish.yml on dmachard/pdns-backup
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pdnsbackup-1.0.11.tar.gz -
Subject digest:
e5baa565cae46f5dad5a388dc8d9e4a9b84bbdbd45b943a5376b2ff5a25a961d - Sigstore transparency entry: 2311267762
- Sigstore integration time:
-
Permalink:
dmachard/pdns-backup@b13c3cd680fd25e4040b10b185097ecd513aa822 -
Branch / Tag:
refs/tags/v1.0.11 - Owner: https://github.com/dmachard
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b13c3cd680fd25e4040b10b185097ecd513aa822 -
Trigger Event:
release
-
Statement type:
File details
Details for the file pdnsbackup-1.0.11-py3-none-any.whl.
File metadata
- Download URL: pdnsbackup-1.0.11-py3-none-any.whl
- Upload date:
- Size: 10.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
349bb1c9d24634c52d39a47229f8d3967e2e190f2f3e5911147e83ee6dca353a
|
|
| MD5 |
133300b48c41806cd96fd9eaf6b54526
|
|
| BLAKE2b-256 |
c09d2e301099848c4d3cf8300d587e3baadf884641c2a187432fba6dc8ad8253
|
Provenance
The following attestation bundles were made for pdnsbackup-1.0.11-py3-none-any.whl:
Publisher:
publish.yml on dmachard/pdns-backup
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pdnsbackup-1.0.11-py3-none-any.whl -
Subject digest:
349bb1c9d24634c52d39a47229f8d3967e2e190f2f3e5911147e83ee6dca353a - Sigstore transparency entry: 2311267803
- Sigstore integration time:
-
Permalink:
dmachard/pdns-backup@b13c3cd680fd25e4040b10b185097ecd513aa822 -
Branch / Tag:
refs/tags/v1.0.11 - Owner: https://github.com/dmachard
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b13c3cd680fd25e4040b10b185097ecd513aa822 -
Trigger Event:
release
-
Statement type:
