Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 3.29 KB

StyleGuideHome.md

File metadata and controls

65 lines (47 loc) · 3.29 KB

Haufe Docker Style Guide

Haufe Docker

Introduction

Docker is a technology, that provides:

  • unique way to include a softwarepackage and all its dependencies into one single package: Docker Images
  • a lightweight solution for process-isolation in contrast to the heavier Virtual-Machine approach: Docker Containers
  • a runtime to decouple the Linux installation inside and outside of a Docker Container (with the exception of the kernel being shared): Docker Engine
  • a solution to combine, configure and control multiple containers, networks and hosts: Docker Compose
  • a tool to prepare and manage single or clustered systems running the Docker Engine: Docker Machine
  • an almost explosively growing system of tools and pre-packaged applications ... by Docker Inc., other Companies and "The Community": Rancher, Consul, Panamax, ...

The overall architecture is explained in the original Docker documentation in Understand the architecture

You find a slightly outdated, but quite good Docker overview at Peter Rossbachs Docker Basics

The Official Docker Documentation gives a good overview about the main component and its accompanying tools on the Introduction to Engine user guide

The style guide

This set of documents called the "Haufe Docker Style Guide" represent mandatory requirements, recommended best practices and informational resources for using Docker in official (public or internal) Haufe products, services or solutions.

When to use the style guide?

The "Haufe Docker Style Guide" MUST be used when you create, modify or extend Docker based solutions.

Existing Docker installations and/or components might have to adapt out of specific security or business reasons.

Who has to use the style guide?

It is the responsibility of Developers, Release Engineers AND Runtime Operators to apply the style guide to a specific project!

Please follow the style guide, but don't follow blindly! You can break the rules with justification.

How to ask for changes to the style guide?

This and related documents are "work in progress". We’d love your feedback – whether you agree, disagree, or have some additional practices and tips to add.

We encourage you to improve the style guide with modifications and extensions. Inform the CTO Office (mailto:_CTOLeads@haufe-lexware.com) in this cases.

Please contribute!

Style Guide

To be done ...