From a99094d2564a70ee32bdf34a30908d82fe998375 Mon Sep 17 00:00:00 2001 From: Peter Schiffer Date: Tue, 22 Aug 2017 23:16:13 +0200 Subject: [PATCH] Updated README --- README.md | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 94 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9f86bff..8230b92 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,20 @@ # PowerDNS Docker Images -This repository contains two Docker images - pdns-mysql and pdns-admin. Image **pdns-mysql** contains completely configurable [PowerDNS 4.x server](https://www.powerdns.com/) with mysql backend (without mysql server). Image **pdns-admin** contains [PowerDNS Admin](https://github.com/ngoduykhanh/PowerDNS-Admin) web app, written in Flask, for managing PowerDNS servers. Pdns-admin is also completely configurable, running under uWSGI with nginx. +This repository contains four Docker images - pdns-mysql, pdns-admin-static, pdns-admin-uwsgi and deprecated pdns-admin. Image **pdns-mysql** contains completely configurable [PowerDNS 4.x server](https://www.powerdns.com/) with mysql backend (without mysql server). Images **pdns-admin-static** and **pdns-admin-uwsgi** contains fronted (nginx) and backend (uWSGI) for [PowerDNS Admin](https://git.omicroninteractive.com/0x97/powerdns-admin) web app, written in Flask, for managing PowerDNS servers. Pdns-admin is also completely configurable. Deprecated **pdns-admin** contains PowerDNS Admin in single image where both nginx and uWSGI processes are managed by systemd. This image won't be updated anymore. + +All images are available on Docker Hub: + +https://hub.docker.com/r/pschiffe/pdns-mysql/ +https://hub.docker.com/r/pschiffe/pdns-admin-uwsgi/ +https://hub.docker.com/r/pschiffe/pdns-admin-static/ +https://hub.docker.com/r/pschiffe/pdns-admin/ ## pdns-mysql [![](https://images.microbadger.com/badges/image/pschiffe/pdns-mysql.svg)](http://microbadger.com/images/pschiffe/pdns-mysql "Get your own image badge on microbadger.com") +https://hub.docker.com/r/pschiffe/pdns-mysql/ + Docker image with [PowerDNS 4.x server](https://www.powerdns.com/) and mysql backend (without mysql server). For running, it needs external mysql server. Env vars for mysql configuration: ``` (name=default value) @@ -57,10 +66,89 @@ docker run -d -p 53:53 -p 53:53/udp --name pdns-slave \ pschiffe/pdns-mysql ``` -## pdns-admin +## pdns-admin-uwsgi + +[![](https://images.microbadger.com/badges/image/pschiffe/pdns-admin-uwsgi.svg)](https://microbadger.com/images/pschiffe/pdns-admin-uwsgi "Get your own image badge on microbadger.com") + +https://hub.docker.com/r/pschiffe/pdns-admin-uwsgi/ + +Docker image with backend of [PowerDNS Admin](https://git.omicroninteractive.com/0x97/powerdns-admin) web app, written in Flask, for managing PowerDNS servers. This image contains the python part of the app running under uWSGI. It needs external mysql server. Env vars for mysql configuration: +``` +(name=default value) + +PDNS_ADMIN_SQLA_DB_HOST="'mysql'" +PDNS_ADMIN_SQLA_DB_PORT="'3306'" +PDNS_ADMIN_SQLA_DB_USER="'root'" +PDNS_ADMIN_SQLA_DB_PASSWORD="'powerdnsadmin'" +PDNS_ADMIN_SQLA_DB_NAME="'powerdnsadmin'" +``` +If linked with official [mariadb](https://hub.docker.com/_/mariadb/) image with alias `mysql`, the connection can be automatically configured, so you don't need to specify any of the above. Also, DB is automatically initialized if tables are missing. + +Similar to the pdns-mysql, pdns-admin is also completely configurable via env vars. Prefix in this case is `PDNS_ADMIN_`, but there is one caveat: as the config file is a python source file, every string value must be quoted, as shown above. Double quotes are consumed by Bash, so the single quotes stay for Python. (Port number in this case is treated as string, because later on it's concatenated with hostname, user, etc in the db uri). Configuration from these env vars will be written to the `/opt/powerdns-admin/config.py` file. + +### Connecting to the PowerDNS server + +For the pdns-admin to make sense, it needs a PowerDNS server to manage. The PowerDNS server needs to have exposed API (example configuration for PowerDNS 4.x): +``` +api=yes +api-key=secret +webserver=yes +``` + +And again, PowerDNS connection is configured via env vars (it needs url of the PowerDNS server, api key and a version of PowerDNS server, for example 4.0.1): +``` +(name=default value) + +PDNS_ADMIN_PDNS_STATS_URL="'http://pdns:8081/'" +PDNS_ADMIN_PDNS_API_KEY="''" +PDNS_ADMIN_PDNS_VERSION="''" +``` + +If this container is linked with pdns-mysql from this repo with alias `pdns`, it will be configured automatically and none of the env vars from above are needed to be specified. + +### Persistent data + +There is a directory with user uploads which should be persistent: `/opt/powerdns-admin/upload` + +### Example + +When linked with pdns-mysql from this repo and with LDAP auth: +``` +docker run -d --name pdns-admin-uwsgi \ + --link mariadb:mysql --link pdns-master:pdns \ + -v pdns-admin-upload:/opt/powerdns-admin/upload \ + -e PDNS_ADMIN_LDAP_TYPE="'ldap'" \ + -e PDNS_ADMIN_LDAP_URI="'ldaps://your-ldap-server:636'" \ + -e PDNS_ADMIN_LDAP_USERNAME="'cn=dnsuser,ou=users,ou=services,dc=example,dc=com'" \ + -e PDNS_ADMIN_LDAP_PASSWORD="'dnsuser'" \ + -e PDNS_ADMIN_LDAP_SEARCH_BASE="'ou=System Admins,ou=People,dc=example,dc=com'" \ + -e PDNS_ADMIN_LDAP_USERNAMEFIELD="'uid'" \ + -e PDNS_ADMIN_LDAP_FILTER="'(objectClass=inetorgperson)'" \ + pschiffe/pdns-admin-uwsgi +``` + +## pdns-admin-static + +[![](https://images.microbadger.com/badges/image/pschiffe/pdns-admin-static.svg)](https://microbadger.com/images/pschiffe/pdns-admin-static "Get your own image badge on microbadger.com") + +https://hub.docker.com/r/pschiffe/pdns-admin-static/ + +Fronted image with nginx and static files for [PowerDNS Admin](https://git.omicroninteractive.com/0x97/powerdns-admin). Exposes port 80 for connections, expects uWSGI backend image under `pdns-admin-uwsgi` alias. + +### Example + +``` +docker run -d -p 8080:80 --name pdns-admin-static \ + --link pdns-admin-uwsgi:pdns-admin-uwsgi \ + pschiffe/pdns-admin-static +``` + +## pdns-admin - DEPRECATED [![](https://images.microbadger.com/badges/image/pschiffe/pdns-admin.svg)](http://microbadger.com/images/pschiffe/pdns-admin "Get your own image badge on microbadger.com") +https://hub.docker.com/r/pschiffe/pdns-admin/ + Docker image with [PowerDNS Admin](https://github.com/ngoduykhanh/PowerDNS-Admin) web app, written in Flask, for managing PowerDNS servers. The app is running under uWSGI with nginx. Processes in the container are managed by systemd. For running, it needs external mysql server. Env vars for mysql configuration: ``` (name=default value) @@ -125,4 +213,7 @@ docker run -dt -p 8080:80 --name pdns-admin \ ## ansible-playbook.yml -Included ansible playbook can be used to build and run the containers from this repo. To use it, you will need to be running recent Fedora with `oci-systemd-hook` rpm package installed and ansible 2.2+ (which is not released yet, see this [copr repo](https://copr.fedorainfracloud.org/coprs/abutcher/ansible/)). +Included ansible playbook can be used to build and run the containers from this repo. Run it simply with: +``` +ansible-playbook ansible-playbook.yml +```