Merge pull request #4 from TryToLearnProgramming/k8s-cluseter

K8s cluseter

Author: TryToLearnProgramming

README.md

@@ -59,6 +59,11 @@ graph TB
     <td align="center">🚀</td>
     <td>Ready-to-use Kubernetes cluster setup</td>
 </tr>
+<tr>
+    <td align="center">📜</td>
+    <td>Easy-to-use Bash Scripts for Kubernetes cluster setup - reduce typing errors</td>
+</tr>
+
 <tr>
     <td align="center">🔒</td>
     <td>Secure communication between nodes</td>
@@ -177,16 +182,32 @@ sudo kubeadm config images pull
 
 Initialize the cluster:
 ```bash
-sudo kubeadm init --pod-network-cidr=10.201.0.0/16 --apiserver-advertise-address=192.168.63.11
+sudo kubeadm init --pod-network-cidr=10.244.0.0/16 --apiserver-advertise-address=192.168.63.11
 ```
 
-### 2. Install CNI (Container Network Interface)
+### 2a. Install Weave CNI (Container Network Interface)
 
 After the cluster initialization, install Weave CNI:
 ```bash
 kubectl apply -f https://github.com/weaveworks/weave/releases/download/v2.8.1/weave-daemonset-k8s.yaml
 ```
 
+### NOTE: Weave CNI has been discontinued
+
+With the shutdown of Weaveworks, Weave CNI has been effectively discontinued, the GitHub repo archived in June 2024. So a new CNI should be considered, and the first suggestion is Flannel
+
+### 2b. Install Flannel CNI (Container Network Interface)
+
+First, install Flannel CNI:
+```bash
+kubectl apply -f https://raw.githubusercontent.com/flannel-io/flannel/master/Documentation/kube-flannel.yml 
+```
+
+Then, restart the Kublet service:
+```bash
+sudo service kubelet restart
+```
+
 ### NOTE: Control Plane script 'cluster_init.sh' wraps steps 1. and 2.
 
 For ease of use, a single script `cluster_init.sh` was created as a function of the "vagrant up" command for the control plane(s) that performs all of the above steps:
@@ -229,6 +250,40 @@ worker   Ready    <none>          2m14s   v1.30.x
 
 > **Note**: The nodes may show `NotReady` status initially as the CNI (Container Network Interface) is being configured. Please wait a few minutes for the status to change to `Ready`.
 
+### 5. (Optional) Set Role for Worker Node(s)
+
+As the output above shows, there is no initial role set for worker nodes.  You can set their role to "worker" with:
+
+The Kubernetes Dashboard is Web UI that allows you to manage your cluster; configure and manage aspects of the system, troubleshoot, and to have an overview of applications running on your cluster
+
+```bash
+vagrant ssh cplane -c "./set_worker_role.sh"
+```
+
+This script can be run any time a new node is added.
+
+### 6. (Optional) Kubernetes Dashboard Installation
+
+The Kubernetes Dashboard is Web UI that allows you to manage your cluster; configure and manage aspects of the system, troubleshoot, and to have an overview of applications running on your cluster
+
+First, log into the control plane node:
+```bash
+vagrant ssh cplane
+```
+
+Execute the Dashboard setup script:
+```bash
+./kub_dashboard.sh <option>
+```
+
+Where `<option>` is one of:
+* worker - to deploy dashboard on any worker node
+* cplane - to deploy dashboard on the control plane
+* token  - to show the dashboard credentials token (and the dashboard url)
+
+Normally, the Kubernetes Dashboard would be deployed to one of the worker nodes.  This would always be the case in a production
+Kubernetes cluster.  However for a small development cluster, it doesn't hurt to run the dashboard on the control plane
+
 ### Troubleshooting
 
 If you encounter issues while joining the worker node, try these steps on both nodes:

Vagrantfile

@@ -1,7 +1,6 @@
 # Configuration parameters
-VAGRANT_BASE_OS = "bento/ubuntu-24.04" # "bento/ubuntu-22.04"
+VAGRANT_BASE_OS = "bento/ubuntu-24.04"
 PRIVATE_NETWORK = "private_network"    # For Host -> VM and VM <-> VM (within the network)
