Skip to main content
Version: v2.3

Deploy a custom ThreatMapper Console

You should first build the management console and push the images to a suitable repository. You can then adapt the standard installation instructions (Docker, Kubernetes) to refer to your custom images rather than the Deepfence-provided ones.

Installing and Running the Management Console on a Docker Host​

tip

Refer to the Docker Installation Instructions along with the modifications below.

  1. Download the file docker-compose.yml to the system that will host the Console

    wget https://github.com/deepfence/ThreatMapper/raw/release-2.3/deployment-scripts/docker-compose.yml

  2. Execute the following command to install and start the Console. Note the override to specify your repository myorg, rather than the deepfenceio default:

    ACC=myorg             # the name of the dockerhub account 
    docker login -u $ACC  # log in to the account
    IMAGE_REPOSITORY=$ACC docker-compose -f docker-compose.yml up --detach

Installing and Running the Management Console in a Kubernetes Cluster​

tip

Refer to the Kubernetes Installation Instructions along with the modifications below.

  1. Prepare the cluster, installing the storage driver and metrics service

    Follow the instructions to install the OpenEBS storage and metrics server: Installation Instructions

  2. Install your Management Console

    We will install the Management Console using the helm chart, but overriding the repository source for the images:

    helm repo add deepfence https://deepfence-helm-charts.s3.amazonaws.com/threatmapper
    helm repo update

    # Create the values file
    helm show values deepfence/deepfence-console --version 2.3.1 > deepfence_console_values.yaml

    Edit the deepfence_console_values.yaml file, replacing the image: repository: value to point to your repository, and making any other changes as needed.

    Install the management console:

    helm install -f deepfence_console_values.yaml deepfence-console deepfence/deepfence-console --version 2.3.1

    Full instructions can be found in the Console helm chart documentation.

  3. Optional: enable external access with the deepfence-router package:

    Refer to the instructions to install the Router, typically as follows:

    # Create the values file
    helm show values deepfence/deepfence-router --version 2.3.1 > deepfence_router_values.yaml

    Edit the deepfence_router_values.yaml file, replacing the image: repository: value to point to your repository, and making any other changes as needed.

    helm install -f deepfence_router_values.yaml deepfence-router deepfence/deepfence-router --version 2.3.1