Reference

Updated 2 years ago by Admin

Index of all configuration parameters:

  • DRONE_CPU_PERIOD
    Optional integer value. Specify the CPU CFS scheduler period, which is used alongside the CPU quota.
    DRONE_CPU_PERIOD=100000
  • DRONE_CPU_QUOTA
    Optional integer value. Impose a CPU CFS quota on all pipeline containers. The number of microseconds per CPU period that the container is limited to before throttled
    DRONE_CPU_QUOTA=100
  • DRONE_CPU_SET
    Optional comma-separated string value. Limit the specific CPUs or cores a pipeline container can use.
    DRONE_CPU_SET=1,3
  • DRONE_CPU_SHARES
    Optional integer value. Set this flag to a value greater or less than the default of 1024 to increase or reduce a pipeline container’s weight, and give it access to a greater or lesser proportion of the host machine’s CPU cycles.
    DRONE_CPU_SHARES=1024
  • DRONE_DEBUG
    Optional boolean value. Enables debug level logging.
    DRONE_DEBUG=true
  • DRONE_DOCKER_STREAM_PULL
    Optional boolean value. Disable writing the output from Docker pull to the build logs. This setting is enabled by default.
    DRONE_DOCKER_STREAM_PULL=true
  • DRONE_ENV_PLUGIN_ENDPOINT
    Optional string value. Provides the endpoint used to make http requests to an external environment variable plugin. The external environment variable plugin can be used to source custom pipeline environment variables from third party system.
    DRONE_ENV_PLUGIN_ENDPOINT=http://1.2.3.4:3000
  • DRONE_ENV_PLUGIN_SKIP_VERIFY
    Optional boolean value. Disable SSL verification when making http requests to the plugin endpoint. This is unsafe and is not recommended.
    DRONE_ENV_PLUGIN_SKIP_VERIFY=false
  • DRONE_ENV_PLUGIN_TOKEN
    Optional string value. Provides the secret token used to authenticate http requests to the plugin endpoint.
    DRONE_ENV_PLUGIN_TOKEN=bea26a2221fd8090ea38720fc445eca6
  • DRONE_HTTP_BIND
    Optional string value configures the http listener port. The default value is :3000. Overriding this value is not recommended.
    DRONE_HTTP_BIND=:3000
  • DRONE_HTTP_HOST
    Optional string value that configures the http listener hostname. The default value is an empty string. Setting this value is not recommended.
    DRONE_HTTP_HOST=runner.company.com:3000
  • DRONE_HTTP_PROTO
    Optional string value configures the http listener protocol. The default value is http. Overriding this value is not recommended.
    DRONE_HTTP_PROTO=http
  • DRONE_JOB_DATACENTER
    Optional comma-separate string value sets the datacenter in which the jobs should run. If this value is unset it use dc1 as the default value.
    DRONE_JOB_DATACENTER=us-west-1,us-east-1
  • DRONE_JOB_NAMESPACE
    Optional string value sets the cluster namespace in which the jobs should run.
    DRONE_JOB_NAMESPACE=drone
  • DRONE_JOB_REGION
    Optional string value sets the region in which the jobs should run.
    DRONE_JOB_REGION=us
  • DRONE_LIMIT_EVENTS
    Optional comma-separated string value. Provides a white list of build events that can be processed by this runner. This provides an extra layer of security to limit the kind of workloads this runner can process.
    DRONE_LIMIT_EVENTS=push,tag
  • DRONE_LIMIT_REPOS
    Optional comma-separated string value. Configures the runner to only process matching repositories. This provides an extra layer of security and can stop untrusted repositories from executing pipelines with this runner.
    DRONE_LIMIT_EVENTS=octocat/hello-world,spaceghost/*
  • DRONE_LIMIT_TRUSTED
    Optional boolean value. Configures the runner to only process trusted repositories. This provides an extra layer of security and can stop untrusted repositories from executing pipelines with this runner.
    DRONE_LIMIT_TRUSTED=true
  • DRONE_MEMORY_LIMIT
    Optional integer value. The maximum amount of memory a single pipeline container can use, configured in bytes.
    DRONE_MEMORY_LIMIT=500000000
  • DRONE_MEMORY_SWAP_LIMIT
    Optional integer value. The maximum amount of memory a single pipeline container is allowed to swap to disk, configured in bytes.
    DRONE_MEMORY_SWAP_LIMIT=500000000
  • DRONE_REGISTRY_PLUGIN_ENDPOINT
    Optional string value. Provides the endpoint used to make http requests to an external registry plugin. The external registry plugin can be used to source registry credentials from third party system.
    DRONE_REGISTRY_PLUGIN_ENDPOINT=http://1.2.3.4:3000
  • DRONE_REGISTRY_PLUGIN_SKIP_VERIFY
    Optional boolean value. Disable SSL verification when making http requests to the registry plugin endpoint. This is unsafe and is not recommended.
    DRONE_REGISTRY_PLUGIN_SKIP_VERIFY=false
  • DRONE_REGISTRY_PLUGIN_TOKEN
    Optional string value. Provides the token used to authenticate http requests to the registry plugin endpoint.
    DRONE_REGISTRY_PLUGIN_TOKEN=bea26a2221fd8090ea38720fc445eca6
  • DRONE_RPC_DUMP_HTTP
    Optional boolean value. Enables dumping the http request and response to the logs for debugging purposes. This should only be enabled while debugging connectivity issues between the runner and server.
    DRONE_RPC_DUMP_HTTP=true
  • DRONE_RPC_DUMP_HTTP_BODY
    Optional boolean value. Enables dumping the http request and response body to the logs for debugging purposes. This should only be enabled while debugging connectivity issues between the runner and server.
    DRONE_RPC_DUMP_HTTP_BODY=true
  • DRONE_RPC_HOST
    Required string values. Defines the hostname (and optional port) used to connect to the Drone server.
    DRONE_RPC_HOST=drone.company.com
  • DRONE_RPC_PROTO
    Required string value. Defines the protocol used to connect to the Drone server. The value must be either http or https.
    DRONE_RPC_PROTO=https
  • DRONE_RPC_SECRET
    Required string value. Provides the shared secret used by the Drone server to authenticate http requests.
    DRONE_RPC_SECRET=bea26a2221fd8090ea38720fc445eca6
  • DRONE_RPC_SKIP_VERIFY
    Optional boolean value. Disable SSL verification when making http requests to the Drone server. This is unsafe and is not recommended.
    DRONE_RPC_SKIP_VERIFY=false
  • DRONE_RUNNER_CLONE_IMAGE
    Optional string value. Overrides the Docker image used to clone a repository.
    DRONE_RUNNER_CLONE_IMAGE=drone/git:1
  • DRONE_RUNNER_DEVICES
    Optional comma separated list. Provides a list of devices that are mounted into every pipeline step.
    DRONE_RUNNER_DEVICES=/dev/sdb
  • DRONE_RUNNER_ENV_FILE
    Optional string value. Provides the path to an environment variable file used to define global environment variables injected into all pipeline steps. The environment file format is documented here.
    DRONE_RUNNER_ENV_FILE=/etc/drone.conf
    Remember to mount this file from the host machine into the Docker container. Note the configuration path defined above should point to the file path inside the container.
    docker run \
    --volume /etc/drone.conf:/etc/drone.conf
  • DRONE_RUNNER_ENVIRON
    Optional string map. Provides a set of global environment variables that are injected into every pipeline step.
    DRONE_RUNNER_ENVIRON=foo:bar,baz:qux
  • DRONE_RUNNER_MAX_PROCS
    Optional number value. Limits the number of concurrent steps that a runner can execute for a single pipeline. This is disabled by default. This can be useful if you need to throttle the maximum number of parallel steps to prevent resource exhaustion.
    DRONE_RUNNER_MAX_PROCS=10
  • DRONE_RUNNER_NETWORKS
    Optional comma separated list. Provides a list of Docker networks that are attached to every pipeline step.
    DRONE_RUNNER_NETWORKS=networkA,networkB
  • DRONE_RUNNER_PRIVILEGED_IMAGES
    Optional comma separated list. Provides a list of Docker images that are started as privileged containers by default.
    Privileged mode effectively grants the container root access to your host machine. Please use with caution.
    DRONE_RUNNER_PRIVILEGED_IMAGES=plugins/docker,plugin/ecr
  • DRONE_RUNNER_VOLUMES
    Optional comma separated list. Provides a list of Docker volumes that are mounted into every pipeline step.
    DRONE_RUNNER_VOLUMES=/path/on/host:/path/in/container
    In the above example, the path to the left of the colon is the host machine path. The path to the right is the path inside your pipeline containers.

  • DRONE_SECRET_PLUGIN_ENDPOINT
    Optional string value. Provides the endpoint used to make http requests to an external secret plugin. The external secret plugin (e.g. vault) can be used to source secrets from third party system.
    DRONE_SECRET_PLUGIN_ENDPOINT=http://1.2.3.4:3000
  • DRONE_SECRET_PLUGIN_SKIP_VERIFY
    Optional boolean value. Disable SSL verification when making http requests to the plugin endpoint. This is unsafe and is not recommended.
    DRONE_SECRET_PLUGIN_SKIP_VERIFY=false
  • DRONE_SECRET_PLUGIN_TOKEN
    Optional string value. Provides the secret token used to authenticate http requests to the plugin endpoint.
    DRONE_SECRET_PLUGIN_TOKEN=bea26a2221fd8090ea38720fc445eca6
  • DRONE_TASK_COMPUTE
    Optional integer value that assigns the tasks default compute resources. Please note that this does not limit the compute resources for the pipeline; it limits the compute resources for the Pipeline runner task, which is a controller process that is separate from the pipeline processes.
    DRONE_TASK_COMPUTE=1024
  • DRONE_TASK_MEMORY
    Optional integer value that assigns the tasks default memory resources. Please note that this does not limit the memory resources for the pipeline; it limits the compute resources for the Pipeline runner task, which is a controller process that is separate from the pipeline processes.
    DRONE_TASK_MEMORY=500
  • DRONE_TRACE
    Optional boolean value. Enables trace level logging.
    DRONE_TRACE=true

How did we do?