Skip to main content
Skip table of contents

Install DKP in an Air-gapped Environment with Catalog Applications

How to run DKP in an Air-gapped installation with catalog applications.

The following explains how to run DKP on top of an air-gapped DKP cluster installation with catalog applications.

Depending on your configuration, there are three different ways you can install DKP to an air-gapped environment.
Ensure you follow the correct procedure for your configuration type, and ignore the other two sections that do not pertain to your environment:

Load the Docker images into your Docker Registry

Follow these steps:

  1. Download the DKP image bundle file:

    NONE
    curl -LJ https://downloads.d2iq.com/dkp/v2.3.3/kommander-image-bundle-v2.3.3.tar | tar -xv
  2. Download the Konvoy Docker Images.

    CODE
    curl -o konvoy-image-bundle-v2.3.3.tar -O https://downloads.d2iq.com/dkp/v2.3.3/konvoy_image_bundle_v2.3.3_linux_amd64.tar
  3. Optionally download the DKP catalog applications image bundle file:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-catalog-applications-image-bundle-v2.3.3.tar" -O && tar -xvf dkp-catalog-applications-image-bundle-v2.3.3.tar
  4. Optionally download the DKP insights image bundle file:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-insights-image-bundle-v2.3.3.tar" -O
  5. See the NOTICES.txt file for 3rd party software attributions and place the kommander-image-bundle-v2.3.3.tar and dkp-catalog-applications-image-bundle-v2.3.3.tar bundles within a location where you can load and push the images to your private Docker registry.

  6. Run the following command to load the air-gapped image bundle into your private Docker registry:

CODE
dkp push image-bundle --image-bundle kommander-image-bundle-v2.3.3.tar --to-registry <REGISTRY_URL>
dkp push image-bundle --image-bundle dkp-catalog-applications-image-bundle-v2.3.3.tar --to-registry <REGISTRY_URL>
dkp push image-bundle --image-bundle dkp-insights-image-bundle-v2.3.3.tar --to-registry <REGISTRY_URL>

Install air-gapped Kommander with the DKP Catalog Applications

Use this section to install DKP with Catalog Applications.

Prerequisites

To use the DKP Catalog Applications in an air-gapped environment, you need the following files (including downloading and pushing the dkp-insights-image-bundle file mentioned above):

  1. Download the DKP catalog application definitions:

    CODE
    curl https://downloads.d2iq.com/dkp/v2.3.3/dkp-catalog-applications-v2.3.3.tar.gz -O
  2. Download the DKP catalog applications chart bundle:

    CODE
    curl -LJ https://downloads.d2iq.com/dkp/v2.3.3/dkp-catalog-applications-charts-bundle-v2.3.3.tar.gz | tar -xvz
  3. Download the Kommander charts bundle:

    CODE
    curl -LJ https://downloads.d2iq.com/dkp/v2.3.3/dkp-kommander-charts-bundle-v2.3.3.tar.gz | tar -xvz
  4. Download the Kommander application definitions:

    CODE
    curl -O https://downloads.d2iq.com/dkp/v2.3.3/kommander-applications-v2.3.3.tar.gz
  5. Download the Containerd 1.14.13packages for the OS you plan to provision dkp on. The options for OS are listed below for replacement in the command before running:

    • centos-7.9

    • ol-7.9

    • rhel-7.9

    • rhel-8.2

    • rhel-8.4

    • sles-15.3

    • ubuntu-18.04

    • ubuntu-20.04

    CODE
    export CONTAINERD_OS=centos-7.9
    BASH
    curl --output artifacts/containerd-1.4.13-d2iq.1-"$CONTAINERD_OS"-x86_64.tar.gz --location https://packages.d2iq.com/dkp/containerd/containerd-1.4.13-d2iq.1-"$CONTAINERD_OS"-x86_64.tar.gz

    To get the fips builds append _fips after -x86_64 in the url. To get the fips build for centos-7.9 the url would be
    https://packages.d2iq.com/dkp/containerd/containerd-1.4.13-d2iq.1-centos-7.9-x86_64_fips.tar.gz

    The following OS’s have containerd fips builds:

    • centos-7.9

    • ol-7.9

    • rhel-7.9

    • rhel-8.2

    • rhel-8.4

  6. Set up the

  7. Download the Kubernetes images:

    CODE
    curl -o kib/artifacts/images/"$VERSION"_images.tar.gz -O https://downloads.d2iq.com/dkp/airgapped/kubernetes-images/"$VERSION"_images.tar.gz

Install Kommander

