Skip to content

Documentation

This describes working with Shipyard. You can use the Deployment Guide to deploy Shipyard.

luxury-yacht-boat-speed-water-163236

See the following for details on using Shipyard.

Containers
Images
Nodes
Registries
Accounts
Events

Usage

API

Shipyard features a powerful API to manage the cluster.
API Documentation

Database

RethinkDB is used for the account, engine, service key and metadata information. It is not used to store anything about the Docker containers or images. The /data directory is exposed as a volume.

pexels-photo-296242

Usage Info

By default, the controller will periodically report anonymous usage information. This includes things like number of engines etc. It is anonymous (not even an IP or image name is recorded). To opt-out, use the -disable-usage-info argument when launching the controller.