Skip to Content

Helm Chart Requirements

The Detectify Internal Scanning engine can be deployed to a Kubernetes cluster using Helm.

Requirements for deploying the Internal Scanning Agent on Kubernetes are documented below.

Software Tools

Install these tools on your workstation:

ToolVersionInstallationPurpose
kubectl>= 1.29kubernetes.io Cluster management
Helm>= 3.0helm.sh App deployment
# Make sure they're installed correctly kubectl version helm version

Kubernetes Cluster

The Internal Scanner runs on Kubernetes. Your cluster needs:

RequirementMinimumRecommended
Kubernetes Version1.29+Latest stable
Nodes12+ (for HA)
CPU2 vCPU-
Memory8 Gi-
Persistent Storage8 Gi8 Gi

Persistent Volumes

Unless you intend to use an externally managed Redis, the cluster needs to support PersistentVolumeClaim to provide Redis with persistent data storage.

kubectl get storageclass # NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE # ebs-gp3 ebs.csi.eks.amazonaws.com Delete WaitForFirstConsumer true 21h # gp2 (default) kubernetes.io/aws-ebs Delete WaitForFirstConsumer false 21h

For Scanner API

If you need to interact with Internal Scanning via the REST API (i.e. not via the Detectify UI) the cluster also needs to support:

  • Ingress (e.g. nginx-ingress)
  • Certificate issuing (e.g. cert-manager)
  • DNS management (e.g. external-dns)

Network

Outbound Access

The scanner needs outbound HTTPS access to:

DestinationPortPurpose
registry.detectify.com443Pull container images
license.detectify.com443License validation
connector.detectify.com443Job polling, results reporting, etc

Detectify Credentials

You need credentials and a license key.

CredentialDescriptionUsed For
License KeyUnique identifier for your scanner instanceScanner activation
Connector API KeyAuthentication token for Detectify APIJob polling, results upload
Registry UsernameDocker registry usernamePulling container images
Registry PasswordDocker registry passwordPulling container images

Don’t have credentials? Contact your Detectify account team or reach out to us  to enable Internal Scanning.

Next Steps

Last updated on