fleet-api

This is a fork of the gem fleet-api which at the time of writing appeared to no longer be maintained. This fork includes bug fixes to the gem, as well as additional functionality.

This gem provides a Ruby wrapper around the CoreOS Fleet API.

The client allows programmatic access to most of the fleetctl commands including the ability to load, start, stop, unload and destroy unit files.

Install the gem directly:

gem install fleet-ruby

Alternatively, add this line to your application's Gemfile:

gem 'fleet-ruby', require: 'fleet'

Configure the URL for the Fleet API:

require 'fleet'

Fleet.configure do |fleet|
  fleet.fleet_api_url = 'http://10.1.42.1:49153'
end

If you don't provide an explicit value for the .fleet_api_url attribute, it will default to using the value of the FLEETCTL_ENDPOINT environment variable (if present) or the socket at unix:///var/run/fleet.sock.

When submitting a service definition to the Fleet::Client you must convert your unit file into a Ruby hash. Each section in the unit file is represented as a key/value pair in the hash where the key is the name of the section and the value is another hash containing all the statements for that section.

For example, look at the following unit file.

[Unit]
Description=Useless infinite loop

[Service]
ExecStart=/bin/bash -c "while true; do sleep 1; done"

This unit file would be represented as the following Ruby hash.

{
  'Unit' => {
    'Description' => 'Useless infinite loop'
  },
  'Service' => {
    'ExecStart' => "/bin/bash -c \"while true; do sleep 1; done\""
  }
}

If you need mutiple values for a single statement (like multiple ExecStart instructions) you can use an array of strings:

{
  'Unit' => {
    'Description' => 'Useless infinite loop'
  },
  'Service' => {
    'ExecStart' => ["/bin/bash -c \"while true; do sleep 1; done\"", "some other command"]
  }
}

Equivalent of fleetctl submit:

service = {
  'Unit' => {
    'Description' => 'Useless infinite loop'
  },
  'Service' => {
    'ExecStart' => "/bin/bash -c \"while true; do sleep 1; done\""
  }
}

client = Fleet.new
client.submit('forever.service', service)

Note that the name you pass-in as the first parameter to the .submit method should end in ".service"

Equivalent of fleetctl load:

client = Fleet.new
client.load('forever.service')

Equivalent of fleetctl start:

client = Fleet.new
client.start('forever.service')

Equivalent of fleetctl stop:

client = Fleet.new
client.stop('forever.service')

Equivalent of fleetctl unload:

client = Fleet.new
client.unload('forever.service')

Equivalent of fleetctl destroy:

client = Fleet.new
client.destroy('forever.service')

Equivalent of fleetctl list-units:

client = Fleet.new
client.list

Equivalent of fleetctl status:

client = Fleet.new
client.get_unit_state('forever.service')

Retrieves current status of a unit file:

client = Fleet.new
client.status('forever.service')

Retrieves contents and current state of a unit file:

client = Fleet.new
client.get_unit_file('foo.service')