CircleCI Logo
Navigation Menu Icon

Phase 1 - Prerequisites

Language Icon 1 month ago
Server 4.9 Server Admin
Contribute Go to Code

The guides in this section walk you through the steps required to install CircleCI Server in an air-gapped environment.

Required components for air-gapped installation

The following table shows an overview of the prerequisites required to run an air-gapped CircleCI Server installation. These items must be present in your air-gapped environment in order to move forward with the installation.

Component Used for

Container registry

Hosting CircleCI Server images for Kubernetes

A Kubernetes cluster

Running CircleCI Server

An object storage system (MinIO)

Object and artifact storage

GitHub Enterprise

Source of code for CircleCI Server to build

Nomad Virtual Machines

Machines for running Nomad

1. Copy images

CircleCI Server is deployed into a Kubernetes cluster using a Helm chart. You will need to copy the latest images and charts from CircleCI into your virtual environment. All images referenced in the CircleCI Helm chart must be accessible within your air-gapped environment.

a. Log in to CircleCI Server container registry

Access to the images you need for your installation requires you to use a username and token, which will be provided by CircleCI. Access the CircleCI support portal for more information.

docker login cciserver.azurecr.io --username <your-circleci-provided-username> --password <your-circleci-provided-token>

b. Download all images required for this release

Download all images required for the release of CircleCI Server to your local machine. This list contains all required images for the Helm installation, the CircleCI Agent, and the Reality Check testing tool.

  1. Download the script to a convenient location:

    curl -fsSL https://raw.githubusercontent.com/CircleCI-Public/server-scripts/main/air-gap/extract-images-from-helm-chart.sh -o extract-images-from-helm-chart.sh

  2. Fetch the Helm chart for inspection:

    helm fetch oci://cciserver.azurecr.io/circleci-server --version 4.9.0 --untar

  3. Extract images to images.txt:

    bash ./extract-images-from-helm-chart.sh ./circleci-server images.txt

  4. Pull all images to your local machine:

    while read -r image; do docker pull "$image"; done < images.txt

c. Copy all images to your air-gapped environment

Copy all downloaded images to the container registry in your air-gapped environment.

2. Copy charts

Copy the CircleCI Server Helm chart to your air-gapped environment.

a. Download the latest CircleCI Server Helm chart

Download the latest CircleCI Server Helm chart to the current directory.

helm registry login cciserver.azurecr.io
helm pull oci://cciserver.azurecr.io/circleci-server -d ./

b. Copy the Helm chart to your air-gapped environment

Copy the downloaded .tgz Helm chart to your air-gapped environment.

Next steps

Once the steps on this page are complete, go to the Phase 2 - Configure Object Storage guide.