Restructure k3d docs
Windows instructions unclear. `/usr/local/bin` might not be in PATH.
Epinio version will soon be outdated.
Inconsistent capitalization in headings. Trailing whitespace.
Heading levels were off.
-# Creating a K3d kubernetes cluster
+# Creating a K3d Kubernetes Cluster
## Get K3d Kubernetes Cluster
@@ -30,65 +30,55 @@ NAME STATUS ROLES AGE VERSION
k3d-epinio-server-0 Ready control-plane,master 38s v1.20.0+k3s2
```
-#### Install Dependencies
+## Install Dependencies
Follow these [steps](./install_dependencies.md) to install dependencies.
-#### Install Epinio CLI
+## Install Epinio CLI
-##### Linux
+### Download the Binary
+
+Change the version (v0.0.18) to the current release.
-* Download the binary
+##### Linux
```bash
curl -o epinio -L https://github.com/epinio/epinio/releases/download/v0.0.18/epinio-linux-amd64
```
-* Make the binary executable
+##### MacOS
```bash
-chmod +x epinio
+curl -o epinio -L https://github.com/epinio/epinio/releases/download/v0.0.18/epinio-darwin-amd64
```
-* Move the binary to your PATH
+##### Windows
```bash
-sudo mv ./epinio /usr/local/bin/epinio
+ curl -LO https://github.com/epinio/epinio/releases/download/v0.0.18/epinio-windows-amd64
```
-##### MacOS
-
-* Download the binary
-
-```bash
-curl -o epinio -L https://github.com/epinio/epinio/releases/download/v0.0.18/epinio-darwin-amd64
-```
+### Make the binary executable
-* Make the binary executable
+For example on Linux and Mac:
```bash
chmod +x epinio
```
-* Move the binary to your PATH
+Move the binary to your PATH
```bash
sudo mv ./epinio /usr/local/bin/epinio
```
-##### Windows
-
-```bash
- curl -LO https://github.com/epinio/epinio/releases/download/v0.0.18/epinio-windows-amd64
-```
-
-#### Install Epinio in cluster
+### Install Epinio on the Cluster
```bash
epinio install
```
-#### Install Epinio in cluster when K3d is inside a VM
+If k3d is inside a VM, in addition to the special k3d setup, explained above, use this system domain instead:
```bash
epinio install --system-domain=<YOUR-IP>.omg.howdoi.website
@@ -100,7 +90,18 @@ epinio install --system-domain=<YOUR-IP>.omg.howdoi.website
ifconfig |grep "inet.*broadcast
```
+
### Troubleshooting
+#### Kubeconfig
+
+To get the kube config to access the cluster:
+
+```
+k3d kubeconfig get epinio
+```
+
+#### Traefik
+
In case of trouble with Epinio's Traefik component or Ingress controllers, the [Traefik](../explanations/advanced.md#traefik) section in the
[Advanced Topics](../explanations/advanced.md) document shall be your friend.
