Skip to content

chore: set up section for C4D docs #882

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.

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 29 commits into from
Mar 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
004dfa0
chore: set up section for C4D docs
Mar 8, 2022
659f0ff
chore: add warning to local preview doc
Mar 8, 2022
220a2b1
updated Linked Accounts for VPN scenario (#903)
sharkymark Mar 16, 2022
d303681
chore: add 1.26.4 changelog (#910)
coadler Mar 18, 2022
3b7116c
chore: bump lint-staged from 12.3.6 to 12.3.7 (#911)
dependabot[bot] Mar 18, 2022
e0499d3
replaced kubeapply jetstack cert-manager approach with helm install (…
sharkymark Mar 18, 2022
6fcc68b
show how to open files at terminal in code-server (#904)
sharkymark Mar 18, 2022
09799d2
add c4d template link to the templates section (#905)
sharkymark Mar 18, 2022
11df17f
chore: refreshed images section, with deployment best practices (#906)
sharkymark Mar 18, 2022
5a9a721
chore: add 1.28.4 changelog (#909)
Mar 18, 2022
2f6fe18
feat: Config steps for multiple JetBrains IDEs in a browser (#912)
sharkymark Mar 21, 2022
98def2b
chore: add ssh-keyscan to configure script example when git cloning (…
sharkymark Mar 21, 2022
97ff277
chore: bump actions/cache from 2 to 3 (#914)
dependabot[bot] Mar 21, 2022
9f06744
chore: minor edits to recently merged docs updates (#915)
Mar 21, 2022
e8fc76b
chore: add multi jetbrains to list at top of editors md (#917)
sharkymark Mar 22, 2022
034b5b7
chore: bump minimist from 1.2.5 to 1.2.6 (#916)
dependabot[bot] Mar 22, 2022
395edee
fix(docs): correct use of login to log in (#918)
greyscaled Mar 22, 2022
7ff5f0d
chore: add upload limit & IDE logs (#919)
ericpaulsen Mar 23, 2022
275a9eb
Merge remote-tracking branch 'origin/main' into docker
Emyrk Mar 23, 2022
f359289
feat(docs): Add 'PROXY_TRUSTED_ORIGINS' to proxy docs
Emyrk Mar 23, 2022
2eeec58
feat(docs): Create Remote C4D docs
Emyrk Mar 23, 2022
3a89816
fixup! feat(docs): Create Remote C4D docs
Emyrk Mar 23, 2022
3cb0bbf
fix(docs): **Providers** -> **Workspace Providers**
Emyrk Mar 23, 2022
6c15dda
Linting fixes
Emyrk Mar 23, 2022
e5f367f
chore: edit text
Mar 23, 2022
cf91a85
chore: add link to workspace provider doc
Mar 23, 2022
ec7e70b
chore: fix links
Mar 23, 2022
0c7f595
update local preview link
Mar 23, 2022
3a59e4b
Merge branch 'release-1.29' into docker
Mar 23, 2022
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
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
fetch-depth: 0

- name: Cache Node Modules
uses: actions/cache@v2
uses: actions/cache@v3
with:
path: "/node_modules"
key: node-${{ hashFiles('yarn.lock') }}
Expand Down
3 changes: 2 additions & 1 deletion admin/access-control/users/password-reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ If you need to reset the password for a site admin, you can do so using
> sure to install it before proceeding.
>
> If you are using Docker, follow
> [these instructions](../../../setup/docker#admin-password) instead.
> [these instructions](../../../setup/coder-for-docker/local.md#admin-password)
> instead.

To reset the site admin password, run the following in the terminal:

Expand Down
7 changes: 4 additions & 3 deletions admin/satellites/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,10 @@ satellite to any cluster and any namespace.

### Step 2: Enable Networking v2

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

At this point, rebuild a workspace to ensure connectivity between the workspace
provider and the workspace. Note that latency to the workspace may be negatively
Expand Down
2 changes: 1 addition & 1 deletion admin/workspace-management/process-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ fields @timestamp, log_processed.fields.cmdline
sidecar container. Depending on how your Kubernetes cluster is configured, you
may incur extra charges from your cloud provider to store the additional logs.

[c4d-doc]: ../../setup/docker.md
[c4d-doc]: ../../setup/coder-for-docker/index.md
[ebpf]: https://ebpf.io
[ec2-doc]: ../workspace-providers/deployment/ec2.md
[eks-cloudwatch]:
Expand Down
103 changes: 103 additions & 0 deletions admin/workspace-providers/deployment/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
title: Docker
description: Learn how to deploy a workspace provider to a Docker instance.
state: alpha
---

This article walks you through the process of deploying a workspace provider to
a remote VM instance using Docker.

## Prerequisites

- You must have a provisioned VM with the Docker Engine installed and running.
The Docker Engine must be at least version [20.10][docker-engine-version].

- Coder must be able to access the VM over an SSH connection.

- The Coder deployment must be accessible from the containers deployed inside
the VM.

## 1. Create a new SSH key

Coder uses SSH to connect to the remote VM and communicate with the Docker
Engine.

We recommend that you create a new SSH key for this purpose and do _not_ reuse
this key. Furthermore, ensure that you save this key, since you'll need it to
edit your workspace provider in the future.

> ❗ Coder does not currently support password-protected SSH keys; the SSH
> key must be unencrypted.

To generate your SSH key, run:

```console
ssh-keygen -t ed25519 -C remote-c4d -f $HOME/.ssh/remote_c4d -N ""
```

## 2. Add the SSH key to the remote VM

Add your SSH key to the remote VM's `authorized_keys` file; this will allow
Coder to connect via SSH using the new `remote_c4d` key:

```console
# Replace 'remote-user@192.0.2.10' with your VM's user and host/ip.
ssh-copy-id -f -i $HOME/.ssh/remote_c4d.pub remote-user@192.0.2.10
```

## 3. Verify the SSH key

Verify that you can use the key to connect via SSH to your remote VM:

```console
# Replace 'remote-user@192.0.2.10' with your VM's user and host/ip.
ssh remote-user@192.0.2.10 -o IdentitiesOnly=yes -i $HOME/.ssh/remote_c4d 'echo All good!'
```

## 4. Enable the Docker providers feature flag

In your Coder for Docker deployment, ensure that you've enabled the **Remote
Docker Providers** feature flag.

1. Log in to Coder, and go to **Account** > **Feature Preview**

![See feature flags](../../../assets/deployment/docker/feature-flag-setting.png)

1. Click to enable **Remote Docker Providers**

![Enable feature flag](../../../assets/deployment/docker/docker-feature.png)

## 5. Create the workspace provider

To create your workspace provider, go to **Manage** > **Workspace providers**.
Click the dropdown in the top-right corner to launch **Create Docker Provider**

![Create docker provider](../../../assets/deployment/docker/create-docker-provider.png)

You can now fill out the provider form.

1. Provide a **name** for your new provider.

1. For the **Docker Daemon URL**, use `unix:///var/run./docker.sock`

1. Under the **SSH configuration** section:

1. Under **SSH Host URL**, provide the SSH URL for the remote VM, **including
the port** (e.g., `remote-user@192.0.2.10:22`)
1. Copy over the private key that you created earlier (you can retrieve it
with `cat $HOME/.ssh/remote_c4d`)
1. Run the keyscan provided for known host verification, and copy over the
output:

```console
# Example:
ssh-keyscan -p 22 -H 192.0.2.10
```

1. Optionally, set the access URL to an IP address or URL that workspaces can
use to access `coderd`. You do not need this override if the site-wide
access URL is accessible from the workspace container.

![Docker ssh config](../../../assets/deployment/docker/docker-ssh-config.png)

[docker-engine-version]: https://docs.docker.com/engine/release-notes/#20100
2 changes: 1 addition & 1 deletion admin/workspace-providers/deployment/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Install the following dependencies if you haven't already:

## Creating the new workspace provider

1. Log in to Coder, and go to **Manage** > **Providers**.
1. Log in to Coder, and go to **Manage** > **Workspace providers**.

1. Click **Create New** in the top-right corner to launch the **Create a
Kubernetes Provider** page.
Expand Down
2 changes: 1 addition & 1 deletion admin/workspace-providers/management.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Once you've made your changes, click **Update Provider** to save and continue.

## Delete a workspace provider

1. Log in to Coder, and go to **Manage** > **Providers**.
1. Log in to Coder, and go to **Manage** > **Workspace providers**.

1. In the **Providers** list, find the workspace provider you want to delete.
Click the vertical ellipsis to its right. Select **Delete**.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/deployment/docker/docker-feature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/deployment/docker/docker-ssh-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/deployment/docker/feature-flag-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions changelog/1.26.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "1.26.4"
description: "Released on 03/17/2022"
---

### Breaking changes ❗

There are no breaking changes in 1.26.4.

### Features ✨

There are no security updates in 1.26.4.

### Bug fixes 🐛

- infra: ensure CVM daemons aren't oom-killed.

### Security updates 🔐

There are no security updates in 1.26.4.
3 changes: 1 addition & 2 deletions changelog/1.28.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ description: "Released on 02/16/2022"
<!-- Turn off linting to avoid changing the link -->
<!-- markdownlint-disable MD044 -->

[version support policy]:
../setup/kubernetes#supported-kubernetes-versions
[version support policy]: ../setup/kubernetes#supported-kubernetes-versions

<!-- markdownlint-enable MD044 -->

Expand Down
23 changes: 23 additions & 0 deletions changelog/1.28.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "1.28.4"
description: "Released on 03/17/2022"
---

### Breaking changes ❗

There are no breaking changes in 1.28.4.

### Features ✨

- web: the **Open in Coder** SVG is now served from your Coder deployment,
rather than Coder's CDN, so air-gapped customers can use this feature as well.
We will continue to serve existing images from our CDN.

### Bug fixes 🐛

- web: fixed changelog URLs pointing to docs pages ending with `index.md`.
- infra: ensure CVM daemons aren't oom-killed.

### Security updates 🔐

- infra: upgraded from Go boring `1.17.5b7` to `1.17.8b7` to fix CVEs.
6 changes: 3 additions & 3 deletions getting-started/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ To get started with Coder, you will need to:

1. [Install Coder via Helm](../setup/installation.md)

Alternatively, [Coder for Docker](../setup/docker.md) allows you to deploy Coder
quickly to machines where you have Docker installed. We recommend this option
for teams with 5-10 developers.
Alternatively, [Coder for Docker](../setup/coder-for-docker/index.md) allows you
to deploy Coder quickly to machines where you have Docker installed. We
recommend this option for teams with 5-10 developers.

## Configure Coder

Expand Down
3 changes: 2 additions & 1 deletion getting-started/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ You'll learn how to:

## Prerequisites

Please [install Coder for Docker](../setup/docker.md) before proceeding.
Please [install Coder for Docker](../setup/coder-for-docker/index.md) before
proceeding.

## Step 1: Log in and connect Coder to your Git provider

Expand Down
Loading