Ubuntu Server 10.04 LTS installation media Swift can run with other distros, but for this document we will focus on installing on Ubuntu Server, ypmv (your packaging may vary). Basic architecture and terms ---------------------------- - *node* - a host machine running one or more Swift services - *Proxy node* - node that runs Proxy services; also runs TempAuth - *Storage node* - node that runs Account, Container, and Object services - *ring* - a set of mappings of Swift data to physical devices This document shows a cluster using the following types of nodes: one Proxy node Runs the swift-proxy-server processes which proxy requests to the appropriate Storage nodes. The proxy server will also contain the TempAuth service as WSGI middleware. five Storage nodes Runs the swift-account-server, swift-container-server, and swift-object-server processes which control storage of the account databases, the container databases, as well as the actual stored objects. Fewer Storage nodes can be used initially, but a minimum of 5 is recommended for a production cluster. This document describes each Storage node as a separate zone in the ring. It is recommended to have a minimum of 5 zones. A zone is a group of nodes that is as isolated as possible from other nodes (separate servers, network, power, even geography). The ring guarantees that every replica is stored in a separate zone. For more information about the ring and zones, see: The Ring. To increase reliability, you may want to add additional Proxy servers for performance which is described in Adding a Proxy Server.

This document refers to two networks. An external network for connecting to the Proxy server, and a storage network that is not accessible from outside the cluster, to which all of the nodes are connected. All of the Swift services, as well as the rsync daemon on the Storage nodes are configured to listen on their STORAGE_LOCAL_NET IP addresses. Run all commands as the root user

Install the baseline Ubuntu Server 10.04 LTS on all nodes. Install common Swift software prereqs: apt-get install python-software-properties add-apt-repository ppa:swift-core/release apt-get update apt-get install swift openssh-server Create and populate configuration directories: mkdir -p /etc/swift chown -R swift:swift /etc/swift/ On the first node only, create /etc/swift/swift.conf: cat >/etc/swift/swift.conf <<EOF [swift-hash] # random unique string that can never change (DO NOT LOSE) swift_hash_path_suffix = `od -t x8 -N 8 -A n </dev/random` EOF On the second and subsequent nodes: Copy that file over. It must be the same on every node in the cluster!: scp firstnode.example.com:/etc/swift/swift.conf /etc/swift/ Publish the local network IP address for use by scripts found later in this documentation: export STORAGE_LOCAL_NET_IP=10.1.2.3 export PROXY_LOCAL_NET_IP=10.1.2.4 The random string of text in /etc/swift/swift.conf is used as a salt when hashing to determine mappings in the ring.