-BASE_CIDR       = "10.201.0.0"         # Base address for pods
 
 # Create list of one or more Control Plane Nodes (but one is sufficient)
 CPLANE_NODES = [
@@ -12,9 +11,11 @@ CPLANE_NODES = [
 # Mindful of the 'name' and 'ip' values for each
 WORKER_NODES = [
   { name: "worker1", box: VAGRANT_BASE_OS, network: PRIVATE_NETWORK, ip: "192.168.63.12" }
+#  { name: "worker1", box: VAGRANT_BASE_OS, network: PRIVATE_NETWORK, ip: "192.168.63.12" },
+#  { name: "worker2", box: VAGRANT_BASE_OS, network: PRIVATE_NETWORK, ip: "192.168.63.13" }
 ]
 
-# Work out the "/etc/hosts" values to get copied in each node (cplanes and workers)
+# Work out the "/etc/hosts" values to be copied in each node (cplanes and workers)
 ALL_NODES = CPLANE_NODES + WORKER_NODES
 ETC_HOSTS = ALL_NODES.map { |n| "#{n[:ip]} #{n[:name]}" }.join("\n") + "\n"
 
@@ -24,94 +25,20 @@ Vagrant.configure("2") do |config|
     config.vm.define node[:name] do |cplane|
       cplane.vm.box = node[:box]
       cplane.vm.network node[:network], ip: node[:ip]
-      cplane.vm.network "forwarded_port", guest: 443, host: 8443 # Port Forward for k8s dashboard
       cplane.vm.hostname = node[:name]
       cplane.vm.provider "virtualbox" do |v|
         v.name = node[:name]
         v.memory = 2048
         v.cpus = 2
       end
       cplane.vm.provision "shell",
-        env: {
-          "ETC_HOSTS"     => ETC_HOSTS,
-          "BASE_CIDR"     => BASE_CIDR,
-          "API_SERVER_IP" => node[:ip] # API Server is the control plane host itself
-        },
+        env: { "ETC_HOSTS" => ETC_HOSTS },
         inline: <<-SHELL
-        # Add Nodes to /etc/hosts
-        sudo echo "# Added by Vagrant" >> /etc/hosts
-        sudo echo "#" >> /etc/hosts
-        echo -e "${ETC_HOSTS}" | while read -r hline; do
-          sudo echo ${hline} >> /etc/hosts
-        done
+          # Provision the Control Plane (Base and Specific)
+          /vagrant/scripts/provision/provision_base.sh
+          [ -f "/vagrant/scripts/provision/provision_cplane.sh" ] && /vagrant/scripts/provision/provision_cplane.sh
 
-        # Create Cluster Init Script:
-        echo "#!/bin/bash"                                                     >  cluster_init.sh
-        echo "echo 'Pulling k8s Images'"                                       >> cluster_init.sh
-        echo "sudo kubeadm config images pull"                                 >> cluster_init.sh
-        echo "echo ''"                                                         >> cluster_init.sh
-        echo "echo 'Initializing Cluster'"                                     >> cluster_init.sh
-        echo "sudo kubeadm init --pod-network-cidr=${BASE_CIDR}/16 --apiserver-advertise-address=${API_SERVER_IP}" >> cluster_init.sh
-        echo "if [ -f /etc/kubernetes/admin.conf ] ; then"                     >> cluster_init.sh
-        echo "  echo ''"                                                       >> cluster_init.sh
-        echo "  echo 'Create local .kube/config'"                              >> cluster_init.sh
-        echo "  mkdir -p \\\${HOME}/.kube"                                     >> cluster_init.sh
-        echo "  sudo cp -i /etc/kubernetes/admin.conf \\\${HOME}/.kube/config" >> cluster_init.sh
-        echo "  sudo chown \\\$(id -u):\\\$(id -g) \\\${HOME}/.kube/config"    >> cluster_init.sh
-        echo "  echo ''"                                                       >> cluster_init.sh
-        echo "  echo 'Install Weave'"                                          >> cluster_init.sh
-        echo "  kubectl apply -f https://github.com/weaveworks/weave/releases/download/v2.8.1/weave-daemonset-k8s.yaml" >> cluster_init.sh
-        echo "fi"                                                              >> cluster_init.sh
-        chmod a+rx cluster_init.sh
-
-        # Show the k8s join command:
-        echo "#!/bin/bash"                                     >  join_cmd.sh
-        echo "echo 'k8s worker join command (may need sudo):'" >> join_cmd.sh
-        echo "echo ''"                                         >> join_cmd.sh
-        echo "kubeadm token create --print-join-command"       >> join_cmd.sh
-        echo "echo ''"                                         >> join_cmd.sh
-        sudo chmod a+rx join_cmd.sh
-
-        # Apt Stuff:
-        sudo apt update
-        sudo apt install ca-certificates curl
-        sudo install -m 0755 -d /etc/apt/keyrings
-        sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
-        sudo chmod a+r /etc/apt/keyrings/docker.asc
-
-        # Add the repository to Apt sources:
-        echo \
-          "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
-          $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
-          sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-        sudo apt update
-        sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
-        sudo systemctl enable docker
-        sudo ufw disable
-        sudo swapoff -a
-        sudo apt update && sudo apt install -y apt-transport-https
-        curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
-        sudo apt update
-
-        # apt-transport-https may be a dummy package; if so, you can skip that package
-        sudo apt install -y apt-transport-https ca-certificates curl gpg
-        # Helm Deployment Manager
-        curl -fsSL https://packages.buildkite.com/helm-linux/helm-debian/gpgkey | gpg --dearmor | sudo tee /usr/share/keyrings/helm.gpg > /dev/null
-        echo "deb [signed-by=/usr/share/keyrings/helm.gpg] https://packages.buildkite.com/helm-linux/helm-debian/any/ any main" | sudo tee /etc/apt/sources.list.d/helm-stable-debian.list
-        sudo apt update
-        sudo apt install -y helm
-
-        # Containerd
-        curl -fsSL https://pkgs.k8s.io/core:/stable:/v1.30/deb/Release.key | sudo gpg --dearmor -o /etc/apt/keyrings/kubernetes-apt-keyring.gpg
-        echo 'deb [signed-by=/etc/apt/keyrings/kubernetes-apt-keyring.gpg] https://pkgs.k8s.io/core:/stable:/v1.30/deb/ /' | sudo tee /etc/apt/sources.list.d/kubernetes.list
-        sudo apt update
-        sudo apt install -y kubelet kubeadm kubectl
-        sudo apt-mark hold kubelet kubeadm kubectl
-        sudo systemctl enable --now kubelet
-        sudo containerd config default | sudo tee /etc/containerd/config.toml
-        sudo sed -i 's/            SystemdCgroup = false/            SystemdCgroup = true/' /etc/containerd/config.toml
-        sudo sed -i 's|sandbox_image = "registry.k8s.io/pause:3.8"|sandbox_image = "registry.k8s.io/pause:3.9"|g' /etc/containerd/config.toml
-        sudo systemctl restart containerd
+          cp -f /vagrant/scripts/cplane/*.sh . 2>/dev/null || true
         SHELL
     end
   end
@@ -130,44 +57,11 @@ Vagrant.configure("2") do |config|
       worker.vm.provision "shell",
         env: {"ETC_HOSTS" => ETC_HOSTS},
         inline: <<-SHELL
-        # Add Nodes to /etc/hosts
-        sudo echo "# Added by Vagrant" >> /etc/hosts
-        sudo echo "#" >> /etc/hosts
-        echo -e "${ETC_HOSTS}" | while read -r hline; do
-          sudo echo ${hline} >> /etc/hosts
-        done
-        # Apt Stuff:
-        sudo apt update
-        sudo apt install ca-certificates curl
-        sudo install -m 0755 -d /etc/apt/keyrings
-        sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
-        sudo chmod a+r /etc/apt/keyrings/docker.asc
+          # Provision the Worker (Base and Specific)
+          /vagrant/scripts/provision/provision_base.sh
+          [ -f "/vagrant/scripts/provision/provision_worker.sh" ] && /vagrant/scripts/provision/provision_worker.sh
 
-        # Add the repository to Apt sources:
-        echo \
-          "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
-          $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
-          sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-        sudo apt update
-        sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
-        sudo systemctl enable docker
-        sudo ufw disable
-        sudo swapoff -a
-        sudo apt update && sudo apt install -y apt-transport-https
-        curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
-        sudo apt update
-        # apt-transport-https may be a dummy package; if so, you can skip that package
-        sudo apt install -y apt-transport-https ca-certificates curl gpg
-        curl -fsSL https://pkgs.k8s.io/core:/stable:/v1.30/deb/Release.key | sudo gpg --dearmor -o /etc/apt/keyrings/kubernetes-apt-keyring.gpg
-        echo 'deb [signed-by=/etc/apt/keyrings/kubernetes-apt-keyring.gpg] https://pkgs.k8s.io/core:/stable:/v1.30/deb/ /' | sudo tee /etc/apt/sources.list.d/kubernetes.list
-        sudo apt update
-        sudo apt install -y kubelet kubeadm kubectl
-        sudo apt-mark hold kubelet kubeadm kubectl
-        sudo systemctl enable --now kubelet
-        sudo containerd config default | sudo tee /etc/containerd/config.toml
-        sudo sed -i 's/            SystemdCgroup = false/            SystemdCgroup = true/' /etc/containerd/config.toml
-        sudo sed -i 's|sandbox_image = "registry.k8s.io/pause:3.8"|sandbox_image = "registry.k8s.io/pause:3.9"|g' /etc/containerd/config.toml
-        sudo systemctl restart containerd
+          cp -f /vagrant/scripts/worker/*.sh . 2>/dev/null || true
         SHELL
     end
   end

instructions.txt

@@ -1,26 +1,21 @@
-TO SPEED UP THE PROCESS 1ST RUN in the master NODE-
+TO SPEED UP THE PROCESS 1ST RUN in the master NODE:
 - sudo kubeadm config images pull
 
-TO INIT, RUN  in the master NODE-
-- sudo kubeadm init --pod-network-cidr=10.201.0.0/16 --apiserver-advertise-address=192.168.63.1
-- you wull get a kubeadm join command run that in you master node after Install the CNI
+TO INIT, RUN  in the master NODE:
+- sudo kubeadm init --pod-network-cidr=10.201.0.0/16 --apiserver-advertise-address=192.168.63.11
+- you will get a kubeadm join command run that in you master node after Install the CNI
 
-TO INSTALL CNI (weave) -
-- kubectl apply -f https://github.com/weaveworks/weave/releases/download/v2.8.1/weave-daemonset-k8s.yaml
+TO INSTALL CNI (weave):
+- sudo kubectl apply -f https://github.com/weaveworks/weave/releases/download/v2.8.1/weave-daemonset-k8s.yaml
 
-IF face proble while jioning worker node, reatart master node and run below commands-
-sudo kubeadm reset
+If you face problems while joining a worker node, restart master node and run below commands:
+- sudo kubeadm reset
+- sudo swapoff -a => all nodes.
+- sudo systemctl restart kubelet
+- sudo iptables -F
+- sudo rm -rf /var/lib/cni/
+- sudo systemctl restart containerd
+- sudo systemctl daemon-reload
 
-sudo swapoff -a => all nodes.
+then try again to join... I hope it will work :')
 
-sudo systemctl restart kubelet
-
-sudo iptables -F
-
-sudo rm -rf /var/lib/cni/
-
-sudo systemctl restart containerd
-
-sudo systemctl daemon-reload
-
-then againg try to join... hope it will work :')

scripts/README.md

@@ -0,0 +1,50 @@
+# Vagrant Kubernetes Cluster
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Vagrant](https://img.shields.io/badge/vagrant-%231563FF.svg?style=for-the-badge&logo=vagrant&logoColor=white)](https://www.vagrantup.com/)
+[![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://kubernetes.io/)
+[![Ubuntu](https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge&logo=ubuntu&logoColor=white)](https://ubuntu.com/)
+
+This project sets up a local Kubernetes cluster using Vagrant and VirtualBox. It creates two Ubuntu 24.04 virtual machines: one control plane node and one worker node with automatic installation of Docker, Kubernetes components, and necessary configurations.
+
+## Bash Scripts
+
+These scripts are to make it easy to bring up and maintain the Kubernetes Cluster.  Some are collections of manual provisioning commands from the original project (which reduces manual typing errors). Others are facilitators, to manage the Control Plane and Worker nodes in an easy and repeatable fashion.
+
+<table>
+<tr>
+    <td>🚜&nbsp;Provision</td>
+    <td>Package Installation and Service Management of Machines</td>
+</tr>
+<tr>
+    <td>🚀&nbsp;Cplane</td>
+    <td>To spin up and manage the Control Plane</td>
+</tr>
+<tr>
+    <td>🛠&nbsp;Worker</td>
+    <td>To join up and manage the Worker nodes</td>
+</tr>
+</table>
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+Copyright (c) 2024 Vagrant Kubernetes Cluster
+
+## 📫 Support & Contribution
+
+If you encounter any issues or need assistance:
+
+[![Create Issue](https://img.shields.io/badge/Create-Issue-green.svg)](https://github.com/yourusername/vagrant-kubernetes/issues/new)
+[![Pull Request](https://img.shields.io/badge/Pull-Request-blue.svg)](https://github.com/yourusername/vagrant-kubernetes/pulls)
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+<div align="center">
+Made with ❤️ for the Kubernetes community
+</div>