Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

assemblyline/sidekicks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Assemblyine

Sidekicks

Generic sidekicks to aid in registration and health checking of containers running in production / pre-production.

Vulcand

The vulcand sideick is designed to register a container with the vulcand reverse proxy.

It finds the port exposed in the given docker container and sets up a server in the given backend.

Usage

docker run [-e ...] assemblyline/sidekicks vulcand

Config

The Vulcand sidekick takes its configuration from the environment.

ENV Var Description
HOSTNAME The hostname or ip of the current instance
CONTAINER_NAME The name of the container to upsert
CONTAINER_PORT The container port to lookup the exposed port by
VULCAND_BACKEND The name of the Vulcand backend to upsert this server in

Limitations

  • It expects to connect to the docker remote api over the docker gateway see for coreos instuctions

ELB

The ELB sidekick is designed to register an instance with an Amazon Web Services Elastic Load Balancer.

It registers the current instance with the named ELB or the tagged ELB(s) on start, if the sidekick receives an INT or TERM signal it will deregister the instance.

Usage

docker run [-e ...] assemblyline/sidekicks elb

Config

The ELB sidekick takes its configuration from the environment.

The id of the current instance is looked up dynamically using ec2 instance metadata

ENV Var Description Optional
AWS_ELB_NAME The name of the ELB to register with true
AWS_ELB_TAG The tag of the ELB(s) to register with true
AWS_REGION The name of the AWS Region
AWS_ACCESS_KEY The AWS Access Key to use
AWS_SECRET_KEY The AWS Secret Key to use

Limitations

  • It only works with AWS Elastic Load Balancers
  • It needs the load balancer to be set up properly
  • Remember an ELB can only balance instances in the same region