Release v0.4.0

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 # Changelog
 
-## v0.4.0-rc.1
+## v0.4.0
 
 The first release candidate for Ignite's biggest release yet!
 
@@ -12,15 +12,22 @@ There are many significant changes compared to before:
 
  - Make base and kernel OCI images composable for a VM. You can now choose what kernel to combine with what base image freely https://github.com/weaveworks/ignite/pull/105
  - Add the GitOps mode for Ignite using `ignite gitops` https://github.com/weaveworks/ignite/pull/100
+   - Documentation: https://github.com/weaveworks/ignite/blob/master/gitops
  - Make it possible to run `ignite create` and `ignite run` declaratively https://github.com/weaveworks/ignite/commit/57333646b52a0e1e3a725340e994b2749b39e5bd
+   - Documentation: https://github.com/weaveworks/ignite/blob/master/docs/declarative-config.md
  - Added Prometheus metrics for `ignite-spawn` https://github.com/weaveworks/ignite/commit/94abc529972873db3fa3ee954099a4f62d67b6f3
+   - Documentation: https://github.com/weaveworks/ignite/blob/master/docs/prometheus.md
  - Implemented CNI support https://github.com/weaveworks/ignite/commit/a8897532f9f6a8f5c40025f0f93ab2d24f2c7cd3
 
 ### API Machinery
 
  - Added the `ignite.weave.works/v1alpha1` API group with the Ignite API types https://github.com/weaveworks/ignite/commit/ca1edc8e7a61b950811c6145ba2ad53f8cdc2a04
+   - API reference: https://github.com/weaveworks/ignite/blob/master/api/ignite.md
+   - This API version will not change in a future version. When improvements are made, it will be to `v1alpha2` etc.
  - Add a meta API package containing supporting but generic API types for Ignite https://github.com/weaveworks/ignite/commit/09d51abd409ee361e93884baae24ffc92cde63a9
+   - API reference: https://github.com/weaveworks/ignite/blob/master/api/meta.md
  - Create composable interfaces for the internal API machinery: `Client` -> `Cache` -> `Storage` -> `RawStorage` -> `Serializer` https://github.com/weaveworks/ignite/pull/93 https://github.com/weaveworks/ignite/pull/96 https://github.com/weaveworks/ignite/pull/99
+ - The API Machinery used in Ignite is partly based on the Kubernetes API machinery (`k8s.io/apimachinery`), and hence follows some of the same patterns
 
 ### New Commands
 
@@ -30,18 +37,53 @@ There are many significant changes compared to before:
 ### Documentation
 
  - Add user-facing documentation and guides https://github.com/weaveworks/ignite/pull/113
+   - See: https://github.com/weaveworks/ignite/tree/master/docs
  - Generate OpenAPI specifications https://github.com/weaveworks/ignite/commit/f1c5bfd473799f712c4c1d8fb276426780c1bf01
+   - See: https://github.com/weaveworks/ignite/blob/master/api/openapi/openapi_generated.go
  - Add API type documentation https://github.com/weaveworks/ignite/commit/218c94723f836b8e2cb82886b8664544933ea605
+   - See: https://github.com/weaveworks/ignite/blob/master/api
  - Added architecture diagram https://github.com/weaveworks/ignite/commit/da53f9fc2f5790edacb5d1b541dd4da8a6089673
+   - See: https://github.com/weaveworks/ignite/blob/master/docs/architecture.png
  - Added graph of module dependencies https://github.com/weaveworks/ignite/commit/be7cc088c671c5728155fb146367a67d4ada4ea6
+   - See: https://github.com/weaveworks/ignite/blob/master/docs/dependencies.svg
+
+### Updated Images
+
+#### Base Images
+
+ - `weaveworks/ignite-ubuntu:v0.4.0`: https://github.com/weaveworks/ignite/blob/master/images/ubuntu/Dockerfile
+ - `weaveworks/ignite-centos:v0.4.0`: https://github.com/weaveworks/ignite/blob/master/images/centos/Dockerfile
+ - `weaveworks/ignite-amazonlinux:v0.4.0`: https://github.com/weaveworks/ignite/blob/master/images/amazonlinux/Dockerfile
+ - `weaveworks/ignite-alpine:v0.4.0`: https://github.com/weaveworks/ignite/blob/master/images/alpine/Dockerfile
+
+#### Kernel Images
+
+ - `weaveworks/ignite-kernel:4.14.123`: https://github.com/weaveworks/ignite/blob/master/images/kernel/Dockerfile
+ - `weaveworks/ignite-kernel:4.19.47` (default): https://github.com/weaveworks/ignite/blob/master/images/kernel/Dockerfile
+ - `weaveworks/ignite-amazon-kernel:v0.4.0` (using `4.14.55`): https://github.com/weaveworks/ignite/blob/master/images/amazon-kernel/Dockerfile
 
 ### Internal Improvements
 
+ - A significant refactor of the whole application has been made to support the new API machinery
  - Add structured logging https://github.com/weaveworks/ignite/pull/110
  - Factor out `ignite-spawn` into its own binary running in the container https://github.com/weaveworks/ignite/commit/0a1965e7203877c591dc79504ce257a57fd00480
  - Upgraded the Firecracker version to v0.17.0 https://github.com/weaveworks/ignite/commit/41e3595b9e8d35c24e8cd97037cc1c7045779ee9
  - Set Go version to 1.12.6 https://github.com/weaveworks/ignite/commit/d00cce7d2b09e97f8d515c4a6161b11fc6c61a2c
 
+
+## Trying it out / Next Steps!
+
+In short:
+
+```bash
+export VERSION=v0.4.0
+curl -Lo ignite https://github.com/weaveworks/ignite/releases/download/${VERSION}/ignite
+chmod +x ignite
+sudo mv ignite /usr/local/bin
+```
+
+A longer installation guide is available here: https://github.com/weaveworks/ignite/blob/master/docs/installation.md
+
 ## v0.3.0
 
 Major release with significant UX and internal improvements: