Skip to content
This repository has been archived by the owner on Nov 20, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisRx committed Nov 4, 2019
1 parent 47c0694 commit 117c7d0
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ e2d is a command-line tool for deploying and managing etcd clusters, both in the
- [Features](#features)
- [Design](#design)
- [Getting started](#getting-started)
- [Required ports](#required-ports)
- [Configuration](#configuration)
- [Peer discovery](#peer-discovery)
- [Snapshots](#snapshots)
Expand Down Expand Up @@ -68,6 +69,19 @@ or specify a method for [peer discovery](#peer-discovery):
$ e2d run -n 3 --peer-discovery aws-autoscaling-group
```

### Required ports

The same ports required by etcd are necessary, along with a couple new ones:

| Port | Description |
| --- | --- |
| TCP/2379 | Required by etcd. Used for incoming client connections. This port should allow ingress from any system that will need to connect to etcd as a client. |
| TCP/2380 | Required by etcd. Used by etcd members for internal etcd cluster communication. This port should be allowed only for systems that will be running e2d. |
| UDP/7980 | Required by memberlist. Used for node-liveness checks and sharing membership data. |
| TCP/7980 | Required by memberlist. Used for node-liveness checks and sharing membership data. |

*Note: Hashicorp's [memberlist](https://github.com/hashicorp/memberlist) requires both TCP and UDP for port 7980 to allow memberlist to fully communicate.*

## Configuration

### Peer discovery
Expand Down

0 comments on commit 117c7d0

Please sign in to comment.