From d3e4b11ea4d2ef03d78142b65cd236831a359bf6 Mon Sep 17 00:00:00 2001
From: Drew Bednar <drew@androiddrew.com>
Date: Wed, 16 Dec 2020 16:23:35 -0500
Subject: [PATCH] making it a little more convient

---
 .gitignore               |  1 +
 README.md                | 58 ++++++++++++++++++++++++++++++++++++++++
 manifests/kuard-pod.yaml |  2 +-
 scripts/profile          | 15 +++++++++++
 4 files changed, 75 insertions(+), 1 deletion(-)
 create mode 100755 scripts/profile

diff --git a/.gitignore b/.gitignore
index e69de29..19b213b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+kubeconfig.conf
diff --git a/README.md b/README.md
index 6a1aade..2fbefeb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,63 @@
 # Kubernetes up and Running
 
+## Setting your kubeconfig
+
+To make it easier on you copy your kube config file to the root of this project and name it kubeconfig.conf. Then just remember to run source `scripts/profile` to start using the kubectl command. I am just setting the KUBECONFIG envar to the kubeconfig.conf file for the bash session.
+
+
+## Accessing a pod from your laptop
+
+Portforwarding
+
+```
+kubectl port-forward <pod name> <port>:<pod_port>
+```
+
+## Basic logging
+
+```
+kubectl logs <pod name>
+```
+
+Stream logs with `-f`
+
+```
+kubectl logs -f <pod name>
+```
+
+To view logs from the previous pod. Useful if the pod instances keep restarting.
+```
+kubectl logs --previous <pod_name>
+```
+
+## Running commands in your container with exec
+
+One off commands
+
+```
+kubectl exec <pod name> <cmd>
+
+
+kubectl exec kuard date
+```
+
+Interactive sessions
+
+```
+kubectl exec -it <pod name> <cmd>
+```
+
+## Copying files to and from a running container
+
+
+```
+kubectl cp <pod name>:<path> <host path>
+```
+
+```
+kubectl cp <host path> <pod name>:<path>
+```
+
 ## Demo app
 
 https://github.com/kubernetes-up-and-running/kuard
diff --git a/manifests/kuard-pod.yaml b/manifests/kuard-pod.yaml
index 800fbcd..e01cfe4 100644
--- a/manifests/kuard-pod.yaml
+++ b/manifests/kuard-pod.yaml
@@ -1,7 +1,7 @@
 apiVersion: v1
 kind: Pod
 metadata:
-  name: kaurd
+  name: kuard
 spec:
   containers:
     - image: gcr.io/kuar-demo/kuard-amd64:blue
diff --git a/scripts/profile b/scripts/profile
new file mode 100755
index 0000000..e0ac910
--- /dev/null
+++ b/scripts/profile
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set +ex
+
+CDIR=$(pwd -P)
+
+echo "Setting 'kk' as a kubectl alias"
+alias kk=kubectl
+
+if [ -f kubeconfig.conf ]; then
+    export KUBECONFIG="${CDIR}/kubeconfig.conf" 
+else
+    echo "Fail whale. You have no kubeconfig.conf file"
+    exit 1
+fi