It is assumed that all commands are run as the root user Install swift-proxy service: apt-get install swift-proxy memcached Create self-signed cert for SSL: cd /etc/swift openssl req -new -x509 -nodes -out cert.crt -keyout cert.key If you don't create the cert files, Swift silently uses http internally rather than https. This document assumes that you have created these certs, so if you're following along step-by-step, create them. Modify memcached to listen on the default interfaces. Preferably this should be on a local, non-public network. Edit the IP address in /etc/memcached.conf, for example: perl -pi -e "s/-l 127.0.0.1/-l $PROXY_LOCAL_NET_IP/" /etc/memcached.conf Restart the memcached server: service memcached restart Create /etc/swift/proxy-server.conf: cat >/etc/swift/proxy-server.conf <<EOF [DEFAULT] cert_file = /etc/swift/cert.crt key_file = /etc/swift/cert.key bind_port = 8080 workers = 8 user = swift [pipeline:main] pipeline = healthcheck cache tempauth proxy-server [app:proxy-server] use = egg:swift#proxy allow_account_management = true account_autocreate = true [filter:tempauth] use = egg:swift#tempauth user_system_root = testpass .admin https://$PROXY_LOCAL_NET_IP:8080/v1/AUTH_system [filter:healthcheck] use = egg:swift#healthcheck [filter:cache] use = egg:swift#memcache memcache_servers = $PROXY_LOCAL_NET_IP:11211 EOF If you run multiple memcache servers, put the multiple IP:port listings in the [filter:cache] section of the proxy-server.conf file like: `10.1.2.3:11211,10.1.2.4:11211`. Only the proxy server uses memcache. The memcache_servers variable can also be set in a separate file: /etc/swift/memcache.conf. If it is set in both places, the value in proxy-server.conf will override the one in memcache.conf. Create the account, container and object rings. The builder command is basically creating a builder file with a few parameters. The parameter with the value of 18 represents 2 ^ 18th, the value that the partition will be sized to. Set this "partition power" value based on the total amount of storage you expect your entire ring to use. The value of 3 represents the number of replicas of each object, with the last value being the number of hours to restrict moving a partition more than once. cd /etc/swift swift-ring-builder account.builder create 18 3 1 swift-ring-builder container.builder create 18 3 1 swift-ring-builder object.builder create 18 3 1 For every storage device in /srv/node on each node add entries to each ring: export ZONE= # set the zone number for that storage device export STORAGE_LOCAL_NET_IP= # and the IP address export WEIGHT=100 # relative weight (higher for bigger/faster disks) export DEVICE=sdb1 swift-ring-builder account.builder add z$ZONE-$STORAGE_LOCAL_NET_IP:6002/$DEVICE $WEIGHT swift-ring-builder container.builder add z$ZONE-$STORAGE_LOCAL_NET_IP:6001/$DEVICE $WEIGHT swift-ring-builder object.builder add z$ZONE-$STORAGE_LOCAL_NET_IP:6000/$DEVICE $WEIGHT Assuming there are 5 zones with 1 node per zone, ZONE should start at 1 and increment by one for each additional node. Verify the ring contents for each ring: swift-ring-builder account.builder swift-ring-builder container.builder swift-ring-builder object.builder Rebalance the rings: swift-ring-builder account.builder rebalance swift-ring-builder container.builder rebalance swift-ring-builder object.builder rebalance Rebalancing rings can take some time. Copy the account.ring.gz, container.ring.gz, and object.ring.gz files to each of the Proxy and Storage nodes in /etc/swift. Make sure all the config files are owned by the swift user: chown -R swift:swift /etc/swift Start Proxy services: swift-init proxy start

Swift should work on any modern filesystem that supports Extended Attributes (XATTRS). We currently recommend XFS as it demonstrated the best overall performance for the swift use case after considerable testing and benchmarking at Rackspace. It is also the only filesystem that has been thoroughly tested. These instructions assume that you are going to devote /dev/sdb1 to an XFS filesystem. Install Storage node packages: apt-get install swift-account swift-container swift-object xfsprogs For every device on the node, setup the XFS volume (/dev/sdb is used as an example): fdisk /dev/sdb (set up a single partition) mkfs.xfs -i size=1024 /dev/sdb1 echo "/dev/sdb1 /srv/node/sdb1 xfs noatime,nodiratime,nobarrier,logbufs=8 0 0" >> /etc/fstab mkdir -p /srv/node/sdb1 mount /srv/node/sdb1 chown -R swift:swift /srv/node Create /etc/rsyncd.conf: cat >/etc/rsyncd.conf <<EOF uid = swift gid = swift log file = /var/log/rsyncd.log pid file = /var/run/rsyncd.pid address = $STORAGE_LOCAL_NET_IP [account] max connections = 2 path = /srv/node/ read only = false lock file = /var/lock/account.lock [container] max connections = 2 path = /srv/node/ read only = false lock file = /var/lock/container.lock [object] max connections = 2 path = /srv/node/ read only = false lock file = /var/lock/object.lock EOF Edit the RSYNC_ENABLE= line in /etc/default/rsync: perl -pi -e 's/RSYNC_ENABLE=false/RSYNC_ENABLE=true/' /etc/default/rsync Start rsync daemon: service rsync start The rsync daemon requires no authentication, so it should be run on a local, private network. Create /etc/swift/account-server.conf: cat >/etc/swift/account-server.conf <<EOF [DEFAULT] bind_ip = $STORAGE_LOCAL_NET_IP workers = 2 [pipeline:main] pipeline = account-server [app:account-server] use = egg:swift#account [account-replicator] [account-auditor] [account-reaper] EOF Create /etc/swift/container-server.conf: cat >/etc/swift/container-server.conf <<EOF [DEFAULT] bind_ip = $STORAGE_LOCAL_NET_IP workers = 2 [pipeline:main] pipeline = container-server [app:container-server] use = egg:swift#container [container-replicator] [container-updater] [container-auditor] EOF Create /etc/swift/object-server.conf: cat >/etc/swift/object-server.conf <<EOF [DEFAULT] bind_ip = $STORAGE_LOCAL_NET_IP workers = 2 [pipeline:main] pipeline = object-server [app:object-server] use = egg:swift#object [object-replicator] [object-updater] [object-auditor] EOF Start the storage services. If you use this command, it will try to start every service for which a configuration file exists, and throw a warning for any configuration files which don't exist: swift-init all start Or, if you want to start them one at a time, run them as below. Note that if the server program in question generates any output on its stdout or stderr, swift-init has already redirected the command's output to /dev/null. If you encounter any difficulty, stop the server and run it by hand from the command line. Any server may be started using "swift-$SERVER-$SERVICE /etc/swift/$SERVER-config", where $SERVER might be object, continer, or account, and $SERVICE might be server, replicator, updater, or auditor. swift-init object-server start swift-init object-replicator start swift-init object-updater start swift-init object-auditor start swift-init container-server start swift-init container-replicator start swift-init container-updater start swift-init container-auditor start swift-init account-server start swift-init account-replicator start swift-init account-auditor start

