mirror of
https://github.com/kelseyhightower/kubernetes-the-hard-way.git
synced 2025-12-15 17:28:58 +03:00
Refresh and add Apple Silicon (#338)
* Delete CKA stuff. It's covered in CKA repo * Rename nodes * Cluster up again * Update issue template * Update README * Begin rearranging docs * Update links * Initial mac instructions * iterm2 image * update ssh-copy-id to be cross platform * remove vagrant specific * Apple scripts WIP * Add var for architecture * order input files * Apple build working! * auto-locate docs * install sshpass * Set execute bit * apple done! * install sshpass * edits * Corrections * kube version output * Adjustments * Adjustments
This commit is contained in:
Alistair Mackay
91
VirtualBox/docs/01-prerequisites.md
Normal file
91
VirtualBox/docs/01-prerequisites.md
Normal file
@@ -0,0 +1,91 @@
|
||||
# Kubernetes The Hard Way on VirtualBox
|
||||
|
||||
Begin here if your machine is Windows or Intel Mac. For these machines, we use VirtualBox as the hypervisor, and Vagrant to provision the Virtual Machines.
|
||||
|
||||
This should also work with Linux (as the host operating system, not running in a VM), but it not so far tested.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
### Hardware Requirements
|
||||
|
||||
This lab provisions 5 VMs on your workstation. That's a lot of compute resource!
|
||||
|
||||
- 16GB RAM. It may work with less, but will be slow and may crash unexpectedly.
|
||||
- 8 core or better CPU e.g. Intel Core-i7/Core-i9, AMD Ryzen-7/Ryzen-9. May work with fewer, but will be slow and may crash unexpectedly.
|
||||
- 50 GB disk space
|
||||
|
||||
### VirtualBox
|
||||
|
||||
Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) on any one of the supported platforms:
|
||||
|
||||
- Windows
|
||||
- Intel Mac
|
||||
- Linux
|
||||
|
||||
### Vagrant
|
||||
|
||||
Once VirtualBox is installed you may chose to deploy virtual machines manually on it.
|
||||
Vagrant provides an easier way to deploy multiple virtual machines on VirtualBox more consistently.
|
||||
|
||||
Download and install [Vagrant](https://www.vagrantup.com/) on your platform.
|
||||
|
||||
- Windows
|
||||
- Debian/Ubuntu
|
||||
- CentOS
|
||||
- Linux
|
||||
- Intel Mac
|
||||
|
||||
This tutorial assumes that you have also installed Vagrant.
|
||||
|
||||
|
||||
### Lab Defaults
|
||||
|
||||
The labs have been configured with the following networking defaults. It is not recommended to change these. If you change any of these after you have deployed any of the lab, you'll need to completely reset it and start again from the beginning:
|
||||
|
||||
```bash
|
||||
vagrant destroy -f
|
||||
vagrant up
|
||||
```
|
||||
|
||||
If you do change any of these, **please consider that a personal preference and don't submit a PR for it**.
|
||||
|
||||
#### Virtual Machine Network
|
||||
|
||||
The network used by the VirtualBox virtual machines is `192.168.56.0/24`.
|
||||
|
||||
To change this, edit the [Vagrantfile](../../vagrant/Vagrantfile) in your cloned copy (do not edit directly in github), and set the new value for the network prefix at line 9. This should not overlap any of the other network settings.
|
||||
|
||||
Note that you do not need to edit any of the other scripts to make the above change. It is all managed by shell variable computations based on the assigned VM IP addresses and the values in the hosts file (also computed).
|
||||
|
||||
It is *recommended* that you leave the pod and service networks with the following defaults. If you change them then you will also need to edit one or both of the CoreDNS and Weave networking manifests to accommodate your change.
|
||||
|
||||
#### Pod Network
|
||||
|
||||
The network used to assign IP addresses to pods is `10.244.0.0/16`.
|
||||
|
||||
To change this, open all the `.md` files in the [docs](../../docs/) directory in your favourite IDE and do a global replace on<br>
|
||||
`POD_CIDR=10.244.0.0/16`<br>
|
||||
with the new CDIR range. This should not overlap any of the other network settings.
|
||||
|
||||
#### Service Network
|
||||
|
||||
The network used to assign IP addresses to Cluster IP services is `10.96.0.0/16`.
|
||||
|
||||
To change this, open all the `.md` files in the [docs](../../docs/) directory in your favourite IDE and do a global replace on<br>
|
||||
`SERVICE_CIDR=10.96.0.0/16`<br>
|
||||
with the new CDIR range. This should not overlap any of the other network settings.
|
||||
|
||||
Additionally edit line 164 of [coredns.yaml](../../deployments/coredns.yaml) to set the new DNS service address (should still end with `.10`)
|
||||
|
||||
## Running Commands in Parallel with tmux
|
||||
|
||||
[tmux](https://github.com/tmux/tmux/wiki) can be used to run commands on multiple compute instances at the same time. Labs in this tutorial may require running the same commands across multiple compute instances, in those cases consider using tmux and splitting a window into multiple panes with synchronize-panes enabled to speed up the provisioning process.
|
||||
|
||||
> The use of tmux is optional and not required to complete this tutorial.
|
||||
|
||||
|
||||
|
||||
> Enable synchronize-panes by pressing `CTRL+B` followed by `"` to split the window into two panes. In each pane (selectable with mouse), ssh to the host(s) you will be working with.</br>Next type `CTRL+X` at the prompt to begin sync. In sync mode, the dividing line between panes will be red. Everything you type or paste in one pane will be echoed in the other.<br>To disable synchronization type `CTRL+X` again.</br></br>Note that the `CTRL-X` key binding is provided by a `.tmux.conf` loaded onto the VM by the vagrant provisioner.
|
||||
|
||||
Next: [Compute Resources](02-compute-resources.md)
|
||||
141
VirtualBox/docs/02-compute-resources.md
Normal file
141
VirtualBox/docs/02-compute-resources.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# Provisioning Compute Resources
|
||||
|
||||
Note: You must have VirtualBox and Vagrant configured at this point.
|
||||
|
||||
Download this github repository and cd into the vagrant folder:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/mmumshad/kubernetes-the-hard-way.git
|
||||
```
|
||||
|
||||
CD into vagrant directory:
|
||||
|
||||
```bash
|
||||
cd kubernetes-the-hard-way/vagrant
|
||||
```
|
||||
|
||||
The `Vagrantfile` is configured to assume you have at least an 8 core CPU which most modern core i5, i7 and i9 do, and at least 16GB RAM. You can tune these values especially if you have *less* than this by editing the `Vagrantfile` before the next step below and adjusting the values for `RAM_SIZE` and `CPU_CORES` accordingly. It is not recommended to change these unless you know what you are doing as it may result in crashes and will make the lab harder to support.
|
||||
|
||||
This will not work if you have less than 8GB of RAM.
|
||||
|
||||
Run Vagrant up:
|
||||
|
||||
```bash
|
||||
vagrant up
|
||||
```
|
||||
|
||||
|
||||
This does the below:
|
||||
|
||||
- Deploys 5 VMs - 2 controlplane, 2 worker and 1 loadbalancer with the name 'kubernetes-ha-* '
|
||||
> This is the default settings. This can be changed at the top of the Vagrant file.
|
||||
> If you choose to change these settings, please also update `vagrant/ubuntu/vagrant/setup-hosts.sh`
|
||||
> to add the additional hosts to the `/etc/hosts` default before running `vagrant up`.
|
||||
|
||||
- Set's IP addresses in the range `192.168.56.x`
|
||||
|
||||
| VM | VM Name | Purpose | IP | Forwarded Port | RAM |
|
||||
| ------------ | ---------------------- |:-------------:| -------------:| ----------------:|-----:|
|
||||
| controlplane01 | kubernetes-ha-controlplane01 | Master | 192.168.56.11 | 2711 | 2048 |
|
||||
| controlplane02 | kubernetes-ha-controlplane02 | Master | 192.168.56.12 | 2712 | 1024 |
|
||||
| node01 | kubernetes-ha-node01 | Worker | 192.168.56.21 | 2721 | 512 |
|
||||
| node02 | kubernetes-ha-node02 | Worker | 192.168.56.22 | 2722 | 1024 |
|
||||
| loadbalancer | kubernetes-ha-lb | LoadBalancer | 192.168.56.30 | 2730 | 1024 |
|
||||
|
||||
> These are the default settings. These can be changed in the Vagrant file
|
||||
|
||||
- Add's a DNS entry to each of the nodes to access internet
|
||||
> DNS: 8.8.8.8
|
||||
|
||||
- Sets required kernel settings for kubernetes networking to function correctly.
|
||||
|
||||
See [Vagrant page](../../vagrant/README.md) for details.
|
||||
|
||||
## SSH to the nodes
|
||||
|
||||
There are two ways to SSH into the nodes:
|
||||
|
||||
### 1. SSH using Vagrant
|
||||
|
||||
From the directory you ran the `vagrant up` command, run `vagrant ssh \<vm\>` for example `vagrant ssh controlplane01`. This is the recommended way.
|
||||
> Note: Use VM field from the above table and not the VM name itself.
|
||||
|
||||
### 2. SSH Using SSH Client Tools
|
||||
|
||||
Use your favourite SSH terminal tool (putty).
|
||||
|
||||
Use the above IP addresses. Username and password-based SSH is disabled by default.
|
||||
|
||||
Vagrant generates a private key for each of these VMs. It is placed under the `.vagrant` folder (in the directory you ran the `vagrant up` command from) at the below path for each VM:
|
||||
|
||||
- **Private key path**: `.vagrant/machines/\<machine name\>/virtualbox/private_key`
|
||||
- **Username/password**: `vagrant/vagrant`
|
||||
|
||||
|
||||
## Verify Environment
|
||||
|
||||
- Ensure all VMs are up.
|
||||
- Ensure VMs are assigned the above IP addresses.
|
||||
- Ensure you can SSH into these VMs using the IP and private keys, or `vagrant ssh`.
|
||||
- Ensure the VMs can ping each other.
|
||||
|
||||
## Troubleshooting Tips
|
||||
|
||||
### Failed Provisioning
|
||||
|
||||
If any of the VMs failed to provision, or is not configured correct, delete the VM using the command:
|
||||
|
||||
```bash
|
||||
vagrant destroy \<vm\>
|
||||
```
|
||||
|
||||
Then re-provision. Only the missing VMs will be re-provisioned
|
||||
|
||||
```bash
|
||||
vagrant up
|
||||
```
|
||||
|
||||
|
||||
Sometimes the delete does not delete the folder created for the VM and throws an error similar to this:
|
||||
|
||||
VirtualBox error:
|
||||
|
||||
VBoxManage.exe: error: Could not rename the directory 'D:\VirtualBox VMs\ubuntu-bionic-18.04-cloudimg-20190122_1552891552601_76806' to 'D:\VirtualBox VMs\kubernetes-ha-node02' to save the settings file (VERR_ALREADY_EXISTS)
|
||||
VBoxManage.exe: error: Details: code E_FAIL (0x80004005), component SessionMachine, interface IMachine, callee IUnknown
|
||||
VBoxManage.exe: error: Context: "SaveSettings()" at line 3105 of file VBoxManageModifyVM.cpp
|
||||
|
||||
In such cases delete the VM, then delete the VM folder and then re-provision, e.g.
|
||||
|
||||
```bash
|
||||
vagrant destroy node02
|
||||
rmdir "\<path-to-vm-folder\>\kubernetes-ha-node02
|
||||
vagrant up
|
||||
```
|
||||
|
||||
### Provisioner gets stuck
|
||||
|
||||
This will most likely happen at "Waiting for machine to reboot"
|
||||
|
||||
1. Hit `CTRL+C`
|
||||
1. Kill any running `ruby` process, or Vagrant will complain.
|
||||
1. Destroy the VM that got stuck: `vagrant destroy \<vm\>`
|
||||
1. Re-provision. It will pick up where it left off: `vagrant up`
|
||||
|
||||
# Pausing the Environment
|
||||
|
||||
You do not need to complete the entire lab in one session. You may shut down and resume the environment as follows, if you need to power off your computer.
|
||||
|
||||
To shut down. This will gracefully shut down all the VMs in the reverse order to which they were started:
|
||||
|
||||
```bash
|
||||
vagrant halt
|
||||
```
|
||||
|
||||
To power on again:
|
||||
|
||||
```bash
|
||||
vagrant up
|
||||
```
|
||||
|
||||
Next: [Client tools](../../docs/03-client-tools.md)<br>
|
||||
Prev: [Prerequisites](01-prerequisites.md)
|
||||
Reference in New Issue
Block a user