Skip to content

move dev urls section in local preview docs #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 21, 2021
Merged

move dev urls section in local preview docs #626

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions setup/kubernetes/local-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,42 @@ Password: yfu...yu2

Visit the URL shown, and log in using the provided credentials.

### Dev URLs
## Option 2: Docker Desktop

[Docker Desktop][docker-desktop-url] includes a standalone Kubernetes server and
client that you can use to run Coder.

1. [Enable the Kubernetes cluster][docker-k8s-docs] inside Docker.

1. Ensure that Docker has enough resources allocated to meet
[Coder's requirements](../requirements) (you can do so by going to Docker
preferences).

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

1. Install [metrics-server](https://github.com/kubernetes-sigs/metrics-server)
so that Coder gets valid metrics from your cluster:

```console
helm repo add bitnami https://charts.bitnami.com/bitnami
```

1. [Install Coder](../installation) on to your cluster.

If you run into `OutOfmemory` errors when installing, try increasing your
resource allocation in Docker. If increasing the resource allocation doesn't fix
the error, reinstall Coder using the following Helm values:

```console
helm upgrade --install coder \
coder/coder
```

> For Coder v1.21+, you will need to update your access URL (go to **Manage** >
> **Admin**) to your private IP address (e.g `192.168.1.x`) instead of using
> `localhost`.

## Using Dev URLs with local preview

Coder allows you to access services you're developing in your workspace via
[dev URLs](../../workspaces/devurls.md). You can enable dev URLs after you've
Expand Down Expand Up @@ -174,41 +209,6 @@ protection. Here's how to do this:
devurlsHost: "*.coder"
```

## Option 2: Docker Desktop

[Docker Desktop][docker-desktop-url] includes a standalone Kubernetes server and
client that you can use to run Coder.

1. [Enable the Kubernetes cluster][docker-k8s-docs] inside Docker.

1. Ensure that Docker has enough resources allocated to meet
[Coder's requirements](../requirements) (you can do so by going to Docker
preferences).

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

1. Install [metrics-server](https://github.com/kubernetes-sigs/metrics-server)
so that Coder gets valid metrics from your cluster:

```console
helm repo add bitnami https://charts.bitnami.com/bitnami
```

1. [Install Coder](../installation) on to your cluster.

If you run into `OutOfmemory` errors when installing, try increasing your
resource allocation in Docker. If increasing the resource allocation doesn't fix
the error, reinstall Coder using the following Helm values:

```console
helm upgrade --install coder \
coder/coder
```

> For Coder v1.21+, you will need to update your access URL (go to **Manage** >
> **Admin**) to your private IP address (e.g `192.168.1.x`) instead of using
> `localhost`.

## Removing Coder

To remove the local Coder deployment, run:
Expand Down