Skip to content

Commit 2a07a99

Browse files
author
Katie Horne
committed
Edit text
1 parent 9060c04 commit 2a07a99

File tree

1 file changed

+32
-31
lines changed

1 file changed

+32
-31
lines changed

‎setup/kubernetes/k3s.md

+32-31
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ machine for use with Coder.
99
[K3s](https://k3s.io/) is a lightweight Kubernetes distribution that works well
1010
for single-node or multi-node clusters. This guide covers the installation of
1111
K3s onto a new Ubuntu 20.04 LTS machine. If you want to install Coder on a local
12-
machine or an existing host, a [kind cluster](./kind.md) or
13-
[k3d cluster](https://k3d.io/) may be a better choice, as it leverages Docker to
14-
set up/tear down clusters with little hassle.
12+
machine or an existing host, a [kind cluster](./kind.md) or [k3d
13+
cluster](https://k3d.io/) may be a better choice, as it leverages Docker to set
14+
up/tear down clusters with little hassle.
1515

1616
> This installation method is not officially supported or tested by Coder. If
1717
> you have questions or run into issues, feel free to reach out using our
@@ -23,44 +23,45 @@ set up/tear down clusters with little hassle.
2323

2424
Before proceeding, please make sure that:
2525

26-
1. You have an **Ubuntu 20.04 machine**: This can be a bare metal or a virtual
26+
- You have an **Ubuntu 20.04 machine**: This can be a bare metal or a virtual
2727
machine.
2828

29-
Ensure that the machine's specs satisfy Coder's
30-
[resource requirements](../requirements.md), since your experience with Coder
31-
is dependent on your system specs.
29+
Ensure that the machine's specs satisfy Coder's [resource
30+
requirements](../requirements.md), since your experience with Coder is
31+
dependent on your system specs.
3232

33-
1. You have the following software installed on your machine:
33+
- You have the following software installed on your machine:
3434

35-
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)
36-
- [helm](https://helm.sh/docs/intro/install/)
35+
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)
36+
- [helm](https://helm.sh/docs/intro/install/)
3737

38-
1. Your network policy or firewall accepts incoming traffic on:
39-
- Port 22 (SSH)
40-
- Port 80 (HTTP)
41-
- Port 443 (HTTPS)
42-
- Port 5349 (TURNS)
43-
- **Optional**: Port 8443 (Kubernetes API)
38+
- Your network policy or firewall accepts incoming traffic on:
39+
40+
- Port 22 (SSH)
41+
- Port 80 (HTTP)
42+
- Port 443 (HTTPS)
43+
- Port 5349 (TURNS)
44+
- **Optional**: Port 8443 (Kubernetes API)
4445

4546
## Step 1: Change the default SSH port
4647

47-
If you enable Networking v2 after installing Coder (in
48-
`Manage > Admin > Infrastructure`), this step is not necessary to SSH into
49-
workspaces, as TURNS is used instead.
48+
> If you've enabled Networking v2 after installing Coder (you can do so by going
49+
to **Manage** > **Admin** > **Infrastructure**), this step to SSH into
50+
workspaces isn't necessary, since TURNS is used instead.
5051

51-
Otherwise, in order to allow [SSH into workspaces](../../workspaces/ssh), you
52-
must change the host's default SSH port to free up port `22`. You may also need
53-
to modify your firewall to accept incoming traffic from the alternative port
54-
(e.g., if you rename port `22` to `5522`, then your firewall must accept traffic
55-
from `5522`).
52+
To allow [SSH into workspaces](../../workspaces/ssh), you must change the host's
53+
default SSH port to free up port `22`. You may also need to modify your firewall
54+
to accept incoming traffic from the alternative port (e.g., if you rename port
55+
`22` to `5522`, then your firewall must accept traffic from `5522`).
5656

5757
> If you don't know how to change the SSH port in Linux, please review this
58-
> [guide from Linuxize](https://linuxize.com/post/how-to-change-ssh-port-in-linux/)
58+
> [guide from
59+
> Linuxize](https://linuxize.com/post/how-to-change-ssh-port-in-linux/)
5960
6061
## Step 2: Install K3s with Calico
6162

62-
The following steps are based on
63-
[Calico's quickstart guide](https://docs.projectcalico.org/getting-started/kubernetes/k3s/quickstart)
63+
The following steps are based on [Calico's quickstart
64+
guide](https://docs.projectcalico.org/getting-started/kubernetes/k3s/quickstart)
6465
for setting up K3s. However, you will disable K3s' default network policies and
6566
Traefik in favor of Calico and nginx-ingress.
6667

@@ -70,8 +71,8 @@ Traefik in favor of Calico and nginx-ingress.
7071
curl -sfL https://get.k3s.io | K3S_KUBECONFIG_MODE="644" INSTALL_K3S_EXEC="--flannel-backend=none --cluster-cidr=192.168.0.0/16 --disable-network-policy --disable=traefik" sh -
7172
```
7273

73-
> Per the
74-
> [Calico docs](https://docs.projectcalico.org/getting-started/kubernetes/k3s/quickstart):
74+
> Per the [Calico
75+
> docs](https://docs.projectcalico.org/getting-started/kubernetes/k3s/quickstart):
7576
>
7677
> If `192.168.0.0/16` is already in use within your network, you must select
7778
> a different pod network CIDR by replacing `192.168.0.0/16` in the above
@@ -136,5 +137,5 @@ cp /etc/rancher/k3s/k3s.yaml ~/.kube/config
136137

137138
## Next steps
138139

139-
At this point, you're ready to proceed to
140-
[installing Coder](../installation.md).
140+
At this point, you're ready to proceed to [installing
141+
Coder](../installation.md).

0 commit comments

Comments
 (0)