= RightPublish

= DESCRIPTION

== Synopsis

RightPublish facilitates the management of remote package repositories. It is in
essense a wrapper around package repository management tools such as YUM and
RubyGems allowing one to add/remove/replace packages stored in a repository
residing in a remote storage location, typically Amazon's S3. The current
incantation of RightPublish can manage RubyGem, YUM (RPM) and APT (DEB) pacakge
repositories.

== Interface

RightPublish is used as a command line tool and controlled via command line options
and a YAML configuration file known as a RightPublish <i>profile</i>. It expects
createrepo to be installed on yum based distros and reprepro to be installed on
debian distros. It expects the "expect" package to be installed on all distros.

=== Profile Format

  ###########################################################
  # RightPublish Profile
  #
  # + Attribute is required, example shown
  # * Attribute is optional, no default; example shown
  # - Attribute is optional, default shown
  #
  # Values of the form "@@...@@" indicate an environment
  # variable should be substituted in place of the value.
  # These substitution sequences can appear as the entire
  # value of an attribute, or they can appear anywhere in
  # the attribute with static text surrounding them.
  #
  verbose:                       # -: false
  apt_repo:
    dists:                       # *: [ woody, sid, etch, jaunty, lucid ]
    auto:                        # -: true
    subdir:                      # -: apt/
    gpg_key_id:                  # *: 9A917D05
    gpg_password:                # *: @@GPG_PASSWORD@@
  gem_repo:
    subdir:                      # -: gems/
  yum_repo:
    dists:                       # *: el: ['6']
    epel:                        # -: 1
    subdir:                      # -: yum/
    gpg_key_id:                  # *: 9A917D05
    gpg_password:                # *: @@GPG_PASSWORD@@
  local_storage:
    cache_dir                    # -: ~/.right_publish/cache
  remote_storage:
    provider:                    # -: s3
    access_id:                   # *: @@AWS_ACCESS_KEY_ID@@
    access_key:                  # *: @@AWS_SECRET_ACCESS_KEY@@
    remote_path:                 # +: rightlink-testing
  #
  # End of RightPublish Profile
  ###########################################################

=== Command Line Usage

  RightPublish can manage a YUM/APT/RubyGem repository in remote storage, e.g. S3.
  If autosigning packages import the private key beforehand with gpg --import.  If 
  no gpg_password config key is supplied but a gpg_key_id is it should  prompt you
  for a password.

  Usage:
         right_publish [global_options] <command> [cmd_options]
  commands:
    pull
    publish
    push
  global options:
      --profile, -p <s>:   Publish profile
    --repo-type, -r <s>:   Repository type: ["apt", "gem", "msi", "yum", "zypp"]
             --dist, -d:   Target dist: ["el/6", "precise"]
          --verbose, -v:   Verbose output
          --version, -e:   Print version and exit
             --help, -h:   Show this message


== Supported Configuration

RightPublish has been tested on EL6, Ubuntu 12.10 and ArchLinux (as of March `13).

== Work in Progress

RightPublish is work in progress, expect more documentation and examples in the near future.

= LICENSE

<b>RightPublish</b>

Copyright:: Copyright (c) 2013 RightScale, Inc.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.