Skip to content

Commit a873998

Browse files
author
Katie Horne
authored
chore: set up section for C4D docs (#882)
1 parent d9882b3 commit a873998

File tree

41 files changed

+782
-162
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+782
-162
lines changed

‎.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242
fetch-depth: 0
4343

4444
- name: Cache Node Modules
45-
uses: actions/cache@v2
45+
uses: actions/cache@v3
4646
with:
4747
path: "/node_modules"
4848
key: node-${{ hashFiles('yarn.lock') }}

‎admin/access-control/users/password-reset.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ If you need to reset the password for a site admin, you can do so using
3535
> sure to install it before proceeding.
3636
>
3737
> If you are using Docker, follow
38-
> [these instructions](../../../setup/docker#admin-password) instead.
38+
> [these instructions](../../../setup/coder-for-docker/local.md#admin-password)
39+
> instead.
3940
4041
To reset the site admin password, run the following in the terminal:
4142

‎admin/satellites/migration.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,10 @@ satellite to any cluster and any namespace.
6363

6464
### Step 2: Enable Networking v2
6565

66-
Log into Coder as a site manager, and go to **Manage** > **Providers**. Select
67-
the workspace provider, click the **vertical ellipsis** to its right, and select
68-
**Edit**. Enable the **NetworkingV2 toggle** and click **Update Provider**.
66+
Log into Coder as a site manager, and go to **Manage** > **Workspace
67+
providers**. Select the workspace provider, click the **vertical ellipsis** to
68+
its right, and select **Edit**. Enable the **NetworkingV2 toggle** and click
69+
**Update Provider**.
6970

7071
At this point, rebuild a workspace to ensure connectivity between the workspace
7172
provider and the workspace. Note that latency to the workspace may be negatively

‎admin/workspace-management/process-logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ fields @timestamp, log_processed.fields.cmdline
150150
sidecar container. Depending on how your Kubernetes cluster is configured, you
151151
may incur extra charges from your cloud provider to store the additional logs.
152152

153-
[c4d-doc]: ../../setup/docker.md
153+
[c4d-doc]: ../../setup/coder-for-docker/index.md
154154
[ebpf]: https://ebpf.io
155155
[ec2-doc]: ../workspace-providers/deployment/ec2.md
156156
[eks-cloudwatch]:

‎admin/workspace-providers/deployment/docker.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Docker
3+
description: Learn how to deploy a workspace provider to a Docker instance.
4+
state: alpha
5+
---
6+
7+
This article walks you through the process of deploying a workspace provider to
8+
a remote VM instance using Docker.
9+
10+
## Prerequisites
11+
12+
- You must have a provisioned VM with the Docker Engine installed and running.
13+
The Docker Engine must be at least version [20.10][docker-engine-version].
14+
15+
- Coder must be able to access the VM over an SSH connection.
16+
17+
- The Coder deployment must be accessible from the containers deployed inside
18+
the VM.
19+
20+
## 1. Create a new SSH key
21+
22+
Coder uses SSH to connect to the remote VM and communicate with the Docker
23+
Engine.
24+
25+
We recommend that you create a new SSH key for this purpose and do _not_ reuse
26+
this key. Furthermore, ensure that you save this key, since you'll need it to
27+
edit your workspace provider in the future.
28+
29+
> ❗ Coder does not currently support password-protected SSH keys; the SSH
30+
> key must be unencrypted.
31+
32+
To generate your SSH key, run:
33+
34+
```console
35+
ssh-keygen -t ed25519 -C remote-c4d -f $HOME/.ssh/remote_c4d -N ""
36+
```
37+
38+
## 2. Add the SSH key to the remote VM
39+
40+
Add your SSH key to the remote VM's `authorized_keys` file; this will allow
41+
Coder to connect via SSH using the new `remote_c4d` key:
42+
43+
```console
44+
# Replace 'remote-user@192.0.2.10' with your VM's user and host/ip.
45+
ssh-copy-id -f -i $HOME/.ssh/remote_c4d.pub remote-user@192.0.2.10
46+
```
47+
48+
## 3. Verify the SSH key
49+
50+
Verify that you can use the key to connect via SSH to your remote VM:
51+
52+
```console
53+
# Replace 'remote-user@192.0.2.10' with your VM's user and host/ip.
54+
ssh remote-user@192.0.2.10 -o IdentitiesOnly=yes -i $HOME/.ssh/remote_c4d 'echo All good!'
55+
```
56+
57+
## 4. Enable the Docker providers feature flag
58+
59+
In your Coder for Docker deployment, ensure that you've enabled the **Remote
60+
Docker Providers** feature flag.
61+
62+
1. Log in to Coder, and go to **Account** > **Feature Preview**
63+
64+
![See feature flags](../../../assets/deployment/docker/feature-flag-setting.png)
65+
66+
1. Click to enable **Remote Docker Providers**
67+
68+
![Enable feature flag](../../../assets/deployment/docker/docker-feature.png)
69+
70+
## 5. Create the workspace provider
71+
72+
To create your workspace provider, go to **Manage** > **Workspace providers**.
73+
Click the dropdown in the top-right corner to launch **Create Docker Provider**
74+
75+
![Create docker provider](../../../assets/deployment/docker/create-docker-provider.png)
76+
77+
You can now fill out the provider form.
78+
79+
1. Provide a **name** for your new provider.
80+
81+
1. For the **Docker Daemon URL**, use `unix:///var/run./docker.sock`
82+
83+
1. Under the **SSH configuration** section:
84+
85+
1. Under **SSH Host URL**, provide the SSH URL for the remote VM, **including
86+
the port** (e.g., `remote-user@192.0.2.10:22`)
87+
1. Copy over the private key that you created earlier (you can retrieve it
88+
with `cat $HOME/.ssh/remote_c4d`)
89+
1. Run the keyscan provided for known host verification, and copy over the
90+
output:
91+
92+
```console
93+
# Example:
94+
ssh-keyscan -p 22 -H 192.0.2.10
95+
```
96+
97+
1. Optionally, set the access URL to an IP address or URL that workspaces can
98+
use to access `coderd`. You do not need this override if the site-wide
99+
access URL is accessible from the workspace container.
100+
101+
![Docker ssh config](../../../assets/deployment/docker/docker-ssh-config.png)
102+
103+
[docker-engine-version]: https://docs.docker.com/engine/release-notes/#20100

‎admin/workspace-providers/deployment/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Install the following dependencies if you haven't already:
1616

1717
## Creating the new workspace provider
1818

19-
1. Log in to Coder, and go to **Manage** > **Providers**.
19+
1. Log in to Coder, and go to **Manage** > **Workspace providers**.
2020

2121
1. Click **Create New** in the top-right corner to launch the **Create a
2222
Kubernetes Provider** page.

‎admin/workspace-providers/management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Once you've made your changes, click **Update Provider** to save and continue.
151151

152152
## Delete a workspace provider
153153

154-
1. Log in to Coder, and go to **Manage** > **Providers**.
154+
1. Log in to Coder, and go to **Manage** > **Workspace providers**.
155155

156156
1. In the **Providers** list, find the workspace provider you want to delete.
157157
Click the vertical ellipsis to its right. Select **Delete**.

‎assets/deployment/docker/create-docker-provider.png

32 KB
Loading

‎assets/deployment/docker/docker-feature.png

93 KB
Loading

‎assets/deployment/docker/docker-ssh-config.png

211 KB
Loading

0 commit comments

Comments
 (0)