Install Kommander in an air-gapped environment with catalog applications

ENTERPRISE

How to install Kommander in an air-gapped installation with catalog applications

This topic shows how to run Kommander on top of an [air-gapped Konvoy cluster][air-gap-konvoy] installation with catalog applications.

Depending on your configuration, there are three different ways you can install DKP to an air-gapped environment.

NOTE: Ensure you follow the correct procedure for your configuration type, and ignore the other two sections that do not pertain to your environment:

  • Install air-gapped Kommander with DKP Catalog Applications

  • Install air-gapped Kommander with DKP Insights

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

Load the Docker images into your Docker Registry

  1. Download the DKP image bundle file:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/kommander-image-bundle-v2.2.2.tar" -O - | tar -xvf -
    
  2. Optionally download the DKP catalog applications image bundle file:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-catalog-applications-image-bundle-v2.2.2.tar" -O - | tar -xvf -
    
  3. Optionally download the DKP insights image bundle file:

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

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

    dkp push image-bundle --image-bundle kommander-image-bundle-v2.2.2.tar --to-registry <REGISTRY_URL>
    dkp push image-bundle --image-bundle dkp-catalog-applications-image-bundle-v2.2.2.tar --to-registry <REGISTRY_URL>`
    dkp push image-bundle --image-bundle dkp-insights-image-bundle-v2.2.2.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:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-catalog-applications-v2.2.2.tar.gz"
    
  2. Download the DKP catalog applications chart bundle:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-catalog-applications-charts-bundle-v2.2.2.tar.gz" -O - | tar -xvf -
    
  3. Download the Kommander charts bundle:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-kommander-charts-bundle-v2.2.2.tar.gz" -O - | tar -xvf -
    
  4. Download the Kommander application definitions:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/kommander-applications-v2.2.2.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:

    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:

    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:

    dkp install kommander --installer-config ./install.yaml\
    --kommander-applications-repository kommander-applications-v2.2.2.tar.gz\
    --charts-bundle dkp-kommander-charts-bundle-v2.2.2.tar.gz\
    --charts-bundle dkp-catalog-applications-charts-bundle-v2.2.2.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:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-insights-v2.2.2.tar.gz"
    
  2. Download the DKP Insights chart bundle:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-insights-charts-bundle-v2.2.2.tar.gz"
    
  3. Download the Kommander charts bundle:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-kommander-charts-bundle-v2.2.2.tar.gz" -O - | tar -xvf -
    
  4. Download the Kommander application definitions:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/kommander-applications-v2.2.2.tar.gz"
    

Install Kommander

  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:

    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:

    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.2.2.tar.gz
    
  3. Push the DKP Insights charts bundle:

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

    dkp install kommander --installer-config ./install.yaml\
    --kommander-applications-repository kommander-applications-v2.2.2.tar.gz\
    --charts-bundle dkp-kommander-charts-bundle-v2.2.2.tar.gz\
    --charts-bundle dkp-insights-charts-bundle-v2.2.2.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:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-catalog-applications-v2.2.2.tar.gz"
    
  2. Download the DKP catalog applications chart bundle:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-catalog-applications-charts-bundle-v2.2.2.tar.gz" -O - | tar -xvf -
    
  3. Download the DKP Insights catalog:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-insights-v2.2.2.tar.gz"
    
  4. Download the DKP Insights chart bundle:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-insights-charts-bundle-v2.2.2.tar.gz"
    
  5. Download the Kommander charts bundle:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/dkp-kommander-charts-bundle-v2.2.2.tar.gz" -O - | tar -xvf -
    
  6. Download the Kommander application definitions:

    wget "https://downloads.d2iq.com/dkp/v2.2.2/kommander-applications-v2.2.2.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:

    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:

    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.2.2.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:

    dkp install kommander --installer-config ./install.yaml\
    --kommander-applications-repository kommander-applications-v2.2.2.tar.gz\
    --charts-bundle dkp-kommander-charts-bundle-v2.2.2.tar.gz\
    --charts-bundle dkp-catalog-applications-charts-bundle-v2.2.2.tar.gz\
    --charts-bundle dkp-insights-charts-bundle-v2.2.2.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:

dkp create chart-bundle

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

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:

dkp get charts

Individual charts can be removed using:

dkp delete chart [chartName] [chartVersion]

It is possible to push new charts as well:

dkp push chart [chartTarball]

Or push a new bundle:

dkp push chart-bundle [chartsTarball]

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