From 546aa831294d02c66dab7c09e4c44be242b4481c Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Wed, 22 Dec 2021 09:03:00 -0600 Subject: [PATCH 1/2] chore: undo overzealous renaming of environments to workspaces --- setup/air-gapped/index.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/setup/air-gapped/index.md b/setup/air-gapped/index.md index da6b0c5e4..2d094fd88 100644 --- a/setup/air-gapped/index.md +++ b/setup/air-gapped/index.md @@ -8,9 +8,9 @@ air-gapped deployment. To do so, you must: -- Pull all Coder deployment resources into your air-gapped workspace +- Pull all Coder deployment resources into your air-gapped environment - Push the images to your Docker registry, -- Deploy Coder from within your air-gapped workspace +- Deploy Coder from within your air-gapped environment > Coder licenses issued as part of the trial program do not support air-gapped > deployments. @@ -50,13 +50,13 @@ Throughout this article, we will suggest changes to the Helm chart that you'll obtain from the `.tgz` that's returned when you run `helm pull`. We recommend version controlling your files. -## Step 1: Pull all Coder resources into your air-gapped workspace +## Step 1: Pull all Coder resources into your air-gapped environment Coder is deployed through [helm](https://helm.sh/docs/intro/install/), and the platform images are hosted in Coder's Docker Hub repo. 1. Pull down the Coder helm charts by running the following in a non-air-gapped - workspace: + environment: ```console helm repo add coder https://helm.coder.com @@ -80,10 +80,10 @@ platform images are hosted in Coder's Docker Hub repo. [timescale](https://hub.docker.com/r/coderenvs/timescale) (**Note**: We recommend you only use timescale for evaluation purposes if you don't have an - external PostgreSQL database available. For production workspaces, we strong - recommend that you use an external PostgreSQL database; the installation - section will cover more on updating your Helm chart with your database - information.) + external PostgreSQL database available. For production environments, we + strong recommend that you use an external PostgreSQL database; the + installation section will cover more on updating your Helm chart with your + database information.) You can pull each of these images from their `coderenvs/:` registry location using the image's name and Coder version: @@ -103,14 +103,14 @@ platform images are hosted in Coder's Docker Hub repo. [ubuntu](https://hub.docker.com/_/ubuntu) - When building images for your workspaces that rely on a custom certificate + When building images for your environments that rely on a custom certificate authority, be sure to follow the [docs for adding certificates](../../images/tls-certificates#adding-certificates-for-coder) to images. 1. Tag and push all of the images that you've downloaded in the previous step to your internal registry; this registry must be accessible from your air-gapped - workspace. For example, to push `coder-service`: + environment. For example, to push `coder-service`: ```console docker tag coderenvs/coder-service: my-registry.com/coderenvs/coder-service: @@ -145,7 +145,7 @@ platform images are hosted in Coder's Docker Hub repo. ## Extensions marketplace -Coder users in an air-gapped workspace cannot access the public VS Code +Coder users in an air-gapped environment cannot access the public VS Code marketplace. However, you can point Coder to an air-gapped instance of [OpenVSX](https://github.com/eclipse/openvsx) to serve assets to users. For instructions on implementing this, see From dd8d35749b89e5dbd9ec4cef2c8f8fcd47ea0342 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Wed, 22 Dec 2021 13:34:11 -0600 Subject: [PATCH 2/2] edit text --- setup/air-gapped/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/setup/air-gapped/index.md b/setup/air-gapped/index.md index 2d094fd88..9ed9f170c 100644 --- a/setup/air-gapped/index.md +++ b/setup/air-gapped/index.md @@ -55,8 +55,8 @@ version controlling your files. Coder is deployed through [helm](https://helm.sh/docs/intro/install/), and the platform images are hosted in Coder's Docker Hub repo. -1. Pull down the Coder helm charts by running the following in a non-air-gapped - environment: +1. Download the Coder Helm charts by running the following command _outside_ of + the air-gapped environment: ```console helm repo add coder https://helm.coder.com @@ -81,8 +81,8 @@ platform images are hosted in Coder's Docker Hub repo. [timescale](https://hub.docker.com/r/coderenvs/timescale) (**Note**: We recommend you only use timescale for evaluation purposes if you don't have an external PostgreSQL database available. For production environments, we - strong recommend that you use an external PostgreSQL database; the - installation section will cover more on updating your Helm chart with your + strongly recommend that you use an external PostgreSQL database; the + installation section will cover more on updating your Helm values with your database information.) You can pull each of these images from their `coderenvs/:`