Miss any of our Open RFC calls?Watch the recordings here! »

cordage

0.0.1 • Public • Published

Cordage Build Status NPM Downloads

Cordage is a simple command-line tool which makes it easy to deploy and manage your application(s) across several of your own servers using Docker, CoreOS and fleet.

Define the services for your application in Cordagefile.coffee and then deploy them using the command-line tool.

Cordage runs fleetctl commands behind the scenes and removes the need of writing systemd configuration files, as they are generated automatically when you deploy. Cordage makes it easy to add additional units for a service, making it easy to scale your application when necessary.

Cordage runs locally on your machine, meaning there is no complicated software to install on your servers. If you're already using CoreOS, then you can get started straight away.

Features

  • Deploy multiple units/instances of a service easily
  • Configure your services so there is only one unit for that service per host
  • Automatically detects updates to docker images on deployment
  • View your deployed services and units
  • Destroy a specific service and/or a specific version of a service

Install

$ npm install -g cordage

Cordage depends on Node.js, npm and fleetctl. Please make sure these dependencies are installed on your system.

Usage

Cordagefile.coffee

Cordage uses a simple file called Cordagefile.coffee which should live in the root of your project repository. This file will define what services will run across your cluster.

Here is an example Cordagefile.coffee:

module.exports = ->
 
  @service 'app',
    description: 'Application Server'
    image: 'nginx'
    rules:
      onePerHost: true

Please note that Cordage is still early days. The configuration format is likely to change significantly in the future and several more options will be added.

Command-line tool

Cordage is just running fleetctl commands behind the scenes, so as long as you can run fleetctl commands successfully against your cluster, Cordage should work just fine.

See all available Cordage commands
$ cordage

Deploying services

Once you have configured your services in Cordagefile.coffee, you can deploy them to your cluster. Cordage will automatically detect new versions of your service docker images, making it easy to deploy a new version of your application.

Build and deploy your services across the cluster
$ cordage deploy

Listing services and running units

To check that your deployment went smoothly, you can run the list command to view all of your services and any running units (containers) for each one.

List services and units
$ cordage list

Destroying services

If you want to shutdown and destroy all units for a particular service, then you can use the destroy command.

Destroy all units for a particular service
$ cordage destroy app
Destroy all units for a specific version of a service
$ cordage destroy app:12.04

License

Licensed under the MIT License.

View the full license here.

Install

npm i cordage

DownloadsWeekly Downloads

1

Version

0.0.1

License

MIT

Last publish

Collaborators

  • avatar