From 1c3fed808aceef34768c2231e0fabe84644930bb Mon Sep 17 00:00:00 2001 From: Brady Sullivan Date: Mon, 17 Mar 2025 13:55:11 -0700 Subject: [PATCH 1/9] docs: add AWS AMI upgrade instructions (#16937) Adds a small note for those who just used the AWS AMI for their initial installation. --- docs/install/upgrade.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index de10681adb4d9..45afaa936eb36 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -7,7 +7,8 @@ This article walks you through how to upgrade your Coder server. > Coder does not support rollbacks. To upgrade your Coder server, simply reinstall Coder using your original method -of [install](../install). +of [install](../install). If you are using the Official Coder AMI on AWS, use the +first option to upgrade. ## Via install.sh From 1b3cea0365a2381c0eaa60395e44bf16ab8f395b Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Mon, 17 Mar 2025 20:58:22 +0000 Subject: [PATCH 2/9] move sections to tabs --- docs/install/upgrade.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index 45afaa936eb36..48806f29b2896 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -6,11 +6,15 @@ This article walks you through how to upgrade your Coder server. > Prior to upgrading a production Coder deployment, take a database snapshot since > Coder does not support rollbacks. +## Reinstall Coder to upgrade + +
+ To upgrade your Coder server, simply reinstall Coder using your original method of [install](../install). If you are using the Official Coder AMI on AWS, use the first option to upgrade. -## Via install.sh +### install.sh If you installed Coder using the `install.sh` script, re-run the below command on the host: @@ -28,7 +32,7 @@ systemctl daemon-reload systemctl restart coder ``` -## Via docker-compose +### docker-compose If you installed using `docker-compose`, run the below command to upgrade the Coder container: @@ -37,12 +41,12 @@ Coder container: docker-compose pull coder && docker-compose up -d coder ``` -## Via Kubernetes +### Kubernetes See [Upgrading Coder via Helm](../install/kubernetes.md#upgrading-coder-via-helm). -## Via Windows +### Windows Download the latest Windows installer or binary from [GitHub releases](https://github.com/coder/coder/releases/latest), or upgrade @@ -51,3 +55,5 @@ from Winget. ```pwsh winget install Coder.Coder ``` + +
From b4a11bd75ffdb8113d44cb8e9697b9311753c71e Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Mon, 17 Mar 2025 21:02:52 +0000 Subject: [PATCH 3/9] add coder ami tab --- docs/install/upgrade.md | 43 +++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index 48806f29b2896..cadda6123c6fe 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -11,26 +11,23 @@ This article walks you through how to upgrade your Coder server.
To upgrade your Coder server, simply reinstall Coder using your original method -of [install](../install). If you are using the Official Coder AMI on AWS, use the -first option to upgrade. +of [install](../install). ### install.sh -If you installed Coder using the `install.sh` script, re-run the below command -on the host: +1. If you installed Coder using the `install.sh` script, re-run the below command + on the host: -```shell -curl -L https://coder.com/install.sh | sh -``` + ```shell + curl -L https://coder.com/install.sh | sh + ``` -The script will unpack the new `coder` binary version over the one currently -installed. Next, you can restart Coder with the following commands (if running -it as a system service): +1. If you're running Coder as a system service, you can restart it with `systemctl`: -```shell -systemctl daemon-reload -systemctl restart coder -``` + ```shell + systemctl daemon-reload + systemctl restart coder + ``` ### docker-compose @@ -46,6 +43,24 @@ docker-compose pull coder && docker-compose up -d coder See [Upgrading Coder via Helm](../install/kubernetes.md#upgrading-coder-via-helm). +### Coder AMI on AWS + +1. Run the Coder installation script on the host: + + ```shell + curl -L https://coder.com/install.sh | sh + ``` + + The script will unpack the new `coder` binary version over the one currently + installed. + +1. If you're running Coder as a system service, you can restart it with `systemctl`: + + ```shell + systemctl daemon-reload + systemctl restart coder + ``` + ### Windows Download the latest Windows installer or binary from From b253f6d9d62ca3dbb4666e78627e739a4c0fe549 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Mon, 17 Mar 2025 21:06:03 +0000 Subject: [PATCH 4/9] ## for tabs? --- docs/install/upgrade.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index cadda6123c6fe..081884c1b2cd0 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -13,7 +13,7 @@ This article walks you through how to upgrade your Coder server. To upgrade your Coder server, simply reinstall Coder using your original method of [install](../install). -### install.sh +## install.sh 1. If you installed Coder using the `install.sh` script, re-run the below command on the host: @@ -29,7 +29,7 @@ of [install](../install). systemctl restart coder ``` -### docker-compose +## docker-compose If you installed using `docker-compose`, run the below command to upgrade the Coder container: @@ -38,12 +38,12 @@ Coder container: docker-compose pull coder && docker-compose up -d coder ``` -### Kubernetes +## Kubernetes See [Upgrading Coder via Helm](../install/kubernetes.md#upgrading-coder-via-helm). -### Coder AMI on AWS +## Coder AMI on AWS 1. Run the Coder installation script on the host: @@ -61,7 +61,7 @@ See systemctl restart coder ``` -### Windows +## Windows Download the latest Windows installer or binary from [GitHub releases](https://github.com/coder/coder/releases/latest), or upgrade From 475da27a92b73cc811034826628a8eb7611bd8cb Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Mon, 17 Mar 2025 21:08:15 +0000 Subject: [PATCH 5/9] move default out of tabs --- docs/install/upgrade.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index 081884c1b2cd0..2293fdab86c04 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -8,12 +8,10 @@ This article walks you through how to upgrade your Coder server. ## Reinstall Coder to upgrade -
- -To upgrade your Coder server, simply reinstall Coder using your original method +To upgrade your Coder server, reinstall Coder using your original method of [install](../install). -## install.sh +### install.sh 1. If you installed Coder using the `install.sh` script, re-run the below command on the host: @@ -29,7 +27,9 @@ of [install](../install). systemctl restart coder ``` -## docker-compose +
+ +### docker-compose If you installed using `docker-compose`, run the below command to upgrade the Coder container: @@ -38,12 +38,12 @@ Coder container: docker-compose pull coder && docker-compose up -d coder ``` -## Kubernetes +### Kubernetes See [Upgrading Coder via Helm](../install/kubernetes.md#upgrading-coder-via-helm). -## Coder AMI on AWS +### Coder AMI on AWS 1. Run the Coder installation script on the host: @@ -61,7 +61,7 @@ See systemctl restart coder ``` -## Windows +### Windows Download the latest Windows installer or binary from [GitHub releases](https://github.com/coder/coder/releases/latest), or upgrade From 97799715e22b70c0f7fef0dce50c84fe4c9f5ee4 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Mon, 17 Mar 2025 21:09:43 +0000 Subject: [PATCH 6/9] s/walk through/describe --- docs/install/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index 2293fdab86c04..8e40c529ab882 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -1,6 +1,6 @@ # Upgrade -This article walks you through how to upgrade your Coder server. +This article describes how to upgrade your Coder server. > [!CAUTION] > Prior to upgrading a production Coder deployment, take a database snapshot since From 169cdf82a6798ff5ea270a723786b334b6fac308 Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Mon, 17 Mar 2025 21:22:15 +0000 Subject: [PATCH 7/9] add other methods heading --- docs/install/upgrade.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index 8e40c529ab882..262c7902457dd 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -11,7 +11,7 @@ This article describes how to upgrade your Coder server. To upgrade your Coder server, reinstall Coder using your original method of [install](../install). -### install.sh +### Coder install script 1. If you installed Coder using the `install.sh` script, re-run the below command on the host: @@ -27,6 +27,8 @@ of [install](../install). systemctl restart coder ``` +### Other methods +
### docker-compose From 9c056404c973b0ce0dc16dae2ca07404906d518c Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Tue, 18 Mar 2025 00:35:31 +0000 Subject: [PATCH 8/9] restart process --- docs/install/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index 262c7902457dd..f7b31337a8472 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -56,7 +56,7 @@ See The script will unpack the new `coder` binary version over the one currently installed. -1. If you're running Coder as a system service, you can restart it with `systemctl`: +1. Restart the Coder system process with `systemctl`: ```shell systemctl daemon-reload From dd96ccf5366e515a337dd47ce7c8247f88612c24 Mon Sep 17 00:00:00 2001 From: Edward Angert Date: Wed, 19 Mar 2025 08:42:01 -0400 Subject: [PATCH 9/9] Update docs/install/upgrade.md --- docs/install/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index f7b31337a8472..7b8b0347bda9a 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -27,7 +27,7 @@ of [install](../install). systemctl restart coder ``` -### Other methods +### Other upgrade methods