Follow these steps:

  1. Create the configuration file by running dkp install kommander --init --airgapped > install.yaml for the air-gapped deployment. Open the install.yaml file and review that it looks like the following:

    CODE
    apiVersion: config.kommander.mesosphere.io/v1alpha1
    kind: Installation
    airgapped:
      enabled: true
  2. In the same file, if you are installing Kommander in an AWS VPC, set the Traefik annotation to create an internal facing ELB by setting the following:

    CODE
    apps:
      traefik:
        values: |
          service:
            annotations:
              service.beta.kubernetes.io/aws-load-balancer-internal: "true"
    catalog:
      repositories:
        - name: dkp-catalog-applications
          labels:
            kommander.d2iq.io/project-default-catalog-repository: "true"
            kommander.d2iq.io/workspace-default-catalog-repository: "true"
            kommander.d2iq.io/gitapps-gitrepository-type: "dkp"
          path: ./dkp-catalog-applications.tar.gz
  3. To install DKP in your air-gapped environment using the above configuration file, run the following command:

    CODE
    dkp install kommander --installer-config ./install.yaml \
    --kommander-applications-repository kommander-applications-v2.3.3.tar.gz \
    --charts-bundle dkp-kommander-charts-bundle-v2.3.3.tar.gz \
    --charts-bundle dkp-catalog-applications-charts-bundle-v2.3.3.tar.gz
  4. Verify your installation.

Install air-gapped Kommander with DKP Insights

Use this section to install DKP with DKP Insights.

Prerequisites

If you are utilizing DKP Insights in an air-gapped environment, there are additional files in order to use the DKP Insights engine:

  1. Download the DKP Insights catalog:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-insights-v2.3.3.tar.gz" -O
  2. Download the DKP Insights chart bundle:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-insights-charts-bundle-v2.3.3.tar.gz" -O
  3. Download the Kommander charts bundle:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-kommander-charts-bundle-v2.3.3.tar.gz" -O && tar -xvf dkp-kommander-charts-bundle-v2.3.3.tar.gz
  4. Download the Kommander application definitions:

    CODE
    curl -O https://downloads.d2iq.com/dkp/v2.3.3/kommander-applications-v2.3.3.tar.gz
  5. Download the Containerd 1.14.13packages for the OS you plan to provision dkp on. The options for OS are listed below for replacement in the command before running:

    • centos-7.9

    • ol-7.9

    • rhel-7.9

    • rhel-8.2

    • rhel-8.4

    • sles-15.3

    • ubuntu-18.04

    • ubuntu-20.04

    CODE
    export CONTAINERD_OS=centos-7.9
    BASH
    curl --output artifacts/containerd-1.4.13-d2iq.1-"$CONTAINERD_OS"-x86_64.tar.gz --location https://packages.d2iq.com/dkp/containerd/containerd-1.4.13-d2iq.1-"$CONTAINERD_OS"-x86_64.tar.gz

    To get the fips builds append _fips after -x86_64 in the url. To get the fips build for centos-7.9 the url would be
    https://packages.d2iq.com/dkp/containerd/containerd-1.4.13-d2iq.1-centos-7.9-x86_64_fips.tar.gz

    The following OS’s have containerd fips builds:

    • centos-7.9

    • ol-7.9

    • rhel-7.9

    • rhel-8.2

    • rhel-8.4

  6. Download the Kubernetes images:

    CODE
    curl -o kib/artifacts/images/"$VERSION"_images.tar.gz -O https://downloads.d2iq.com/dkp/airgapped/kubernetes-images/"$VERSION"_images.tar.gz

Install Kommander

Follow these steps:

  1. Create the configuration file by running dkp install kommander --init --airgapped > install.yaml for the air-gapped deployment. Open the install.yaml file and review that it looks like the following:

    CODE
    apiVersion: config.kommander.mesosphere.io/v1alpha1
    kind: Installation
    airgapped:
      enabled: true
  2. In the same file, if you are installing Kommander in an AWS VPC, set the Traefik annotation to create an internal facing ELB by setting the following:

    CODE
    apps:
      traefik:
        values: |
          service:
            annotations:
              service.beta.kubernetes.io/aws-load-balancer-internal: "true"
    dkp-insights-management:
      enabled: true
    catalog:
      repositories:
        - name: insights-catalog-applications
          labels:
            kommander.d2iq.io/workspace-default-catalog-repository: "true"
            kommander.d2iq.io/gitapps-gitrepository-type: "dkp"
          path: ./dkp-insights-v2.3.3.tar.gz
  3. Push the DKP Insights charts bundle:

    CODE
    dkp push chart-bundle dkp-insights-charts-bundle-v2.3.3.tar.gz
  4. Install DKP with Insights enabled by running:

    CODE
    dkp install kommander --installer-config ./install.yaml \
    --kommander-applications-repository kommander-applications-v2.3.3.tar.gz \
    --charts-bundle dkp-kommander-charts-bundle-v2.3.3.tar.gz \
    --charts-bundle dkp-insights-charts-bundle-v2.3.3.tar.gz
  5. Verify your installation.

