Juju Charm - Swift proxy
Go to file
Corey Bryant 7cd9a08bb2 [thedac,r=corey.bryant] Enable multiple devices per node 2015-10-13 21:29:27 +00:00
actions Call assess_status() in pause/resume actions and update is_paused 2015-10-13 08:59:52 -04:00
charmhelpers Resync charms 2015-10-10 14:31:55 -07:00
hooks [thedac,r=corey.bryant] Enable multiple devices per node 2015-10-13 21:29:27 +00:00
lib [thedac,r=corey.bryant] Enable multiple devices per node 2015-10-13 21:29:27 +00:00
scripts - removed health checks 2013-04-05 17:34:01 -04:00
templates [xtrusia,r=james-page] Add support for debug and header logging. 2015-04-20 12:17:45 +01:00
tests [corey.bryant, r=thedac] Workload Status 2015-10-13 10:17:22 -07:00
unit_tests [thedac,r=corey.bryant] Enable multiple devices per node 2015-10-13 21:29:27 +00:00
.bzrignore Use canonical_url helper for endpoint resolution 2014-07-14 15:03:48 +01:00
.coveragerc Move swift helpers out of hooks, into lib for re-use by more than just hooks 2015-09-07 14:44:04 +01:00
.project Fixup missing files 2013-02-27 16:18:34 +00:00
.pydevproject Fixup missing files 2013-02-27 16:18:34 +00:00
Makefile add actions dir to lint test target 2015-10-06 15:11:21 +00:00
README.md removed new README clause 2014-11-05 14:52:59 +01:00
actions.yaml Action managed upgrade 2015-09-23 09:28:19 -07:00
charm-helpers-hooks.yaml Move swift helpers out of hooks, into lib for re-use by more than just hooks 2015-09-07 14:44:04 +01:00
charm-helpers-tests.yaml reset charm-helpers sync path to lp:charm-helpers 2014-09-23 11:22:16 +01:00
config.yaml Action managed upgrade 2015-09-23 09:28:19 -07:00
copyright Add copyright. 2012-12-19 14:37:19 -08:00
icon.svg Update icon.svg 2013-10-23 13:14:57 -07:00
metadata.yaml Rename categories to tags (please the linter) 2015-09-10 15:11:06 +01:00
revision Add config options for proxy-server.conf template. node-timeout and recoverable-node-timeout. For large swift/glance uploads, higher defaults are needed to prevent uploads from failing on real servers which are slower than VMs. 2014-06-03 20:38:25 -05:00
setup.cfg Move swift helpers out of hooks, into lib for re-use by more than just hooks 2015-09-07 14:44:04 +01:00

README.md

Overview

This charm provides the swift-proxy component of the OpenStack Swift object storage system. It can be deployed as part of its own stand-alone storage cluster or it can be integrated with the other OpenStack components, assuming those are also managed by Juju. For Swift to function, you'll also need to deploy additional swift-storage nodes using the cs:precise/swift-storage charm.

For more information about Swift and its architecture, visit the official project website

This charm was developed to support deploying multiple version of Swift on Ubuntu Precise 12.04, as they relate to the release series of OpenStack. That is, OpenStack Essex corresponds to Swift 1.4.8 while OpenStack Folsom shipped 1.7.4. This charm can be used to deploy either (and future) versions of Swift onto an Ubuntu Precise 12.04 or Trusty 14.04 making use of the Ubuntu Cloud Archive when needed.

Usage

Currently, Swift may be deployed in two ways. In either case, additional storage nodes are required. The configuration option that dictates how to deploy this charm is the 'zone-assignment' setting. This section describes how to select the appropriate zone assignment policy, as well as a few other configuration settings of interest. Many of the configuration settings can be left as default.

Zone Assignment

This setting determines how the charm assigns new storage nodes to storage zones.

The default, 'manual' option is suggested for production as it allows administrators to carefully architect the storage cluster. It requires each swift-storage service to be deployed with an explicit storage zone configured in its deployment settings. Upon relation to a swift-proxy, the storage node will request membership to its configured zone and be assigned by the swift-proxy charm accordingly. Using the cs:precise/swift-storage charm with this charm, a deployment would look something like:

$ cat >swift.cfg <<END
    swift-proxy:
        zone-assignment: manual
        replicas: 3
    swift-storage-zone1:
        zone: 1
        block-device: /etc/swift/storage.img|2G
    swift-storage-zone2:
        zone: 2
        block-device: /etc/swift/storage.img|2G
    swift-storage-zone3:
        zone: 3
        block-device: /etc/swift/storage.img|2G
END
$ juju deploy --config=swift.cfg swift-proxy
$ juju deploy --config=swift.cfg swift-storage swift-storage-zone1
$ juju deploy --config=swift.cfg swift-storage swift-storage-zone2
$ juju deploy --config=swift.cfg swift-storage swift-storage-zone3
$ juju add-relation swift-proxy swift-storage-zone1
$ juju add-relation swift-proxy swift-storage-zone2
$ juju add-relation swift-proxy swift-storage-zone3

This will result in a configured storage cluster of 3 zones, each with one node. To expand capacity of the storage system, nodes can be added to specific zones in the ring.

$ juju add-unit swift-storage-zone1
$ juju add-unit -n5 swift-storage-zone3    # Adds 5 units to zone3

This charm will not balance the storage ring until there are enough storage zones to meet its minimum replica requirement, in this case 3.

The other option for zone assignment is 'auto'. In this mode, swift-proxy gets a relation to a single swift-storage service unit. Each machine unit assigned to that service unit will be distributed evenly across zones.

$ cat >swift.cfg <<END
swift-proxy:
    zone-assignment: auto
    replicas: 3
swift-storage:
    zone: 1
    block-device: /etc/swift/storage.img|2G
END
$ juju deploy --config=swift.cfg swift-proxy
$ juju deploy --config=swift.cfg swift-storage
$ juju add-relation swift-proxy swift-storage
# The swift-storage/0 unit ends up the first node in zone 1
$ juju add-unit swift-storage
# swift-storage/1 ends up the first node in zone 2.
$ juju add-unit swift-storage
# swift-storage/2 is the first in zone 3, replica requirement is satisfied
# the ring is balanced.

Extending the ring in the case is just a matter of adding more units to the single service unit. New units will be distributed across the existing zones.

$ juju add-unit swift-storage
# swift-storage/3 is assigned to zone 1.
$ juju add-unit swift-storage
# swift-storage/4 is assigned to zone 2.
etc.

Installation repository.

The 'openstack-origin' setting allows Swift to be installed from installation repositories and can be used to setup access to the Ubuntu Cloud Archive to support installing Swift versions more recent than what is shipped with Ubuntu 12.04 (1.4.8). For more information, see config.yaml.

Authentication.

By default, the charm will be deployed using the tempauth auth system. This is a simple and not-recommended auth system that functions without any external dependencies. See Swift documentation for details.

The charm may also be configured to use Keystone, either manually (via config) or automatically via a relation to an existing Keystone service using the cs:precise/keystone charm. The latter is preferred, however, if a Keystone service is desired but it is not managed by Juju, the configuration for the auth token middleware can be set manually via the charm's config. A relation to a Keystone server via the identity-service interface will configure swift-proxy with the appropriate credentials to make use of Keystone and is required for any integration with other OpenStack components.

Glance

Swift may be used to as a storage backend for the Glance image service. To do so, simply add a relation between swift-proxy and an existing Glance service deployed using the cs:precise/glance charm.