Categorygithub.com/ONSdigital/dp-deployer
module
1.39.0
Repository: https://github.com/onsdigital/dp-deployer.git
Documentation: pkg.go.dev

# README

dp-deployer

Event handler for Digital Publishing CI

Configuration

Environment variableDefaultDescription
CONSUMER_QUEUEThe name of the SQS queue to consume from
CONSUMER_QUEUE_URLThe url of the SQS queue to consume from
DEPLOYMENT_ROOTThe path to download deployment bundles
NOMAD_CA_CERTThe path to the CA cert file
NOMAD_ENDPOINThttp://localhost:4646The endpoint of the Nomad API
NOMAD_TLS_SKIP_VERIFYfalseWhen using TLS to nomad, skip checking certs (bool)
NOMAD_TOKENThe ACL token used to authorise HTTP requests
PRIVATE_KEYPrivate key for decrypting secrets
PRODUCER_QUEUEThe name of the SQS queue to produce to
VERIFICATION_KEYPublic key for verifying SQS messages
AWS_REGIONeu-west-1The AWS region used
VAULT_ADDRhttps://127.0.0.1:8200Vault endpoint URL
HEALTHCHECK_INTERVAL10sThe time between calling healthcheck endpoints for check subsystems
HEALTHCHECK_CRITICAL_TIMEOUT60sThe time taken for the health changes from warning state to critical due to subsystem check failures
BIND_ADDR:24300The listen address to bind to
DEPLOYMENT_TIMEOUT20mThe max time to wait for a deployment to complete
CONSUMER_QUEUE_NEWThe name of the new SQS queue to consume from
CONSUMER_QUEUE_URL_NEWThe url of the new SQS queue to consume from

The application also expects your AWS credentials to be configured.

Healthcheck

The /health endpoint returns the current status of the service. Dependent services are health checked on an interval defined by the HEALTHCHECK_INTERVAL environment variable.

On a development machine a request to the health check endpoint can be made by:

curl localhost:24300/health

Licence

Copyright © 2019, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

# Packages

No description provided by the author
No description provided by the author
Package engine provides functionality for creating and running an engine.
No description provided by the author
No description provided by the author
No description provided by the author
Package queue provides functionality for creating and running an engine.
No description provided by the author
Package ssqs provides a super simple AWS SQS consumer.