Improve README
Change-Id: I2b77ff1e3ffd6355e4721e170abe6c4b6d5d5f05
This commit is contained in:
parent
10340cbd9e
commit
dee32248dd
46
README.md
46
README.md
|
@ -4,17 +4,47 @@ ansible-role-container-registry
|
|||
A role to deploy a container registry.
|
||||
For now, the role only support Docker Registry v2.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Right now the role has been tested on Red Hat systems only.
|
||||
## Role Variables ##
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
**Variables used for container registry**
|
||||
|
||||
none
|
||||
| Name | Default Value | Description |
|
||||
|-------------------|---------------------|----------------------|
|
||||
| `container_registry_debug` | `false` | Enable debug option in Docker |
|
||||
| `container_registry_deploy_docker` | `true` | Whether or not to deploy Docker |
|
||||
| `container_registry_deploy_docker_distribution` | `true` | Whether or not to deploy Docker Distribution |
|
||||
| `container_registry_deployment_user` | `centos` | User which needs to manage containers |
|
||||
| `container_registry_docker_options` | `--log-driver=journald --signature-verification=false --iptables=false --live-restore` | Options given to Docker configuration |
|
||||
| `container_registry_insecure_registries` | `[]` | Array of insecure registries |
|
||||
| `container_registry_network_options` | `[undefined]` | Docker networking options |
|
||||
| `container_registry_host` | `localhost` | Docker registry host |
|
||||
| `container_registry_port` | `8787` | Docker registry port |
|
||||
| `container_registry_mirror` | `[undefined]` | Docker registry mirror |
|
||||
| `container_registry_storage_options` | `-s overlay2` | Docker storage options |
|
||||
| `container_registry_selinux` | `false` | Whether or not SElinux is enabled for containers |
|
||||
| `container_registry_additional_sockets` | `[undefined]` | Additional sockets for containers |
|
||||
|
||||
License
|
||||
-------
|
||||
## Requirements ##
|
||||
|
||||
- ansible >= 2.4
|
||||
- python >= 2.6
|
||||
|
||||
## Dependencies ##
|
||||
|
||||
None
|
||||
|
||||
## Example Playbooks ##
|
||||
|
||||
### Modify Image ###
|
||||
|
||||
The following playbook will deploy a Docker registry:
|
||||
|
||||
- hosts: localhost
|
||||
become: true
|
||||
roles:
|
||||
- container-registry
|
||||
|
||||
## License ##
|
||||
|
||||
Apache 2.0
|
||||
|
|
Loading…
Reference in New Issue