You run these commands from the Proxy node. Get an X-Storage-Url and X-Auth-Token: curl -k -v -H 'X-Storage-User: system:root' -H 'X-Storage-Pass: testpass' https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 Check that you can HEAD the account: curl -k -v -H 'X-Auth-Token: <token-from-x-auth-token-above>' <url-from-x-storage-url-above> Check that swift works (at this point, expect zero containers, zero objects, and zero bytes): swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass stat Use swift to upload a few files named 'bigfile[1-2].tgz' to a container named 'myfiles': swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass upload myfiles bigfile1.tgz swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass upload myfiles bigfile2.tgz Use swift to download all files from the 'myfiles' container: swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass download myfiles Use swift to save a backup of your builder files to a container named 'builders'. Very important not to lose your builders!: swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass upload builders /etc/swift/*.builder Use swift to list your containers: swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass list Use swift to list the contents of your 'builders' container: swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass list builders Use swift to download all files from the 'builders' container: swift -A https://$PROXY_LOCAL_NET_IP:8080/auth/v1.0 -U system:root -K testpass download builders

For reliability's sake you may want to have more than one proxy server. You can set up the additional proxy node in the same manner that you set up the first proxy node but with additional configuration steps. Once you have more than two proxies, you also want to load balance between the two, which means your storage endpoint also changes. You can select from different strategies for load balancing. For example, you could use round robin dns, or an actual load balancer (like pound) in front of the two proxies, and point your storage url to the load balancer. See config-proxy for the initial setup, and then follow these additional steps. Update the list of memcache servers in /etc/swift/proxy-server.conf for all the added proxy servers. If you run multiple memcache servers, use this pattern for the multiple IP:port listings: `10.1.2.3:11211,10.1.2.4:11211` in each proxy server's conf file.: [filter:cache] use = egg:swift#memcache memcache_servers = $PROXY_LOCAL_NET_IP:11211 Change the storage url for any users to point to the load balanced url, rather than the first proxy server you created in /etc/swift/proxy-server.conf: [filter:tempauth] use = egg:swift#tempauth user_system_root = testpass .admin http[s]://<LOAD_BALANCER_HOSTNAME>:<PORT>/v1/AUTH_system Next, copy all the ring information to all the nodes, including your new proxy nodes, and ensure the ring info gets to all the storage nodes as well. After you sync all the nodes, make sure the admin has the keys in /etc/swift and the ownership for the ring file is correct.

If you see problems, look in var/log/syslog (or messages on some distros). Also, at Rackspace we have seen hints at drive failures by looking at error messages in /var/log/kern.log. There are more debugging hints and tips in the Troubleshooting section.