Merge pull request openyurtio#114 from Fei-Guo/fguo-dev-1

[Doc] Add 0.2.0 CHANGELOG
JameKeal · Aug 31, 2020 · 130e024 · 130e024
2 parents 54636d7 + 52974d4
commit 130e024
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,36 @@
-**v0.1.0-beta.1**
+# v0.2.0
+
+## Project
+
+- Support Kubernetes 1.16 dependency for all components
+- Support multi-arch binaries and images (arm/arm64/amd64)
+- Add e2e test framework and tests for node autonomy
+- New tutorials (e2e test and yurt-tunnel)
+
+## yurt-tunnel
+
+### Features
+
+- Implement yurt-tunnel-server and yurt-tunnel-agent based on Kubernetes apiserver network proxy framework
+- Implement cert-manager to manage yurt-tunnel certificates
+- Add timeout mechanism for yurt-tunnel
+
+## yurtctl
+
+### Features
+
+- Add global lock to prevent multiple yurtctl invocations concurrently
+- Add timeout for acquiring global lock
+- Allow user to set the label prefix used to identify edge nodes
+- Deploy yurt-tunnel using convert option
+
+### Bugs
+
+- Remove kubelet config bootstrap args during manual setup 
+
+---
+
+# v0.1.0-beta.1
 
 ## yurt-controller-manager
 

diff --git a/README.md b/README.md
@@ -11,11 +11,12 @@
 
 |![notification](docs/img/bell-outline-badge.svg) What is NEW!|
 |------------------|
+|August 30th, 2020. OpenYurt v0.2.0 is **RELEASED**! Please check the [CHANGELOG](CHANGELOG.md) for details.|
 |May 29th, 2020. OpenYurt v0.1.0-beta.1 is **RELEASED**! Please check the [CHANGELOG](CHANGELOG.md) for details.|
 
 OpenYurt is built based on native Kubernetes and targets to extend it to support edge computing seamlessly.
 In a nutshell, OpenYurt enables users to manage applications that run in the edge infrastructure as if they were running
-in the cloud infrastructure. 
+in the cloud infrastructure. Our official website is [https://openyurt.io](https://openyurt.io).
 
 OpenYurt is suitable for common edge computing use cases whose requirements include:
 - Minimizing the network traffic over long distances between the devices and the workloads.

diff --git a/docs/tutorial/README.md b/docs/tutorial/README.md
@@ -5,4 +5,5 @@ These tutorials walk through several examples to demonstrate how to use OpenYurt
 
 ## Try tutorials
 - [Use `YurtCtl` to install/uninstall OpenYurt components](./yurtctl.md)
+- [Use `YurtTunnel` to connect apiserver and edge node](./yurt-tunnel.md)
 - [Set up OpenYurt cluster manually](./manually-setup.md)
diff --git a/docs/tutorial/manually-setup.md b/docs/tutorial/manually-setup.md
@@ -70,6 +70,10 @@ scp -i <yourt-ssh-identity-file> /tmp/yurthub-ack.yaml root@us-west-1.192.168.0.
 ```
 and the Yurthub will be ready in minutes.
 
+## Setup Yurt-tunnel (Optional)
+
+Please refer to this [document](.//yurt-tunnel.md#5-setup-the-yurt-tunnel-manually) to setup Yurttunnel manually. 
+
 ## Reset the Kubelet 
 
 By now, we have setup all required components for the OpenYurt cluster, next, we only need to reset the 

diff --git a/docs/tutorial/yurt-tunnel.md b/docs/tutorial/yurt-tunnel.md
@@ -1,4 +1,4 @@
-# Try out Yurt-tunnel
+# Use Yurt-tunnel to connect apiserver and edge node
 
 In this tutorial, we will show how the yurt-tunnel helps the apiserver send 
 request to nodes when the network traffic from apiserver to the node is 
@@ -83,7 +83,16 @@ $ sudo iptables -A OUTPUT -p tcp -d 192.168.64.9 --dport 10250 -j DROP
 Now, if we try to execute the `date` command in `test-po` again, the command 
 will hang.
 
-### 5. Setup the yurt-tunnel
+### 5. Setup the yurt-tunnel manually
+
+It is recommended to use `yurtctl` tool to deploy yurt-tunnel components by
+adding the `--deploy-yurttunnel` option when coverting a Kubernetes cluster. For example,
+```bash
+yurtctl convert --cloud-nodes minikube --provider minikube --deploy-yurttunnel
+```
+
+You may also setup the yurt-tunnel manually by deploying yurt-tunnel-server
+and yurt-tunnel-agent separately.
 
 To set up the yurt-tunnel-server, let's first add a label to the cloud node
 ```bash