From 6002405757cb841089af15f52cbb56b5d7ee59c2 Mon Sep 17 00:00:00 2001 From: adamhosier Date: Wed, 13 Nov 2019 17:37:58 +0000 Subject: [PATCH] Release v0.1.0 (#71) --- README.md | 5 ++++- docs/contributing.md | 4 ++-- docs/release-notes/v0.1.md | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 43 insertions(+), 3 deletions(-) create mode 100644 docs/release-notes/v0.1.md diff --git a/README.md b/README.md index d43671d4..7bd1747a 100644 --- a/README.md +++ b/README.md @@ -107,8 +107,11 @@ Contribution guidelines are found in [docs/contributing.md](https://github.com/i ## Status +This project is in the early stages of development. +Please do not expect the operator to be stable, and expect breaking changes to the API until we hit stability. + - [x] In-memory ETCD clusters -- [ ] Persisted data ETCD clusters +- [x] Persisted data ETCD clusters - [ ] Scaling up/down of existing clusters - [ ] Upgrading existing clusters - [ ] Backup/restore of cluster data diff --git a/docs/contributing.md b/docs/contributing.md index afea15c7..16ffe886 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -71,8 +71,8 @@ string will be prefixed with `v` and use semver. ### Pre-release tasks * Sanity check documentation under `docs` and `README.md`. -* Compile and prepare release notes under `docs/release-notes/$VERSION.md`. For example version v0.1.0 would have a file - `docs/release-notes/v0.1.0.md`. +* Compile and prepare release notes under `docs/release-notes/$VERSION.md`. For example versions v0.1.X would share a +file `docs/release-notes/v0.1.md`. ### Process diff --git a/docs/release-notes/v0.1.md b/docs/release-notes/v0.1.md new file mode 100644 index 00000000..0a42c6db --- /dev/null +++ b/docs/release-notes/v0.1.md @@ -0,0 +1,37 @@ +# Release v0.1 + +## Changelog for [v0.1.0](https://github.com/improbable-eng/etcd-cluster-operator/releases/v0.1.0) - 2019-11-13 + +### Notable changes + +* [#5](https://github.com/improbable-eng/etcd-cluster-operator/issues/5) **EtcdPeer resource controller** + + An MVP implementation of the EtcdPeer controller now exists. + This controller allows users to create `EtcdPeer` resources, and will [create pods](https://github.com/improbable-eng/etcd-cluster-operator/pull/16) running `etcd` in response. + This controller handles the [bootstrap](https://github.com/improbable-eng/etcd-cluster-operator/pull/18) process, using etcd's static bootstrap method. + +* [#23](https://github.com/improbable-eng/etcd-cluster-operator/issues/23) **EtcdCluster resource controller** + + A etcd cluster controller has also been added. + This controller allows users to create `EtcdCluster` resources, and will [create `EtcdPeer` resources](https://github.com/improbable-eng/etcd-cluster-operator/pull/27) in response. + It also [creates a headless service](https://github.com/improbable-eng/etcd-cluster-operator/pull/24) for client and peer access to the cluster. + The membership status of the etcd cluster will be [posted](https://github.com/improbable-eng/etcd-cluster-operator/pull/58) to the `EtcdCluster` resource status. + +* [#29](https://github.com/improbable-eng/etcd-cluster-operator/issues/29) **Persisted data for etcd clusters** + + Etcd clusters can have their data be persisted between cluster restarts. + The EtcdPeer controller will [create a PVC](https://github.com/improbable-eng/etcd-cluster-operator/pull/46) for each `EtcdPeer`. + This PVC is used to store etcd data, and persists between updates to the peer or cluster resoures. + +* [#39](https://github.com/improbable-eng/etcd-cluster-operator/issues/39) **Default and validating webhooks** + + All current resource types (`EtcdPeer` and `EtcdCluster`) now have [defaulting and validating webhooks](https://github.com/improbable-eng/etcd-cluster-operator/issues/39) deployed. + These webhooks allow resources to hold defaults which are applied before the resource is stored, as well as perform pre-apply validation in addition to the OpenAPI validation done by default. + +### Everything else + +* [#28](https://github.com/improbable-eng/etcd-cluster-operator/pull/28) **Project README created** +* [#26](https://github.com/improbable-eng/etcd-cluster-operator/pull/26) **End-to-end test suite created** +* [#43](https://github.com/improbable-eng/etcd-cluster-operator/pull/43) **Testing strategy documented** +* [#45](https://github.com/improbable-eng/etcd-cluster-operator/pull/45) **Release process documented** +