Skip to content
This repository was archived by the owner on Sep 26, 2026. It is now read-only.

Clarify retired etcd compatibility documentation #1

Merged
chen21019 merged 1 commit into from
Sep 26, 2026
Merged

Clarify retired etcd compatibility documentation #1

Show file tree
Hide file tree
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
220 changes: 26 additions & 194 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,198 +1,30 @@
# etcd
# PastureStack etcd compatibility archive

> [!CAUTION]
> **Retired:** this repository preserves an end-of-life etcd 2.3 data-migration
> boundary. It is not an active PastureStack runtime and must not be used for a
> new deployment. Active deployments use `PastureStack/etcd-image` (etcd 3.7.2).
> See [RETIREMENT.md](RETIREMENT.md) for the bounded retirement decision and
> migration path.

## PastureStack compatibility runtime
> This repository preserves the retired etcd 2.3 data-migration boundary. It
> is not an active PastureStack runtime and must not be used for a new
> deployment. See [RETIREMENT.md](RETIREMENT.md) and the
> [etcd v2 data-migration gate](migration/README.md) before handling existing
> data.

This GitHub fork preserves the etcd 2.3.7 storage and protocol boundary for
historical migration analysis. The abandoned `2.3.8` package candidate will not
be published. The upstream engine remains end of life and is not a supported
etcd release.

The candidate uses a digest-pinned Ubuntu 26.04 base, the `20260808T000000Z` Ubuntu package snapshot, exact direct-package versions, Go 1.27.0 with an archive checksum, and an exact checksum-verified helper source archive. A small maintained patch corrects the helper's formatting and integer-conversion defects so current compiler, vet, and race checks can run without suppressions. The release gate builds the current commit instead of reusing a previously published image.

The maintained health checks use mutual TLS and verify the managed service identity `etcd.<stack>`. Connecting through a container name or the loopback listener never disables certificate verification.

The preserved v3 client accepts Unix socket endpoints whose filenames contain a colon on current Go toolchains. Internal gRPC errors also use fixed format strings so Go 1.26 validation does not reinterpret upstream error text as a format string.

Three public private-key fixtures inherited from upstream remain only for the original HTTP/2 demo and etcd integration tests. They are unsafe for any deployment, are excluded from the runtime image, and are covered by exact path and content-hash gates. `trivy-secret.yaml` suppresses only those hash-pinned fixtures; every other detected secret blocks publication.

PastureStack is an independent community effort to preserve, audit, and modernize the Rancher 1.6 ecosystem. It is not affiliated with or endorsed by Rancher Labs or SUSE.

