Skip to content

chore: update change log to v2.10.0 and install docs for release channels #12863

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 9 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
make fmt
  • Loading branch information
stirby committed Apr 3, 2024
commit afae242b94fb9f20bed9b2dd7cd8fcdf929a2367
7 changes: 1 addition & 6 deletions docs/changelogs/v2.10.0.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@


## Changelog

> [!NOTE]
> 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 how we release in our [docs](../install/releases.md).


### BREAKING CHANGES

- Removed `max_ttl` from templates (#12644) (@Emyrk)
Expand Down Expand Up @@ -53,7 +50,7 @@
- CLI: Clean template destination path for `pull` (#12559) (@dannykopping)
- Agent: Ensure agent token is from latest build in middleware (#12443) (@f0ssel)
- CLI: Handle CLI default organization when none exists in <v2.9.0 coderd (#12594) (@Emyrk)
- Server: Separate signals for passive, active, and forced shutdown (#12358) (@kylecarbs)
- Server: Separate signals for passive, active, and forced shutdown (#12358) (@kylecarbs)
- Docs: Correct typo error about minTerraformVersion (#12621) (@garylavayou)
- Docs: Correct troubleshooting links (#12608) (@dannykopping)
- Server: Prevent single replica proxies from staying unhealthy (#12641) (@deansheather)
Expand Down Expand Up @@ -112,7 +109,6 @@
- Fix TODO for increased accuracy in insights test (#12727) (@mafredri)
- Fix template name too long in TestPatchTemplateMeta (#12781) (@mafredri)


Compare: [`v2.9.0...v2.10.0`](https://github.com/coder/coder/compare/v2.9.0...v2.10.0)

## Container image
Expand All @@ -122,4 +118,3 @@ Compare: [`v2.9.0...v2.10.0`](https://github.com/coder/coder/compare/v2.9.0...v2
## Install/upgrade

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.

3 changes: 2 additions & 1 deletion docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

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

We support two release channels: mainline and stable - read the [Releases](./releases.md) page to learn more about which best suits your team.
We support two release channels: mainline and stable - read the
[Releases](./releases.md) page to learn more about which best suits your team.

There are several ways to install Coder. For production deployments with 50+
users, we recommend [installing on Kubernetes](./kubernetes.md). Otherwise, you
Expand Down
37 changes: 21 additions & 16 deletions docs/install/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,14 @@ You'll also want to install the
[latest version of Coder](https://github.com/coder/coder/releases/latest)
locally in order to log in and manage templates.

> Coder supports two release channels: mainline for the true latest version of Coder, and stable for large enterprise deployments. Before installing your control plane via Helm, please read the [Releases](./releases.md) document to identify the best-suited release for your team, then specify the version using Helm's `--version` flag.
> Coder supports two release channels: mainline for the true latest version of
> Coder, and stable for large enterprise deployments. Before installing your
> control plane via Helm, please read the [Releases](./releases.md) document to
> identify the best-suited release for your team, then specify the version using
> Helm's `--version` flag.

> The version flags for both stable and mainline are automatically filled in this page.
> The version flags for both stable and mainline are automatically filled in
> this page.

## Install Coder with Helm

Expand Down Expand Up @@ -116,23 +121,23 @@ locally in order to log in and manage templates.

1. Run the following command to install the chart in your cluster.

For the **mainline** Coder release:
For the **mainline** Coder release:

```shell
helm install coder coder-v2/coder \
--namespace coder \
--values values.yaml \
--version 2.10.0
```
```shell
helm install coder coder-v2/coder \
--namespace coder \
--values values.yaml \
--version 2.10.0
```

For the **stable** Coder release:
For the **stable** Coder release:

```shell
helm install coder coder-v2/coder \
--namespace coder \
--values values.yaml \
--version 2.9.1
```
```shell
helm install coder coder-v2/coder \
--namespace coder \
--values values.yaml \
--version 2.9.1
```

You can watch Coder start up by running `kubectl get pods -n coder`. Once
Coder has started, the `coder-*` pods should enter the `Running` state.
Expand Down
29 changes: 18 additions & 11 deletions docs/install/releases.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@




# Releases

Coder releases are cut directly from main in our [Github](https://github.com/coder/coder) on the first Tuesday of each month.
Coder releases are cut directly from main in our
[Github](https://github.com/coder/coder) on the first Tuesday of each month.

We recommend enterprise customers test the compatibility of new releases with their infrastructure on a staging environment before upgrading a production deployment.
We recommend enterprise customers test the compatibility of new releases with
their infrastructure on a staging environment before upgrading a production
deployment.

We support two release channels: [mainline](https://github.com/coder/coder/2.10.0) for the edge version of Coder and [stable](https://github.com/coder/coder/releases/latest) for those with lower tolerance for fault. We field our mainline releases publicly for two weeks before promoting them to stable.
We support two release channels:
[mainline](https://github.com/coder/coder/2.10.0) for the edge version of Coder
and [stable](https://github.com/coder/coder/releases/latest) for those with
lower tolerance for fault. We field our mainline releases publicly for two weeks
before promoting them to stable.

### Mainline releases

Expand All @@ -23,19 +26,23 @@ We support two release channels: [mainline](https://github.com/coder/coder/2.10.
- May not include the latest features
- Security vulnerabilities and major bugfixes are supported

> Note: We support major security vulnerabilities (CVEs) for the past three versions of Coder.
> Note: We support major security vulnerabilities (CVEs) for the past three
> versions of Coder.

## Installing stable

When installing Coder, we generally advise specifying the desired version from our Github [releases page](https://github.com/coder/coder/releases).
When installing Coder, we generally advise specifying the desired version from
our Github [releases page](https://github.com/coder/coder/releases).

You can also use our `install.sh` script with the `stable` flag to install the latest stable release:
You can also use our `install.sh` script with the `stable` flag to install the
latest stable release:

```shell
curl -fsSL https://coder.com/install.sh | sh -s -- --stable
```

Best practices for installing Coder can be found on our [install](./index.md) pages.
Best practices for installing Coder can be found on our [install](./index.md)
pages.

## Release schedule

Expand Down