Skip to content

coder-michaelwu/shipyard

 
 

Repository files navigation

Shipyard

Composable Docker Management

Build Status

Shipyard enables multi-host, Docker cluster management. It uses Docker Swarm for cluster resourcing and scheduling.

Quick Start

There is a deploy script provided on the Shipyard website for quick installation.

Note: you must already have a Docker engine available. If you do not have Docker, you can use Docker Machine to get started.

curl -s https://shipyard-project.com/deploy | bash -s

For full options:

curl -s https://shipyard-project.com/deploy | bash -s -- -h

Documentation

Full docs are available at http://shipyard-project.com

Components

There are three components to Shipyard:

Controller

The Shipyard controller talks to a RethinkDB instance for data storage (user accounts, engine addresses, events, etc). It also serves the API and web interface (see below).

API

Everything in Shipyard is built around the Shipyard API. It enables actions such as starting, stopping and inspecting containers, adding and removing engines and more. It is a very simple RESTful JSON based API.

UI

The Shipyard UI is a web interface to the Shipyard cluster. It uses the Shipyard API for all interaction. It is an React app that is served via the Controller.

Contributing

Ensure that you are using engine 1.13.x

docker-compose -f docker-compose.dev.yml build
docker-compose -f docker-compose.dev.yml up

The UI will then be available at: http://localhost:3000

License

Shipyard is licensed under the Apache License, Version 2.0. See LICENSE for full license text.

About

Composable Docker Management

Resources

Stars

Watchers

Forks

Packages

No packages published