In this page you will find documentation about the python swiftclient library you can use to access Object Store via the Swift protocol.

Library documentation

There are numerous libraries and bindings for Swift. These are listed on: https://docs.openstack.org/developer/swift/associated_projects.html.

The only one that is officially supported by the OpenStack Swift project is the Python-SwiftClient. So this is the only one we will discuss here. The Python-SwiftClient has a Service API and a Connection API.

Connection API

A low level API that provides methods for authentication and methods that correspond to the individual REST API calls described in the swift documentation. For usage details see the client docs: swiftclient.client. A more detailed description and examples of the API is at the Connection API page.

One example of creating a new container is given below:

The script looks like this:

#!/usr/bin/python3

from swiftclient.client import Connection

_authurl = 'https://objectstore.surf.nl:5000/v3'
_auth_version = '3'
_user = '<user name>'
_project = '<project name>'
_key = '<password>'

#For local keystone accounts
_user_domain='Default'
_project_domain='Default'

#For keystone accounts coupled to SURF CUA accounts
#_user_domain='CuaUsers'
#_project_domain='CuaUsers'

_os_options = {
    'user_domain_name': _user_domain,
    'project_domain_name': _project_domain,
    'project_name': _project
}

conn = Connection(
    authurl=_authurl,
    user=_user,
    key=_key,
    os_options=_os_options,
    auth_version=_auth_version
)

#Create a container
container_name = 'my-new-container'
conn.put_container(container_name)

If you are a keystone user with a local account, then both the project domain and user domain have the value Default. If you are a keystone user with a SURF Central User Administration (CUA) account, then both the project domain and user domain must be set to CuaUsers.

Service API

A higher-level API aimed at allowing developers an easy way to perform multiple operations asynchronously using a configurable thread pool. Documentation for each service method call can be found here: swiftclient.service.

More detailed information on this API is described at the Service API page. There are also examples given on that page. To let your scripts do the authentication you need to set some environment variables. That is also described on the Service API page.

One example of stat is given below:

First you need to set some environment variables for the authentication:

export OS_PROJECT_DOMAIN_NAME=<project domain>
export OS_USER_DOMAIN_NAME=<user domain>
export OS_PROJECT_NAME=<project>
export OS_USERNAME=<user>
export OS_PASSWORD=<password>
export OS_AUTH_URL=https://objectstore.surf.nl:5000/v3
export OS_IDENTITY_API_VERSION=3
export OS_AUTH_VERSION=3

Having done this you can run your script to do,for example, a stat on an object in a container. Such a script could look like this:

#!/usr/bin/python3

import logging
import pprint

from swiftclient.service import SwiftService
from sys import argv

logging.basicConfig(level=logging.ERROR)
logging.getLogger("requests").setLevel(logging.CRITICAL)
logging.getLogger("swiftclient").setLevel(logging.CRITICAL)
logger = logging.getLogger(__name__)

_opts = {'object_dd_threads': 20}
with SwiftService(options=_opts) as swift:
    container = argv[1]
    objects = argv[2:]
    header_data = {}
    stats_it = swift.stat(container=container, objects=objects)
    for stat_res in stats_it:
        if stat_res['success']:
            header_data[stat_res['object']] = stat_res['headers']
        else:
            logger.error(
                'Failed to retrieve stats for %s' % stat_res['object']
            )
    pprint.pprint(header_data)

If you are a keystone user with a local account, then both the project domain and user domain have the value Default. If you are a keystone user with a SURF Central User Administration (CUA) account, then both the project domain and user domain must be set to CuaUsers. Running this you could get something like this:

$ ./stat.py mycontainer myobject
{'myobject': {'accept-ranges': 'bytes',
              'content-length': '100000000',
              'content-type': 'binary/octet-stream',
              'date': 'Tue, 16 Jul 2024 07:25:54 GMT',
              'etag': '0f86d7c5a6180cf9584c1d21144d85b0',
              'last-modified': 'Tue, 16 Jul 2024 07:25:49 GMT',
              'strict-transport-security': 'max-age=15768000',
              'x-object-meta-mtime': '1721114724.810172',
              'x-openstack-request-id': 'tx00000fc374217aecf37c8-0066962082-9270f-default',
              'x-timestamp': '1721114749.36228',
              'x-trans-id': 'tx00000fc374217aecf37c8-0066962082-9270f-default'}}


  • No labels