Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7404380279 | ||
|
|
d0b98b201d | ||
|
|
33ac5c9e4c |
@@ -1,13 +1,14 @@
|
|||||||
# Alpine :: Traefik Labels
|
# Alpine :: Traefik Labels
|
||||||
    
|
    
|
||||||
|
|
||||||
Run Traefik Labels based on Alpine Linux. Small, lightweight, secure and fast 🏔️
|
Run Traefik Labels based on Alpine Linux. Small, lightweight, secure and fast 🏔️
|
||||||
|
|
||||||
What can I do with this? Simply put: It will export any traefik labels on a container on the same host as this image runs to a Redis instance. This makes it possible for a centralized Traefik load balancer to update endpoints dynamically by utilizing the docker labels, just like you would on a local installation of Traefik with labels. It is meant as an alternative and simple way to proxy requests from a Traefik load balanacer to multiple docker nodes running in different networks and locations.
|
## Description
|
||||||
|
What can I do with this? Simply put: It will export any traefik labels on a container on the same host as this image runs to a Redis instance. This makes it possible for a centralized Traefik load balancer to update endpoints dynamically by utilizing the docker labels, just like you would on a local installation of Traefik with labels. It is meant as an alternative and simple way to proxy requests from a Traefik load balancer to multiple docker nodes running in different networks and locations. The image has the ability to use nsupdate with labels too, so that not only you can add a dynamic proxy to your Traefik, but add DNS entries to your internal or external NS servers. It uses split DNS as WAN and LAN in your labels, so you can update external as well as internal DNS entries on the fly. If a container is removed the image will automatically reverse any `nsupdate update add` to `nsupdate update delete` so entrie are removed too.
|
||||||
|
|
||||||
In order to use this image, you need to setup Traefik with a Redis provider and then point this image via REDIS_URL to the same Redis instance. Each entry will have an expire timer set in Redis, so that if a container is removed by a server crashing, Redis will automatically remove stale entries as well. Entries are refreshed every 300 seconds or on all docker container events (create, run, kill, stop, restart, ...).
|
In order to use this image, you need to setup Traefik with a Redis provider and then point this image via REDIS_URL to the same Redis instance. Each entry will have an expire timer set in Redis, so that if a container is removed by a server crashing, Redis will automatically remove stale entries as well. Entries are refreshed every 300 seconds or on all docker container events (create, run, kill, stop, restart, ...). As for nsupdate, you need to setup tsig authentication in your NS servers and add the keys to the zones you want to be able to update, you can restrict the keys by using update-policy if you use BIND.
|
||||||
|
|
||||||
This image provides the ability to call a webhook for each container for each event or poll after the data was updates in Redis.
|
This image provides the ability to call a webhook for each container for each event or poll after the data was updates in Redis and or nsupdate.
|
||||||
|
|
||||||
## Run
|
## Run
|
||||||
```shell
|
```shell
|
||||||
@@ -26,9 +27,9 @@ docker run --name traefik-labels \
|
|||||||
-d 11notes/traefik-labels:[tag]
|
-d 11notes/traefik-labels:[tag]
|
||||||
```
|
```
|
||||||
|
|
||||||
This is a demo webserver that will start on :8080, all the traefik labels will be exportet to the Redis instance. They follow the exact same [syntax](https://doc.traefik.io/traefik/routing/providers/kv/) as for normal Redis and Traefik, just as labels.
|
## Examples
|
||||||
```shell
|
```shell
|
||||||
docker run --name demo \
|
docker run --name traefik-demo \
|
||||||
-p 8080:8080 \
|
-p 8080:8080 \
|
||||||
-l "traefik/http/routers/demo.domain.com/service=demo.domain.com" \
|
-l "traefik/http/routers/demo.domain.com/service=demo.domain.com" \
|
||||||
-l "traefik/http/routers/demo.domain.com/rule=Host(`demo.domain.com`)" \
|
-l "traefik/http/routers/demo.domain.com/rule=Host(`demo.domain.com`)" \
|
||||||
@@ -38,6 +39,24 @@ docker run --name demo \
|
|||||||
-d 11notes/nginx:stable
|
-d 11notes/nginx:stable
|
||||||
```
|
```
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker run --name traefik-rfc2136-demo \
|
||||||
|
-p 8080:8080 \
|
||||||
|
-l "traefik/http/routers/demo.domain.com/service=demo.domain.com" \
|
||||||
|
-l "traefik/http/routers/demo.domain.com/rule=Host(`demo.domain.com`)" \
|
||||||
|
-l "traefik/http/routers/demo.domain.com/tls=true" \
|
||||||
|
-l "traefik/http/routers/demo.domain.com/entrypoints=https" \
|
||||||
|
-l "traefik/http/services/demo.domain.com/loadbalancer/servers/0/url=http://fqdn-of-docker-node:8080" \
|
||||||
|
-l "rfc2136/WAN/server=ns.domain.com" \
|
||||||
|
-l "rfc2136/WAN/key=algo:name:secret" \
|
||||||
|
-l "rfc2136/WAN/nsupdate=update add foo.domain.com A 175.12.41.11" \
|
||||||
|
-l "rfc2136/WAN/nsupdate=update add foo.domain.com TXT \"hello from traefik-labels!\"" \
|
||||||
|
-l "rfc2136/LAN/server=ns.domain.local" \
|
||||||
|
-l "rfc2136/LAN/key=algo:name:secret" \
|
||||||
|
-l "rfc2136/LAN/nsupdate=update add foo.domain.local A 192.168.12.54" \
|
||||||
|
-d 11notes/nginx:stable
|
||||||
|
```
|
||||||
|
|
||||||
## Defaults
|
## Defaults
|
||||||
| Parameter | Value | Description |
|
| Parameter | Value | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@@ -45,10 +64,12 @@ docker run --name demo \
|
|||||||
| `uid` | 1000 | user id 1000 |
|
| `uid` | 1000 | user id 1000 |
|
||||||
| `gid` | 1000 | group id 1000 |
|
| `gid` | 1000 | group id 1000 |
|
||||||
| `home` | /labels | home directory of user docker |
|
| `home` | /labels | home directory of user docker |
|
||||||
|
| `api` | https://${IP}:5000 | HTTPS endpoint of Docker registry |
|
||||||
|
|
||||||
## Environment
|
## Environment
|
||||||
| Parameter | Value | Default |
|
| Parameter | Value | Default |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
|
| `TZ` | [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | null |
|
||||||
| `LABELS_REDIS_URL` | the redis URL to connect, use rediss:// for SSL | rediss://localhost:6379/0 |
|
| `LABELS_REDIS_URL` | the redis URL to connect, use rediss:// for SSL | rediss://localhost:6379/0 |
|
||||||
| `LABELS_INTERVAL` | in what interval container information is pulled in seconds | 300 |
|
| `LABELS_INTERVAL` | in what interval container information is pulled in seconds | 300 |
|
||||||
| `LABELS_TIMEOUT` | how many seconds after an interval the keys should stay till they expire in seconds | 30 |
|
| `LABELS_TIMEOUT` | how many seconds after an interval the keys should stay till they expire in seconds | 30 |
|
||||||
@@ -56,9 +77,9 @@ docker run --name demo \
|
|||||||
| `LABELS_WEBHOOK_AUTH_BASIC` | Basic authentication to use in the form of "username:password" for the webhook | |
|
| `LABELS_WEBHOOK_AUTH_BASIC` | Basic authentication to use in the form of "username:password" for the webhook | |
|
||||||
|
|
||||||
## Parent image
|
## Parent image
|
||||||
* [11notes/node:stable](https://github.com/11notes/docker-node)
|
* [11notes/node:stable](https://hub.docker.com/r/11notes/node)
|
||||||
|
|
||||||
## Built with and thanks to
|
## Built with (thanks to)
|
||||||
* [npm::redis](https://www.npmjs.com/package/redis)
|
* [npm::redis](https://www.npmjs.com/package/redis)
|
||||||
* [npm::dockerode](https://www.npmjs.com/package/dockerode)
|
* [npm::dockerode](https://www.npmjs.com/package/dockerode)
|
||||||
* [nodejs](https://nodejs.org/en)
|
* [nodejs](https://nodejs.org/en)
|
||||||
|
|||||||
+13
-1
@@ -1,5 +1,14 @@
|
|||||||
|
# :: Util
|
||||||
|
FROM alpine as util
|
||||||
|
|
||||||
|
RUN set -ex; \
|
||||||
|
apk add --no-cache \
|
||||||
|
git; \
|
||||||
|
git clone https://github.com/11notes/util.git;
|
||||||
|
|
||||||
# :: Header
|
# :: Header
|
||||||
FROM 11notes/node:stable
|
FROM 11notes/node:stable
|
||||||
|
COPY --from=util /util/node/util.js /labels/lib
|
||||||
ENV APP_ROOT=/labels
|
ENV APP_ROOT=/labels
|
||||||
|
|
||||||
# :: Run
|
# :: Run
|
||||||
@@ -7,7 +16,10 @@
|
|||||||
|
|
||||||
# :: prepare image
|
# :: prepare image
|
||||||
RUN set -ex; \
|
RUN set -ex; \
|
||||||
mkdir -p ${APP_ROOT};
|
mkdir -p ${APP_ROOT}; \
|
||||||
|
apk --no-cache add \
|
||||||
|
bind-tools; \
|
||||||
|
apk --no-cache upgrade;
|
||||||
|
|
||||||
# :: install
|
# :: install
|
||||||
RUN set -ex; \
|
RUN set -ex; \
|
||||||
|
|||||||
+13
-1
@@ -1,3 +1,11 @@
|
|||||||
|
# :: Util
|
||||||
|
FROM alpine as util
|
||||||
|
|
||||||
|
RUN set -ex; \
|
||||||
|
apk add --no-cache \
|
||||||
|
git; \
|
||||||
|
git clone https://github.com/11notes/util.git;
|
||||||
|
|
||||||
# :: Builder
|
# :: Builder
|
||||||
FROM alpine AS qemu
|
FROM alpine AS qemu
|
||||||
ENV QEMU_URL https://github.com/balena-io/qemu/releases/download/v3.0.0%2Bresin/qemu-3.0.0+resin-aarch64.tar.gz
|
ENV QEMU_URL https://github.com/balena-io/qemu/releases/download/v3.0.0%2Bresin/qemu-3.0.0+resin-aarch64.tar.gz
|
||||||
@@ -5,6 +13,7 @@
|
|||||||
|
|
||||||
# :: Header
|
# :: Header
|
||||||
FROM arm64v8/node:20.10.0-alpine3.19
|
FROM arm64v8/node:20.10.0-alpine3.19
|
||||||
|
COPY --from=util /util/node/util.js /labels/lib
|
||||||
COPY --from=qemu qemu-aarch64-static /usr/bin
|
COPY --from=qemu qemu-aarch64-static /usr/bin
|
||||||
ENV APP_ROOT=/labels
|
ENV APP_ROOT=/labels
|
||||||
|
|
||||||
@@ -13,7 +22,10 @@
|
|||||||
|
|
||||||
# :: prepare image
|
# :: prepare image
|
||||||
RUN set -ex; \
|
RUN set -ex; \
|
||||||
mkdir -p ${APP_ROOT};
|
mkdir -p ${APP_ROOT}; \
|
||||||
|
apk --no-cache add \
|
||||||
|
bind-tools; \
|
||||||
|
apk --no-cache upgrade;
|
||||||
|
|
||||||
# :: install
|
# :: install
|
||||||
RUN set -ex; \
|
RUN set -ex; \
|
||||||
|
|||||||
+70
-41
@@ -3,10 +3,13 @@ process.once('SIGINT', () => process.exit(0));
|
|||||||
|
|
||||||
const Docker = require('dockerode');
|
const Docker = require('dockerode');
|
||||||
const redis = require('redis');
|
const redis = require('redis');
|
||||||
|
const { nsupdate } = requore('./nsupdate');
|
||||||
|
const { logJSON } = require('/labels/lib/util.js');
|
||||||
|
|
||||||
const ERROR = 1;
|
const ENV_REDIS_INTERVAL = parseInt(process.env?.LABELS_INTERVAL || 300);
|
||||||
const POLL_INTERVAL = parseInt(process.env?.LABELS_INTERVAL || 300);
|
const ENV_REDIS_TIMEOUT = parseInt(process.env?.LABELS_TIMEOUT|| 30);
|
||||||
const POLL_TIMEOUT = parseInt(process.env?.LABELS_TIMEOUT|| 30);
|
const ENV_LABELS_WEBHOOK = process.env?.LABELS_WEBHOOK;
|
||||||
|
const ENV_LABELS_WEBHOOK_AUTH_BASIC = process.env?.LABELS_WEBHOOK_AUTH_BASIC;
|
||||||
|
|
||||||
class Labels{
|
class Labels{
|
||||||
#docker;
|
#docker;
|
||||||
@@ -18,22 +21,14 @@ class Labels{
|
|||||||
|
|
||||||
constructor(){
|
constructor(){
|
||||||
this.#docker = new Docker({socketPath:'/run/docker.sock'});
|
this.#docker = new Docker({socketPath:'/run/docker.sock'});
|
||||||
if(undefined !== process.env.LABELS_WEBHOOK_AUTH_BASIC){
|
if(ENV_LABELS_WEBHOOK_AUTH_BASIC){
|
||||||
this.#webhook.headers['Authorization'] = 'Basic ' + Buffer.from(process.env.LABELS_WEBHOOK_AUTH_BASIC).toString('base64')
|
this.#webhook.headers['Authorization'] = 'Basic ' + Buffer.from(ENV_LABELS_WEBHOOK_AUTH_BASIC).toString('base64')
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#log(message, type){
|
|
||||||
console.log(JSON.stringify({
|
|
||||||
time:new Date().toISOString(),
|
|
||||||
type:(type === ERROR) ? 'ERROR' : 'INFO',
|
|
||||||
message:message,
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
|
|
||||||
async watch(){
|
async watch(){
|
||||||
if(undefined !== process.env.LABELS_WEBHOOK){
|
if(ENV_LABELS_WEBHOOK){
|
||||||
this.#log(`using webhook ${process.env.LABELS_WEBHOOK}`);
|
logJSON('info', `using webhook ${ENV_LABELS_WEBHOOK}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
this.#redis = await redis.createClient({
|
this.#redis = await redis.createClient({
|
||||||
@@ -46,7 +41,7 @@ class Labels{
|
|||||||
|
|
||||||
this.#redis.connect();
|
this.#redis.connect();
|
||||||
this.#redis.on('ready', ()=>{
|
this.#redis.on('ready', ()=>{
|
||||||
this.#log('successfully connected to redis');
|
logJSON('info', 'successfully connected to redis');
|
||||||
(async() => {
|
(async() => {
|
||||||
await this.dockerPoll();
|
await this.dockerPoll();
|
||||||
})();
|
})();
|
||||||
@@ -54,18 +49,18 @@ class Labels{
|
|||||||
});
|
});
|
||||||
|
|
||||||
this.#redis.on('error', error =>{
|
this.#redis.on('error', error =>{
|
||||||
this.#log(error, ERROR);
|
logJSON('error', error);
|
||||||
});
|
});
|
||||||
|
|
||||||
setInterval(async() => {
|
setInterval(async() => {
|
||||||
await this.dockerPoll();
|
await this.dockerPoll();
|
||||||
}, POLL_INTERVAL*1000);
|
}, ENV_REDIS_INTERVAL*1000);
|
||||||
}
|
}
|
||||||
|
|
||||||
dockerEvents(){
|
dockerEvents(){
|
||||||
this.#docker.getEvents({}, (error, data) => {
|
this.#docker.getEvents({}, (error, data) => {
|
||||||
if(error){
|
if(error){
|
||||||
this.#log(error, ERROR);
|
logJSON('error', error);
|
||||||
}else{
|
}else{
|
||||||
data.on('data', async(chunk) => {
|
data.on('data', async(chunk) => {
|
||||||
const event = JSON.parse(chunk.toString('utf8'));
|
const event = JSON.parse(chunk.toString('utf8'));
|
||||||
@@ -89,48 +84,82 @@ class Labels{
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
}catch(e){
|
}catch(e){
|
||||||
this.#log(e, ERROR);
|
logJSON('error', e);
|
||||||
}finally{
|
}finally{
|
||||||
this.#poll = false;
|
this.#poll = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
dockerInspect(id, status = null){
|
async dockerInspect(id, status = null){
|
||||||
return(new Promise((resolve, reject) => {
|
return(new Promise((resolve, reject) => {
|
||||||
const container = this.#docker.getContainer(id);
|
const container = this.#docker.getContainer(id);
|
||||||
container.inspect(async(error, data) => {
|
container.inspect(async(error, data) => {
|
||||||
if(!error){
|
if(!error){
|
||||||
const update = (/start|poll/i.test(status)) ? true : false;
|
const update = (/start|poll/i.test(status)) ? true : false;
|
||||||
const webHook = {event:status, labels:{}};
|
const container = {
|
||||||
let log = false;
|
event:status,
|
||||||
|
labels:{
|
||||||
|
traefik:[],
|
||||||
|
rfc2136:[],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const rfc2136 = {
|
||||||
|
WAN:{server:'', key:'', commands:[]},
|
||||||
|
LAN:{server:'', key:'', commands:[]},
|
||||||
|
}
|
||||||
|
|
||||||
for(const label in data?.Config?.Labels){
|
for(const label in data?.Config?.Labels){
|
||||||
if(/traefik\//i.test(label)){
|
switch(true){
|
||||||
if(!log){
|
case /traefik\//i.test(label):
|
||||||
this.#log(`inspect container {${(data?.Name || data?.id).replace(/^\//i, '')}}${(
|
if(update){
|
||||||
(null === status) ? '' : ` event[${status}]`
|
await this.#redis.set(label, data?.Config?.Labels[label], {EX:ENV_REDIS_INTERVAL + ENV_REDIS_TIMEOUT});
|
||||||
)} traefik labels`);
|
}else{
|
||||||
log = true;
|
await this.#redis.del(label);
|
||||||
}
|
}
|
||||||
if(undefined !== process.env.LABELS_WEBHOOK){
|
container.labels.traefik[label] = data?.Config?.Labels[label];
|
||||||
webHook.labels[label] = data?.Config?.Labels[label];
|
break;
|
||||||
}
|
|
||||||
if(update){
|
case /rfc2136\//i.test(label):
|
||||||
await this.#redis.set(label, data?.Config?.Labels[label], {EX:POLL_INTERVAL + POLL_TIMEOUT});
|
container.labels.rfc2136[label] = data?.Config?.Labels[label];
|
||||||
}else{
|
const type = ((label.match(/rfc2136\/WAN\//i)) ? 'WAN' : 'LAN');
|
||||||
await this.#redis.del(label);
|
switch(true){
|
||||||
|
case /rfc2136\/\S+\/server/i.test(label):
|
||||||
|
rfc2136[type].server = data?.Config?.Labels[label];
|
||||||
|
break;
|
||||||
|
|
||||||
|
case /rfc2136\/\S+\/key/i.test(label):
|
||||||
|
rfc2136[type].key = data?.Config?.Labels[label];
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
if(!update){
|
||||||
|
data?.Config?.Labels[label] = data?.Config?.Labels[label].replace(/update add/i, 'update delete');
|
||||||
|
}
|
||||||
|
rfc2136[type].commands.push(data?.Config?.Labels[label]);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for(const type in rfc2136){
|
||||||
|
if(rfc2136[type].commands.length > 0 && rfc2136[type].server && rfc2136[type].key){
|
||||||
|
try{
|
||||||
|
await nsupdate(rfc2136[type].server, rfc2136[type].key, rfc2136[type].commands);
|
||||||
|
}catch(e){
|
||||||
|
logJSON('error', e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if(undefined !== process.env.LABELS_WEBHOOK){
|
if(ENV_LABELS_WEBHOOK){
|
||||||
try{
|
try{
|
||||||
await fetch(process.env.LABELS_WEBHOOK, {method:(
|
await fetch(ENV_LABELS_WEBHOOK, {method:(
|
||||||
(update) ? 'PUT' : 'DELETE'
|
(update) ? 'PUT' : 'DELETE'
|
||||||
), body:JSON.stringify(webHook), headers:this.#webhook.headers, signal:AbortSignal.timeout(2500)});
|
), body:JSON.stringify(container), headers:this.#webhook.headers, signal:AbortSignal.timeout(2500)});
|
||||||
}catch(e){
|
}catch(e){
|
||||||
this.#log(e, ERROR);
|
logJSON('error', e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
const { spawn } = require('node:child_process');
|
||||||
|
|
||||||
|
exports.nsupdate = async(server, key, commands) => {
|
||||||
|
commands.unshift(`server ${server}`);
|
||||||
|
commands.push('send');
|
||||||
|
return(new Promise((resolve, reject) => {
|
||||||
|
const nsupdate = spawn('/usr/bin/nsupdate', ['-y', key]);
|
||||||
|
let errors = '';
|
||||||
|
nsupdate.stderr.on('data', data =>{errors += data.toString()});
|
||||||
|
nsupdate.on('error', error => {reject(error)});
|
||||||
|
nsupdate.on('exit', code =>{
|
||||||
|
if(code === 0){
|
||||||
|
if(errors.length > 0){
|
||||||
|
reject(errors);
|
||||||
|
}else{
|
||||||
|
resolve(true);
|
||||||
|
}
|
||||||
|
}else{
|
||||||
|
reject(errors);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
for(const command of commands){
|
||||||
|
nsupdate.stdin.write(`${command}\n`);
|
||||||
|
}
|
||||||
|
nsupdate.stdin.end();
|
||||||
|
}));
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user