This article reviews how to perform a completely offline, or "air-gapped", installation of the Stoplight platform.
If you haven't already, be sure to read through either the Kubernetes or Embedded installation guides before continuing. This article assumes you already have met the required dependencies and are familiar with the installation process.
You'll need the following items before continuing:
- A Stoplight license file
- A Stoplight offline installation bundle
- Read and write credentials for a container registry, which will be used for storing Stoplight-related container images
If you are a Stoplight customer and do not have either the license or bundle file mentioned above, please contact email@example.com.
Installing the kubectl Plugin
Stoplight requires the kots kubectl plugin to be installed in order to manage the Stoplight installation and licensing system. If you do not have kots installed already, you can do so by running the following command:
curl https://kots.io/install | bash
The command above will pull the necessary dependencies and install them into your local kubectl configuration. If you would prefer to do this manually, you can download the binaries directly here.
Note that kubectl must be installed prior to running the command above. It is recommended that the kots plugin be installed anywhere with access to your Kubernetes cluster.
Once installed, you can verify that the kots plugin is accessible by using the following command:
kubectl kots --help
Once kots is installed, proceed with the setup process below.
Running the Admin Interface
Once the kubectl plugin has been installed, it is time to deploy the admin interface into your Kubernetes cluster. In a fully offline environment, you will first need to push the container images into your container registry in order for them to be installed into the cluster. You can download the latest image in tarball format here.
Once downloaded, you can push them to your registry using a command similar to the one below:
kubectl kots admin-console push-images ./kotsadm.tar.gz private.registry.host/application-name \
--registry-username rw-username \
Once the image has been added to the registry, run the following command to deploy the admin interface to the cluster:
kubectl kots install \ --kotsadm-registry private.registry.host/application-name \ --registry-username ro-username \ --registry-password ro-password \ application-name
Once the service is running, a local proxy should be started on http://localhost:8800 which can be used to access the interface and complete the setup.
Uploading the Offline Bundle
With the admin service up and running, choose the "Install in airgapped environment" option to install Stoplight into your environment. This process involves providing connection details and credentials to your container registry, and then uploading the offline bundle provided by Stoplight.
Once the upload is completed, you can now proceed with the installation using the typical installation guides below: