containership.plugin.service-discovery/README.md

A service discovery plugin for ContainerShip

service-discovery
==================

##About

### Build Status
[![Build Status](https://drone.containership.io/api/badges/containership/containership.plugin.service-discovery/status.svg)](https://drone.containership.io/containership/containership.plugin.service-discovery)

### Description
A service discovery plugin for Containership

### Author
ContainerShip Developers - developers@containership.io

## Usage

### Install
`containership plugin add service-discovery`

### Update
`containership plugin update service-discovery`

### Remove
`containership plugin remove service-discovery`

## Under the Hood
The ContainerShip controlling leader dynamically creates an application named `containership-haproxy` on the cluster, using the `containership/haproxy` image. The follower nodes automatically configure DNS records for all applications on the cluster, as well as hosts. Haproxy listens on each application's `discovery_port`, loadbalancing tcp connections to the backing containers for that application. To route to another application, you can simply make a request to `{app_name}.{process.env.CS_CLUSTER_ID}.containership:{CS_DISCOVERY_PORT_APP_NAME}`. More detailed information about the service-discovery plugin can be found in the [docs](https://docs.containership.io/v0.2.0/docs/service-discovery).

## Contributing
Pull requests and issues are encouraged!