[SKIP CI] update readme
This commit is contained in:
parent
ad8452b3d4
commit
24c664ad20
406
README.md
406
README.md
@ -1,2 +1,408 @@
|
||||
# xoxys.droneci
|
||||
|
||||
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.droneci/status.svg)](https://drone.rknet.org/ansible/xoxys.droneci)
|
||||
|
||||
|
||||
Setup Drone CI with docker compose
|
||||
|
||||
## Table of content
|
||||
|
||||
* [Default Variables](#default-variables)
|
||||
* [droneci_version](#droneci_version)
|
||||
* [droneci_service_directory](#droneci_service_directory)
|
||||
* [droneci_docker_socket_path](#droneci_docker_socket_path)
|
||||
* [droneci_host](#droneci_host)
|
||||
* [droneci_secret](#droneci_secret)
|
||||
* [droneci_restart_policy](#droneci_restart_policy)
|
||||
* [droneci_server_container_name](#droneci_server_container_name)
|
||||
* [droneci_server_image](#droneci_server_image)
|
||||
* [droneci_server_exposed_port](#droneci_server_exposed_port)
|
||||
* [droneci_server_exposed_ip](#droneci_server_exposed_ip)
|
||||
* [droneci_server_extra_hosts](#droneci_server_extra_hosts)
|
||||
* [droneci_server_privileged](#droneci_server_privileged)
|
||||
* [droneci_agent_container_name](#droneci_agent_container_name)
|
||||
* [droneci_agent_image](#droneci_agent_image)
|
||||
* [droneci_agent_capacity](#droneci_agent_capacity)
|
||||
* [droneci_agent_privileged](#droneci_agent_privileged)
|
||||
* [droneci_postgres_enabled](#droneci_postgres_enabled)
|
||||
* [droneci_postgres_ssl_mode](#droneci_postgres_ssl_mode)
|
||||
* [droneci_postgres_server](#droneci_postgres_server)
|
||||
* [droneci_postgres_port](#droneci_postgres_port)
|
||||
* [droneci_postgres_superuser](#droneci_postgres_superuser)
|
||||
* [droneci_postgres_password](#droneci_postgres_password)
|
||||
* [droneci_postgres_db](#droneci_postgres_db)
|
||||
* [droneci_postgres_user](#droneci_postgres_user)
|
||||
* [droneci_gitea_enabled](#droneci_gitea_enabled)
|
||||
* [droneci_gitea_server](#droneci_gitea_server)
|
||||
* [droneci_gitea_skip_verify](#droneci_gitea_skip_verify)
|
||||
* [droneci_no_proxy](#droneci_no_proxy)
|
||||
* [droneci_iptables_enabled](#droneci_iptables_enabled)
|
||||
* [droneci_open_ports](#droneci_open_ports)
|
||||
* [droneci_license_key](#droneci_license_key)
|
||||
* [droneci_server_memory_limit](#droneci_server_memory_limit)
|
||||
* [droneci_server_memory_reservation](#droneci_server_memory_reservation)
|
||||
* [droneci_agent_memory_limit](#droneci_agent_memory_limit)
|
||||
* [droneci_agent_memory_reservation](#droneci_agent_memory_reservation)
|
||||
* [droneci_admin](#droneci_admin)
|
||||
* [droneci_http_proxy](#droneci_http_proxy)
|
||||
* [droneci_https_proxy](#droneci_https_proxy)
|
||||
* [Dependencies](#dependencies)
|
||||
* [License](#license)
|
||||
* [Author](#author)
|
||||
|
||||
---
|
||||
|
||||
## Default Variables
|
||||
|
||||
### droneci_version
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_version: 1.4.0
|
||||
```
|
||||
|
||||
### droneci_service_directory
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_service_directory: /var/lib/docker/services/drone-ci
|
||||
```
|
||||
|
||||
### droneci_docker_socket_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_docker_socket_path: /var/run/docker.sock
|
||||
```
|
||||
|
||||
### droneci_host
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_host: http://localhost
|
||||
```
|
||||
|
||||
### droneci_secret
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_secret: myveryownsecret
|
||||
```
|
||||
|
||||
### droneci_restart_policy
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_restart_policy: always
|
||||
```
|
||||
|
||||
### droneci_server_container_name
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_container_name: drone-server
|
||||
```
|
||||
|
||||
### droneci_server_image
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_image: drone/drone:{{ droneci_version }}
|
||||
```
|
||||
|
||||
### droneci_server_exposed_port
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_exposed_port: 8080
|
||||
```
|
||||
|
||||
### droneci_server_exposed_ip
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_exposed_ip: 127.0.0.1
|
||||
```
|
||||
|
||||
### droneci_server_extra_hosts
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_extra_hosts: []
|
||||
```
|
||||
|
||||
### droneci_server_privileged
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_privileged: false
|
||||
```
|
||||
|
||||
### droneci_agent_container_name
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_agent_container_name: drone-agent
|
||||
```
|
||||
|
||||
### droneci_agent_image
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_agent_image: drone/agent:{{ droneci_version }}
|
||||
```
|
||||
|
||||
### droneci_agent_capacity
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_agent_capacity: 2
|
||||
```
|
||||
|
||||
### droneci_agent_privileged
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_agent_privileged: false
|
||||
```
|
||||
|
||||
### droneci_postgres_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_enabled: false
|
||||
```
|
||||
|
||||
### droneci_postgres_ssl_mode
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_ssl_mode: disable
|
||||
```
|
||||
|
||||
### droneci_postgres_server
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_server: postgres.example.com
|
||||
```
|
||||
|
||||
### droneci_postgres_port
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_port: 5432
|
||||
```
|
||||
|
||||
### droneci_postgres_superuser
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_superuser: postgres
|
||||
```
|
||||
|
||||
### droneci_postgres_password
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_password: secure
|
||||
```
|
||||
|
||||
### droneci_postgres_db
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_db:
|
||||
name: droneci
|
||||
lc_collate: en_US.UTF-8
|
||||
lc_ctype: en_US.UTF-8'
|
||||
encoding: UTF-8
|
||||
template: template0
|
||||
login_host: localhost
|
||||
login_user: '{{ droneci_postgres_superuser }}'
|
||||
login_password: '{{ droneci_postgres_password }}'
|
||||
port: '{{ droneci_postgres_port }}'
|
||||
state: present
|
||||
```
|
||||
|
||||
### droneci_postgres_user
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_postgres_user:
|
||||
name: pgdroneci
|
||||
password: droneci
|
||||
encrypted: yes
|
||||
db: '{{ droneci_postgres_db.name }}'
|
||||
login_host: localhost
|
||||
login_user: '{{ droneci_postgres_superuser }}'
|
||||
login_password: '{{ droneci_postgres_password }}'
|
||||
port: '{{ droneci_postgres_port }}'
|
||||
state: present
|
||||
```
|
||||
|
||||
### droneci_gitea_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_gitea_enabled: false
|
||||
```
|
||||
|
||||
### droneci_gitea_server
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_gitea_server: http://my-git.example.com
|
||||
```
|
||||
|
||||
### droneci_gitea_skip_verify
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_gitea_skip_verify: false
|
||||
```
|
||||
|
||||
### droneci_no_proxy
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_no_proxy:
|
||||
- drone-server
|
||||
- drone-agent
|
||||
```
|
||||
|
||||
### droneci_iptables_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_iptables_enabled: false
|
||||
```
|
||||
|
||||
### droneci_open_ports
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_open_ports:
|
||||
- name: allow_droneci_web
|
||||
rules: "-A INPUT -m state --state NEW -p tcp --dport {{ droneci_server_exposed_port\
|
||||
\ }} -j ACCEPT\n"
|
||||
state: present
|
||||
```
|
||||
|
||||
### droneci_license_key
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_license_key: _unset_
|
||||
```
|
||||
|
||||
### droneci_server_memory_limit
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_memory_limit: _unset_
|
||||
```
|
||||
|
||||
#### Example usage
|
||||
|
||||
```YAML
|
||||
512m
|
||||
```
|
||||
|
||||
### droneci_server_memory_reservation
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_server_memory_reservation: _unset_
|
||||
```
|
||||
|
||||
#### Example usage
|
||||
|
||||
```YAML
|
||||
256m
|
||||
```
|
||||
|
||||
### droneci_agent_memory_limit
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_agent_memory_limit: _unset_
|
||||
```
|
||||
|
||||
### droneci_agent_memory_reservation
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_agent_memory_reservation: _unset_
|
||||
```
|
||||
|
||||
### droneci_admin
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_admin: _unset_
|
||||
```
|
||||
|
||||
### droneci_http_proxy
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_http_proxy: _unset_
|
||||
```
|
||||
|
||||
### droneci_https_proxy
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
droneci_https_proxy: _unset_
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
None.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
## Author
|
||||
|
||||
Robert Kaussow
|
||||
|
Loading…
Reference in New Issue
Block a user