mirror of
https://github.com/atosatto/ansible-minio.git
synced 2025-01-07 18:38:30 +01:00
clean readme
This commit is contained in:
parent
2ec972e983
commit
78ee86844e
80
README.md
80
README.md
@ -1,75 +1,95 @@
|
||||
Ansible Role: Minio
|
||||
===================
|
||||
<p><img src="https://avatars0.githubusercontent.com/u/695951?s=200&v=4" alt="minio logo" title="minio" align="right" height="60" /></p>
|
||||
|
||||
# Ansible Role: Minio
|
||||
|
||||
[![Build Status](https://travis-ci.org/atosatto/ansible-minio.svg?branch=master)](https://travis-ci.org/atosatto/ansible-minio)
|
||||
[![License](https://img.shields.io/badge/license-MIT%20License-brightgreen.svg)](https://opensource.org/licenses/MIT)
|
||||
[![Ansible Role](https://img.shields.io/badge/ansible%20role-atosatto.minio-blue.svg)](https://galaxy.ansible.com/atosatto/minio/)
|
||||
[![GitHub tag](https://img.shields.io/github/tag/atosatto/ansible-minio.svg)](https://github.com/atosatto/ansible-minio/tags)
|
||||
|
||||
Install and configure the [Minio](https://minio.io/) S3 compatible object storage server
|
||||
on RHEL/CentOS and Debian/Ubuntu.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Requirements
|
||||
|
||||
None.
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
## Role Variables
|
||||
|
||||
Available variables are listed below, along with default values (see `defaults/main.yml`):
|
||||
|
||||
minio_server_bin: /usr/local/bin/minio
|
||||
minio_client_bin: /usr/local/bin/mc
|
||||
```yaml
|
||||
minio_server_bin: /usr/local/bin/minio
|
||||
minio_client_bin: /usr/local/bin/mc
|
||||
```
|
||||
|
||||
Installation path of the Minio server and client binaries.
|
||||
|
||||
minio_user: minio
|
||||
minio_group: minio
|
||||
```yaml
|
||||
minio_user: minio
|
||||
minio_group: minio
|
||||
```
|
||||
|
||||
Name and group of the user running the minio server.
|
||||
**NB**: This role automatically creates the minio user and/or group if these does not exist in the system.
|
||||
|
||||
minio_server_envfile: /etc/default/minio
|
||||
```yaml
|
||||
minio_server_envfile: /etc/default/minio
|
||||
```
|
||||
|
||||
Path to the file containing the minio server configuration ENV variables.
|
||||
|
||||
minio_server_addr: ":9091"
|
||||
```yaml
|
||||
minio_server_addr: ":9091"
|
||||
```
|
||||
|
||||
The Minio server listen address.
|
||||
|
||||
minio_server_datadirs: [ ]
|
||||
```yaml
|
||||
minio_server_datadirs: [ ]
|
||||
```
|
||||
|
||||
Directories of the folder containing the minio server data
|
||||
**NB**: This variable must always be set by the role, otherwise the minio service will not start.
|
||||
|
||||
minio_server_opts: ""
|
||||
```yaml
|
||||
minio_server_opts: ""
|
||||
```
|
||||
|
||||
Additional CLI options that must be appended to the minio server start command.
|
||||
|
||||
minio_access_key: ""
|
||||
minio_secret_key: ""
|
||||
```yaml
|
||||
minio_access_key: ""
|
||||
minio_secret_key: ""
|
||||
```
|
||||
|
||||
Minio access and secret keys.
|
||||
|
||||
minio_install_server: false
|
||||
minio_install_client: false
|
||||
```yaml
|
||||
minio_install_server: true
|
||||
minio_install_client: true
|
||||
```
|
||||
|
||||
Switches to disable minio server and/or minio client installation.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
## Dependencies
|
||||
|
||||
None.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
## Example Playbook
|
||||
|
||||
$ cat playbook.yml
|
||||
- name: "Install Minio"
|
||||
hosts: all
|
||||
roles:
|
||||
- { role: atosatto.minio,
|
||||
minio_server_datadirs: [ "/tmp" ] }
|
||||
```yaml
|
||||
- name: "Install Minio"
|
||||
hosts: all
|
||||
roles:
|
||||
- { role: atosatto.minio,
|
||||
minio_server_datadirs: [ "/tmp" ] }
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
## Changelog
|
||||
|
||||
See [changelog](CHANGELOG.md).
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
Loading…
Reference in New Issue
Block a user