Install air-gapped Kommander with DKP Insights and DKP Catalog Applications

Use this section to install DKP with DKP Insights and Catalog Applications.

Prerequisites

Follow these steps:

  1. Download the DKP catalog application definitions:

    CODE
    curl https://downloads.d2iq.com/dkp/v2.3.3/dkp-catalog-applications-v2.3.3.tar.gz -O
  2. Download the DKP catalog applications chart bundle:

    CODE
    curl -LJ https://downloads.d2iq.com/dkp/v2.3.3/dkp-catalog-applications-charts-bundle-v2.3.3.tar.gz | tar -xvz
  3. Download the DKP Insights catalog:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-insights-v2.3.3.tar.gz" -O
  4. Download the DKP Insights chart bundle:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-insights-charts-bundle-v2.3.3.tar.gz" -O
  5. Download the Kommander charts bundle:

    CODE
    curl "https://downloads.d2iq.com/dkp/v2.3.3/dkp-kommander-charts-bundle-v2.3.3.tar.gz" -O && tar -xvf dkp-kommander-charts-bundle-v2.3.3.tar.gz
  6. Download the Kommander application definitions:

    CODE
    curl -O https://downloads.d2iq.com/dkp/v2.3.3/kommander-applications-v2.3.3.tar.gz

Install Kommander

Follow these steps:

  1. Create the configuration file by running dkp install kommander --init --airgapped > install.yaml for the air-gapped deployment. Open the install.yaml file and review that it looks like the following:

    CODE
    apiVersion: config.kommander.mesosphere.io/v1alpha1
    kind: Installation
    airgapped:
      enabled: true
  2. In the same file, if you are installing Kommander in an AWS VPC, set the Traefik annotation to create an internal facing ELB by setting the following:

    CODE
    apps:
      traefik:
        values: |
          service:
            annotations:
              service.beta.kubernetes.io/aws-load-balancer-internal: "true"
    dkp-insights-management:
      enabled: true
    catalog:
      repositories:
        - name: insights-catalog-applications
          labels:
            kommander.d2iq.io/workspace-default-catalog-repository: "true"
            kommander.d2iq.io/gitapps-gitrepository-type: "dkp"
          path: ./dkp-insights-v2.3.3.tar.gz
        - name: dkp-catalog-applications
          labels:
            kommander.d2iq.io/project-default-catalog-repository: "true"
            kommander.d2iq.io/workspace-default-catalog-repository: "true"
            kommander.d2iq.io/gitapps-gitrepository-type: "dkp"
          path: ./dkp-catalog-applications.tar.gz
  3. Follow the steps on the Configure an Enterprise catalog page to configure the DKP catalog applications.

  4. To install DKP in your air-gapped environment using the above configuration file, run the following command:

    CODE
    dkp install kommander --installer-config ./install.yaml \
    --kommander-applications-repository kommander-applications-v2.3.3.tar.gz \
    --charts-bundle dkp-kommander-charts-bundle-v2.3.3.tar.gz \
    --charts-bundle dkp-catalog-applications-charts-bundle-v2.3.3.tar.gz \
    --charts-bundle dkp-insights-charts-bundle-v2.3.3.tar.gz
  5. Verify your installation.

Useful DKP CLI Commands

Kommander Charts Bundle

The charts bundle is a gzipped tar archive containing Helm charts, which are required during Kommander installation. Create the charts bundle with the Kommander CLI or downloaded along with the DKP CLI. Execute this command to create the charts bundle:

CODE
dkp create chart-bundle

DKP creates charts-bundle.tar.gz. Optionally, specify the output using the -o parameter:

CODE
dkp create chart-bundle -o [name of the output file]

DKP Internal Helm Repository

The DKP charts bundle is pushed to DKP’s internal Helm repository. To inspect the contents:

CODE
dkp get charts

Individual charts can be removed using:

CODE
dkp delete chart [chartName] [chartVersion]

It is possible to push new charts as well:

CODE
dkp push chart [chartTarball]

Or push a new bundle:

CODE
dkp push chart-bundle [chartsTarball]

Check the built-in help text for each command for more information.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.