2020-01-22 22:31:04 +00:00
---
title: droneci
type: docs
---
2020-06-04 16:49:27 +00:00
[![Source Code ](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white )](https://gitea.rknet.org/ansible/xoxys.droneci) [![Build Status ](https://img.shields.io/drone/build/ansible/xoxys.droneci?logo=drone&server=https%3A%2F%2Fdrone.rknet.org )](https://drone.rknet.org/ansible/xoxys.droneci) [![License: MIT ](https://img.shields.io/badge/license-MIT-blue.svg )](https://gitea.rknet.org/ansible/xoxys.droneci/src/branch/master/LICENSE)
2020-01-31 10:33:51 +00:00
Setup [Drone CI ](https://drone.io/ ) base server. Drone is a Continuous Delivery system built on container technology. Drone uses a simple YAML configuration file, a superset of docker-compose, to define and execute Pipelines inside Docker containers.
2020-01-22 22:31:04 +00:00
* [Default Variables ](#default-variables )
2020-06-23 09:24:26 +00:00
* [droneci_admin_user ](#droneci_admin_user )
* [droneci_container_name ](#droneci_container_name )
2020-06-04 16:49:27 +00:00
* [droneci_db_name ](#droneci_db_name )
* [droneci_db_password ](#droneci_db_password )
* [droneci_db_port ](#droneci_db_port )
2021-01-14 10:31:17 +00:00
* [droneci_db_secret ](#droneci_db_secret )
2020-06-04 16:49:27 +00:00
* [droneci_db_server ](#droneci_db_server )
* [droneci_db_ssl_mode ](#droneci_db_ssl_mode )
* [droneci_db_type ](#droneci_db_type )
* [droneci_db_user ](#droneci_db_user )
* [droneci_docker_socket_path ](#droneci_docker_socket_path )
2020-06-23 09:24:26 +00:00
* [droneci_exposed_ports ](#droneci_exposed_ports )
* [droneci_extra_hosts ](#droneci_extra_hosts )
2021-01-14 09:59:04 +00:00
* [droneci_gitea_oauth_client_id ](#droneci_gitea_oauth_client_id )
* [droneci_gitea_oauth_client_secret ](#droneci_gitea_oauth_client_secret )
2020-06-04 16:49:27 +00:00
* [droneci_gitea_server ](#droneci_gitea_server )
* [droneci_gitea_skip_verify ](#droneci_gitea_skip_verify )
2021-01-14 09:59:04 +00:00
* [droneci_github_client_id ](#droneci_github_client_id )
* [droneci_github_client_secret ](#droneci_github_client_secret )
2020-06-04 16:49:27 +00:00
* [droneci_host ](#droneci_host )
* [droneci_http_proxy ](#droneci_http_proxy )
* [droneci_https_proxy ](#droneci_https_proxy )
2020-06-23 09:24:26 +00:00
* [droneci_image ](#droneci_image )
2020-06-04 16:49:27 +00:00
* [droneci_license_key ](#droneci_license_key )
2020-06-23 09:24:26 +00:00
* [droneci_memory_limit ](#droneci_memory_limit )
* [droneci_memory_reservation ](#droneci_memory_reservation )
* [droneci_networks ](#droneci_networks )
* [droneci_networks_applied ](#droneci_networks_applied )
2020-06-04 16:49:27 +00:00
* [droneci_no_proxy ](#droneci_no_proxy )
2022-01-28 10:27:05 +00:00
* [droneci_privileged ](#droneci_privileged )
2020-09-25 07:48:30 +00:00
* [droneci_prometheus_anonymous_access ](#droneci_prometheus_anonymous_access )
2021-01-15 10:28:40 +00:00
* [droneci_repository_filter ](#droneci_repository_filter )
2020-06-04 16:49:27 +00:00
* [droneci_restart_policy ](#droneci_restart_policy )
2021-01-14 09:59:04 +00:00
* [droneci_scm_provider ](#droneci_scm_provider )
2020-06-04 16:49:27 +00:00
* [droneci_secret ](#droneci_secret )
* [droneci_service_directory ](#droneci_service_directory )
2020-06-23 09:24:26 +00:00
* [droneci_service_stopped ](#droneci_service_stopped )
2021-01-14 09:59:04 +00:00
* [droneci_user_filter ](#droneci_user_filter )
2020-06-04 16:49:27 +00:00
* [droneci_version ](#droneci_version )
2020-06-23 09:24:26 +00:00
* [droneci_volumes ](#droneci_volumes )
2020-01-22 22:31:04 +00:00
* [Dependencies ](#dependencies )
---
## Default Variables
2020-06-23 09:24:26 +00:00
### droneci_admin_user
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_admin_user: _unset_
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_container_name
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_container_name: droneci
2020-01-22 22:31:04 +00:00
```
### droneci_db_name
#### Default value
```YAML
droneci_db_name: droneci
```
### droneci_db_password
#### Default value
```YAML
droneci_db_password: secure
```
### droneci_db_port
#### Default value
```YAML
droneci_db_port: 5432
```
2021-01-14 10:31:17 +00:00
### droneci_db_secret
Drone supports aesgcm encryption of secrets stored in the database. You must enable encryption before any secrets are stored in the database! You can generate an encryption key with e.g. `openssl rand -hex 16` .
#### Default value
```YAML
droneci_db_secret: _unset_
```
#### Example usage
```YAML
droneci_db_secret: 0c549fd39ae397333761d2cb0c53c219
```
2020-01-22 22:31:04 +00:00
### droneci_db_server
#### Default value
```YAML
droneci_db_server: localhost
```
### droneci_db_ssl_mode
#### Default value
```YAML
droneci_db_ssl_mode: disable
```
### droneci_db_type
#### Default value
```YAML
droneci_db_type: sqlite
```
### droneci_db_user
#### Default value
```YAML
droneci_db_user: pgdroneci
```
2020-06-23 09:24:26 +00:00
### droneci_docker_socket_path
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_docker_socket_path: /var/run/docker.sock
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_exposed_ports
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_exposed_ports:
- 127.0.0.1:8080:80
```
### droneci_extra_hosts
#### Default value
```YAML
droneci_extra_hosts: []
2020-01-22 22:31:04 +00:00
```
2021-01-14 09:59:04 +00:00
### droneci_gitea_oauth_client_id
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2021-01-14 09:59:04 +00:00
droneci_gitea_oauth_client_id: _unset_
```
#### Example usage
```YAML
droneci_gitea_oauth_client_id: 1111-222-33333-44444
```
### droneci_gitea_oauth_client_secret
#### Default value
```YAML
droneci_gitea_oauth_client_secret: _unset_
```
#### Example usage
```YAML
droneci_gitea_oauth_client_secret: 1234abcd5678efgh
2020-01-22 22:31:04 +00:00
```
### 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
```
2021-01-14 09:59:04 +00:00
### droneci_github_client_id
#### Default value
```YAML
droneci_github_client_id: _unset_
```
### droneci_github_client_secret
#### Default value
```YAML
droneci_github_client_secret: _unset_
```
2020-01-22 22:31:04 +00:00
### droneci_host
#### Default value
```YAML
droneci_host: http://localhost
```
### droneci_http_proxy
#### Default value
```YAML
droneci_http_proxy: _unset_
```
### droneci_https_proxy
#### Default value
```YAML
droneci_https_proxy: _unset_
```
2020-06-23 09:24:26 +00:00
### droneci_image
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_image: drone/drone:{{ droneci_version }}
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_license_key
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_license_key: _unset_
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_memory_limit
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_memory_limit: _unset_
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
#### Example usage
2020-01-22 22:31:04 +00:00
```YAML
2020-06-23 09:24:26 +00:00
droneci_memory_limit: 512m
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_memory_reservation
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_memory_reservation: _unset_
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
#### Example usage
2020-01-22 22:31:04 +00:00
```YAML
2020-06-23 09:24:26 +00:00
droneci_memory_reservation: 256m
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_networks
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_networks:
- name: default
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
#### Example usage
2020-01-22 22:31:04 +00:00
```YAML
2020-06-23 09:24:26 +00:00
droneci_networks:
- name: default
# optional network driver, defaults to 'bride'
driver: host
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_networks_applied
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_networks_applied:
- default
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_no_proxy
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_no_proxy:
- drone-server
- drone-agent
2020-01-22 22:31:04 +00:00
```
2022-01-28 10:27:05 +00:00
### droneci_privileged
#### Default value
```YAML
droneci_privileged: false
```
2020-09-25 07:48:30 +00:00
### droneci_prometheus_anonymous_access
#### Default value
```YAML
droneci_prometheus_anonymous_access: false
```
2021-01-15 10:28:40 +00:00
### droneci_repository_filter
Optional comma-separated list of accounts, used to limit which repositories are syncronized between your source control management system and Drone.
#### Default value
```YAML
droneci_repository_filter: []
```
2020-06-23 09:24:26 +00:00
### droneci_restart_policy
#### Default value
2020-01-22 22:31:04 +00:00
```YAML
2020-06-23 09:24:26 +00:00
droneci_restart_policy: always
2020-01-22 22:31:04 +00:00
```
2021-01-14 09:59:04 +00:00
### droneci_scm_provider
SCM provider to use with Drone (gitea|github)
#### Default value
```YAML
droneci_scm_provider: none
```
2020-06-23 09:24:26 +00:00
### droneci_secret
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_secret: myveryownsecret
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_service_directory
#### Default value
2020-01-22 22:31:04 +00:00
```YAML
2020-06-23 09:24:26 +00:00
droneci_service_directory: /var/lib/docker/services/droneci
2020-01-22 22:31:04 +00:00
```
2020-06-23 09:24:26 +00:00
### droneci_service_stopped
2020-01-22 22:31:04 +00:00
#### Default value
```YAML
2020-06-23 09:24:26 +00:00
droneci_service_stopped: false
2020-01-22 22:31:04 +00:00
```
2021-01-14 09:59:04 +00:00
### droneci_user_filter
#### Default value
```YAML
droneci_user_filter: []
```
2020-01-22 22:31:04 +00:00
### droneci_version
#### Default value
```YAML
droneci_version: 1.6.0
```
2020-06-23 09:24:26 +00:00
### droneci_volumes
> Define required docker volumes.
#### Default value
```YAML
droneci_volumes:
- name: data
dest: /var/lib/drone
bind: false
```
#### Example usage
```YAML
droneci_volumes:
# Instead of the name you could specify a path on the container host system,
# but you also have to enable bind mount for this volume
- name: data
# target location inside the container
dest: /var/lib/drone
# enable bind mount, if false volume will be configured as named volume
# keep in mind you MUST set bind in any case
bind: True
```
2020-01-22 22:31:04 +00:00
## Dependencies
None.