Setting Up Air-Gapped Deployments

If you need increased security for your Coder deployments, you can set up an air-gapped deployment.

Coder licenses issued as part of the trial program do not support air-gapped deployments.

To set up an air-gapped deployment, you must:

1. Pull all Coder deployment resources into your air-gapped environment
2. Push the images to your Docker registry,
3. Deploy Coder from within your air-gapped environment

Dependencies

Before proceeding, please ensure that you've installed the following dependencies:

• kubectl
• helm

Step 1: Pull all Coder resources into your air-gapped environment

Coder is deployed through helm, and the platform images are hosted in Coder's Docker Hub repo.

1a. Pull the helm Charts

Pull down the Coder helm charts by running the following in a non-air-gapped environment:

helm repo add coder https://helm.coder.com
helm pull coder/coder

These commands will add Coder's helm charts and pull the latest stable release into a tarball file whose name uses the following format: coder-X.Y.Z.tgz (X.Y.Z is the release number).

1b. Pull the Images

Pull the images for the Coder platform from the following Docker Hub locations:

• https://hub.docker.com/r/coderenvs/coder-service
• https://hub.docker.com/r/coderenvs/envbuilder
• https://hub.docker.com/r/coderenvs/dockerd
• https://hub.docker.com/r/coderenvs/timescale
• https://hub.docker.com/r/coderenvs/dashboard

You can pull each of these images from their coderenvs/<img-name>:<coder-version> registry location using the image's name and Coder version:

docker pull coderenvs/coder-service:1.11.0

Step 2: Push the images to your Docker registry

After you download the images, tag and push them to your internal Docker registry (this registry must be accessible from your air-gapped environment):

docker tag coderenvs/coder-service:1.11.0 my-registry.example.com/coderenvs/coder-service:1.11.0
docker push my-registry.example.com/coderenvs/coder-service:1.11.0

Step 3: Deploy Coder from within your air-gapped environment

Once all of the resources are in your air-gapped network, run the following to deploy Coder to your Kubernetes cluster:

kubectl create namespace coder
helm --namespace coder install coder /path/to/coder-X.Y.Z.tgz \
--set cemanager.image=my-registry.example.com/coderenvs/coder-service:1.11.0 \
--set envproxy.image=my-registry.example.com/coderenvs/coder-service:1.11.0 \
--set envbuilder.image=my-registry.example.com/coderenvs/envbuilder:1.11.0 \
--set timescale.image=my-registry.example.com/coderenvs/timescale:1.11.0 \
--set dockerd.image=my-registry.example.com/coderenvs/dockerd:1.11.0 \
--set envmetrics.image=my-registry.example.com/coderenvs/coder-service:1.11.0

Next, follow the Installation guide beginning with step 6 to get the access URL and the temporary admin password, which allows you to proceed with setting up and configuring Coder.

Extensions Marketplace

You can configure your deployment to use the internal, built-in extension marketplace, allowing your developers to utilize whitelisted IDE extensions within your air-gapped environment. For additional details, see Extensions.