distribution/docs/storage-drivers/swift.md
Richard Scothern df2184c810 Merge pull request #1627 from luckyraul/swift_auth_url
Swift auth version param
2016-06-01 11:23:23 -07:00

7.5 KiB

OpenStack Swift storage driver

An implementation of the storagedriver.StorageDriver interface that uses OpenStack Swift for object storage.

Parameters

Parameter Required Description
authurl yes URL for obtaining an auth token. https://storage.myprovider.com/v2.0 or https://storage.myprovider.com/v3/auth
username yes Your Openstack user name.
password yes Your Openstack password.
region no The Openstack region in which your container exists.
container yes The name of your Swift container where you wish to store the registry's data. The driver creates the named container during its initialization.
tenant no Your Openstack tenant name. You can either use tenant or tenantid.
tenantid no Your Openstack tenant id. You can either use tenant or tenantid.
domain no Your Openstack domain name for Identity v3 API. You can either use domain or domainid.
domainid no Your Openstack domain id for Identity v3 API. You can either use domain or domainid.
trustid no Your Openstack trust id for Identity v3 API.
insecureskipverify no true to skip TLS verification, false by default.
chunksize no Size of the data segments for the Swift Dynamic Large Objects. This value should be a number (defaults to 5M).
prefix no This is a prefix that will be applied to all Swift keys to allow you to segment data in your container if necessary. Defaults to the empty string which is the container's root.
secretkey no The secret key used to generate temporary URLs.
accesskey no The access key to generate temporary URLs. It is used by HP Cloud Object Storage in addition to the `secretkey` parameter.
authurl

URL for obtaining an auth token.

username

Your OpenStack user name.

password

Your OpenStack password.

container

The name of your Swift container where you wish to store the registry's data. The driver creates the named container during its initialization.

tenant

Optionally, your OpenStack tenant name. You can either use tenant or tenantid.

tenantid

Optionally, your OpenStack tenant id. You can either use tenant or tenantid.

domain

Optionally, your OpenStack domain name for Identity v3 API. You can either use domain or domainid.

domainid

Optionally, your OpenStack domain id for Identity v3 API. You can either use domain or domainid.

trustid

Optionally, your OpenStack trust id for Identity v3 API.

insecureskipverify

Optionally, set insecureskipverify to true to skip TLS verification for your OpenStack provider. The driver uses false by default.

region

Optionally, specify the OpenStack region name in which you would like to store objects (for example fr).

authversion

Optionally, specify the OpenStack Auth's version,for example 3. By default the driver will autodetect the auth's version from the AuthURL.

chunksize

Optionally, specify the segment size for Dynamic Large Objects uploads (performed by WriteStream) to Swift. The default is 5 MB. You might experience better performance for larger chunk sizes depending on the speed of your connection to Swift.

prefix

Optionally, supply a prefix that will be applied to all Swift keys to allow you to segment data in your container if necessary. Defaults to the empty string which is the container's root.

secretkey

Optionally, the secret key used to generate temporary URLs.

accesskey

Optionally, the access key to generate temporary URLs. It is used by HP Cloud Object Storage in addition to the `secretkey` parameter.

The features supported by the Swift server are queried by requesting the /info URL on the server. In case the administrator disabled that feature, the configuration file can specify the following optional parameters :

tempurlcontainerkey

Specify whether to use container secret key to generate temporary URL when set to true, or the account secret key otherwise.

tempurlmethods

Array of HTTP methods that are supported by the TempURL middleware of the Swift server. Example:

- tempurlmethods: - GET - PUT - HEAD - POST - DELETE