Project

algo

0.0
No commit activity in last 3 years
No release in over 3 years
algoyoshiso/algoHomepageDocumentationSource CodeBug TrackerWiki
Docker container orchestration tool for swarm cluster.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
7,044
Stars
2
Forks
0
Watchers
4
 Releases
Current version
0.2.0
Total releases
2
First release
2016-07-25
Latest release
2016-08-03
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-07-29
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.12
pry
~> 0.10
rake
~> 10.0
rspec
~> 3.0

Runtime

activesupport
~> 4.0
excon
= 0.51.0
thor
>= 0
 Project Readme

Algo

Docker container orchestration tool for swarm cluster.

Installation

Add this line to your application's Gemfile:

gem 'algo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install algo

Usage

Definition

cluster 'awesomecluster' do

  # Define service/network prefix for cluster
  prefix 'awsm'

  # Define cluster wide available environment variable
  env 'CLUSTER_ENV', 'PRODUCTION'

  # Define cluster wide available label
  label 'com.example.sample', 'clusterwidelabel'

  # Define network
  network 'net1'

  # Define service
  service 'name' do
    image 'quay.io/yss44/curl'
    replicas 3
    command 'sh'
    args '-ic', "while true; do curl -s awsm-nginx > /dev/null; echo $?; sleep 3; done"

    update_parallelism 2

    # Service related environment variable
    env 'APP_DOMAIN', 'example.com'

    network 'net1'

    # Mount host's directory/file
    volume do
      type 'bind'
      source '/tmp/mount'
      target '/mnt/sample'
    end

    # Mount host docker volume
    volume do
      type 'volume'
      source 'volume-name'
      target '/mnt/volume-sample'
    end

  end

  # Define another service
  service 'nginx' do
    image 'nginx:alpine'
    replicas 2
    network 'net1'
  end

end

Execution

# Prepare playground for algo
docker-machine create --driver virtualbox \
                      --virtualbox-boot2docker-url="https://github.com/boot2docker/boot2docker/releases/download/v1.12.1/boot2docker-experimental.iso" \
                      algo
eval $(docker-machine env algo)

# Create initial cluster
algo apply examples/awesomecluster.rb
# Applying to cluster awesomecluster...
# network: awsm-net1, status: created
# service: awsm-name, status: created
# service: awsm-nginx, status: created
# Complete applying for cluster awesomecluster!

# Change configuration
sed -i s/replicas 2/replicas 1/g examples/awesomecluster.rb

# Dry-run
algo apply examples/awesomecluster.rb --dry-run
# Running with dry-run mode...
# Applying to cluster awesomecluster...
# network: awsm-net1, status: ok
# service: awsm-name, status: ok
# service: awsm-nginx, status: changed
# Complete applying for cluster awesomecluster!

# Apply changes
algo apply examples/awesomecluster.rb
# Applying to cluster awesomecluster...
# network: awsm-net1, status: ok
# service: awsm-name, status: ok
# service: awsm-nginx, status: changed
# Complete applying for cluster awesomecluster!

# Dry-run terminating cluster
algo rm examples/awesomecluster.rb --dry-run
# Running with dry-run mode...
# Terminating cluster awesomecluster...
# service: awsm-name, status: removed
# service: awsm-nginx, status: removed
# network: awsm-net1, status: removed
# Complete Termination for cluster awesomecluster...

# Terminate cluster
algo rm examples/awesomecluster.rb
# Terminating cluster awesomecluster...
# service: awsm-name, status: removed
# service: awsm-nginx, status: removed
# network: awsm-net1, status: removed
# Complete Termination for cluster awesomecluster...

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/yoshiso/algo/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request