Skip to content

Latest commit

 

History

History
76 lines (62 loc) · 3.78 KB

README.md

File metadata and controls

76 lines (62 loc) · 3.78 KB
Raw

Docker Platform

GitHub release (latest by date) GitHub GitHub GitHub GitHub code size in bytes GitHub all releases

Introduction

Platform for easy management of Docker Containers on single remote hosts

Docker Package

The core idea behind this platform is a so-called "Docker Package" folder that consists of several files, including a metadata file named docker.pkg. This package is synched to the remote host using rSync and can be executed according the given docker-compose.yml. Additionally a pre- and a post-script can be executed before and after starting the Docker services.

The metadata file contains:

  • NAME: The name of the package (used as ID for sync)
  • DESCRIPTION: Description of the package
  • ADDITIONAL_FILES: Comma-separated list of files and folders that should be synched to the remote server
  • PRE_HOOK: Script file that is executed before starting the services
  • POST_HOOK: Script file that is executed after services have been startet

Setup

General Setup

The remote host needs a user that belongs to the docker-group. For convenience, RSA keys of the local machine should be uploaded using ssh-copy-id user@host and SSHd should allow PubkeyAuthentication, otherwise the scipts are forced to enter a password on each connection.

Linux Packages

The platform scripts require following pre-installed packages:

  • docker-ce (> 5:23.0.1)
  • docker-ce-cli (> 5:23.0.1)
  • docker-compose (>2.16)
  • containerd.io (>1.6)
  • zip
  • rsynch

Environment

The following environment variables must be set and exported (e.g. in ~/.profile of each eligible user)

export DOCKER_PLATFORM_HOME="/docker"
export DOCKER_PLATFORM_BACKUPS="/backups"

This toolchain has been successfully tested on Debian GNU/Linux 11 (bullseye), other Linux distributions may be supported in the future too.

Config files

Folder conf contains the configurations for deploy.sh and build.sh. They must be customized for each server environment accordingly.

Binaries

Folder bin contains a variety of toolchain scripts, of which some of them are synched to the remote host.

Local Binaries

  • deploy.sh - Master script for deploying packages, scripts and config files
  • build.sh - Creates and pushes Docker images according to the specified build folder

Remote Binaries

The following scripts are synched to the remote host:

  • armageddon.sh - Script for tearing down the whole Docker environment
  • backup.sh - Backs up all container packages, volumes and environment variables
  • bootstrap.sh - Creates external networks and volumes
  • build.sh - Creates docker images on localhost and pushes them to a (private) registry
  • cleanup_logs.sh - Truncates docker log files and removes rotated ones
  • common.sh - Just a sourcable script holding common functions
  • deploy.sh - Uploads given package files to remote server and triggers run.sh on remote server
  • hosts.sh - Updates and writes docker hostnames to the remote server's host config
  • restore.sh - Restores packages, volumes and environment variables by a given backup file
  • run.sh - Runs a given Docker package and executes pre- and post-scripts
  • stop.sh - Stops a given Docker package


Made with ❤️ in Bavaria
© 2018-2024, Alexander Wolz