Skip to content

Modernize the README #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BolajiOlajide wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Modernize the README #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
227 changes: 106 additions & 121 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,208 +2,193 @@

[![Go Report Card](https://goreportcard.com/badge/github.com/etcd-io/etcd?style=flat-square)](https://goreportcard.com/report/github.com/etcd-io/etcd)
[![Coverage](https://codecov.io/gh/etcd-io/etcd/branch/master/graph/badge.svg)](https://codecov.io/gh/etcd-io/etcd)
[![Build Status Travis](https://img.shields.io/travis/etcd-io/etcdlabs.svg?style=flat-square&&branch=master)](https://travis-ci.com/etcd-io/etcd)
[![Build Status Semaphore](https://semaphoreci.com/api/v1/etcd-io/etcd/branches/master/shields_badge.svg)](https://semaphoreci.com/etcd-io/etcd)
[![Go Reference](https://pkg.go.dev/badge/go.etcd.io/etcd/v3.svg)](https://pkg.go.dev/go.etcd.io/etcd/v3)
[![Docs](https://img.shields.io/badge/docs-latest-green.svg)](https://etcd.io/docs)
[![Godoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://godoc.org/github.com/etcd-io/etcd)
[![Releases](https://img.shields.io/github/release/etcd-io/etcd/all.svg?style=flat-square)](https://github.com/etcd-io/etcd/releases)
[![LICENSE](https://img.shields.io/github/license/etcd-io/etcd.svg?style=flat-square)](https://github.com/etcd-io/etcd/blob/master/LICENSE)

**Note**: The `master` branch may be in an *unstable or even broken state* during development. Please use [releases][github-release] instead of the `master` branch in order to get stable binaries.
[![LICENSE](https://img.shields.io/github/license/etcd-io/etcd.svg?style=flat-square)](./LICENSE)

![etcd Logo](logos/etcd-horizontal-color.svg)

etcd is a distributed reliable key-value store for the most critical data of a distributed system, with a focus on being:
etcd is a distributed reliable key-value store for the most critical data of a
distributed system, with a focus on being:

* *Simple*: well-defined, user-facing API (gRPC)
* *Secure*: automatic TLS with optional client cert authentication
* *Fast*: benchmarked 10,000 writes/sec
* *Reliable*: properly distributed using Raft

etcd is written in Go and uses the [Raft][raft] consensus algorithm to manage a highly-available replicated log.
etcd is written in Go and uses the [Raft][raft] consensus algorithm to manage a
highly-available replicated log. It is used [in production by many
companies](./ADOPTERS.md), and is frequently teamed with applications such as
[Kubernetes][k8s] and many others. Reliability is further ensured by
[**rigorous testing**](./functional).

etcd is used [in production by many companies](./ADOPTERS.md), and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [locksmith][locksmith], [vulcand][vulcand], [Doorman][doorman], and many others. Reliability is further ensured by [**rigorous testing**](https://github.com/etcd-io/etcd/tree/master/functional).
This tree tracks the `3.5.0-pre` development line (see [version/version.go](./version/version.go)).

See [etcdctl][etcdctl] for a simple command line client.
> **Note**: the development branch may be in an *unstable or even broken state*
> during development. Use a published [release][github-release] to get stable
> binaries.

[raft]: https://raft.github.io/
[k8s]: http://kubernetes.io/
[doorman]: https://github.com/youtube/doorman
[locksmith]: https://github.com/coreos/locksmith
[vulcand]: https://github.com/vulcand/vulcand
[etcdctl]: https://github.com/etcd-io/etcd/tree/master/etcdctl

## Community meetings

etcd contributors and maintainers have monthly (every four weeks) meetings at 11:00 AM (USA Pacific) on Thursday.

An initial agenda will be posted to the [shared Google docs][shared-meeting-notes] a day before each meeting, and everyone is welcome to suggest additional topics or other agendas.

[shared-meeting-notes]: https://docs.google.com/document/d/16XEGyPBisZvmmoIHSZzv__LoyOeluC5a4x353CX0SIM/edit


Time:
- [Jan 10th, 2019 11:00 AM video](https://www.youtube.com/watch?v=0Cphtbd1OSc&feature=youtu.be)
- [Feb 7th, 2019 11:00 AM video](https://youtu.be/U80b--oAlYM)
- [Mar 7th, 2019 11:00 AM video](https://youtu.be/w9TI5B7D1zg)
- [Apr 4th, 2019 11:00 AM video](https://youtu.be/oqQR2XH1L_A)
- [May 2nd, 2019 11:00 AM video](https://youtu.be/wFwQePuDWVw)
- [May 30th, 2019 11:00 AM video](https://youtu.be/2t1R5NATYG4)
- [Jul 11th, 2019 11:00 AM video](https://youtu.be/k_FZEipWD6Y)
- [Jul 25, 2019 11:00 AM video](https://youtu.be/VSUJTACO93I)
- [Aug 22, 2019 11:00 AM video](https://youtu.be/6IBQ-VxQmuM)
- [Sep 19, 2019 11:00 AM video](https://youtu.be/SqfxU9DhBOc)
- Nov 14, 2019 11:00 AM
- Dec 12, 2019 11:00 AM
- Jan 09, 2020 11:00 AM
- Feb 06, 2020 11:00 AM
- Mar 05, 2020 11:00 AM
- Apr 02, 2020 11:00 AM
- Apr 30, 2020 11:00 AM
- May 28, 2020 11:00 AM
- Jun 25, 2020 11:00 AM
- Jul 23, 2020 11:00 AM
- Aug 20, 2020 11:00 AM
- Sep 17, 2020 11:00 AM
- Oct 15, 2020 11:00 AM
- Nov 12, 2020 11:00 AM
- Dec 10, 2020 11:00 AM

Join Hangouts Meet: [meet.google.com/umg-nrxn-qvs](https://meet.google.com/umg-nrxn-qvs)

Join by phone: +1 405-792-0633‬ PIN: ‪299 906‬#
See [etcdctl](./etcdctl) for a simple command line client.

[raft]: https://raft.github.io/
[k8s]: https://kubernetes.io/
[github-release]: https://github.com/etcd-io/etcd/releases

## Getting started

### Getting etcd
### Installing etcd

The easiest way to get etcd is to use one of the pre-built release binaries,
which are available for macOS, Linux, Windows, and Docker on the
[release page][github-release]. For more installation guides, see
[operating etcd](https://etcd.io/docs/latest/op-guide).

The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, and Docker on the [release page][github-release].
To build from this source tree instead, install [Go](https://golang.org/) —
`go.mod` declares Go 1.14 as the minimum supported version — and run:

For more installation guides, please check out [play.etcd.io](http://play.etcd.io) and [operating etcd](https://etcd.io/docs/latest/op-guide).
```bash
./build
```

For those wanting to try the very latest version, [build the latest version of etcd][dl-build] from the `master` branch. This first needs [*Go*](https://golang.org/) installed (version 1.13+ is required). All development occurs on `master`, including new features and bug fixes. Bug fixes are first targeted at `master` and subsequently ported to release branches, as described in the [branch management][branch-management] guide.
or, equivalently, via the [Makefile](./Makefile), which also prints the
versions of the binaries it produced:

[github-release]: https://github.com/etcd-io/etcd/releases
[branch-management]: https://etcd.io/docs/latest/branch-management
[dl-build]: https://etcd.io/docs/latest/dl-build#build-the-latest-version
```bash
make build
```

Both write `etcd` and `etcdctl` into `./bin`. Bug fixes land on the development
branch first and are subsequently ported to release branches, as described in
the [branch management](./Documentation/branch-management.md) guide. See
[Documentation/dl-build.md](./Documentation/dl-build.md) for more build details.

### Running etcd

First start a single-member cluster of etcd.
Start a single-member cluster of etcd.

If etcd is installed using the [pre-built release binaries][github-release], run it from the installation location as below:
If etcd was installed from the [pre-built release binaries][github-release],
run it from the installation location:

```bash
/tmp/etcd-download-test/etcd
```

The etcd command can be simply run as such if it is moved to the system path as below:
The command can be run as just `etcd` once the binary is on the system path:

```bash
mv /tmp/etcd-download-test/etcd /usr/local/bin/
etcd
```

If etcd is [built from the master branch][dl-build], run it as below:
If etcd was built from source as above, run it from `./bin`:

```bash
./bin/etcd
```

This will bring up etcd listening on port 2379 for client communication and on port 2380 for server-to-server communication.
This brings up etcd listening on port 2379 for client communication and on port
2380 for server-to-server communication.

Next, let's set a single key, and then retrieve it:
Next, set a single key and then retrieve it:

```console
$ etcdctl put mykey "this is awesome"
OK
$ etcdctl get mykey
mykey
this is awesome
```
etcdctl put mykey "this is awesome"
etcdctl get mykey
```

etcd is now running and serving client requests. For more, please check out:

- [Interactive etcd playground](http://play.etcd.io)
- [Animated quick demo](https://etcd.io/docs/latest/demo)
etcd is now running and serving client requests. For more, check out the
[animated quick demo](https://etcd.io/docs/latest/demo).

### etcd TCP ports

The [official etcd ports][iana-ports] are 2379 for client requests, and 2380 for peer communication.
The [official etcd ports][iana-ports] are 2379 for client requests and 2380 for
peer communication.

[iana-ports]: http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt
[iana-ports]: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt

### Running a local etcd cluster

First install [goreman](https://github.com/mattn/goreman), which manages Procfile-based applications.
First install [goreman](https://github.com/mattn/goreman), which manages
Procfile-based applications.

Our [Procfile script](./Procfile) will set up a local example cluster. Start it with:
The [Procfile](./Procfile) in this repository sets up a local example cluster.
Build the binaries first (the Procfile refers to `bin/etcd`), then start it:

```bash
make build
goreman start
```

This will bring up 3 etcd members `infra1`, `infra2` and `infra3` and etcd `grpc-proxy`, which runs locally and composes a cluster.
This brings up three etcd members, `infra1`, `infra2`, and `infra3`, which
together compose a cluster. Every member accepts key value reads and writes.
The Procfile also contains a commented-out `grpc-proxy` entry that can be
enabled if a proxy is wanted.

Every cluster member and proxy accepts key value reads and key value writes.

Follow the steps in [Procfile.learner](./Procfile.learner) to add a learner node to the cluster. Start the learner node with:
Follow the steps in [Procfile.learner](./Procfile.learner) to add a learner
node to the cluster. Start the learner node with:

```bash
goreman -f ./Procfile.learner start
```

### Next steps

Now it's time to dig into the full etcd API and other guides.
## Documentation

- Read the full [documentation][fulldoc].
- Explore the full gRPC [API][api].
- Set up a [multi-machine cluster][clustering].
- Learn the [config format, env variables and flags][configuration].
- Find [language bindings and tools][integrations].
- Use TLS to [secure an etcd cluster][security].
- [Tune etcd][tuning].
The rendered documentation lives at [etcd.io/docs](https://etcd.io/docs); its
source files are in [Documentation/](./Documentation).

[fulldoc]: https://etcd.io/docs/latest
[api]: https://etcd.io/docs/latest/learning/api
[clustering]: https://etcd.io/docs/latest/op-guide/clustering
[configuration]: https://etcd.io/docs/latest/op-guide/configuration
[integrations]: https://etcd.io/docs/latest/integrations
[security]: https://etcd.io/docs/latest/op-guide/security
[tuning]: https://etcd.io/docs/latest/tuning
- Read the full [documentation](https://etcd.io/docs/latest).
- Explore the gRPC [API reference](./Documentation/dev-guide/api_reference_v3.md).
- Set up a [multi-machine cluster](./Documentation/op-guide/clustering.md).
- Learn the [config format, env variables and flags](./Documentation/op-guide/configuration.md).
- Find [language bindings and tools](./Documentation/integrations.md).
- Use TLS to [secure an etcd cluster](./Documentation/op-guide/security.md).
- [Tune etcd](./Documentation/tuning.md).
- Understand the design in [Documentation/learning](./Documentation/learning).

## Contact

- Mailing list: [etcd-dev](https://groups.google.com/forum/?hl=en#!forum/etcd-dev)
- IRC: #[etcd](irc://irc.freenode.org:6667/#etcd) on freenode.org
- Planning/Roadmap: [milestones](https://github.com/etcd-io/etcd/milestones), [roadmap](./ROADMAP.md)
- Bugs: [issues](https://github.com/etcd-io/etcd/issues)
- Mailing list: [etcd-dev](https://groups.google.com/g/etcd-dev)
- Questions and discussion: [GitHub Discussions](https://github.com/etcd-io/etcd/discussions)
- Bugs and feature requests: [GitHub issues](https://github.com/etcd-io/etcd/issues)
- Planning: [milestones](https://github.com/etcd-io/etcd/milestones), [roadmap](./ROADMAP.md)

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on submitting patches and
the contribution workflow, and [code-of-conduct.md](./code-of-conduct.md) for
the community expectations. Project roles and decision making are described in
[GOVERNANCE.md](./GOVERNANCE.md); current maintainers are listed in
[MAINTAINERS](./MAINTAINERS).

Issues and pull requests are managed according to the
[issue triage guidelines](./Documentation/triage/issues.md) and
[PR management guidelines](./Documentation/triage/PRs.md).

## Reporting bugs

See [reporting bugs](https://etcd.io/docs/latest/reporting-bugs) for details about reporting any issues.
See [reporting bugs](./Documentation/reporting-bugs.md) for details about
reporting any issues.

## Reporting a security vulnerability

See [security disclosure and release process](security/README.md) for details on how to report a security vulnerability and how the etcd team manages it.

## Issue and PR management

See [issue triage guidelines](Documentation/triage/issues.md) for details on how issues are managed.

See [PR management](Documentation/triage/PRs.md) for guidelines on how pull requests are managed.
See the [security disclosure and release process](./security/README.md) for
details on how to report a security vulnerability and how the etcd team manages
it.

## etcd Emeritus Maintainers
## etcd emeritus maintainers

These emeritus maintainers dedicated a part of their career to etcd and reviewed code, triaged bugs, and pushed the project forward over a substantial period of time. Their contribution is greatly appreciated.
These emeritus maintainers dedicated a part of their career to etcd and reviewed
code, triaged bugs, and pushed the project forward over a substantial period of
time. Their contribution is greatly appreciated.

* Fanmin Shi
* Anthony Romano
* Fanmin Shi
* Anthony Romano

### License
## License

etcd is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.
Hello World 2
etcd is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for
details.