TrueCloudLab/distribution
13
0
Fork 3
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions

just reflow to 80 chars

Browse source 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit 2015-03-19 13:44:07 +10:00
parent 37978cd7a0
commit 18649a2839
3 changed files with 38 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/storagedriver/azure.md
View file

@ -1,15 +1,18 @@
# Docker Registry Microsoft Azure Blob Storage Driver
An implementation of the `storagedriver.StorageDriver` interface which uses [Microsoft Azure Blob Storage][azure-blob-storage] for object storage.
An implementation of the `storagedriver.StorageDriver` interface which uses
[Microsoft Azure Blob Storage][azure-blob-storage] for object storage.
## Parameters
The following parameters must be used to authenticate and configure the storage driver (case-sensitive):
The following parameters must be used to authenticate and configure the storage
driver (case-sensitive):
* `accountname`: Name of the Azure Storage Account.
* `accountkey`: Primary or Secondary Key for the Storage Account.
* `container`: Name of the root storage container in which all registry data will be stored. Must comply the storage container name [requirements][create-container-api].
* `container`: Name of the root storage container in which all registry data will
* be stored. Must comply the storage container name [requirements][create-container-api].
[azure-blob-storage]: http://azure.microsoft.com/en-us/services/storage/

6
doc/storagedriver/filesystem.md
View file

@ -1,8 +1,10 @@
Docker-Registry Filesystem Storage Driver
=========================================
An implementation of the `storagedriver.StorageDriver` interface which uses the local filesystem.
An implementation of the `storagedriver.StorageDriver` interface which uses the
local filesystem.
## Parameters
`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to `/tmp/registry/storage`.
- `rootdirectory`: (optional) The root directory tree in which all registry files
will be stored. Defaults to `/tmp/registry/storage`.

48
doc/storagedriver/s3.md
View file

@ -1,26 +1,34 @@
Docker-Registry S3 Storage Driver
=========================================
An implementation of the `storagedriver.StorageDriver` interface which uses Amazon S3 for object storage.
An implementation of the `storagedriver.StorageDriver` interface which uses
Amazon S3 for object storage.
## Parameters
`accesskey`: Your aws access key.
`secretkey`: Your aws secret key.
**Note** You can provide empty strings for your access and secret keys if you plan on running the driver on an ec2 instance and will handle authentication with the instance's credentials.
`region`: The name of the aws region in which you would like to store objects (for example `us-east-1`). For a list of regions, you can look at http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html
`bucket`: The name of your s3 bucket where you wish to store objects (needs to already be created prior to driver initialization).
`encrypt`: (optional) Whether you would like your data encrypted on the server side (defaults to false if not specified).
`secure`: (optional) Whether you would like to transfer data to the bucket over ssl or not. Defaults to true (meaning transfering over ssl) if not specified. Note that while setting this to false will improve performance, it is not recommended due to security concerns.
`v4auth`: (optional) Whether you would like to use aws signature version 4 with your requests. This defaults to true if not specified (note that the eu-central-1 region does not work with version 2 signatures, so the driver will error out if initialized with this region and v4auth set to false)
`chunksize`: (optional) The default part size for multipart uploads (performed by WriteStream) to s3. The default is 10 MB. Keep in mind that the minimum part size for s3 is 5MB. You might experience better performance for larger chunk sizes depending on the speed of your connection to s3.
`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root).
- `accesskey`: Your aws access key.
- `secretkey`: Your aws secret key.
**Note** You can provide empty strings for your access and secret keys if you
plan on running the driver on an ec2 instance and will handle authentication
with the instance's credentials.
- `region`: The name of the aws region in which you would like to store objects
(for example `us-east-1`). For a list of regions, you can look at
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html
- `bucket`: The name of your s3 bucket where you wish to store objects (needs
to already be created prior to driver initialization).
- `encrypt`: (optional) Whether you would like your data encrypted on the server
side (defaults to false if not specified).
- `secure`: (optional) Whether you would like to transfer data to the bucket over
SSL or not. Defaults to true (meaning transferring over SSL) if not specified.
Note that while setting this to false will improve performance, it is not
recommended due to security concerns.
- `v4auth`: (optional) Whether you would like to use aws signature version 4 with
your requests. This defaults to true if not specified (note that the eu-central-1
region does not work with version 2 signatures, so the driver will error out if
initialized with this region and v4auth set to false)
- `chunksize`: (optional) The default part size for multipart uploads (performed
by WriteStream) to s3. The default is 10 MB. Keep in mind that the minimum part
size for s3 is 5MB. You might experience better performance for larger chunk
sizes depending on the speed of your connection to s3.
- `rootdirectory`: (optional) The root directory tree in which all registry files
will be stored. Defaults to the empty string (bucket root).