optica-client

This optica-client is a CLI for Airbnb's Optica service. It's command-line name is optical.

This is not an official Airbnb product.

Installation

Install it via Rubygems:

$ gem install optica-client

You'll want to configure the command-line client to use your Optica instance:

$ optical -H https://optica.example.com

Usage

Usage: optical [options] [FIELD=FILTER] [FIELD2=FILTER2...]

  Fetch host information from Optica, and cache it for 15 minutes.
  Output the fetched information as a JSON stream, suitable for processing with `jq`.

  FIELD: any optica field; see your optica host for availible fields
  FILTER: either a bare string, like "optica", or a regex string, like "/^(o|O)ptica?/"

Options:
    -s, --select a,b,c               Retrieve the given fields, in addition to the defaults
    -a, --all                        Retrieve all fields (default is just role,id,hostname)
    -j, --just a,b,c                 Print just the given fields as tab-seperated strings,
                                     instead of outputting json. Implies selecting those fields.
    -v, --verbose                    Print debug information to STDERR
    -p, --pretty[=false]             Pretty-print JSON (default true when STDOUT is a TTY)
    -r, --refresh                    Delete cache before performing request.
    -h, --host URI                   Optica host (default "https://example.com")
    -H, --set-default-host URI       Set the default optica host

Examples:
  Retrieve all nodes with a role starting with "example-":
    optical role=/^example-/

  Retrieve all the nodes registered to a test optica instance:
    optical -h https://optica-test.example.com

  Retrieve all data about my nodes:
    optical --all launched_by=`whoami`

  SSH into the first matched node:
    ssh $(optical --just hostname role=example branch=jake-test | head -n 1)

Development

After checking out the repo, run bin/setup to install dependencies. You can also 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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/justjake/optica-client.