> For the complete documentation index, see [llms.txt](https://docs-v3.toucantoco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-v3.toucantoco.com/self-hosted-toucan/getting-started/air-gapped.md). # Deploy Toucan in Air-Gapped Environment In this section, we will deploy Toucan in an air-gapped environment using Helm Charts. We'll assume this configuration: * Traffic is only exposed internally: * The machine can only be contacted through private networks (VPC or VPN). * The machine cannot be reached from the internet and is stricly blocked by the firewall. * A **Private DNS** is configured to forward `toucan.example.com` to the machine IP. This guide assumes a strict air-gapped environment: * At first, you have a networked environment. You have access to the internet and can download files to put on a USB stick. * Then, you deploy the Toucan Stack on your air-gapped environment. {% hint style="danger" %} **NOTE**: This guide helps you deploy a simple "one-shot" "all-in-one" Toucan Stack, which might not be suitable for production. We **heavily** recommend in using an external PostgreSQL database as the one embedded might not be suitable for production. Please follow the following guide to connect to your external database: [Toucan - External Database](/self-hosted-toucan/configuration/external-database.md) {% endhint %} ## Description and additional requirements This guide does NOT cover the deployment of Kubernetes in an Air-Gapped environment. If you are interested, we recommend you to read the [k3s - Air-Gap Install](https://docs.k3s.io/installation/airgap) guide. We recommend using the Private Registry method. In this guide, we plan to follow that method: 1. In a networked environment, you have access to the internet and will download files. 2. In an air-gapped environment, you have no access to the internet and will need to put these files on Kubernetes: 1. Helm Charts will be hosted on the deployment server containing the tools for installing the Toucan Stack. 2. The Docker images will be hosted on a local registry. 3. The deployment will use that local registry to pull the images. Therefore, you will need: * A storage to transfer files from the networked environment to the air-gapped environment. Recommended size is 10GB. * After uploading the container images in the local registry, container layers will be uncompressed. The registry will requires at least the double. ## Preparations in the networked environment ### 1. Download the Private Registry If you are using minikube, k3s, or another Kubernetes distribution, it's very possible there is already a private registry, or a way to load container images directly on the container runtime. You should check the documentation of your Kubernetes distribution. If not, in this guide, we'll install [registry](https://hub.docker.com/_/registry) as a private registry. 1. Download the container image:

docker pull "docker.io/library/registry:2"
   docker save "docker.io/library/registry:2" | gzip > "registry-2.tar.gz"

### 2. Download Toucan-Stack 1. Download the Helm Chart

helm pull oci://quay.io/toucantoco/charts/toucan-stack

2. Download the container images:

helm template toucan-stack oci://quay.io/toucantoco/charts/toucan-stack --skip-tests | grep 'image:' | awk '{print $2}' | sort | uniq | while read image; do
     image=$(echo "$image" | sed 's/"//g' | sed "s/'//g")
     docker pull "$image"
   done

You should have every files required for the air-gapped installation! ## Installation in the air-gapped environment ### 1. Deploy the Private Registry Since there is no registry to host the container registry image (chicken-egg problem), we need to deploy a private registry manually. 1. Transfer the registry container image file directly on the Kubernetes node.

scp ./registry-2.tar.gz root@<node-ip>:registry-2.tar.gz

If you are in a multi-node setup, you should do this for all the nodes. Since the registry requires a volume, it is better to stick the registry to a single node using `nodeSelectors` and use a `local-path`/`hostPath` volume. 2. Import the image in the container runtime:

gunzip registry-2.tar.gz

   # containerd
   ctr --namespace k8s.io image import registry-2.tar

   # OR, docker
   docker load -i registry-2.tar

You might need to pass --address to ctr since some distributions move the containerd.sock:

Minikube: /run/docker/containerd/containerd.sock (docker runtime)
k0s: /run/k0s/containerd.sock

3. Deploy the registry using Kubectl:

kubectl apply -f - <<EOF
     apiVersion: v1
     kind: Service
     metadata:
       name: registry-nodeport-service
       labels:
         app: docker-registry
     spec:
       type: NodePort
       selector:
         app: docker-registry
       ports:
         - name: registry-port
           port: 5000
           targetPort: 5000
           nodePort: 32000  # Port 32000 exposed on the node
     ---
     apiVersion: apps/v1
     kind: StatefulSet
     metadata:
       name: registry
     spec:
       serviceName: "registry-nodeport-service"
       replicas: 1
       selector:
         matchLabels:
           app: docker-registry
       template:
         metadata:
           labels:
             app: docker-registry
         spec:
           # Stick the registry to a single node
           nodeSelector:
             kubernetes.io/hostname: node-0
           containers:
           - name: registry
             image: docker.io/library/registry:2
             imagePullPolicy: Never # Air-gapped
             ports:
             - containerPort: 5000
               name: registry-port
             volumeMounts:
             - name: registry-data
               mountPath: /var/lib/registry
       volumeClaimTemplates:
       - metadata:
           name: registry-data
         spec:
           accessModes: [ "ReadWriteOnce" ]
           storageClassName: "local-path"
           resources:
             requests:
               storage: 10Gi
     EOF

### 2. Transfer the images to the Private Registry 1. Edit the `/etc/docker/daemon.json` to indicates that `:32000` is not secured by TLS:

{
     "insecure-registries": ["<node-0 ip>:32000"]
   }

And run:

sudo systemctl restart docker

2. Using the images you've pulled from earlier steps, tag them to the private registry:

docker tag <registry>/<repo>/<image>:<tag> <node-0 ip>:32000/<repo>/<image>:<tag>

If you don't remember which images you've pulled, you can use the following command to push all the images to the private registry:

remove_registry_hostname() {
     image_name="$1"
     slash_count=$(echo "$image_name" | grep -o "/" | wc -l)

   if \[ "$slash\_count" -ge 2 ]; then
   echo "$image\_name" | cut -d '/' -f2-
   else
   echo "$image\_name"
   fi
   }

   helm template toucan-stack ./toucan-stack\*.tgz --skip-tests | grep 'image:' | awk '{print $2}' | sort | uniq | while read image; do
   image=$(echo "$image" | sed 's/"//g' | sed "s/'//g")
   docker tag "$image" "\:32000/$(remove\_registry\_hostname "$image")"
   docker push "\:32000/$(remove\_registry\_hostname "$image")"
   done

Replace \ with the IP address of the node where you've deployed the registry.

### 3. Deploy Toucan Stack {% stepper %} {% step %} #### Create a namespace Create a Kubernetes namespace to deploy the Toucan Stack Helm charts in. {% code title="shell: /work/" overflow="wrap" %} ```shell kubectl create namespace toucan ``` {% endcode %} Namespaces are used to avoid name conflicts between different projects. Since we are deploying a stack of services, we can use the same namespace for all of them, and avoid conflicting with your own projects. {% endstep %} {% step %} #### Deploy the Helm charts Since we are using Helm, we can patch the necessary values to inject the credentials and secrets. We also need to expose the service to the external network and secure it with TLS. 1. Create the values file, which will override the default values.

touch values.override.yaml # You can name it whatever you want

2. (optional) For strict air-gapped environments, assuming you have transferred the container images to your air-gapped container registry, add these lines to `values.override.yaml` override the registry:

global:
     imageRegistry: 'localhost:32000'
     security:
       allowInsecureImages: true

   # Gotenberg doesn't use global.imageRegistry
   gotenberg:
     image:
       repository: localhost:32000/gotenberg/gotenberg

3. Add this line to select your storage provisioner:

global:
     # ...
     defaultStorageClass: local-path
   # ...

You can fetch the available storage classes with:

kubectl get storageclass

You should see something like this:

NAME                 PROVISIONER             RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
   local-path           rancher.io/local-path   Delete          WaitForFirstConsumer   false                  121d

4. (Optional) Override the volume size:

# ...
   laputa:
     persistence:
       size: 10Gi

   keycloak:
     persistence:
       size: 8Gi

   postgresql:
     primary:
       persistence:
         size: 10Gi

   mongodb:
     persistence:
       size: 8Gi

   garage:
     persistence:
       meta:
         size: 8Gi
       data:
         size: 8Gi

NOTE: This is only useful if you are using a storage provisioner which handles "sizing". The local-path-provisioner does NOT! So these values doesn't mean anything, but many cloud provider and block storage provisioners do.

5. Configure TLS for the Toucan Stack:

SUGGESTION: We recommend using cert-manager to issue TLS certificates, which is able to rotatecertificates on a regular basis.

You can also use external-secrets, to fetch TLS certificates from a secretmanager like AWS Secrets Manager, Hashicorp Vault, etc.

Create these files:

apiVersion: v1
   kind: Secret
   metadata:
     name: toucan.example.com-tls
   stringData:
     tls.crt: |
       -----BEGIN CERTIFICATE-----
       ...
       -----END CERTIFICATE-----
     tls.key: |
       -----BEGIN RSA PRIVATE KEY-----
       ...
       -----END RSA PRIVATE KEY-----
     ca.crt: |
       -----BEGIN CERTIFICATE-----
       ...
       -----END CERTIFICATE-----
   type: kubernetes.io/tls

Deploy the certificates with:

kubectl apply -n <namespace> -f tls-secret.yaml

6. Expose the Toucan Stack by adding these lines:

global:
     # ...

     ## global.hostname configures the helm chart to use toucan.example.com as "public" domain.
     hostname: toucan.example.com

   canopee:
     ingress:
       enabled: true
       ingressClassName: nginx
       tls: true
       extraTls:
         - hosts:
             - toucan.example.com
           secretName: 'toucan.example.com-tls' # This secret will be generated.

Annotations are used by controllers like cert-manager to trigger side effects.

7. At this point, your `values.override.yaml` should looks like (minus the volume size overrides): {% code title="yaml: /work/values.override.yaml" %} ```yaml global: imageRegistry: 'localhost:32000' security: allowInsecureImages: true imagePullSecrets: - dockerconfigjson defaultStorageClass: local-path hostname: toucan.example.com canopee: ingress: enabled: true ingressClassName: nginx annotations: cert-manager.io/cluster-issuer: private-cluster-issuer tls: true gotenberg: image: repository: localhost:32000/gotenberg/gotenberg ``` {% endcode %} 11. Deploy the Toucan Stack: {% code title="shell: /work/" overflow="wrap" %} ```shell helm upgrade --install toucan-stack ./toucan-stack*.tgz \ --namespace toucan \ --values ./values.override.yaml ``` {% endcode %} {% hint style="info" %} If the installation fails with: {% code title="shell: /work/" overflow="wrap" %} ```shell Error: INSTALLATION FAILED: failed post-install: 1 error occurred: * timed out waiting for the condition ``` {% endcode %} You should check the health of the deployment. Use `kubectl get -n toucan` to check the status of the deployment. And use `kubectl logs -c -n toucan` to check the logs of the deployment. We **highly recommend** using a Kubernetes GUI for troubleshooting like for example [Headlamp](https://headlamp.dev). {% endhint %} 12. To get the Admin password, run the following command: {% code title="shell: /work/" overflow="wrap" %} ```shell kubectl get secret --namespace toucan toucan-stack-auth -o jsonpath='{.data.toucan-admin-password}' | base64 --decode ``` {% endcode %} 13. You should be able to access the Toucan Stack at and login with the admin credentials. Enter `admin@example.com` for the username and the password you got from the previous step. {% endstep %} {% endstepper %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs-v3.toucantoco.com/self-hosted-toucan/getting-started/air-gapped.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.