docs: update kubernetes deploying document #1917

allencloud · 2018-07-26T15:59:42Z

Signed-off-by: Allen Sun [email protected]

Ⅰ. Describe what this PR did

We have lots of users who are using Kubernetes to be deployed with PouchContainer. Then I think we need to update the Kubernetes install documents.

I did two things:

split the troubleshooting part from the raw file to be a single one;
Update the new structure of the document:

[Overview
[Prerequisite]
- [Software Version Requirement]
- [Node Resource Requirement]
[Install and Configure PouchContainer]
- [Install PouchContainer]
- [Configure PouchContainer]
- [Restart PouchContainer]
- [Verify PouchContainer Correctness]
[Install and Configure Kubernetes]
- [Download Kubernets Packages]
- [Configure Kubernetes Component]
- [Setup Kubernetes Cluster]
- [Verify Kubernetes Correctness]
[Setup CNI network]
- [flannel]
- [Calico]

Ⅱ. Does this pull request fix one issue?

none

Ⅲ. Describe how you did it

none

Ⅳ. Describe how to verify it

none

Ⅴ. Special notes for reviews

none

codecov-io · 2018-07-26T17:08:44Z

Codecov Report

Merging #1917 into master will decrease coverage by 0.21%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1917      +/-   ##
==========================================
- Coverage   62.64%   62.43%   -0.22%     
==========================================
  Files         200      200              
  Lines       15567    15567              
==========================================
- Hits         9752     9719      -33     
- Misses       4567     4595      +28     
- Partials     1248     1253       +5

Flag	Coverage Δ
#criv1alpha1test	`33.24% <ø> (-0.02%)`	⬇️
#criv1alpha2test	`33.74% <ø> (ø)`	⬆️
#integrationtest	`37.58% <ø> (-0.38%)`	⬇️
#unittest	`20.48% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
daemon/containerio/hijack_conn.go	`77.14% <0%> (-11.43%)`	⬇️
daemon/containerio/container_io.go	`69.61% <0%> (-4.98%)`	⬇️
pkg/meta/store.go	`54.76% <0%> (-4.77%)`	⬇️
daemon/containerio/options.go	`76.19% <0%> (-4.77%)`	⬇️
daemon/mgr/container_utils.go	`56.27% <0%> (-1.74%)`	⬇️
daemon/mgr/system.go	`73.27% <0%> (-1.73%)`	⬇️
daemon/logger/jsonfile/utils.go	`71.54% <0%> (-1.63%)`	⬇️
cri/v1alpha1/cri.go	`65.04% <0%> (-0.19%)`	⬇️
daemon/mgr/container.go	`53.85% <0%> (-0.16%)`	⬇️

starnop · 2018-07-27T01:52:34Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

+|Kubernetes|1.10.0+|
+|PouchContainer|1.0.0-rc1+|
+|CNI|0.6.0+|
+|OS Distribution|entOS 7.0+ or Ubuntu 16.04 +|


s/entOS/CentOS

starnop · 2018-07-27T01:54:02Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

+
+### Node Resource Requirement
+
+To make Kubernete run stably, we should provide sufficient resource for node(s) in Kubernetes. Currently we list two kinds of deploying mode:


s/Kubernete/Kubernetes

starnop · 2018-07-27T02:01:23Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

-apt-get update && apt-get install -y apt-transport-https
-curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add -
-cat <<EOF > /etc/apt/sources.list.d/kubernetes.list
+After installing and configuring PouchContainer to make it ready for Kubernete, validation work could be made to verify if the pouchd meets the requirement.


s/Kubernete/Kubernetes

starnop · 2018-07-27T02:05:47Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

-RELEASE="1.9.4-0.x86_64"
-yum install -y kubelet-${RELEASE} kubeadm-${RELEASE} kubectl-${RELEASE}
-```
+After setting up kubelet's configuration, the next step is installing Kubernetes master node. When using kubeadmin to initialize master node, a CIDR address should be provided. CIDR address is an allocated IP range dedicated for pod's network. Please do not make this IP range conflict or overlapped with the undelying network environment.


s/kubeadmin/kubeadm

starnop · 2018-07-27T02:08:58Z

docs/kubernetes/pouch_with_kubernetes_deploying.md


-  kubeadm join --token $token ${master_ip:port} --discovery-token-ca-cert-hash $ca-cert
-```
+If your environment cannot access internete, please make sure to store content of file above to local directory. Then `kubectl create -f kube-flannel.yml` can make it setup flannel network.


s/internete/internet

starnop · 2018-07-27T02:11:52Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

-For more details, please check [install kubelet](https://kubernetes.io/docs/setup/independent/install-kubeadm/#installing-kubeadm-kubelet-and-kubectl).
-
-### Install CNI
+After executing the command above, Kubernete master and kubelet are both running on this node.  As a result, **a complete Kubernete cluster on singe node has been setup.**


s/Kubernete/Kubernetes

allencloud · 2018-07-27T02:24:56Z

Thanks for your review @starnop 👏

YaoZengzeng · 2018-07-27T05:37:14Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

+
+- Download Kubernetes Packages
+- Configure Kubernetes Component;
+- Intialize Kubernetes Master Node;


Intialize -> Initialize

YaoZengzeng · 2018-07-27T05:37:18Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

+
+No matter running Kubernetes in a single node or in a cluster, PouchContainer is the underlying container engine which should be ready first. After that, Kubernetes components should be installed and configured on corresponding nodes.
+
+Kubernetes parts includes three parts:


--> Kubernetes part also includes three steps

It seems more smoothly 😄

YaoZengzeng · 2018-07-27T05:48:01Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

-```
-
-NOTE: For other plugins, please check [Installing a pod network](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#pod-network).
+Network in Kubernetes cluster is very decoupled work when deploying Kubernetes. In kubernetes community, CNI plugin is a wide-spread way to setup network for pods. Fully test CNI plugins in Kubernetes with PouchContainer are:


---> In Kubernetes community

YaoZengzeng · 2018-07-27T05:58:11Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

+
+### Download Kubernetes Packages
+
+When installing Kubernetes, we use [kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/) to create Kubernetes cluster. First step is to download essential packages from software repository. Thus, we need to add kubernetes.io to debian package source for Ubuntu series and also for CentOS series. After setting up source repository, three kubernetes components will be downloaded:


--> three Kubernetes components

allencloud · 2018-07-27T06:04:33Z

Thanks for your review 🍻 @YaoZengzeng
Updated.

allencloud · 2018-07-30T13:08:46Z

@YaoZengzeng @starnop PTAL

YaoZengzeng · 2018-07-31T07:03:54Z

LGTM

starnop · 2018-07-31T09:12:49Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

-For more details, please check [install kubelet](https://kubernetes.io/docs/setup/independent/install-kubeadm/#installing-kubeadm-kubelet-and-kubectl).
-
-### Install CNI
+After executing the command above, Kubernetes master and kubelet are both running on this node.  As a result, **a complete Kubernete cluster on singe node has been setup.**


s/Kubernete/Kubernetes

on single node --> on a single node

ZouRui89 · 2018-07-31T09:17:05Z

docs/kubernetes/pouch_with_kubernetes_deploying.md


 ## Overview

-This document shows how to easily install a Kubernetes cluster with PouchContainer as the container runtime.For Chinese customer, it's might be faster and easier to download Kubernetes components and various kinds of container images from Aliyun [Kubernetes + PouchContainer + Aliyun](pouch_with_kubernetes_deploying_aliyun.md).
+This document shows how to easily install a Kubernetes cluster with PouchContainer as the container runtime. For Chinese customer, it's might be faster and easier to download Kubernetes components and various kinds of container images from Aliyun [Kubernetes + PouchContainer + Aliyun](pouch_with_kubernetes_deploying_aliyun.md).



For Chinese customer --> For a Chinese customer
it's might be --> it might be

ZouRui89 · 2018-07-31T09:18:13Z

docs/kubernetes/pouch_with_kubernetes_deploying.md


-NOTE: PouchContainer version prior to 0.5.x (including version 0.5.0) did not support configuring  CNI network plugin with flannel. If you want to do that, use the latest code from the branch of master, refer to  [Developer Quick-Start](https://github.com/alibaba/pouch/blob/master/INSTALLATION.md#developer-quick-start)
+Before installing Kubernetes and PouchContainer to provide orchestrating service for users, some environment requirement must meet.


must meet --> must be met

ZouRui89 · 2018-07-31T09:22:31Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

+
+## Install and Configure Kubernetes
+
+No matter running Kubernetes in a single node or in a cluster, PouchContainer is the underlying container engine which should be ready first. After that, Kubernetes components should be installed and configured on corresponding nodes.


in a single node --> on a single node

ZouRui89 · 2018-07-31T09:24:46Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

+
+When installing Kubernetes, we use [kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/) to create Kubernetes cluster. First step is to download essential packages from software repository. Thus, we need to add kubernetes.io to debian package source for Ubuntu series and also for CentOS series. After setting up source repository, three Kubernetes components will be downloaded:
+
+- [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/): a primary node agent runs on each node in Kubernetes Clusters.


To make context consistently, change on each node in Kubernetes Clusters to on each node in Kubernetes clusters.

ZouRui89 · 2018-07-31T09:26:47Z

docs/kubernetes/pouch_with_kubernetes_deploying.md

-For more details, please check [install kubelet](https://kubernetes.io/docs/setup/independent/install-kubeadm/#installing-kubeadm-kubelet-and-kubectl).
-
-### Install CNI
+After executing the command above, Kubernetes master and kubelet are both running on this node.  As a result, **a complete Kubernete cluster on singe node has been setup.**


on single node --> on a single node

Signed-off-by: Allen Sun <[email protected]>

allencloud · 2018-07-31T13:37:05Z

Thanks for all your reviews. I will merge this first. If you have any other opinions, please feel free to let me know.

pouchrobot added areas/docs areas/orchestration size/XL labels Jul 26, 2018

allencloud force-pushed the update-k8s-deploy-doc branch from 662cd30 to a7736f4 Compare July 26, 2018 16:04

allencloud assigned ireneYang, YaoZengzeng and starnop Jul 26, 2018

allencloud force-pushed the update-k8s-deploy-doc branch 2 times, most recently from 7f8fcc8 to 601d38a Compare July 26, 2018 16:21

starnop reviewed Jul 27, 2018

View reviewed changes

allencloud force-pushed the update-k8s-deploy-doc branch 2 times, most recently from cbffe36 to 96d770c Compare July 27, 2018 01:57

starnop reviewed Jul 27, 2018

View reviewed changes

allencloud force-pushed the update-k8s-deploy-doc branch from 96d770c to 21fe81d Compare July 27, 2018 02:16

YaoZengzeng reviewed Jul 27, 2018

View reviewed changes

allencloud force-pushed the update-k8s-deploy-doc branch from 21fe81d to aa25321 Compare July 27, 2018 06:04

starnop reviewed Jul 31, 2018

View reviewed changes

ZouRui89 reviewed Jul 31, 2018

View reviewed changes

docs: update kubernetes deploying document

17df581

Signed-off-by: Allen Sun <[email protected]>

allencloud force-pushed the update-k8s-deploy-doc branch from aa25321 to 17df581 Compare July 31, 2018 13:36

allencloud merged commit f590a6d into AliyunContainerService:master Jul 31, 2018

allencloud deleted the update-k8s-deploy-doc branch July 31, 2018 13:37

pouchrobot mentioned this pull request Aug 2, 2018

Weekly Report of PouchContainer from 2018-07-26 to 2018-08-02 #2036

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update kubernetes deploying document #1917

docs: update kubernetes deploying document #1917

allencloud commented Jul 26, 2018

codecov-io commented Jul 26, 2018 •

edited

Loading

starnop Jul 27, 2018

starnop Jul 27, 2018

starnop Jul 27, 2018

starnop Jul 27, 2018

starnop Jul 27, 2018

starnop Jul 27, 2018

allencloud commented Jul 27, 2018

YaoZengzeng Jul 27, 2018

YaoZengzeng Jul 27, 2018

YaoZengzeng Jul 27, 2018

YaoZengzeng Jul 27, 2018

allencloud commented Jul 27, 2018

allencloud commented Jul 30, 2018

YaoZengzeng commented Jul 31, 2018

starnop Jul 31, 2018

ZouRui89 Jul 31, 2018

ZouRui89 Jul 31, 2018

ZouRui89 Jul 31, 2018

ZouRui89 Jul 31, 2018

ZouRui89 Jul 31, 2018

ZouRui89 Jul 31, 2018

allencloud commented Jul 31, 2018


		### Node Resource Requirement

		To make Kubernete run stably, we should provide sufficient resource for node(s) in Kubernetes. Currently we list two kinds of deploying mode:


		No matter running Kubernetes in a single node or in a cluster, PouchContainer is the underlying container engine which should be ready first. After that, Kubernetes components should be installed and configured on corresponding nodes.

		Kubernetes parts includes three parts:


		### Download Kubernetes Packages

		When installing Kubernetes, we use [kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/) to create Kubernetes cluster. First step is to download essential packages from software repository. Thus, we need to add kubernetes.io to debian package source for Ubuntu series and also for CentOS series. After setting up source repository, three kubernetes components will be downloaded:


		NOTE: PouchContainer version prior to 0.5.x (including version 0.5.0) did not support configuring CNI network plugin with flannel. If you want to do that, use the latest code from the branch of master, refer to [Developer Quick-Start](https://github.com/alibaba/pouch/blob/master/INSTALLATION.md#developer-quick-start)
		Before installing Kubernetes and PouchContainer to provide orchestrating service for users, some environment requirement must meet.


		## Install and Configure Kubernetes

		No matter running Kubernetes in a single node or in a cluster, PouchContainer is the underlying container engine which should be ready first. After that, Kubernetes components should be installed and configured on corresponding nodes.


		When installing Kubernetes, we use [kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/) to create Kubernetes cluster. First step is to download essential packages from software repository. Thus, we need to add kubernetes.io to debian package source for Ubuntu series and also for CentOS series. After setting up source repository, three Kubernetes components will be downloaded:

		- [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/): a primary node agent runs on each node in Kubernetes Clusters.

docs: update kubernetes deploying document #1917

docs: update kubernetes deploying document #1917

Conversation

allencloud commented Jul 26, 2018

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Describe how you did it

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

codecov-io commented Jul 26, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allencloud commented Jul 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allencloud commented Jul 27, 2018

allencloud commented Jul 30, 2018

YaoZengzeng commented Jul 31, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allencloud commented Jul 31, 2018

codecov-io commented Jul 26, 2018 •

edited

Loading