vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #827 from aaronlehmann/read-only-mode-2

Browse source 
Add a read-only mode as a configuration option
This commit is contained in:
Stephen Day 2015-10-15 11:50:31 -07:00
commit dfe60f4cb1
6 changed files with 113 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/configuration.md
View file

@ -118,6 +118,8 @@ information about each option that appears later in this page.
age: 168h
interval: 24h
dryrun: false
readonly:
enabled: false
auth:
silly:
realm: silly-realm
@ -644,14 +646,15 @@ This storage backend uses Amazon's Simple Storage Service (S3).
### Maintenance
Currently the registry can perform one maintenance function: upload purging. This and future
maintenance functions which are related to storage can be configured under the maintenance section.
Currently upload purging and read-only mode are the only maintenance functions available.
These and future maintenance functions which are related to storage can be configured under
the maintenance section.
### Upload Purging
Upload purging is a background process that periodically removes orphaned files from the upload
directories of the registry. Upload purging is enabled by default. To
configure upload directory purging, the following parameters
configure upload directory purging, the following parameters
must be set.
@ -664,6 +667,16 @@ must be set.
Note: `age` and `interval` are strings containing a number with optional fraction and a unit suffix: e.g. 45m, 2h10m, 168h (1 week).
### Read-only mode
If the `readonly` section under `maintenance` has `enabled` set to `true`,
clients will not be allowed to write to the registry. This mode is useful to
temporarily prevent writes to the backend storage so a garbage collection pass
can be run. Before running garbage collection, the registry should be
restarted with readonly's `enabled` set to true. After the garbage collection
pass finishes, the registry may be restarted again, this time with `readonly`
removed from the configuration (or set to false).
### Openstack Swift
This storage backend uses Openstack Swift object storage.