the-concierge / concierge

Developer friendly Docker orchestration, observations, and continuous integration

Concierge

User-friendly Docker based Continuous integration and a bit of orchestration with Node.js Previously at paypac/node-concierge

Documentation is available at the-concierge.github.io

What does the Concierge do?

• It can manage local or remote Docker hosts
• Provides a simple Web UI for controlling containers, hosts, images and applications
• Builds Docker images from Git repository branches or tags
• It uses the Dockerfile provided or a custom Dockerfile elsewhere in the repository to build a Docker image
• It pushes images to a Docker registry
• Allows configurable creation of containers from images
• Monitors memory and CPU usage of containers

How can I contribute?

See the Contribution Guide

How do I set up a Concierge from scratch?

To control your local install of Docker on Windows, Mac or Linux

After starting the concierge:

• Create a new Host
• Set the Vanity hostname to localhost, 127.0.0.1 or any other hostname your machine uses
• That's it!

External Requirements*

• Docker Registry (Optional)
• The registry isn't needed for the Concierge to run
• This registry should be private. I.e., only accessible inside a private network
• NodeJS 6.4+
• This is to use the native V8 debugger

Configuration

Environment Variables

• CONCIERGE_DB_PATH: The path to store the application's SQLite database
• CONCIERGE_PORT: The port for the HTTP server

Launch with custom values

• path: Location for the SQLite database
• port: Port for the HTTP API

# E.g.
> the-concierge --path=/Users/me/concierge.sqlite --port=3141

Installation

Method 1: Global NPM package

Install globally using NPM
When used a command line utility, the Concierge uses PM2 and is run as a daemon.

> npm install the-concierge -g
> the-concierge start
> the-concierge status

Method 2: Docker

Use the public Docker image

# Specify the flag below to keep a local copy of the Concierge SQLite database
# -v /your/host/folder:/concierge/db

# With access to your local Docker socket
> docker run -dt -p 3141:3141 -v /var/run/docker.sock:/var/run/docker.sock --restart=always --name concierge theconcierge/concierge:latest

# Without access to your local Docker socket
> docker run -dt -p 3141:3141 --restart=always --name concierge theconcierge/concierge:latest

Method 3: Manual build

Build and run manually

• Clone the repository
• Build the project with yarn or npm
• With yarn:
  • yarn
  • yarn build
• With npm
  • npm install
  • npm run build

Running

• npm start or node .

Configuration Configure the Docker registry URL

• Navigate to the Configuration View
• Set Docker: Registry URL to the URL of the Docker Registry
• See below for instruction for setting up a Docker Registry

How do I set up a Docker registry?

Using the Concierge

You can use the Concierge to pull and run the Docker Registry

1. Go to the Images view
2. Click on Pull Image
3. Enter image name registy and tag latest
4. Click Pull

• The image will automatically appear in the Images list once it has been downloaded

5. Click Run on the registry:latest image in the Images list
6. Ensure the 5000 port is exposed

• It is highly recommended to provide a fixed port

Using the scripts provided

In package.json there is create-registry script provided. It will:

• Create a certificate
• Create a container from registry:latest and use the previously created certificates

Manually

The simplest way to do this is to use the public Docker image.

• sudo docker pull registry:latest
• sudo docker run -d -p 5000:5000 --name=registry -v /var/registry:/var/lib/registry --restart=unless-stopped registry:latest

-d
detached mode. The terminal used to execute the command won't be attached to the new container input/output.

-p hostPort:containerPort
exposed port. allows all hosts and concierges to connect to the registry.

--name
human readable name of the container

--restart=unless-stopped
always restart the container except at startup if the container has been manually stopped

-v hostPath/containerPath
store data from the containerPath on the host at hostPath

registry:latest
the name and tag of the Docker image we are using

I want to create an Image

To create/build an image, the following is required:

• At least one Host
• At least one Application
• (Optional) A private registry is configured
  • This is required to pushing images to your internal registry after a successful build

Hosts

At least one Host is required to create Containers and to build/push images.
See Host.md

Applications

At least one Application should be set up.
See Application.md

concierge's Issues

Display helpful view when no Hosts or Applications are configured

• Link to Hosts instructions when no Host is configured
• Link to Application instructions with no Application is configured

Implement the ability to execute scripts before and after image building

• Pass in build context variables as environment variables
• Pre-requisite: #29 Implement being able to check out from clean directory

Copying ports across takes forever

Replace logger with pino and environment log level

Add restart type to container creation options

Provide ability to pick always on-restart etc when creating a container

Replace table row buttons with menus

Create default host when installed via NPM

A/C

• Detect if Concierge is being installed by NPM
• If it is, create a "localhost" Host entry

Provide ability to get additional information about Docker Hosts

• OS information
• Hostname
• CPU usage/cores/speed
• Memory usage
• Storage usage
• Docker version
• Streams for performance charts (CPU, memory, network util., ...)

Implement authentication

As a user, I want to ensure unwanted actors cannot control my Docker hosts.

Allow building in freshly checked out directory

Relates to: #29

Switch to Vue

Provide ability to manage Docker hosts outside of Concierge's run-time host and network

Provide link to build log for automatic branch builds

Implement container log viewing

• Create route for retrieving logs
• Provide UI for viewing logs
• Provide functionality to follow logs
• Remove colour codes from output or display colour in view

Remove Host and Application info from tables

Instead, show the information in the Edit/Inspect view

Display build logs (.json) in browser

• When clicking on a build log, view the log in the browser
• Provide a download button in the log view to download the log

Add help command for the-concierge command line utlity

List the usable commands (start, stop, restart, status)
Support:

• help
• --help
• -h

Add "Max concurrent builds" and "repo polling interval" to configuration

• Add "Max concurrent builds" to Host configuration
• Add "Polling interval" to Application configuration

Re-implement reverse proxy

As a user, I want to create vanity URLs for containers, so that URLs are easier to remember, use, and share.

Provide a meaningful error message when a Container fails to start

Add "Auto Build" option to "Edit Application" view

Support sidecar containers in concierge.yml and in application config

Provide ability to use a password instead of private key for cloning a repository

Move Hosts menu item to the 4th position

Replace Container Linking to Container Networking

Container Linking has been deprecated and is quite inflexible. This needs to be replaced with Container Networking.

Add search filter to containers view

As a user, I want to filter the containers by name to quickly find a container

A/C

• Add an input text field to the containers view
• Filter the containers by the input text

Remove port config item from database and view

Update the documentation

• gui.md
• host.md
• container.md

Provide generic concept of credentials

As a user, I want to enter credentials once and be able to re-use them for multiple repositories, hosts, etc.

Add tutorial for creating first application

• Use this repo as an example
• Provide instructions of local Docker and Docker host.