Skip to content

Commit bab6125

Browse files
author
Katie Horne
committed
Edit text
1 parent fdf8099 commit bab6125

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

setup/kubernetes/local-preview.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ title: "Local preview"
33
description: Set up a Coder deployment locally for testing.
44
---
55

6-
Docker
7-
8-
Coder is typically deployed to a remote datacenter but [Docker][docker-url] can
9-
be used to create a lightweight preview deployment of Coder.
6+
Coder is typically deployed to a remote data center, but you can use
7+
[Docker][docker-url] to create a lightweight preview deployment of Coder.
108

119
> Coder currently supports local preview only on workstations running macOS or
1210
> Linux.
@@ -66,16 +64,16 @@ We are working on bringing Dev URL support to local previews in later releases.
6664

6765
### SSH
6866

69-
With kind, SSH is not configured to run by default.
67+
When using kind for your local preview, SSH is not configured to run by default.
7068

71-
With Docker Desktop, SSH will work as long as your machine does not have an
72-
existing SSH server running on port 22.
69+
When using Docker Desktop for your local preview, SSH works as long as your
70+
machine does not have an existing SSH server running on port `22`.
7371

7472
### Air-gapped clusters
7573

7674
The local preview option does not work in an air-gapped deployment.
7775

78-
## Option 1) Kind
76+
## Option 1: Kind
7977

8078
To install Coder, run:
8179

@@ -106,31 +104,31 @@ Password: yfu...yu2
106104
Visit the URL, and log in using the provided credentials. The platform is
107105
automatically configured for you, so there's no first-time setup to do.
108106

109-
## Option 2) Docker Desktop
107+
## Option 2: Docker Desktop
110108

111109
[Docker Desktop](docker-desktop-url) includes a standalone Kubernetes server and
112-
client, which can be used to run Coder.
110+
client that you can use to run Coder.
111+
112+
1. [Enable the Kubernetes cluster](docker-k8s-docs) inside Docker.
113113

114-
1. Follow [Docker's docs](docker-k8s-docs) to enable the Kubernetes cluster
115-
1. Ensure Docker has enough resources allocated to meet
114+
1. Ensure that Docker has enough resources allocated to meet
116115
[Coder's requirements](https://coder.com/docs/coder/v1.20/setup/requirements)
117-
in Docker preferences
116+
(you can do so by going to Docker preferences).
118117

119118
![Docker Desktop Resources](../../assets/setup/docker-desktop-resources.png)
120119

121120
1. Install [metrics-server](https://github.com/kubernetes-sigs/metrics-server)
122-
for Coder to get valid metrics from your cluster
121+
so that Coder gets valid metrics from your cluster:
123122

124123
```console
125124
helm repo add bitnami https://charts.bitnami.com/bitnami
126125
```
127126

128-
1. Proceed to our [install docs](../installation) to install Coder on your
129-
cluster
127+
1. [Install Coder](../installation) on to your cluster.
130128

131129
If you run into `OutOfmemory` errors when installing, try increasing your
132-
resource allocation in Docker. If that fails install Coder with the following
133-
helm values:
130+
resource allocation in Docker. If increasing the resource allocation doesn't fix
131+
the error, reinstall Coder using the following Helm values:
134132

135133
```console
136134
helm upgrade --install coder \

0 commit comments

Comments
 (0)