**Upstream:** [`rancher/etcd`](https://github.com/rancher/etcd), in the public etcd fork network. This fork preserves upstream Git history, authorship, dates, tags, and license notices. PastureStack maintenance is consolidated into one commit after upstream version `v2.3.7`.

Existing compatibility artifacts remain historical evidence. There will be no
future `etcd-compat` release. The review-only
[etcd v2 data migration gate](migration/README.md) defines the sequential path
to the active etcd v3 runtime.

See [PASTURESTACK_MAINTENANCE.md](PASTURESTACK_MAINTENANCE.md), [ORIGIN.md](ORIGIN.md), [COMPATIBILITY.md](COMPATIBILITY.md), [SECURITY.md](SECURITY.md), and [migration/README.md](migration/README.md).

[![Go Report Card](https://goreportcard.com/badge/github.com/coreos/etcd)](https://goreportcard.com/report/github.com/coreos/etcd)
[![Build Status](https://travis-ci.org/coreos/etcd.svg?branch=master)](https://travis-ci.org/coreos/etcd)
[![Build Status](https://semaphoreci.com/api/v1/projects/406f9909-2f4f-4839-b59e-95082cb088f1/575109/badge.svg)](https://semaphoreci.com/coreos/etcd)
[![Docker Repository on Quay.io](https://quay.io/repository/coreos/etcd-git/status "Docker Repository on Quay.io")](https://quay.io/repository/coreos/etcd-git)

**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.

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

etcd is a distributed, consistent key-value store for shared configuration and service discovery, with a focus on being:

* *Simple*: curl'able user-facing API (HTTP+JSON)
* *Secure*: optional SSL client cert authentication
* *Fast*: benchmarked 1000s of writes/s per instance
* *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 used [in production by many companies](./Documentation/production-users.md), and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [fleet][fleet], [locksmith][locksmith], [vulcand][vulcand], and many others.

See [etcdctl][etcdctl] for a simple command line client.
Or feel free to just use `curl`, as in the examples below.

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

## Getting Started

### Getting etcd

The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, AppC (ACI), and Docker. Instructions for using these binaries are on the [GitHub releases page][github-release].

For those wanting to try the very latest version, you can build the latest version of etcd from the `master` branch.
You will first need [*Go*](https://golang.org/) installed on your machine (version 1.4+ 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.

[github-release]: https://github.com/coreos/etcd/releases/
[branch-management]: ./Documentation/branch_management.md

### Running etcd

First start a single-member cluster of etcd:

```sh
./bin/etcd
```

This will bring 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:

```
curl -L http://127.0.0.1:2379/v2/keys/mykey -XPUT -d value="this is awesome"
curl -L http://127.0.0.1:2379/v2/keys/mykey
```

You have successfully started an etcd and written a key to the store.

### etcd TCP ports

The [official etcd ports][iana-ports] are 2379 for client requests, and 2380 for peer communication. To maintain compatibility, some etcd configuration and documentation continues to refer to the legacy ports 4001 and 7001, but all new etcd use and discussion should adopt the IANA-assigned ports. The legacy ports 4001 and 7001 will be fully deprecated, and support for their use removed, in future etcd releases.

[iana-ports]: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=etcd

### Running local etcd cluster

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

Our [Procfile script](./Procfile) will set up a local example cluster. You can start it with:

```sh
goreman start
```

This will bring up 3 etcd members `infra1`, `infra2` and `infra3` and etcd proxy `proxy`, which runs locally and composes a cluster.

You can write a key to the cluster and retrieve the value back from any member or proxy.

### Next Steps

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

- Explore the full [API][api].
- Set up a [multi-machine cluster][clustering].
- Learn the [config format, env variables and flags][configuration].
- Find [language bindings and tools][libraries-and-tools].
- Use TLS to [secure an etcd cluster][security].
- [Tune etcd][tuning].
- [Upgrade from 0.4.9+ to 2.2.0][upgrade].

[api]: ./Documentation/api.md
[clustering]: ./Documentation/clustering.md
[configuration]: ./Documentation/configuration.md
[libraries-and-tools]: ./Documentation/libraries-and-tools.md
[security]: ./Documentation/security.md
[tuning]: ./Documentation/tuning.md
[upgrade]: ./Documentation/04_to_2_snapshot_migration.md

## 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/coreos/etcd/milestones), [roadmap](./ROADMAP.md)
- Bugs: [issues](https://github.com/coreos/etcd/issues)

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.

## Reporting bugs

See [reporting bugs](Documentation/reporting_bugs.md) for details about reporting any issue you may encounter.

## Known bugs

[GH518](https://github.com/coreos/etcd/issues/518) is a known bug. Issue is that:

```
curl http://127.0.0.1:2379/v2/keys/foo -XPUT -d value=bar
curl http://127.0.0.1:2379/v2/keys/foo -XPUT -d dir=true -d prevExist=true
```

If the previous node is a key and client tries to overwrite it with `dir=true`, it does not give warnings such as `Not a directory`. Instead, the key is set to empty value.

## Project Details

### Versioning

#### Service Versioning

etcd uses [semantic versioning](http://semver.org)
New minor versions may add additional features to the API.

You can get the version of etcd by issuing a request to /version:

```sh
curl -L http://127.0.0.1:2379/version
```

#### API Versioning

The `v2` API responses should not change after the 2.0.0 release but new features will be added over time.

#### 32-bit and other unsupported systems

etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #[358][358] for more information.

To avoid inadvertantly running a possibly unstable etcd server, `etcd` on unsupported architectures will print
a warning message and immediately exit if the environment variable `ETCD_UNSUPPORTED_ARCH` is not set to
the target architecture.

Currently only the amd64 architecture is officially supported by `etcd`.

[358]: https://github.com/coreos/etcd/issues/358

### License

etcd is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.
historical migration analysis. The abandoned `2.3.8` package candidate will
not be published, and there will be no future `etcd-compat` release. The
upstream engine is end of life and is not a supported etcd release.

PastureStack is an independent community effort to preserve, audit, and
modernize the Rancher 1.6 ecosystem. It is not affiliated with or endorsed
by Rancher Labs or SUSE.

**Upstream:** [`rancher/etcd`](https://github.com/rancher/etcd), in the public
etcd fork network. This fork preserves upstream Git history, authorship,
dates, tags, and license notices. PastureStack maintenance is consolidated
into one commit after upstream version `v2.3.7`.

For the migration boundary and its limits, see [RETIREMENT.md](RETIREMENT.md),
[COMPATIBILITY.md](COMPATIBILITY.md), and [migration/README.md](migration/README.md).
For source provenance and maintenance records, see [ORIGIN.md](ORIGIN.md),
[PASTURESTACK_MAINTENANCE.md](PASTURESTACK_MAINTENANCE.md), and
[SECURITY.md](SECURITY.md). The original upstream README remains available in
the preserved Git history; its installation examples are historical and do
not describe a supported PastureStack deployment.
12 changes: 7 additions & 5 deletions RETIREMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,19 @@
- A bounded search across the other PastureStack repositories and GitHub code
found no consumer of this repository, its image coordinate, or its package
candidate.
- PastureStack has a separate active runtime, `PastureStack/etcd-image`, based
on etcd 3.7.2.
- PastureStack has a separate `PastureStack/etcd-image` 3.7.2 candidate. Its
README states that redistribution remains blocked pending license review;
this retired repository does not provide a deployable replacement.

## Consequences

- Do not build, publish, or deploy a new `etcd-compat` image.
- Do not use the historical release for a new cluster.
- Keep the source and historical release only for audit and recovery planning.
- A remaining v2 data set must follow the sequential, offline process in
[`migration/README.md`](migration/README.md) and end on the active etcd v3
runtime. Migration requires a separately reviewed backup and rollback plan.
- A remaining v2 data set needs the sequential, offline review process in
[`migration/README.md`](migration/README.md). A destination runtime and the
backup, rollback, and rollout plan require separate approval before a live
migration.

Retirement closes the EOL runtime as an active supply-chain surface without
pretending that an etcd 2.x compatibility engine can be made current by changing
Expand Down
Loading