Reference

Updated 2 years ago by Admin

The Kubernetes runner is in Beta and is a community effort. The core Drone team does not yet possess the Kubernetes expertise needed to provide production support.

Index of all configuration parameters:

  • DRONE_ANNOTATIONS_DEFAULT
    Optional string map. Provides a set of default annotations used when creating the pipeline pod. The default annotation values are appended to the annotations defined in the yaml.
    DRONE_ANNOTATIONS_DEFAULT=keyA:valueA,keyB:valueB
  • DRONE_DEBUG
    Optional boolean value. Enables debug level logging.
    DRONE_DEBUG=true
  • DRONE_DOCKER_CONFIG
    Optional string value. Provides the path to a Docker config.json file used to source registry credentials from third party system.
    DRONE_DOCKER_CONFIG=/root/.docker/config.json
    Note that you will typically need to mount this file from the host machine into your Docker container. Note the configuration path defined above should point to the file path inside the container.
    docker run \
    --volume /root/.docker/config.json:/root/.docker/config.json
  • 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_IMAGE_CLONE
    Optional string value overrides the default plugin used to clone the repository. The default value is drone/git.
    DRONE_IMAGE_CLONE=drone/git
  • DRONE_IMAGE_PLACEHOLDER
    Optional string value overrides the placeholder image used when creating Pods. The default value is drone/placeholder.
    DRONE_IMAGE_PLACEHOLDER=drone/placeholder
  • DRONE_LABELS_DEFAULT
    Optional string map. Provides a set of default labels used when creating the pipeline pod. The default annotation values are appended to the labels defined in the yaml.
    DRONE_LABELS_DEFAULT=keyA:valueA,keyB:valueB
  • 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_REPOS=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_NAMESPACE_DEFAULT
    Optional string value provides the default namespace used to create pipeline resources. The default namespace is used if the no namespace is configured in the yaml.
    DRONE_NAMESPACE_DEFAULT=default
    You can optionally configure the runner to create a namespace for each pipeline execution which gets deleted when the pipeline completes. This can be configured using this exact value:
    DRONE_NAMESPACE_DEFAULT=drone-
  • DRONE_NAMESPACE_RULES
    Optional string map. Defines linting rules to prevent an organization or repository from using a restricted namespace.
    DRONE_NAMESPACE_RULES=default:cisco/*,development:Webex/*
    For example, the above rule prevents a pipeline from using the development namespace unless the repository name matches Webex/*
  • DRONE_NAMESPACE_RULES_FILE
    Optional string value. Provides the path to a file that defines namespace usage rules. These rules prevent an organization or repository from using a restricted namespace.
    DRONE_NAMESPACE_RULES_FILE=/path/to/rules.yml
    The namespace rules are defined using yaml syntax. The key is the namespace name, and the value is an array of matching patterns.
    default:
    - cisco/*

    development:
    - cisco/openh264
    - Webex/*
    The rules in the above example prevent a pipeline from using the default namespace unless the repository name matches cisco/*.
  • DRONE_NODE_SELECTOR_DEFAULT
    Optional string map. Provides a set of default node_selector values used when creating the pipeline pod. The default node_selector values are used if node_selector is undefined in the yaml.
    DRONE_NODE_SELECTOR_DEFAULT=disktype:ssd,memory:highmem
  • DRONE_POLICY_FILE
    Optional string value. Provides the path to the policy file that should be loaded on startup. Note that the policy file needs to be mounted into the runner container.
    DRONE_POLICY_FILE=/path/to/policy.yml
  • 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_RESOURCE_LIMIT_CPU
    Optional integer, sets the default millicpu resource limits for all pipeline containers. This value maps to the spec.containers[].resources.limits.cpu field.
    DRONE_RESOURCE_LIMIT_CPU=1000
  • DRONE_RESOURCE_LIMIT_MEMORY
    Optional integer, sets the default memory limits for all pipeline containers. This value maps to the spec.containers[].resources.limits.memory field.
    DRONE_RESOURCE_LIMIT_MEMORY=500MiB
  • DRONE_RESOURCE_REQUEST_CPU
    Optional integer, sets the default millicpu resource request for all pipeline steps. This value maps to the spec.containers[].resources.requests.cpu field.
    DRONE_RESOURCE_REQUEST_CPU=1000
  • DRONE_RESOURCE_REQUEST_MEMORY
    Optional integer, sets the default memory resource request for all pipeline steps. This value maps to the spec.containers[].resources.requests.memory field.
    DRONE_RESOURCE_REQUEST_MEMORY=500MiB
  • 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_CAPACITY
    Optional number value. Limits the number of concurrent pipelines that a runner can execute. This does not limit the number of concurrent pipelines that can execute on a single node.
    DRONE_RUNNER_CAPACITY=100
  • 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_NAME
    Optional string value. Sets the name of the runner. The runner name is stored in the server and can be used to trace a build back to a specific runner.
    DRONE_RUNNER_NAME=ec2-43-21.us-east-1.compute.amazonaws.com
  • 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_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_SERVICE_ACCOUNT_DEFAULT
    Optional string value provides the default service account used when creating Pod. The default service account is used if no service account is configured in the yaml.
    DRONE_SERVICE_ACCOUNT_DEFAULT=build-robot
  • DRONE_TRACE
    Optional boolean value. Enables trace level logging.
    DRONE_TRACE=true
  • DRONE_UI_DISABLED
    Optional boolean value. Disables the runner’s user interface.
    DRONE_UI_DISABLE=true
  • DRONE_UI_PASSWORD
    Optional string value. Sets the basic authentication password used to authenticate and access the web dashboard. If no password is provided the web dashboard is disabled.
    DRONE_UI_PASSWORD=root
  • DRONE_UI_REALM
    Optional string value. Sets the basic authentication realm used to authenticate and access the web dashboard.
    DRONE_UI_REALM=DroneRealm
  • DRONE_UI_USERNAME
    Optional string value. Sets the basic authentication username used to authenticate and access the web dashboard.
    DRONE_UI_USERNAME=root

How did we do?