From 1ada0aa5c9b3299971b2dcf8dc5f1d6f4e9467af Mon Sep 17 00:00:00 2001 From: MoShitrit Date: Thu, 25 Jun 2020 01:26:19 -0400 Subject: [PATCH] Fixing typos and rewording --- docs/examples/basic-requirements.md | 32 +++++++++++++++++------------ 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/docs/examples/basic-requirements.md b/docs/examples/basic-requirements.md index 305d7df8e8..79216ff352 100644 --- a/docs/examples/basic-requirements.md +++ b/docs/examples/basic-requirements.md @@ -1,15 +1,21 @@ -# COMMON BASIC REQUIREMENTS FOR KOPS-RELATED LABS. PRE-FLIGHT CHECK: +# Common Basic Requirements For Kops-Related Labs. Pre-Flight Check: -Before rushing in to replicate any of the exercises, please ensure your basic environment is correctly setup. See the [KOPS AWS tutorial for more information](../getting_started/aws.md). +Before rushing-in to replicate any of the exercises, please ensure your basic environment is correctly set-up. See [KOPS AWS tutorial](../getting_started/aws.md) for more information. -Ensure that the following points are covered and working in your environment: +Basic requirements: -- AWS cli fully configured (aws account already with proper permissions/roles needed for kops). Depending on your distro, you can setup directly from packages, or if you want the most updated version, use "pip" and install awscli by issuing a "pip install awscli" command. Your choice! -- Local ssh key ready on ~/.ssh/id_rsa / id_rsa.pub. You can generate it using "ssh-keygen" command if you don't have one already: `ssh-keygen -t rsa -f ~/.ssh/id_rsa -P ""`. -- Region set to us-east-1 (az's: us-east-1a, us-east-1b, us-east-1c, us-east-1d and us-east-1e). For most of our exercises we'll deploy our clusters in "us-east-1". For real HA at kubernetes master level, you need 3 masters. If you want to ensure that each master is deployed on a different availability zone, then a region with "at least" 3 availability zones is required here. You can still deploy a multi-master kubernetes setup on regions with just 2 az's or even 1 az but this mean that two or all your masters will be deployed on a single az and if this az goes offline then you'll lose two or all your masters. If possible, always pick a region with at least 3 different availability zones for real H.A. You always can check amazon regions and az's on the link: [AWS Global Infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/). Remember: The masters are Kubernetes control plane. If your masters die, you loose control of your Kubernetes cluster. -- kubectl and kops installed. For this last part, you can do this with using following commands. Next commands assume you are running a amd64/x86_64 linux distro: +- Configured AWS cli (aws account set-up with proper permissions/roles needed for kops). Depending on your distro, you can set-up directly from packages, or if you want the most updated version, use `pip` (python package manager) to install by running `pip install awscli` command from your local terminal. Your choice! +- Local ssh key ready on `~/.ssh/id_rsa` / `id_rsa.pub`. You can generate it using `ssh-keygen` command if you don't have one already: `ssh-keygen -t rsa -f ~/.ssh/id_rsa -P ""`. +- AWS Region set. + - Throughout most of the exercises, we'll deploy our clusters in us-east-1 region (AZs: us-east-1a, us-east-1b, us-east-1c, us-east-1d, us-east-1e and us-east-1f). + - For real HA at the Kubernetes API level, you need 3 masters. + - For even better HA, you'd want to make sure your region of choice has at least as many AZs as the amount of masters in your cluster (i.e. 3 masters <= 3 AZs). + - You can still deploy a multi-master Kubernetes cluster on regions with only 2 AZs or even 1 AZ, but that would result in more than one (and potentially all) masters in the same AZ and thus, if that AZ goes offline, you'll lose two or all your masters. + - You can always check Amazon's regions and AZs availability by following this link: [AWS Global Infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/). + - Remember: The masters are your Kubernetes control plane. If your masters die, you lose control over your Kubernetes cluster. +- `kubectl` & `kops` installed. This can be done by running the following commands in your terminal (assuming you are using an amd64/x86_64 linux distro): -As root (either ssh directly to root, local root console, or by using "sudo su -" previously): +Using `root` to set up the utilities for all users on that machine (either ssh directly to `root` or switch to is by running `sudo su -`): ```bash cd ~ @@ -20,7 +26,7 @@ mv kops-linux-amd64 kops mv kubectl kops /usr/local/bin ``` -If you are not root and/or do you want to keep the kops/kubectl utilities in your own account: +Alternatively, if you don't have `root` access and/or wish to keep the `kops`/`kubectl` utilities in your local profile: ```bash cd ~ @@ -33,7 +39,7 @@ export PATH=$PATH:~/bin mv kubectl kops ~/bin ``` -Finally, some of our exercises use the "jq" utility that is available on modern linux distributions. Please ensure to install it too. Some examples of how to do it: +Finally, some of our exercises use the `jq` utility which is available on modern linux distributions. Please ensure to install it as well. Some examples of how to do it: **Centos 7:** @@ -42,18 +48,18 @@ yum -y install epel-release yum -y install jq ``` -**Debian7/Debian8/Debian9/Ubuntu1404lts/Ubuntu1604lts:** +**Debian 9/10, Ubuntu 16.04/18.04/20.04:** ```bash apt-get -y update apt-get -y install jq ``` -Also, if you are using **OS X** you can install jq using ["Homebrew"](https://brew.sh): +Also, if you are using **macOS**, you can install jq using ["Homebrew"](https://brew.sh): ```bash brew install jq ``` -More information about "jq" on the following site: [https://stedolan.github.io/jq/download/](https://stedolan.github.io/jq/download/) +More information on `jq` can be found [here](https://stedolan.github.io/jq/download/).