Managing the Queue Service

Packages

Like the other services, the Queue service is shipped as a Docker image with port 80 exposed.

$ docker run -d -p 9003:80 screwdrivercd/queue-service:latest
$ open http://localhost:9003

Our images are tagged with the version (eg. v1.2.3) as well as a floating tag latest and stable. Most installations should be using stable or the fixed version tags.

Configuration

Screwdriver already defaults most configuration, but you can override defaults using a config/local.yaml or environment variables. All the possible environment variables are defined here.

Authentication

Configure the validation of incoming JWTs from the API.

Environment Variable	Required	Description
JWT_ENVIRONMENT	No	Environment to generate the JWT for. Ex: `prod`, `beta`. If you want the JWT to not contain `environment`, don’t set this environment variable (do not set it to `''`).
SECRET_JWT_PRIVATE_KEY	Yes	A private key uses for signing jwt tokens. Generate one by running `$ openssl genrsa -out jwtqs.pem 2048`
SECRET_JWT_PUBLIC_KEY	Yes	The public key used for verifying the signature. Generate one by running `$ openssl rsa -in jwtqs.pem -pubout -out jwtqs.pub`
SECRET_JWT_SD_API_PUBLIC_KEY	none	The public key used for verifying the signature of the JWT. Use the same one as configured in the API

# config/local.yaml
auth:
    jwtPrivateKey: |
        PRIVATE KEY HERE
    jwtPublicKey: |
        PUBLIC KEY HERE
    jwtSDApiPublicKey: |
        PUBLIC KEY HERE

Serving

Configure the how the service is listening for traffic.

Environment Variable	Default	Description
PORT	80	Port to listen on
HOST	0.0.0.0	Host to listen on (set to localhost to only accept connections from this machine)
URI	http://localhost:80	Externally routable URI (usually your load balancer or CNAME)
HTTPD_TLS	false	SSL support; for SSL, replace `false` with a JSON object that provides the options required by `tls.createServer`

# config/local.yaml
httpd:
    port: 443
    host: 0.0.0.0
    uri: https://localhost
    tls:
        key: |
            PRIVATE KEY HERE
        cert: |
            YOUR CERT HERE

Configure Redis Queue

Configure some settings for setting up the Queue.

Environment Variable	Required	Default	Description
REDIS_HOST	Yes	127.0.0.1	Redis host
REDIS_PORT	Yes	6379	Redis port
REDIS_PASSWORD	Yes	a-secure-password	Redis password
REDIS_TLS_ENABLED	No	false	Redis tls enabled
REDIS_DB_NUMBER	No	0	Redis db number
REDIS_QUEUE_PREFIX	No	’’	Redis queue prefix

# config/local.yaml
queue:
  redisConnection:
    host: "127.0.0.1"
    port: 6379
    options:
      password: a-secure-password
      tls: false
    database: 0
  prefix: ''

Configure Blocked By Settings

Configure some settings for blockedBy.

Environment Variable	Required	Default	Description
PLUGIN_BLOCKEDBY_REENQUEUE_WAIT_TIME	No	1	Minutes to wait before re-enqueuing if blocked
PLUGIN_BLOCKEDBY_BLOCK_TIMEOUT	No	120	Maximum minutes for a job to be blocked before timing out
PLUGIN_BLOCKEDBY_BLOCKED_BY_SELF	No	true	Whether a job will be blocked by itself or not
PLUGIN_BLOCKEDBY_COLLAPSE	No	true	Whether multiple builds run for the same job at the same time will collapse or not

# config/local.yaml
plugins:
  blockedBy:
    reenqueueWaitTime: 5
    blockTimeout: 180
    blockedBySelf: false
    collapse: false

Configure pushgateway

Configure pushgateway to collect build metrics.

Environment Variable	Required	Default	Description
ECOSYSTEM_PUSHGATEWAY_URL	No		Pushgateway URL

Scheduler

When Scheduler is enabled, Queue Service passes on build to a RabbitMQ Build Cluster queue, which will be processed by Build Cluster Queue Worker.

Key	Environment Variable	Description
enabled	SCHEDULER_ENABLED	If `true` build will be sent to RabbitMQ build cluster queue for further processing
protocol	RABBITMQ_PROTOCOL	Protocol to connect to rabbitmq. Use amqp for non-ssl and amqps for ssl. Default: amqp
username	RABBITMQ_USERNAME	User to connect and authorized to consume from rabbitmq queues
password	RABBITMQ_PASSWORD	password
host	RABBITMQ_HOST	Rabbitmq cluster hostname. Default: 127.0.0.1
port	RABBITMQ_PORT	Rabbitmq port. Default: 5672
vhost	RABBITMQ_VIRTUAL_HOST	Virtual host for queues. Default: /screwdriver
connectOptions	RABBITMQ_CONNECT_OPTIONS	options to configure hearbeat check and reconnect in time in case of broken connections. Default: ‘{ “json”: true, “heartbeatIntervalInSeconds”: 20, “reconnectTimeInSeconds”: 30 }’

Executors

Queue Service can directly invoke an executor if RabbitMQ Scheduler is not used. Configuration settings are exactly same as the settings configuration for API.