1## Supported platforms
2
3### Current support
4
5The following table lists etcd support status for common architectures and operating systems,
6
7| Architecture | Operating System | Status       | Maintainers      |
8| ------------ | ---------------- | ------------ | ---------------- |
9| amd64        | Darwin           | Experimental | etcd maintainers |
10| amd64        | Linux            | Stable       | etcd maintainers |
11| amd64        | Windows          | Experimental |                  |
12| arm64        | Linux            | Experimental | @glevand         |
13| arm          | Linux            | Unstable     |                  |
14| 386          | Linux            | Unstable     |                  |
15
16* etcd-maintainers are listed in https://github.com/coreos/etcd/blob/master/MAINTAINERS.
17
18Experimental platforms appear to work in practice and have some platform specific code in etcd, but do not fully conform to the stable support policy. Unstable platforms have been lightly tested, but less than experimental. Unlisted architecture and operating system pairs are currently unsupported; caveat emptor.
19
20### Supporting a new platform
21
22For etcd to officially support a new platform as stable, a few requirements are necessary to ensure acceptable quality:
23
241. An "official" maintainer for the platform with clear motivation; someone must be responsible for taking care of the platform.
252. Set up CI for build; etcd must compile.
263. Set up CI for running unit tests; etcd must pass simple tests.
274. Set up CI (TravisCI, SemaphoreCI or Jenkins) for running integration tests; etcd must pass intensive tests.
285. (Optional) Set up a functional testing cluster; an etcd cluster should survive stress testing.
29
30### 32-bit and other unsupported systems
31
32etcd has known issues on 32-bit systems due to a bug in the Go runtime. See the [Go issue][go-issue] and [atomic package][go-atomic] for more information.
33
34To avoid inadvertently running a possibly unstable etcd server, `etcd` on unstable or unsupported architectures will print a warning message and immediately exit if the environment variable `ETCD_UNSUPPORTED_ARCH` is not set to the target architecture.
35
36Currently only the amd64 architecture is officially supported by `etcd`.
37
38[go-issue]: https://github.com/golang/go/issues/599
39[go-atomic]: https://golang.org/pkg/sync/atomic/#pkg-note-BUG
40