Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit ca06020

Browse files
johnstcnKatie Horne
johnstcn
and
Katie Horne
authored
docs branch for release v1.30 (#970)
* Release 1.30.0 (#952) (cherry picked from commit 553e282) * chore: add changelog for 1.29.3 (#961) (cherry picked from commit 2222dad) * chore: add changelog for v1.30.1 (#967) * chore: add changelog for v1.30.1 * chore: edit text Co-authored-by: Katie Horne <katie@coder.com> (cherry picked from commit 0fe5258) * chore: add changelog for 1.28.5 (#960) (#963) * chore: add changelog for 1.28.5 * fixup! chore: add changelog for 1.28.5 * Update changelog/1.28.5.md Co-authored-by: Katie Horne <katie@coder.com> (cherry picked from commit fb55665) * chore: add changelog for 1.28.6 (#968) * chore: add changelog for 1.28.6 * chore: edit text Co-authored-by: Katie Horne <katie@coder.com> * chore: add changelog for v1.29.4 (#969) * chore: add changelog for v1.29.4 * chore: edit text Co-authored-by: Katie Horne <katie@coder.com> (cherry picked from commit 1ebd547) Co-authored-by: Katie Horne <katie@coder.com>
1 parent a1072d2 commit ca06020

File tree

27 files changed

+372
-52
lines changed

27 files changed

+372
-52
lines changed

‎admin/access-control/manage.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ article.
1616

1717
## Coder's OIDC claims
1818

19-
Coder expects the following [OIDC claims](https://developer.okta.com/blog/2017/07/25/oidc-primer-part-1#whats-a-claim)
19+
Coder expects the following
20+
[OIDC claims](https://developer.okta.com/blog/2017/07/25/oidc-primer-part-1#whats-a-claim)
2021
from your OIDC provider:
2122

2223
- `email` (required)
@@ -65,6 +66,21 @@ you:
6566
to log in with an email/password option when you've enabled OIDC
6667
authentication
6768

69+
### Logging
70+
71+
If you're having issues with your OIDC configuration, you can enable additional
72+
logging of OIDC tokens to aid in troubleshooting.
73+
74+
To do so, [update your Helm chart](../../guides/admin/helm-charts.md) and set
75+
the `OIDC_DEBUG` environment variable to `true`:
76+
77+
```yaml
78+
coderd:
79+
extraEnvs:
80+
- name: "OIDC_DEBUG"
81+
value: "true"
82+
```
83+
6884
### Disable built-in authentication
6985
7086
You can disable built-in authentication as an option for accessing Coder if you

‎admin/git.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Coder integrates with the following service providers for authentication and
2626
2727
Linking your Coder account with a git service provider is _not_ required.
2828
Instead, you can use Visual Studio Code with git, the command-line tool, and we
29-
expect that this combination will work with most hosting software or services.
30-
However, Coder doesn't test these and cannot provide recommendations or support.
29+
expect this combination to work with most hosting software or services. However,
30+
Coder doesn't test these and cannot provide recommendations or support.
3131

3232
> Ensure that your Git provider supports the keygen algorithm that Coder uses;
3333
> you can choose the algorithm in **Manage** > **Admin** > **Security** >
@@ -38,8 +38,16 @@ However, Coder doesn't test these and cannot provide recommendations or support.
3838
## Configuring OAuth
3939

4040
Before developers can link their accounts, you (or another site manager) must
41-
create an OAuth application with the appropriate providers. When registering,
42-
you'll be asked for the following details related to your Coder deployment.
41+
create an OAuth application with the appropriate providers. You can create as
42+
many OAuth applications as necessary.
43+
44+
1. Log into Coder as a site manager, and go to **Manage** > **Admin** > **Git
45+
OAuth**.
46+
1. Click **Add provider**.
47+
1. Select your **Provider** (e.g., GitHub, GitLab, or Bitbucket Server).
48+
1. Create an OAuth application with your Git provider and provide Coder with the
49+
requested details (the parameters required vary based on your Git provider).
50+
See the following sections for additional guidance.
4351

4452
### GitHub
4553

@@ -54,7 +62,9 @@ ask you for the following Coder parameters:
5462
`[your-coder-domain]/oauth/callback` (e.g.
5563
`https://coder.domain.com/oauth/callback`)
5664

57-
Then, provide your **Client ID** and **Client Secret** to Coder.
65+
Then, in Coder, provide a **Name** for your app, your **URL**, **Client ID**,
66+
and **Client Secret** to Coder. You can also provide an optional
67+
**Description**.
5868

5969
When done, click **Save**.
6070

@@ -73,7 +83,9 @@ enabled the following:
7383
- **Confidential**: Check this option
7484
- **API** (scope): Check this option
7585

76-
Then, provide your **Client ID** and **Client Secret** to Coder.
86+
Then, in Coder, provide a **Name** for your app, your **URL**, **Application
87+
ID**, and **Client Secret** to Coder. You can also provide an optional
88+
**Description**.
7789

7890
When done, click **Save**.
7991

@@ -93,4 +105,7 @@ For your newly created Application Link, provide the following values as your
93105
- **Public Key**: Your public key (available from the Coder Admin Configuration
94106
page)
95107

108+
Then, in Coder, provide a **Name** for your app, your **URL**, and, optionally,
109+
a **Description**.
110+
96111
When done, click **Save**.

‎admin/workspace-management/cvms/management.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,27 @@ a site manager must enable CVMs. To do so:
99
1. Go to **Manage > Admin > Infrastructure**.
1010
1. Toggle the **Enable Container-Based Virtual Machines** option to **Enable**.
1111

12-
This section also describes the customization features that Coder offers for
13-
CVMs:
12+
## Customization
13+
14+
Once you've enabled CVMs, you can customize the behavior of your deployment and
15+
workspaces.
1416

1517
![CVM Settings](../../../assets/admin/cvm-settings.png)
1618

1719
These settings will apply to workspaces **after** they have been rebuilt.
1820

21+
## Default workspaces to CVMs
22+
23+
Once you've enabled CVMs, you can control whether all new workspaces should be
24+
built as a CVM or not.
25+
26+
If you would like all newly created workspaces to be CVMs, toggle **Default to
27+
container-based virtual machines** to **On**.
28+
29+
> While this toggle changes the default workspace creation setting, users can still
30+
> override this setting. For example, if you enable CVMS and set them as the
31+
> default, a user can still create non-CVM workspaces (and vice versa).
32+
1933
## Caching
2034

2135
> Cached CVMs are currently an **alpha** feature.

‎admin/workspace-management/limits.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Workspace limits"
3+
description: Learn how to limit the number of workspaces users can create.
4+
---
5+
6+
You can set the maximum number of workspaces that each user can create. To do
7+
so, [update your Helm chart](../../guides/admin/helm-charts.md) and set the
8+
`CODER_MAX_WORKSPACES_PER_USER` parameter to the maximum allowable number:
9+
10+
```yaml
11+
# Allow each user to create no more than 100 workspaces
12+
coderd:
13+
extraEnvs:
14+
- name: CODER_MAX_WORKSPACES_PER_USER
15+
value: 100
16+
```

‎admin/workspace-management/self-contained-builds.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,35 @@
11
---
22
title: "Self-contained workspace builds"
3-
description: Learn how to enable self-contained workspace builds.
4-
state: alpha
3+
description: Learn how to toggle self-contained workspace builds.
54
---
65

7-
By default the Coder workspace boot sequence occurs remotely -- Coder uploads
8-
assets (including the Coder agent, code-server, and JetBrains Projector) from
9-
`coderd` to a workspace.
6+
Currently, there are two ways in which the workspace boot sequence can occur:
107

11-
However, Coder offers the option of using **self-contained workspace builds**.
12-
Enabling this option changes the Coder deployment so that workspaces control the
13-
boot sequence internally, with the workspace downloading assets from `coderd`.
8+
1. Remotely: Coder uploads assets (including the Coder agent, code-server, and
9+
JetBrains Projector) from `coderd` to a workspace.
10+
1. Self-contained: workspaces control the boot sequence internally; the
11+
workspace downloads assets from `coderd`. This requires `curl` to be
12+
available in the image.
1413

15-
> At this time, Coder does not support certificate injection with
16-
> self-contained workspace builds.
14+
Beginning with v1.30.0, the default is **self-contained workspace builds**,
15+
though site managers can toggle this feature off and opt for remote builds
16+
instead.
1717

18-
To enable self-contained workspace builds:
18+
> Coder plans to deprecate remote workspace builds in the future.
19+
20+
To toggle self-contained workspace builds:
1921

2022
1. Log into Coder.
2123
1. Go to Manage > Admin.
2224
1. On the Infrastructure page, scroll down to **Workspace container runtime**.
23-
1. Under **Enable self-contained workspace builds**, flip the toggle to **On**.
25+
1. Under **Enable self-contained workspace builds**, flip the toggle to **On**
26+
or **Off** as required.
2427
1. Click **Save workspaces**.
2528

2629
> Build errors are typically more verbose for remote builds than with
2730
> self-contained builds.
31+
32+
## Known issues
33+
34+
At this time, Coder does not support certificate injection with self-contained
35+
workspace builds.

‎assets/guides/admin/file-download.png

113 KB
Loading

‎changelog/1.28.5.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: "1.28.5"
3+
description: "Released on 4/28/2022"
4+
---
5+
6+
### Breaking changes ❗
7+
8+
There are no breaking changes in 1.28.5.
9+
10+
### Features ✨
11+
12+
There are no new features in 1.28.5.
13+
14+
### Bug fixes 🐛
15+
16+
- infra: fixed issue where the Coder front-end attempts to reconnect to a
17+
workspace even when it is offline.
18+
- web: fixed issue where the error message does not show when a user exceeds
19+
their resource quota when attempting to create a workspace.
20+
21+
### Security updates 🔐
22+
23+
There are no security updates in 1.28.5.

‎changelog/1.28.6.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "1.28.6"
3+
description: "Released on 04/29/2022"
4+
---
5+
6+
### Breaking changes ❗
7+
8+
There are no breaking changes in 1.28.6.
9+
10+
### Features ✨
11+
12+
- infra: Coder tunnel no longer exits after a single connection.
13+
14+
### Bug fixes 🐛
15+
16+
- infra: fixed issue where a lower MTU caused connections to break.
17+
- infra: fixed issue where the default Helm `networkingress` policy did not
18+
allow inbound UDP connections.
19+
20+
### Security updates 🔐
21+
22+
There are no security updates in 1.28.6.

‎changelog/1.29.3.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "1.29.3"
3+
description: "Released on 4/28/2022"
4+
---
5+
6+
### Breaking changes ❗
7+
8+
There are no breaking changes in 1.29.3.
9+
10+
### Features ✨
11+
12+
There are no new features in 1.29.3.
13+
14+
### Bug fixes 🐛
15+
16+
- infra: fixed issue where the Coder front-end attempts to reconnect to a
17+
workspace even when it is offline.
18+
19+
### Security updates 🔐
20+
21+
There are no security updates in 1.29.3.

‎changelog/1.29.4.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "1.29.4"
3+
description: "Released on 04/29/2022"
4+
---
5+
6+
### Breaking changes ❗
7+
8+
There are no breaking changes in 1.29.4.
9+
10+
### Features ✨
11+
12+
- infra: Coder tunnel no longer exits after a single connection.
13+
14+
### Bug fixes 🐛
15+
16+
- infra: fixed issue where a lower MTU caused connections to break.
17+
- infra: fixed issue where the default Helm `networkingress` policy did not
18+
allow inbound UDP connections.
19+
20+
### Security updates 🔐
21+
22+
There are no security updates in 1.29.4.

0 commit comments

Comments
 (0)