Merge pull request #1331 from coreos/crd

*: Replace TPR with CRD

CHANGELOG.md

@@ -1,8 +1,15 @@
-## [Unreleased 0.4.3]
+## [Unreleased 0.5.0]
+
+**BREAKING CHANGE**: The cluster object will now be defined via a [Custom Resource Definition(CRD)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/) instead of a [Third Party Resource(TPR)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-third-party-resource/). See the `Changed` section below for details.
 
 ### Added
 
 ### Changed
+- With k8s 1.7 and onwards TPRs have been deprecated and are replaced with CRD. See the k8s 1.7 [blogpost](http://blog.kubernetes.io/2017/06/kubernetes-1.7-security-hardening-stateful-application-extensibility-updates.html) or [release notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG.md#major-themes) for more details. For this release a live migration of the cluster spec from TPR to CRD is not supported. To preserve the cluster state during the upgrade you will need to create a backup of the cluster and recreate the cluster from the backup after upgrading the operator. See the [upgrade guide](https://github.com/coreos/etcd-operator/blob/master/doc/user/upgrade/upgrade_guide.md) for more detailed steps on how to do that.
+
+- Changes in the cluster object's type metadata:
+  - The `apiVersion` field has been changed from `etcd.coreos.com/v1beta1` to `etcd.database.coreos.com/v1beta2`
+  - The `kind` field has been changed from `Cluster` to `EtcdCluster`
 
 ### Removed
 

README.md

@@ -10,7 +10,7 @@ e2e (Kubernetes master):
 
 Major planned features have been completed and while no breaking API changes are currently planned, we reserve the right to address bugs and API changes in a backwards incompatible way before the project is declared stable. See [upgrade guide](./doc/user/upgrade/upgrade_guide.md) for safe upgrade process.
 
-Currently user facing etcd cluster objects are created as [Kubernetes Third Party Resources](https://kubernetes.io/docs/user-guide/thirdpartyresources/), however, taking advantage of [User Aggregated API Servers](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/aggregated-api-servers.md) to improve reliability, validation and versioning is planned. The use of Aggregated API should be minimally disruptive to existing users but may change what Kubernetes objects are created or how users deploy the etcd operator.
+Currently user facing etcd cluster objects are created as [Kubernetes Custom Resources](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/), however, taking advantage of [User Aggregated API Servers](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/aggregated-api-servers.md) to improve reliability, validation and versioning is planned. The use of Aggregated API should be minimally disruptive to existing users but may change what Kubernetes objects are created or how users deploy the etcd operator.
 
 We expect to consider the etcd operator stable soon; backwards incompatible changes will not be made once the project reaches stability.
 
@@ -91,16 +91,16 @@ Modify the file and change `size` from 3 to 5.
 
 ```
 $ cat example/example-etcd-cluster.yaml
-apiVersion: "etcd.coreos.com/v1beta1"
-kind: "Cluster"
+apiVersion: "etcd.database.coreos.com/v1beta2"
+kind: "EtcdCluster"
 metadata:
   name: "example-etcd-cluster"
 spec:
   size: 5
   version: "3.1.8"
 ```
 
-Apply the size change to the cluster TPR:
+Apply the size change to the cluster CR:
 ```
 $ kubectl apply -f example/example-etcd-cluster.yaml
 ```
@@ -119,8 +119,8 @@ Similarly we can decrease the size of cluster from 5 back to 3 by changing the s
 
 ```
 $ cat example/example-etcd-cluster.yaml
-apiVersion: "etcd.coreos.com/v1beta1"
-kind: "Cluster"
+apiVersion: "etcd.database.coreos.com/v1beta2"
+kind: "EtcdCluster"
 metadata:
   name: "example-etcd-cluster"
 spec:
@@ -281,8 +281,8 @@ Have the following yaml file ready:
 
 ```
 $ cat 3.0-etcd-cluster.yaml
-apiVersion: "etcd.coreos.com/v1beta1"
-kind: "Cluster"
+apiVersion: "etcd.database.coreos.com/v1beta2"
+kind: "EtcdCluster"
 metadata:
   name: "example-etcd-cluster"
 spec:
@@ -312,16 +312,16 @@ Now modify the file `3.0-etcd-cluster.yaml` and change the `version` from 3.0.16
 
 ```
 $ cat 3.0-etcd-cluster.yaml
-apiVersion: "etcd.coreos.com/v1beta1"
-kind: "Cluster"
+apiVersion: "etcd.database.coreos.com/v1beta2"
+kind: "EtcdCluster"
 metadata:
   name: "example-etcd-cluster"
 spec:
   size: 3
   version: "3.1.8"
 ```
 
-Apply the version change to the cluster TPR:
+Apply the version change to the cluster CR:
 
 ```
 $ kubectl apply -f 3.0-etcd-cluster.yaml