Skip to content

chore: undo overzealous renaming of environments to workspaces #765

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 2 commits into from
Dec 22, 2021
Merged
Changes from all commits
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
24 changes: 12 additions & 12 deletions setup/air-gapped/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
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
Expand All @@ -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
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/<img-name>:<version>`
registry location using the image's name and Coder version:
Expand All @@ -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:<version> my-registry.com/coderenvs/coder-service:<version>
Expand Down Expand Up @@ -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
Expand Down