Skip to content

Commit a7234f6

Browse files
authored
chore: update change log to v2.10.0 and install docs for release channels (coder#12863)
* 2.10.0 changelog * updated install docs for mainline/stable releases * make fmt * cpp icon -> C++ * added disclaimer on MAX_TTL, support bundle info * 'release schedule' * lowercase mainline * Agent OOM protection info * minor tweak
1 parent bf19e34 commit a7234f6

File tree

5 files changed

+211
-1
lines changed

5 files changed

+211
-1
lines changed
188 KB
Loading

docs/changelogs/v2.10.0.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
## Changelog
2+
3+
> [!NOTE]
4+
> This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](../install/releases.md).
5+
6+
### BREAKING CHANGES
7+
8+
- Removed `max_ttl` from templates (#12644) (@Emyrk)
9+
> Maximum Workspace Lifetime, or `MAX_TTL`, has been removed from the product in favor of Autostop Requirement. Max Lifetime was designed to automate workspace shutdowns to enable security policy enforcement, enforce routine updates, and reduce idle resource costs.
10+
>
11+
> If you use Maximum Lifetime in your templates, workspaces will no longer stop at the end of this timer. Instead, we advise migrating to Autostop Requirement.
12+
>
13+
> Autostop Requirement shares the benefits of `MAX_TTL`, but also respects user-configured quiet hours to avoid forcing shutdowns while developers are connected.
14+
>
15+
> We only completely deprecate features after a 2-month heads up in the UI.
16+
17+
### Features
18+
19+
- Make agent stats' cardinality configurable (#12535) (@dannykopping)
20+
- Upgrade tailscale fork to set TCP options for performance (#12574) (@spikecurtis)
21+
- Add AWS IAM RDS Database auth driver (#12566) (@f0ssel)
22+
- Support Windows containers in bootstrap script (#12662) (@kylecarbs)
23+
- Add `workspace_id` to `workspace_build` audit logs (#12718) (@sreya)
24+
- Make OAuth2 provider not enterprise-only (#12732) (@code-asher)
25+
- Allow number options with monotonic validation (#12726) (@dannykopping)
26+
- Expose workspace statuses (with details) as a prometheus metric (#12762) (@dannykopping)
27+
- Agent: Support adjusting child process OOM scores (#12655) (@sreya)
28+
> This opt-in configuration protects the Agent process from crashing via OOM. To prevent the agent from being killed in most scenarios, set `CODER_PROC_PRIO_MGMT=1` on your container.
29+
- Expose HTTP debug server over tailnet API (#12582) (@johnstcn)
30+
- Show queue position during workspace builds (#12606) (@dannykopping)
31+
- Unhide support bundle command (#12745) (@johnstcn)
32+
> The Coder support bundle grabs a variety of deployment health information to improve and expedite the debugging experience.
33+
> ![Coder Support Bundle](https://raw.githubusercontent.com/coder/coder/main/docs/changelogs/images/support-bundle.png)
34+
- Add golden tests for errors (#11588) (#12698) (@elasticspoon)
35+
- Enforce confirmation before creating bundle (#12684) (@johnstcn)
36+
- Add enabled experiments to telemetry (#12656) (@dannykopping)
37+
- Export metric indicating each experiment's status (#12657) (@dannykopping)
38+
- Add sftp to insights apps (#12675) (@mafredri)
39+
- Add `template_usage_stats` table and rollup query (#12664) (@mafredri)
40+
- Add `dbrollup` service to rollup insights (#12665) (@mafredri)
41+
- Use `template_usage_stats` in `GetTemplateInsights` query (#12666) (@mafredri)
42+
- Use `template_usage_stats` in `GetTemplateInsightsByInterval` query (#12667) (@mafredri)
43+
- Use `template_usage_stats` in `GetTemplateAppInsights` query (#12669) (@mafredri)
44+
- Use `template_usage_stats` in `GetUserLatencyInsights` query (#12671) (@mafredri)
45+
- Use `template_usage_stats` in `GetUserActivityInsights` query (#12672) (@mafredri)
46+
- Use `template_usage_stats` in `*ByTemplate` insights queries (#12668) (@mafredri)
47+
- Add debug handlers for logs, manifest, and token to agent (#12593) (@johnstcn)
48+
- Add linting to all examples (#12595) (@mafredri)
49+
- Add C++ icon (#12572) (@michaelbrewer)
50+
- Add support for `--mainline` (default) and `--stable` (#12858) (@mafredri)
51+
- Make listening ports scrollable (#12660) (@BrunoQuaresma)
52+
- Fetch agent network info over tailnet (#12577) (@johnstcn)
53+
- Add client magicsock and agent prometheus metrics to support bundle (#12604) (@johnstcn)
54+
55+
### Bug fixes
56+
57+
- Server: Fix data race in TestLabelsAggregation tests (#12578) (@dannykopping)
58+
- Dashboard: Hide actions and notifications from deleted workspaces (#12563) (@aslilac)
59+
- VSCode: Importing api into vscode-coder (#12570) (@code-asher)
60+
- CLI: Clean template destination path for `pull` (#12559) (@dannykopping)
61+
- Agent: Ensure agent token is from latest build in middleware (#12443) (@f0ssel)
62+
- CLI: Handle CLI default organization when none exists in <v2.9.0 coderd (#12594) (@Emyrk)
63+
- Server: Separate signals for passive, active, and forced shutdown (#12358) (@kylecarbs)
64+
- Docs: Correct typo error about minTerraformVersion (#12621) (@garylavayou)
65+
- Docs: Correct troubleshooting links (#12608) (@dannykopping)
66+
- Server: Prevent single replica proxies from staying unhealthy (#12641) (@deansheather)
67+
- Database: Implicit schema in dump (#12646) (@mtojek)
68+
- Server: Disable workspace auto-create if external auth requirements aren't met (#12538) (@aslilac)
69+
- Server: Allow proxy version mismatch (with warning) (#12433) (@deansheather)
70+
- Server: Disable relay if built-in DERP is disabled (#12654) (@coadler)
71+
- Dashboard: Create workspace with optional auth providers (#12729) (@aslilac)
72+
- Always use bash when executing web terminal tests (#12755) (@aslilac)
73+
- Server: Nil ptr dereference when removing a license (#12785) (@coadler)
74+
- Use latest coder/tailscale (@spikecurtis)
75+
- Agent: remove unused token debug handler (#12602) (@johnstcn)
76+
- CLI: Show error/hide help for unsupported subcommands (#10760) (#12624) (@elasticspoon)
77+
- CLI: Port-forward: update workspace last_used_at (#12659) (@johnstcn)
78+
- CLI: Fix newline escape sequence in support blurb (#12749) (@johnstcn)
79+
- Server: Skip logging error for cancelled query in agent report stats (#12730) (@mafredri)
80+
- Server: Add timeout to websocket waitgroup on shutdown (#12754) (@coadler)
81+
- Server: Use insights for DAUs, simplify metricscache (#12775) (@mafredri)
82+
- API: always write agent stats when provided (#12699) (@mafredri)
83+
- Database: Improve data exclusion in `UpsertTemplateUsageStats` (#12764) (@mafredri)
84+
- Database: Improve query performance of `GetTemplateAppInsights` (#12767) (@mafredri)
85+
- Database: Improve performance of `GetTemplateInsightsByInterval` (#12773) (@mafredri)
86+
- Database: Add FK index for `workspace_agent_scripts` (#12791) (@mafredri)
87+
- API: Abort in-progress writes/reads when closing websocket (#12650) (@ammario)
88+
- Update base image in lima/coder.yaml example, remove usage of deprecated LIMA_CIDATA (#12613) (@johnstcn)
89+
- Removed hardcoded public (#12620) (@95gabor)
90+
- API: change test to use bash script instead of binary echo (#12759) (@spikecurtis)
91+
- Dashboard: Display not found page when pagination page is invalid (#12611) (@BrunoQuaresma)
92+
- Dashboard: Fix and improve pending state on template editor UI (#12766) (@BrunoQuaresma)
93+
- Also sanitize agent environment (#12615) (@johnstcn)
94+
- Sanitize manifest for tests (#12711) (@johnstcn)
95+
96+
### Documentation
97+
98+
- Add updated architecture diagrams (#12584) (@ericpaulsen)
99+
- Describe reference architectures (#12609) (@mtojek)
100+
- Use scale testing utility (#12643) (@mtojek)
101+
- Describe Coder's operational readiness (#12723) (@mtojek)
102+
- Add guide for JFrog Xray integration (#12629) (@matifali)
103+
- Document how to run workspace-proxy as a system service (#12810) (@michaelbrewer)
104+
- Describe mutually exclusive create workspace template fields (#12834) (@Emyrk)
105+
- Describe single region and multi-region deployments (#12779) (@mtojek)
106+
- Fix coder-logstream-kube typo in deployment-logs.md (#12845) (@toshikish)
107+
- Remove phone number, we do not offer phone support yet (#12658) (@bpmct)
108+
109+
### Performance improvements
110+
111+
- Optimize `GetWorkspaceAgentAndLatestBuildByAuthToken` query (#12809) (@mafredri)
112+
113+
### Tests
114+
115+
- Apptest was accidently choosing ports in use (#12580) (@Emyrk)
116+
- Ensure `RequireActiveVersion` is actually set when testing with AGPL store (#12843) (@aslilac)
117+
- Add an E2E test for removing a group (#12844) (@aslilac)
118+
- Enable `dbrollup` service for insights tests (#12673) (@mafredri)
119+
- Fix TODO for increased accuracy in insights test (#12727) (@mafredri)
120+
- Fix template name too long in TestPatchTemplateMeta (#12781) (@mafredri)
121+
122+
Compare: [`v2.9.0...v2.10.0`](https://github.com/coder/coder/compare/v2.9.0...v2.10.0)
123+
124+
## Container image
125+
126+
- `docker pull ghcr.io/coder/coder:v2.10.0`
127+
128+
## Install/upgrade
129+
130+
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.

docs/install/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
A single CLI (`coder`) is used for both the Coder server and the client.
44

5+
We support two release channels: mainline and stable - read the
6+
[Releases](./releases.md) page to learn more about which best suits your team.
7+
58
There are several ways to install Coder. For production deployments with 50+
69
users, we recommend [installing on Kubernetes](./kubernetes.md). Otherwise, you
710
can install Coder on your local machine or on a VM:

docs/install/kubernetes.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ You'll also want to install the
77
[latest version of Coder](https://github.com/coder/coder/releases/latest)
88
locally in order to log in and manage templates.
99

10+
> Coder supports two release channels: mainline for the true latest version of
11+
> Coder, and stable for large enterprise deployments. Before installing your
12+
> control plane via Helm, please read the [Releases](./releases.md) document to
13+
> identify the best-suited release for your team, then specify the version using
14+
> Helm's `--version` flag.
15+
16+
> The version flags for both stable and mainline are automatically filled in
17+
> this page.
18+
1019
## Install Coder with Helm
1120

1221
1. Create a namespace for Coder, such as `coder`:
@@ -112,10 +121,22 @@ locally in order to log in and manage templates.
112121
113122
1. Run the following command to install the chart in your cluster.
114123

124+
For the **mainline** Coder release:
125+
126+
```shell
127+
helm install coder coder-v2/coder \
128+
--namespace coder \
129+
--values values.yaml \
130+
--version 2.10.0
131+
```
132+
133+
For the **stable** Coder release:
134+
115135
```shell
116136
helm install coder coder-v2/coder \
117137
--namespace coder \
118-
--values values.yaml
138+
--values values.yaml \
139+
--version 2.9.1
119140
```
120141

121142
You can watch Coder start up by running `kubectl get pods -n coder`. Once

docs/install/releases.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Releases
2+
3+
Coder releases are cut directly from main in our
4+
[Github](https://github.com/coder/coder) on the first Tuesday of each month.
5+
6+
We recommend enterprise customers test the compatibility of new releases with
7+
their infrastructure on a staging environment before upgrading a production
8+
deployment.
9+
10+
We support two release channels:
11+
[mainline](https://github.com/coder/coder/2.10.0) for the edge version of Coder
12+
and [stable](https://github.com/coder/coder/releases/latest) for those with
13+
lower tolerance for fault. We field our mainline releases publicly for two weeks
14+
before promoting them to stable.
15+
16+
### Mainline releases
17+
18+
- Intended for customers with a staging environment
19+
- Gives earliest access to new features
20+
- May include minor bugs
21+
- All bugfixes and security patches are supported
22+
23+
### Stable releases
24+
25+
- Safest upgrade/installation path
26+
- May not include the latest features
27+
- Security vulnerabilities and major bugfixes are supported
28+
29+
> Note: We support major security vulnerabilities (CVEs) for the past three
30+
> versions of Coder.
31+
32+
## Installing stable
33+
34+
When installing Coder, we generally advise specifying the desired version from
35+
our Github [releases page](https://github.com/coder/coder/releases).
36+
37+
You can also use our `install.sh` script with the `stable` flag to install the
38+
latest stable release:
39+
40+
```shell
41+
curl -fsSL https://coder.com/install.sh | sh -s -- --stable
42+
```
43+
44+
Best practices for installing Coder can be found on our [install](./index.md)
45+
pages.
46+
47+
## Release schedule
48+
49+
| Release name | Date | Status |
50+
| ------------ | ------------------ | ---------------- |
51+
| 2.7.0 | January 01, 2024 | Not Supported |
52+
| 2.8.0 | Februrary 06, 2024 | Security Support |
53+
| 2.9.0 | March 07, 2024 | Stable |
54+
| 2.10.0 | April 03, 2024 | Mainline |
55+
| 2.11.0 | May 07, 2024 | Not Released |
56+
| 2.12.0 | June 04, 2024 | Not Released |

0 commit comments

Comments
 (0)