Fix package README errors
With the README file used as the package long description, errors would cause the package checks to fail when uploading to PyPi. This switches the README to be in RST format and gets rid of validation errors. Change-Id: I8f3d3eb9ba2cc4b3d46d8748bc1340500fc7be0e Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
parent
9fcedac3b9
commit
4d0ffa4da7
50
README.md
50
README.md
|
@ -1,50 +0,0 @@
|
|||
ansible-role-container-registry
|
||||
===============================
|
||||
|
||||
A role to deploy a container registry.
|
||||
For now, the role only support Docker Registry v2.
|
||||
|
||||
|
||||
## Role Variables ##
|
||||
|
||||
**Variables used for container registry**
|
||||
|
||||
| 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 |
|
||||
|
||||
## 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
|
|
@ -0,0 +1,87 @@
|
|||
ansible-role-container-registry
|
||||
===============================
|
||||
|
||||
A role to deploy a container registry.
|
||||
For now, the role only support Docker Registry v2.
|
||||
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
.. list-table:: Variables used for container registry
|
||||
:widths: auto
|
||||
:header-rows: 1
|
||||
|
||||
* - 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
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
- ansible >= 2.4
|
||||
- python >= 2.6
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
None
|
||||
|
||||
Example Playbooks
|
||||
-----------------
|
||||
|
||||
Modify Image
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The following playbook will deploy a Docker registry:
|
||||
|
||||
.. code-block::
|
||||
|
||||
- hosts: localhost
|
||||
become: true
|
||||
roles:
|
||||
- container-registry
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Apache 2.0
|
|
@ -2,7 +2,7 @@
|
|||
name = ansible-role-container-registry
|
||||
summary = ansible-container-registry - Ansible role to deploy a container registry
|
||||
description-file =
|
||||
README.md
|
||||
README.rst
|
||||
author = TripleO Team
|
||||
author-email = emilien@redhat.com
|
||||
home-page = https://git.openstack.org/cgit/openstack/ansible-role-container-registry
|
||||
|
|
Loading…
Reference in New Issue