Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bodsch/ansible-registry-ui
Ansible role to install and configure docker registry ui
https://github.com/bodsch/ansible-registry-ui
ansible ansible-role automation docker-registry registry registry-ui
Last synced: 3 months ago
JSON representation
Ansible role to install and configure docker registry ui
- Host: GitHub
- URL: https://github.com/bodsch/ansible-registry-ui
- Owner: bodsch
- License: apache-2.0
- Created: 2022-09-27T04:31:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-03T07:59:50.000Z (over 1 year ago)
- Last Synced: 2023-11-03T08:35:24.230Z (over 1 year ago)
- Topics: ansible, ansible-role, automation, docker-registry, registry, registry-ui
- Language: Python
- Homepage:
- Size: 55.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ansible Role: `registry-ui`
---
> I have transferred this role to its own [collection](https://github.com/bodsch/ansible-collection-docker).
> In future, I will not accept or process any further pull requests or issues here.
>
> **Please use the linked collection from now on!**
---
Ansible role for installing and configuring Docker [registry-ui](https://github.com/Quiq/docker-registry-ui)
without dependencies on a container.
Natively supports systemd and openrc as init system.
[][ci]
[][issues]
[][releases]
[][quality]
[ci]: https://github.com/bodsch/ansible-registry-ui/actions
[issues]: https://github.com/bodsch/ansible-registry-ui/issues?q=is%3Aopen+is%3Aissue
[releases]: https://github.com/bodsch/ansible-registry-ui/releases
[quality]: https://galaxy.ansible.com/bodsch/registry_ui
If `latest` is set for `registry_ui_version`, the role tries to install the latest release version.
**Please use this with caution, as incompatibilities between releases may occur!**
The binaries are installed below `/usr/local/bin/registry-ui/${registry_ui_version}` and later linked to `/usr/bin`.
This should make it possible to downgrade relatively safely.
The downloaded archive is stored on the Ansible controller, unpacked and then the binaries are copied to the target system.
The cache directory can be defined via the environment variable `CUSTOM_LOCAL_TMP_DIRECTORY`.
By default it is `${HOME}/.cache/ansible/registry-ui`.
If this type of installation is not desired, the download can take place directly on the target system.
However, this must be explicitly activated by setting `registry_ui_direct_download` to `true`.
## Requirements & Dependencies
Ansible Collections
- [bodsch.core](https://github.com/bodsch/ansible-collection-core)
- [bodsch.scm](https://github.com/bodsch/ansible-collection-scm)
```bash
ansible-galaxy collection install bodsch.core
ansible-galaxy collection install bodsch.scm
```
or
```bash
ansible-galaxy collection install --requirements-file collections.yml
```
## Operating systems
Tested on
* Arch Linux
* Debian based
- Debian 10 / 11
- Ubuntu 20.10
## Requirements
Running Docker Registry.
## Contribution
Please read [Contribution](CONTRIBUTING.md)
## Development, Branches (Git Tags)
The `master` Branch is my *Working Horse* includes the "latest, hot shit" and can be complete broken!
If you want to use something stable, please use a [Tagged Version](https://github.com/bodsch/ansible-registry-ui/tags)!
## Configuration
> **Please note:** The release of the registry-ui binary is done from a fork and not from the [original](https://github.com/Quiq/docker-registry-ui), because the original repository does not provide a go-binary yet!
```yaml
registry_ui_version: 0.9.5
registry_ui_release_download_url: https://github.com/bodsch/docker-registry-ui/releases
registry_ui_system_user: registry-ui
registry_ui_system_group: registry-ui
registry_ui_config_dir: /etc/registry-ui
registry_ui_data_dir: /var/lib/registry-ui
registry_ui_direct_download: false
registry_ui_service:
log_level: info
registry_ui_listen:
address: 127.0.0.1
port: 8000
registry_ui_base_path: /ui
registry_ui_debug: false
registry_ui_registry: {}
registry_ui_event: {}
registry_ui_cache: {}
registry_ui_admins: []
registry_ui_purge: {}
```
### `registry_ui_listen`
Listen interface and Port
```yaml
registry_ui_listen:
address: 127.0.0.1
port: 8000
```
### `registry_ui_registry`
Registry URL with schema and port.
Verify TLS certificate when using https.
Docker registry credentials.
They need to have a full access to the registry.
If token authentication service is enabled, it will be auto-discovered and those credentials
will be used to obtain access tokens.
When the `password_file` entry is used, the password can be passed as a docker secret
and read from file. This overides the `password` entry.
```yaml
registry_ui_registry:
url: https://docker-registry.local:5000
verify_tls: true
username: ""
password: ""
password_file: ""
```
### `registry_ui_event`
Event listener.
The same one should be configured on Docker registry as Authorization Bearer token.
```yaml
registry_ui_event:
listener_token: "" # token
retention_days: 7
database:
driver: sqlite3 # sqlite3 or mysql
location: "" # data/registry_events.db
username:
password:
hostname: 127.0.0.1:3306
schemaname: docker_events
deletion_enabled: true
anyone_can_view: true
```
### `registry_ui_cache`
```yaml
registry_ui_cache:
refresh_interval: 10
```
### `registry_ui_admins`
```yaml
registry_ui_admins:
anyone_can_delete: false
admins: []
```
### `registry_ui_purge`
Enable built-in cron to schedule purging tags in server mode.
Empty string disables this feature.
Example: `25 54 17 * * *` will run it at 17:54:25 daily.
Note, the cron schedule format includes seconds! See [robfig/cron](https://godoc.org/github.com/robfig/cron)
```yaml
registry_ui_purge:
tags_keep_days: 90
tags_keep_count: 2
tags_keep_regexp: ''
tags_keep_from_file: ''
tags_schedule: ''
```
---
## Author and License
- Bodo Schulz
## License
[Apache](LICENSE)
**FREE SOFTWARE, HELL YEAH!**