Update procedure for setting up single node/multi-node cluster

docs/setup-guide/setup-dev-env.md

@@ -1,28 +1,26 @@
-## Set up developer environment
+## Set up developer environment (updated on 2021-07-19)
 
-Note: tested on AWS EC2 Ubuntu 16.04 x86 image.
-
+Note: Tested on AWS EC2 Ubuntu 16.04/18.04/20.04 x86 image.
 
 ### Clone repo
 ```
 $ mkdir -p go/src/
 $ cd go/src/
-$ git clone https://github.com/futurewei-cloud/arktos
+$ git clone https://github.com/centaurusinfra/arktos
 ```
 
-Note: the following steps can be simplified by running hack/setup-dev-node.sh
+### Install needed packages (docker, make, gcc, jq and golang)
+```
+$ ./hack/setup-dev-node.sh
+```
 
-### Install Golang
+### Install needed packages (docker, make, gcc, jq and golang)
 ```
-$ sudo apt-get update
-# $ sudo apt-get -y upgrade // optional
-$ cd /tmp
-$ wget https://dl.google.com/go/go1.12.9.linux-amd64.tar.gz
-$ tar -xvf go1.12.9.linux-amd64.tar.gz
-$ sudo mv go /usr/local
-$ rm go1.12.9.linux-amd64.tar.gz
+$ ./hack/setup-dev-node.sh
 ```
-Add the following lines to ~/.profile
+
+### Update your account's profile
+Add the following lines into the profile
 ```
 GOROOT=/usr/local/go
 GOPATH=$HOME/go
@@ -31,54 +29,5 @@ PATH=$GOPATH/bin:$GOROOT/bin:$PATH
 Update the current shell session
 ```
 $ source ~/.profile
