diff --git a/index.md b/index.md index f91aff9..3635444 100644 --- a/index.md +++ b/index.md @@ -8,12 +8,8 @@ type: docs 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. * [Default Variables](#default-variables) - * [droneci_admin](#droneci_admin) - * [droneci_agent_capacity](#droneci_agent_capacity) - * [droneci_agent_container_name](#droneci_agent_container_name) - * [droneci_agent_image](#droneci_agent_image) - * [droneci_agent_memory_limit](#droneci_agent_memory_limit) - * [droneci_agent_memory_reservation](#droneci_agent_memory_reservation) + * [droneci_admin_user](#droneci_admin_user) + * [droneci_container_name](#droneci_container_name) * [droneci_db_name](#droneci_db_name) * [droneci_db_password](#droneci_db_password) * [droneci_db_port](#droneci_db_port) @@ -21,91 +17,48 @@ Setup [Drone CI](https://drone.io/) base server. Drone is a Continuous Delivery * [droneci_db_ssl_mode](#droneci_db_ssl_mode) * [droneci_db_type](#droneci_db_type) * [droneci_db_user](#droneci_db_user) - * [droneci_docker_compose_bin](#droneci_docker_compose_bin) * [droneci_docker_socket_path](#droneci_docker_socket_path) + * [droneci_exposed_ports](#droneci_exposed_ports) + * [droneci_extra_hosts](#droneci_extra_hosts) * [droneci_gitea_enabled](#droneci_gitea_enabled) * [droneci_gitea_server](#droneci_gitea_server) * [droneci_gitea_skip_verify](#droneci_gitea_skip_verify) * [droneci_host](#droneci_host) * [droneci_http_proxy](#droneci_http_proxy) * [droneci_https_proxy](#droneci_https_proxy) + * [droneci_image](#droneci_image) * [droneci_license_key](#droneci_license_key) + * [droneci_memory_limit](#droneci_memory_limit) + * [droneci_memory_reservation](#droneci_memory_reservation) + * [droneci_networks](#droneci_networks) + * [droneci_networks_applied](#droneci_networks_applied) * [droneci_no_proxy](#droneci_no_proxy) * [droneci_restart_policy](#droneci_restart_policy) * [droneci_secret](#droneci_secret) - * [droneci_server_container_name](#droneci_server_container_name) - * [droneci_server_exposed_ip](#droneci_server_exposed_ip) - * [droneci_server_exposed_port](#droneci_server_exposed_port) - * [droneci_server_extra_hosts](#droneci_server_extra_hosts) - * [droneci_server_image](#droneci_server_image) - * [droneci_server_memory_limit](#droneci_server_memory_limit) - * [droneci_server_memory_reservation](#droneci_server_memory_reservation) * [droneci_service_directory](#droneci_service_directory) + * [droneci_service_stopped](#droneci_service_stopped) * [droneci_version](#droneci_version) + * [droneci_volumes](#droneci_volumes) * [Dependencies](#dependencies) --- ## Default Variables -### droneci_admin +### droneci_admin_user #### Default value ```YAML -droneci_admin: _unset_ +droneci_admin_user: _unset_ ``` -### droneci_agent_capacity +### droneci_container_name #### Default value ```YAML -droneci_agent_capacity: 2 -``` - -### droneci_agent_container_name - -#### Default value - -```YAML -droneci_agent_container_name: drone-agent -``` - -### droneci_agent_image - -#### Default value - -```YAML -droneci_agent_image: drone/drone-runner-docker:1.0.1 -``` - -### droneci_agent_memory_limit - -#### Default value - -```YAML -droneci_agent_memory_limit: _unset_ -``` - -#### Example usage - -```YAML -droneci_agent_memory_limit: 512m -``` - -### droneci_agent_memory_reservation - -#### Default value - -```YAML -droneci_agent_memory_reservation: _unset_ -``` - -#### Example usage - -```YAML -droneci_agent_memory_reservation: 256m +droneci_container_name: droneci ``` ### droneci_db_name @@ -164,14 +117,6 @@ droneci_db_type: sqlite droneci_db_user: pgdroneci ``` -### droneci_docker_compose_bin - -#### Default value - -```YAML -droneci_docker_compose_bin: /usr/local/bin/docker-compose -``` - ### droneci_docker_socket_path #### Default value @@ -180,6 +125,23 @@ droneci_docker_compose_bin: /usr/local/bin/docker-compose droneci_docker_socket_path: /var/run/docker.sock ``` +### droneci_exposed_ports + +#### Default value + +```YAML +droneci_exposed_ports: + - 127.0.0.1:8080:80 +``` + +### droneci_extra_hosts + +#### Default value + +```YAML +droneci_extra_hosts: [] +``` + ### droneci_gitea_enabled #### Default value @@ -228,6 +190,14 @@ droneci_http_proxy: _unset_ droneci_https_proxy: _unset_ ``` +### droneci_image + +#### Default value + +```YAML +droneci_image: drone/drone:{{ droneci_version }} +``` + ### droneci_license_key #### Default value @@ -236,6 +206,61 @@ droneci_https_proxy: _unset_ droneci_license_key: _unset_ ``` +### droneci_memory_limit + +#### Default value + +```YAML +droneci_memory_limit: _unset_ +``` + +#### Example usage + +```YAML +droneci_memory_limit: 512m +``` + +### droneci_memory_reservation + +#### Default value + +```YAML +droneci_memory_reservation: _unset_ +``` + +#### Example usage + +```YAML +droneci_memory_reservation: 256m +``` + +### droneci_networks + +#### Default value + +```YAML +droneci_networks: + - name: default +``` + +#### Example usage + +```YAML +droneci_networks: + - name: default + # optional network driver, defaults to 'bride' + driver: host +``` + +### droneci_networks_applied + +#### Default value + +```YAML +droneci_networks_applied: + - default +``` + ### droneci_no_proxy #### Default value @@ -262,80 +287,20 @@ droneci_restart_policy: always droneci_secret: myveryownsecret ``` -### droneci_server_container_name - -#### Default value - -```YAML -droneci_server_container_name: drone-server -``` - -### droneci_server_exposed_ip - -#### Default value - -```YAML -droneci_server_exposed_ip: 127.0.0.1 -``` - -### droneci_server_exposed_port - -#### Default value - -```YAML -droneci_server_exposed_port: 8080 -``` - -### droneci_server_extra_hosts - -#### Default value - -```YAML -droneci_server_extra_hosts: [] -``` - -### droneci_server_image - -#### Default value - -```YAML -droneci_server_image: drone/drone:{{ droneci_version }} -``` - -### droneci_server_memory_limit - -#### Default value - -```YAML -droneci_server_memory_limit: _unset_ -``` - -#### Example usage - -```YAML -droneci_server_memory_limit: 512m -``` - -### droneci_server_memory_reservation - -#### Default value - -```YAML -droneci_server_memory_reservation: _unset_ -``` - -#### Example usage - -```YAML -droneci_server_memory_reservation: 256m -``` - ### droneci_service_directory #### Default value ```YAML -droneci_service_directory: /var/lib/docker/services/drone-ci +droneci_service_directory: /var/lib/docker/services/droneci +``` + +### droneci_service_stopped + +#### Default value + +```YAML +droneci_service_stopped: false ``` ### droneci_version @@ -346,6 +311,33 @@ droneci_service_directory: /var/lib/docker/services/drone-ci droneci_version: 1.6.0 ``` +### 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 +``` + ## Dependencies None.