Docker registry ufile driver
Project description
# Docker registry ufile driver
This is a [docker-registry backend driver](https://github.com/dotcloud/docker-registry/tree/master/depends/docker-registry-core) based on the [UFile](http://www.ucloud.cn/product/ufile_main/) key-value storage.
[![License][license-image]][license-url]
[![PyPI version][pypi-image]][pypi-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coverage-image]][coverage-url]
[中文文档](https://gitcafe.com/SkyLothar/docker-registry-driver-ufile/blob/master/README-zhCN.md)
## Usage
Assuming you have a working docker-registry
`pip install docker-registry-driver-ufile`
Edit your configuration so that `storage` reads `ufile`.
## Options
You may add any of the following to your main docker-registry configuration to further configure it.
1. `ufile_baseurl`: your ufile bucket url, like `http://your-bucket.ufile.ucloud.cn` (scheme included), you should use internal url like `http://your-bucket.ufile.cn-north-03.ucloud.cn` if possible
1. `ufile_public_key`: ucloud public key
1. `ufile_private_key`: ucloud private key
1. `ufile_retries`: total retries if an http request fails (default 3)
1. `ufile_retry_interval`: if a http request fails, wait several seconds before trying again (default 1)
1. `ufile_timeout`: seconds to wait for the operation complete (default 60)
Example:
```yaml
ufile:
<<: *common
storage: ufile
ufile_baseurl: http://your-bucket.ufile.ucloud.cn
ufile_public_key: your-ucloud-public-key
ufile_private_key: your-ucloud-private-key
ufile_retries: 3
ufile_retry_interval: 1
ufile_timeout: 60
```
## Developer setup
Clone this.
Setup test environment:
```
pip install tox
```
Start the test `ufile`:
```
tox
```
You are ready to hack.
In order to verify what you did is ok, just run `tox`.
This will run the tests provided by [`docker-registry-core`](https://github.com/dotcloud/docker-registry/tree/master/depends/docker-registry-core)
## License
This is licensed under the Apache license.
Most of the code here comes from docker-registry, under an Apache license as well.
[pypi-url]: https://pypi.python.org/pypi/docker-registry-driver-ufile
[pypi-image]: https://img.shields.io/pypi/v/docker-registry-driver-ufile.svg?style=flat-square
[travis-url]: https://travis-ci.org/SkyLothar/docker-registry-driver-ufile
[travis-image]:https://img.shields.io/travis/SkyLothar/docker-registry-driver-ufile.svg?style=flat-square
[coverage-url]: https://coveralls.io/r/SkyLothar/docker-registry-driver-ufile
[coverage-image]: https://img.shields.io/coveralls/SkyLothar/docker-registry-driver-ufile.svg?style=flat-square
[license-url]: http://www.apache.org/licenses/LICENSE-2.0.html
[license-image]: https://img.shields.io/github/license/skylothar/docker-registry-driver-ufile.svg?style=flat-square
This is a [docker-registry backend driver](https://github.com/dotcloud/docker-registry/tree/master/depends/docker-registry-core) based on the [UFile](http://www.ucloud.cn/product/ufile_main/) key-value storage.
[![License][license-image]][license-url]
[![PyPI version][pypi-image]][pypi-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coverage-image]][coverage-url]
[中文文档](https://gitcafe.com/SkyLothar/docker-registry-driver-ufile/blob/master/README-zhCN.md)
## Usage
Assuming you have a working docker-registry
`pip install docker-registry-driver-ufile`
Edit your configuration so that `storage` reads `ufile`.
## Options
You may add any of the following to your main docker-registry configuration to further configure it.
1. `ufile_baseurl`: your ufile bucket url, like `http://your-bucket.ufile.ucloud.cn` (scheme included), you should use internal url like `http://your-bucket.ufile.cn-north-03.ucloud.cn` if possible
1. `ufile_public_key`: ucloud public key
1. `ufile_private_key`: ucloud private key
1. `ufile_retries`: total retries if an http request fails (default 3)
1. `ufile_retry_interval`: if a http request fails, wait several seconds before trying again (default 1)
1. `ufile_timeout`: seconds to wait for the operation complete (default 60)
Example:
```yaml
ufile:
<<: *common
storage: ufile
ufile_baseurl: http://your-bucket.ufile.ucloud.cn
ufile_public_key: your-ucloud-public-key
ufile_private_key: your-ucloud-private-key
ufile_retries: 3
ufile_retry_interval: 1
ufile_timeout: 60
```
## Developer setup
Clone this.
Setup test environment:
```
pip install tox
```
Start the test `ufile`:
```
tox
```
You are ready to hack.
In order to verify what you did is ok, just run `tox`.
This will run the tests provided by [`docker-registry-core`](https://github.com/dotcloud/docker-registry/tree/master/depends/docker-registry-core)
## License
This is licensed under the Apache license.
Most of the code here comes from docker-registry, under an Apache license as well.
[pypi-url]: https://pypi.python.org/pypi/docker-registry-driver-ufile
[pypi-image]: https://img.shields.io/pypi/v/docker-registry-driver-ufile.svg?style=flat-square
[travis-url]: https://travis-ci.org/SkyLothar/docker-registry-driver-ufile
[travis-image]:https://img.shields.io/travis/SkyLothar/docker-registry-driver-ufile.svg?style=flat-square
[coverage-url]: https://coveralls.io/r/SkyLothar/docker-registry-driver-ufile
[coverage-image]: https://img.shields.io/coveralls/SkyLothar/docker-registry-driver-ufile.svg?style=flat-square
[license-url]: http://www.apache.org/licenses/LICENSE-2.0.html
[license-image]: https://img.shields.io/github/license/skylothar/docker-registry-driver-ufile.svg?style=flat-square
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file docker-registry-driver-ufile-0.1.0.tar.gz
.
File metadata
- Download URL: docker-registry-driver-ufile-0.1.0.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d678cc3af1d2579cf861cf6bd18a903836cfac708412cc61a9d949422749bdcd |
|
MD5 | 2d4b33b2fe0012a4593da60ec85ea2f7 |
|
BLAKE2b-256 | cc23c069b88c8cf00c3dd4b3258f9b6c08558f9aea5577b978c3b297b0f7de26 |