Skip to content

Commit

Permalink
Add release notes for v1.1 (istio-ecosystem#154)
Browse files Browse the repository at this point in the history
  • Loading branch information
aattuluri authored Nov 23, 2020
1 parent ded72b7 commit 406b78d
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 31 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Single cluster integration tests can be run locally using minikube. By default i
```
make gen-yaml
cd $ADMIRAL_HOME/tests
./run.sh "1.16.8" "1.5.6" "../out"
./run.sh "1.16.8" "1.7.4" "../out"
```
* Multi-cluster
```
Expand Down
4 changes: 3 additions & 1 deletion docs/Compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The below information is based on the testing done, please submit a PR if you ha
v0.1-beta | 1.2.3 | 1.4.6 | 1.13 | 1.14.2
v0.9 | 1.2.3 | 1.5.1 | 1.13 | 1.18.0
v1.0 | 1.2.3 | 1.5.6 | 1.13 | 1.18.0

v1.1 | 1.5.7 | 1.7.4 | 1.13 | 1.18.0

## Admiral feature support by Istio Version

Expand All @@ -17,6 +17,7 @@ v1.0 | 1.2.3 | 1.5.6 | 1.13
v0.1-beta | Yes | Yes | No
v0.9 | Yes | Yes | Yes (requires Istio 1.5.1 or higher)
v1.0 | Yes | Yes | Yes (requires Istio 1.5.1 or higher)
v1.1 | Yes | Yes | Yes (requires Istio 1.5.1 or higher)


## Tested cloud vendors
Expand All @@ -26,5 +27,6 @@ v1.0 | Yes | Yes | Yes (requires Istio 1.5.1 or h
v0.1-beta | AWS
v0.9 | AWS
v1.0 | AWS, GCP, Azure
v1.1 | AWS, GCP, Azure

`Note`: Please submit a PR if admiral was tested on other cloud vendors
12 changes: 6 additions & 6 deletions docs/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ export REMOTE_CLUSTER=<path_to_kubeconfig_for_remote_cluster>
```bash
#Download and extract admiral

wget https://github.com/istio-ecosystem/admiral/releases/download/v1.0/admiral-install-v1.0.tar.gz
tar xvf admiral-install-v1.0.tar.gz
wget https://github.com/istio-ecosystem/admiral/releases/download/v1.1/admiral-install-v1.1.tar.gz
tar xvf admiral-install-v1.1.tar.gz

export ADMIRAL_HOME=./admiral-install-v1.0
export ADMIRAL_HOME=./admiral-install-v1.1
```

```bash
Expand Down Expand Up @@ -98,10 +98,10 @@ At this point, admiral is watching `remote cluster`
```
#Download and extract admiral
wget https://github.com/istio-ecosystem/admiral/releases/download/v1.0/admiral-install-v1.0.tar.gz
tar xvf admiral-install-v1.0.tar.gz
wget https://github.com/istio-ecosystem/admiral/releases/download/v1.1/admiral-install-v1.1.tar.gz
tar xvf admiral-install-v1.1.tar.gz
export ADMIRAL_HOME=./admiral-install-v1.0
export ADMIRAL_HOME=./admiral-install-v1.1
```

```
Expand Down
25 changes: 2 additions & 23 deletions docs/Release-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,7 @@

* You are an admin on the admiral github project (to cut the release)
* You have access to admiral slack channel and AdmiralProj twitter account (to make release announcements)

## Validate the `latest` admiral tag

* Install minikube (and the associated VM environment like VirtualBox)

* Checkout admiral `master` branch and run the integration tests locally.

```bash
git clone https://github.com/istio-ecosystem/admiral.git
cd admiral
git pull
make gen-yaml
cd tests
./run.sh "1.16.8" "1.5.6" "../out"
```

Expect to see the following output when the test completes:
```bash
Admiral did it's magic!
PASS
PASS
```
* [Validate that the master branch build is passing](https://circleci.com/gh/istio-ecosystem/admiral/tree/master)

## Draft the release notes

Expand All @@ -38,7 +17,7 @@ The release notes is maintained [here](ReleaseNotes.md). Open a PR to the releas

### How to find the issues/commits
* You can find the [issues associated with a milestone](https://github.com/istio-ecosystem/admiral/issues?q=is%3Aissue+milestone%3Av1.0+) to get started.
* [Commits](https://github.com/istio-ecosystem/admiral/compare/release-0.9...master) between last release (the link assumes `v0.9`) and `master` branch
* [Commits](https://github.com/istio-ecosystem/admiral/compare/v1.0...master) between last release (the link assumes `v1.0`) and `master` branch


## Draft a new release on github.com
Expand Down
18 changes: 18 additions & 0 deletions docs/ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Release notes

## v1.1

This is a minor release that addresses some usability and clean up aspects.

### Features

#### [gRPC and http2 protocol support](https://github.com/istio-ecosystem/admiral/issues/76)
Version 1.1 adds support to use gRPC and http2 protocols in addition to the default http for admiral generated endpoints. Try the [example](https://github.com/istio-ecosystem/admiral/blob/master/docs/Examples.md#grpc-demo) to explore this further.

#### [Deletion support](https://github.com/istio-ecosystem/admiral/issues/9)
Admiral now cleans up the CNAMEs and the associated configurations when a k8s deployement is deleted.

#### [Guidance on using Admiral in production](https://github.com/istio-ecosystem/admiral/issues/106)
Added documentation and guidance on how to deploy admiral in a production setting. The documentation is available [here](https://github.com/istio-ecosystem/admiral/blob/master/docs/Examples.md#production-deployment)

### Project improvements
Added automated integration tests for admiral to simulates real uses cases

## v1.0

Admiral has graduated to Generally Available! Version 1.0 has a series of bugfixes and includes support for [Argo Rollouts](https://argoproj.github.io/argo-rollouts/)
Expand Down

0 comments on commit 406b78d

Please sign in to comment.