Skip to content

Commit 88840b6

Browse files
authored
Merge pull request #226 from oracle/RMcheatsheet
minor edits
2 parents f24f8d5 + 966cc11 commit 88840b6

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

site/k8s_setup.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ If you need some help setting up a Kubernetes environment to experiment with the
1111

1212
* Set up your own Kubernetes environment on bare compute resources on a cloud.
1313
* Use you cloud provider's management console to provision a managed Kubernetes environment.
14-
* Install Kubernetes on your own compute resources (i.e. "real" computers, outside a cloud).
14+
* Install Kubernetes on your own compute resources (for example, "real" computers, outside a cloud).
1515

1616
"Development/test" options:
1717

1818
* Install [Docker for Mac](https://docs.docker.com/docker-for-mac/#kubernetes) and enable its embedded Kubernetes cluster (or register for the [Docker for Windows](https://beta.docker.com/form) beta and wait until Kubernetes is available there).
1919
* Install [Minikube](https://github.com/kubernetes/minikube) on your Windows/Linux/Mac computer.
2020

21-
We have provided our hints and tips for several of these options in the sections below:
21+
We have provided our hints and tips for several of these options in the sections below.
2222

2323
## Set up Kubernetes on bare compute resources in a cloud
2424

25-
Follow the basic steps from the [Terraform Kubernetes installer for Oracle Cloud Infrastructure](https://github.com/oracle/terraform-kubernetes-installer):
25+
Follow the basic steps from the [Terraform Kubernetes installer for Oracle Cloud Infrastructure](https://github.com/oracle/terraform-kubernetes-installer).
2626

2727
### Prerequisites
2828

@@ -34,7 +34,7 @@ providers {
3434
oci = "<path_to_provider_binary>/terraform-provider-oci"
3535
}
3636
```
37-
4. Ensure you have [Kubectl][Kubectl] installed if you plan to interact with the cluster locally.
37+
4. Ensure that you have [Kubectl][Kubectl] installed if you plan to interact with the cluster locally.
3838

3939
### Quick Start
4040

@@ -50,13 +50,13 @@ cd terraform-kubernetes-installer
5050
terraform init
5151
```
5252

53-
3. Copy the example terraform.tvfars:
53+
3. Copy the example `terraform.tvfars`:
5454

5555
```
5656
cp terraform.example.tfvars terraform.tfvars
5757
```
5858

59-
4. Edit the `terraform.tvfars` file to include values for your tenancy, user, and compartment. Optionally edit variables to change the `Shape` of the VMs for your Kubernetes master and workers, and your etcd cluster. For example:
59+
4. Edit the `terraform.tvfars` file to include values for your tenancy, user, and compartment. Optionally, edit variables to change the `Shape` of the VMs for your Kubernetes master and workers, and your `etcd` cluster. For example:
6060

6161
```
6262
#give a label to your cluster to help identify it if you have multiple
@@ -138,20 +138,20 @@ $
138138
```
139139

140140

141-
## Install Kubernetes on your own compute resources (e.g. Oracle Linux servers outside a cloud)
141+
## Install Kubernetes on your own compute resources (for example, Oracle Linux servers outside a cloud)
142142

143-
These instructions are for Oracle Linux 7u2+. If you are using a different flavor of Linux, you will need to adjust accordingly.
143+
These instructions are for Oracle Linux 7u2+. If you are using a different flavor of Linux, you will need to adjust them accordingly.
144144

145-
**NOTE** These steps must be run with the `root` user, until specified otherwise! Any time you see `YOUR_USERID` in a command, you should replace it with your actual userid.
145+
**NOTE**: These steps must be run with the `root` user, until specified otherwise! Any time you see `YOUR_USERID` in a command, you should replace it with your actual `userid`.
146146

147-
Choose the directories where your Docker and Kubernetes files will be stored. The Docker directory should be on a disk with a lot of free space (more than 100GB) because it will be used for the `/var/lib/docker` file syste, which contains all of your images and containers. The Kubernetes directory will be used for the `/var/lib/kubelet` file system and persistent volume storage.
147+
Choose the directories where your Docker and Kubernetes files will be stored. The Docker directory should be on a disk with a lot of free space (more than 100GB) because it will be used for the `/var/lib/docker` file system, which contains all of your images and containers. The Kubernetes directory will be used for the `/var/lib/kubelet` file system and persistent volume storage.
148148

149149
```
150150
export docker_dir=/scratch/docker
151151
export k8s_dir=/scratch/k8s_dir
152152
```
153153

154-
Create a shell script that sets up the necessary environment variables. You should probably just append this to the user's `.bashrc` so that it will get executed at login. You will also need to configure your proxy settings in here if you are behind an HTTP proxy:
154+
Create a shell script that sets up the necessary environment variables. You should probably just append this to the user's `.bashrc` so that it will get executed at login. You will also need to configure your proxy settings here if you are behind an HTTP proxy:
155155

156156
```
157157
export PATH=$PATH:/sbin:/usr/sbin
@@ -186,14 +186,14 @@ If you want command completion, you can add the following to the script:
186186
source <(kubectl completion bash)
187187
```
188188

189-
Create the directories we need:
189+
Create the directories you need:
190190

191191
```
192192
mkdir -p $docker_dir $k8s_dir/kubelet
193193
ln -s $k8s_dir/kubelet /var/lib/kubelet
194194
```
195195

196-
Set an environment variable with the Docker version we want to install:
196+
Set an environment variable with the Docker version you want to install:
197197

198198
```
199199
docker_version="17.03.1.ce"
@@ -219,7 +219,7 @@ diff /etc/sysconfig/docker /tmp/docker.out
219219
mv /tmp/docker.out /etc/sysconfig/docker
220220
```
221221

222-
Set up the Docker network, including the HTTP proxy configuration if you need it:
222+
Set up the Docker network, including the HTTP proxy configuration, if you need it:
223223

224224
```
225225
# generate a custom /setc/sysconfig/docker-network
@@ -238,7 +238,7 @@ Add your user to the `docker` group:
238238
usermod -aG docker YOUR_USERID
239239
```
240240

241-
Enable and start the Docker service that we just installed and configured:
241+
Enable and start the Docker service that you just installed and configured:
242242

243243
```
244244
systemctl enable docker && systemctl start docker
@@ -314,7 +314,7 @@ chown YOUR_USERID:YOUR_GROUP $KUBECONFIG
314314
chmod 644 $KUBECONFIG
315315
```
316316

317-
**NOTE** The following steps should be run with your normal (non-`root`) user.
317+
**NOTE**: The following steps should be run with your normal (non-`root`) user.
318318

319319
Configure CNI:
320320

@@ -357,7 +357,7 @@ Congratulations! Docker and Kubernetes are installed and configured!
357357

358358
## Install Docker for Mac with Kubernetes
359359

360-
Docker for Mac 17.12 CE Edge provides an [embedded Kubernetes environment](https://docs.docker.com/docker-for-mac/#kubernetes) that is a pretty quick and easy way to get a simple test environment set up on your Mac. To set it up, follow these instructions:
360+
Docker for Mac 17.12 CE Edge provides an [embedded Kubernetes environment](https://docs.docker.com/docker-for-mac/#kubernetes) that is a quick and easy way to get a simple test environment set up on your Mac. To set it up, follow these instructions:
361361

362362
Install "Docker for Mac" from the Edge channel [https://download.docker.com/mac/edge/Docker.dmg](https://download.docker.com/mac/edge/Docker.dmg). Then start up the Docker application (press Command-Space bar, type in `Docker` and run it). After it is running you will see the Docker icon appear in your status bar:
363363

@@ -371,7 +371,7 @@ Go to the "Kubernetes" tab and click on the option to enable Kubernetes:
371371

372372
![Enable Kubernetes setting](images/docker-enable-k8s.png)
373373

374-
**Note** If you are behind an HTTP proxy, then you should also go to the "Proxies" tab and enter your proxy details.
374+
**Note**: If you are behind an HTTP proxy, then you should also go to the "Proxies" tab and enter your proxy details.
375375

376376
Docker will download the Kuberentes components and start them up for you. When it is done, you will see the Kubernetes status go to green/running in the menu:
377377

0 commit comments

Comments
 (0)