-```
-
-### Install gcc and make. There might be an issue to build images. It can be fixed by running "git tag -a v2.7.4"
-```
-$ sudo apt install build-essential
-```
-
-### Install Docker
-```
-# sudo apt-get update -y -q
-
-# sudo apt-get install \
-    apt-transport-https \
-    ca-certificates \
-    curl \
-    gnupg-agent \
-    software-properties-common -y -q
-
-$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
-# sudo apt-key fingerprint 0EBFCD88
-
-# sudo add-apt-repository \
-   "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
-   $(lsb_release -cs) \
-   stable"
-
-# sudo apt-get update -y -q
-# sudo apt-get install docker-ce docker-ce-cli containerd.io -y -q
-# sudo gpasswd -a $USER docker
-```
-
-### Install crictl
-```
-$ cd /tmp
-$ wget https://github.com/kubernetes-sigs/cri-tools/releases/download/v1.17.0/crictl-v1.17.0-linux-amd64.tar.gz
-# sudo tar zxvf crictl-v1.17.0-linux-amd64.tar.gz -C /usr/local/bin
-$ rm -f crictl-v1.17.0-linux-amd64.tar.gz
-
-$ touch /tmp/crictl.yaml
-$ echo runtime-endpoint: unix:///run/containerd/containerd.sock >> /tmp/crictl.yaml
-$ echo image-endpoint: unix:///run/containerd/containerd.sock >> /tmp/crictl.yaml
-$ echo timeout: 10 >> /tmp/crictl.yaml
-$ echo debug: true >> /tmp/crictl.yaml
-# sudo mv /tmp/crictl.yaml /etc/crictl.yaml
-
-# mkdir -p /etc/containerd
-# sudo rm -rf /etc/containerd/config.toml
-# sudo containerd config default > /tmp/config.toml
-# sudo mv /tmp/config.toml /etc/containerd/config.toml
-# sudo systemctl restart containerd
+$ echo $PATH
 ```

docs/setup-guide/single-node-dev-cluster.md

@@ -0,0 +1,50 @@
+# How to Setup a Dev Cluster of single node on AWS EC2 instance running Ubuntu 18.04, 16.04 and 20.04
+
+0. Pre-requisite - setup local development environment
+```
+  https://github.com/CentaurusInfra/arktos/blob/master/docs/setup-guide/setup-dev-env.md
+```
+
+1. Run script to create a single arktos cluster
+
+   Note: If your Dev Cluster of single node is on AWS EC2 instance running Ubuntu 20.04, please FIRST comment out the following three lines at https://github.com/CentaurusInfra/arktos/blob/master/pkg/kubelet/cm/container_manager_linux.go#L804,#L806 before running the command './hack/arktos-up.sh'.
+
+        if cpu != memory {
+		return "", fmt.Errorf("cpu and memory cgroup hierarchy not unified.  cpu: %s, memory: %s", cpu, memory)
+	}
+
+```bash
+   $ ./hack/arktos-up.sh
+```
+
+   Note: If your Dev Cluster of single node is on AWS EC2 instance running Ubuntu 18.04, after you run the command './hack/arktos-up.sh', you may experience the following error. Just simply remove the symbolic link and re-run the command './hack/arktos-up.sh'.
+
+         ln: failed to create symbolic link '/home/ubuntu/go/src/arktos/_output/bin': File exists 
+
+```bash
+   $ rm -i /home/ubuntu/go/src/arktos/_output/bin
+   $ ./hack/arktos-up.sh
+```
+
+
+2. Open another terminal to use arktos cluster
+```bash
+  $ export KUBECONFIG=/var/run/kubernetes/admin.kubeconfig
+Or
+  $ export KUBECONFIG=/var/run/kubernetes/adminN(N=0,1,...).kubeconfig
+
+  $ cluster/kubectl.sh
+
+Alternatively, you can write to the default kubeconfig:
+
+  $ export KUBERNETES_PROVIDER=local
+
+  $ sudo cluster/kubectl.sh config set-cluster local --server=https://ip-172-31-3-192:6443 --certificate-authority=/var/run/kubernetes/server-ca.crt
+  $ sudo cluster/kubectl.sh config set-credentials myself --client-key=/var/run/kubernetes/client-admin.key --client-certificate=/var/run/kubernetes/client-admin.crt
+  $ sudo cluster/kubectl.sh config set-context local --cluster=local --user=myself
+  $ sudo cluster/kubectl.sh config use-context local
+  $ sudo cluster/kubectl.sh config get-contexts
+  $ cluster/kubectl.sh
+  $ cluster/kubectl.sh get nodes
+  $ cluster/kubectl.sh get all --all-namespaces
+```

hack/arktos-up.sh

@@ -396,11 +396,14 @@ Alternatively, you can write to the default kubeconfig:
 
   export KUBERNETES_PROVIDER=local
 
-  cluster/kubectl.sh config set-cluster local --server=https://${API_HOST}:${API_SECURE_PORT} --certificate-authority=${ROOT_CA_FILE}
-  cluster/kubectl.sh config set-credentials myself ${AUTH_ARGS}
-  cluster/kubectl.sh config set-context local --cluster=local --user=myself
-  cluster/kubectl.sh config use-context local
+  sudo cluster/kubectl.sh config set-cluster local --server=https://${API_HOST}:${API_SECURE_PORT} --certificate-authority=${ROOT_CA_FILE}
+  sudo cluster/kubectl.sh config set-credentials myself ${AUTH_ARGS}
+  sudo cluster/kubectl.sh config set-context local --cluster=local --user=myself
+  sudo cluster/kubectl.sh config use-context local
+  sudo cluster/kubectl.sh config get-contexts
   cluster/kubectl.sh
+  cluster/kubectl.sh get nodes
+  cluster/kubectl.sh get all --all-namespaces
 EOF
 else
   cat <<EOF

hack/setup-dev-node.sh

@@ -22,7 +22,7 @@ set -o pipefail
 
 echo "The script is to help install prerequisites of Arktos development environment"
 echo "on a fresh Linux installation."
-echo "It's been tested on Ubuntu 16.04 LTS and 18.04 LTS."
+echo "It's been tested on Ubuntu 16.04 LTS, 18.04 and 20.04 LTS."
 
 GOLANG_VERSION=${GOLANG_VERSION:-"1.13.9"}
 
@@ -42,5 +42,15 @@ wget https://dl.google.com/go/go${GOLANG_VERSION}.linux-amd64.tar.gz -P /tmp
 sudo tar -C /usr/local -xzf /tmp/go${GOLANG_VERSION}.linux-amd64.tar.gz
 
 echo "Done."
-echo "Please run and add 'export PATH=\$PATH:/usr/local/go/bin' into your shell profile."
+echo ""
+echo "Please add the following lines into your shell profile ~/.profile."
+echo "    GOROOT=/usr/local/go"
+echo "    GOPATH=$HOME/go"
+echo "    PATH=$GOPATH/bin:$GOROOT/bin:$PATH"
+echo "    export PATH
+echo ""
+echo "Update the current shell session."
+echo "    $ source ~/.profile"
+echo "    $ echo $PATH"
+echo ""
 echo "You can proceed to run arktos-up.sh if you want to launch a single-node cluster."

pkg/kubelet/cm/container_manager_linux.go

@@ -801,6 +801,7 @@ func getContainer(pid int) (string, error) {
 	}
 
 	// since we use this container for accounting, we need to ensure its a unified hierarchy.
+	// Note: please comment out the following 3 lines if you want create arktos single cluster on Ubuntu 20.04 x86
 	if cpu != memory {
 		return "", fmt.Errorf("cpu and memory cgroup hierarchy not unified.  cpu: %s, memory: %s", cpu, memory)
 	}