Kubescape Operator

The Kubescape Operator is the central orchestration engine for Kubescape's in-cluster components. It coordinates security scanning operations, manages scheduled tasks, and provides a REST API for triggering actions across your Kubernetes cluster.

---

Table of Contents

• Why Use the Operator?
• Architecture
• Quick Start
• Installation
  • Using Helm (Recommended)
  • Running Locally for Development
• Configuration
  • Configuration Files
  • Environment Variables
  • Configuration Defaults
• API Documentation
• API Examples
  • Kubescape Configuration Scans
  • Vulnerability Scans
  • Registry Scans
• Private Registry Authentication
• Features
  • Continuous Scanning
  • Admission Controller
• Development
  • Building from Source
  • VS Code Configuration
• Troubleshooting
• Contributing
• License

---

Why Use the Operator?

The Kubescape Operator provides:

• 🔄 Centralized Orchestration - Single control plane for all Kubescape in-cluster security operations
• 🕐 Scheduled Scanning - CronJob-based recurring security and vulnerability scans
• 🔍 Continuous Monitoring - Real-time detection of configuration changes with automatic rescanning
• 🛡️ Admission Control - Validate workloads against security policies before deployment
• 📡 REST API - Programmatic access to trigger scans and manage security operations
• 🔗 Component Integration - Seamlessly coordinates Kubescape, Kubevuln, and other in-cluster components

---

Architecture

┌─────────────────────────────────────────────────────────────────────────────┐
│                              Kubernetes Cluster                              │
├─────────────────────────────────────────────────────────────────────────────┤
│                                                                              │
│   ┌──────────────────────────────────────────────────────────────────────┐  │
│   │                        kubescape namespace                            │  │
│   │                                                                       │  │
│   │  ┌─────────────┐     REST API      ┌─────────────────────────────┐   │  │
│   │  │   Client    │ ─────────────────▶│       OPERATOR              │   │  │
│   │  │  (kubectl,  │    :4002          │                             │   │  │
│   │  │   curl)     │                   │  • Command Processing       │   │  │
│   │  └─────────────┘                   │  • CronJob Management       │   │  │
│   │                                    │  • Continuous Scanning      │   │  │
│   │                                    │  • Admission Controller     │   │  │
│   │                                    └──────────┬──────────────────┘   │  │
│   │                                               │                       │  │
│   │                    ┌──────────────────────────┼──────────────────┐   │  │
│   │                    │                          │                  │   │  │
│   │                    ▼                          ▼                  ▼   │  │
│   │           ┌────────────────┐      ┌────────────────┐    ┌──────────┐│  │
│   │           │   Kubescape    │      │    Kubevuln    │    │ Storage  ││  │
│   │           │                │      │                │    │          ││  │
│   │           │ Config Scans   │      │ Vuln Scans     │    │ Results  ││  │
│   │           └────────────────┘      └────────────────┘    └──────────┘│  │
│   │                                                                       │  │
│   └──────────────────────────────────────────────────────────────────────┘  │
│                                                                              │
└─────────────────────────────────────────────────────────────────────────────┘

---

Quick Start

Get Kubescape with the Operator running in under 5 minutes:

# 1. Add the Kubescape Helm repository
helm repo add kubescape https://kubescape.github.io/helm-charts/
helm repo update

# 2. Install Kubescape with all components
helm upgrade --install kubescape kubescape/kubescape-operator \
  -n kubescape --create-namespace \
  --set clusterName="my-cluster"

# 3. Verify the Operator is running
kubectl get pods -n kubescape -l app.kubernetes.io/name=operator

# 4. Trigger a configuration scan via port-forward
kubectl port-forward -n kubescape svc/operator 4002:4002 &

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "kubescapeScan",
      "args": {
        "scanV1": {
          "submit": true
        }
      }
    }]
  }'

Expected output:

{"commands":[{"commandName":"kubescapeScan",...}]}

---

Installation

Using Helm (Recommended)

The Kubescape Operator is deployed as part of the Kubescape Helm chart. Visit the Kubescape Helm Charts repository for detailed installation options.

# Basic installation
helm upgrade --install kubescape kubescape/kubescape-operator \
  -n kubescape --create-namespace \
  --set clusterName="my-cluster"

# With cloud connection (for Kubescape Cloud users)
helm upgrade --install kubescape kubescape/kubescape-operator \
  -n kubescape --create-namespace \
  --set clusterName="my-cluster" \
  --set account="your-account-id" \
  --set accessKey="your-access-key"

Running Locally for Development

For development or testing, you can run the Operator locally:

Prerequisites

• A running Kubernetes cluster (minikube, kind, etc.)
• kubectl configured to access your cluster
• Go 1.24+ installed

Steps

1. Install Kubescape in-cluster components:

   helm upgrade --install kubescape kubescape/kubescape-operator \
     -n kubescape --create-namespace \
     --set operator.enabled=false  # We'll run it locally

2. Port-forward the required services:

   kubectl port-forward -n kubescape service/kubescape 8080:8080 &
   kubectl port-forward -n kubescape service/kubevuln 8081:8080 &

3. Create configuration files (see Configuration Files section)

4. Build and run:

   go build -o operator .
   ./operator

---

Configuration

Configuration Files

The Operator reads configuration from /etc/config/. When running locally, set the CONFIG environment variable to point to your config directory.

/etc/config/clusterData.json - Cluster connection settings

{
  "gatewayWebsocketURL": "",
  "gatewayRestURL": "",
  "kubevulnURL": "127.0.0.1:8081",
  "kubescapeURL": "127.0.0.1:8080",
  "accountID": "your-account-id",
  "clusterName": "my-cluster"
}

/etc/config/config.json - Operator settings

{
  "namespace": "kubescape",
  "port": "4002",
  "cleanupDelay": 600000000000,
  "workerConcurrency": 3,
  "triggerSecurityFramework": false,
  "matchingRulesFilename": "/etc/config/matchingRules.json",
  "excludeNamespaces": "kube-system,kubescape",
  "excludeNamespacesRegex": "",
  "includeNamespaces": "",
  "includeNamespacesRegex": ""
}

/etc/config/capabilities.json - Feature toggles

{
  "capabilities": {
    "configurationScan": "enable",
    "continuousScan": "disable",
    "nodeScan": "enable",
    "vulnerabilityScan": "enable",
    "relevancy": "enable",
    "networkGenerator": "disable",
    "runtimeObservability": "disable",
    "nodeSbomGeneration": "disable",
    "seccomp": "disable",
    "otel": "enable",
    "admissionController": "disable"
  },
  "components": {
    "operator": { "enabled": true },
    "kubescape": { "enabled": true },
    "kubescapeScheduler": { "enabled": true },
    "kubevuln": { "enabled": true },
    "kubevulnScheduler": { "enabled": true },
    "nodeAgent": { "enabled": true },
    "hostScanner": { "enabled": true },
    "storage": { "enabled": true },
    "otelCollector": { "enabled": true },
    "serviceDiscovery": { "enabled": true }
  },
  "configurations": {
    "persistence": "enable",
    "server": {
      "account": null,
      "discoveryUrl": "https://api.kubescape.io"
    }
  }
}

/etc/config/matchingRules.json - Continuous scanning filters (optional)

{
  "match": [
    {
      "apiGroups": ["apps"],
      "apiVersions": ["v1"],
      "resources": ["deployments", "daemonsets", "statefulsets"]
    },
    {
      "apiGroups": [""],
      "apiVersions": ["v1"],
      "resources": ["pods"]
    }
  ],
  "namespaces": ["default", "production"]
}

Environment Variables

Variable	Description	Default
CONFIG	Path to cluster configuration file	/etc/config/clusterData.json
SERVICES	Path to services configuration file	/etc/config/services.json
OTEL_COLLECTOR_SVC	OpenTelemetry collector address (e.g., otel-collector:4317)	not set
RELEASE	Image version for logging	set at build time
NODE_NAME	Kubernetes node name (from downward API)	set by Kubernetes
KS_SKIP_UPDATE_CHECK	Set to true on the Operator container to suppress its daily report	not set

Configuration Defaults

Setting	Default Value	Description
namespace	kubescape	Namespace for Kubescape components
port	4002	REST API port
cleanupDelay	10m	Interval for cleanup routines
workerConcurrency	3	Number of concurrent workers
triggerSecurityFramework	false	Trigger security framework on startup
eventDeduplicationInterval	2m	Interval to deduplicate continuous scan events
podScanGuardTime	1h	Minimum pod age before scanning (for orphan pods)
registryScanningSkipTlsVerify	false	Skip TLS verification for registry scanning
registryScanningInsecure	false	Allow insecure registry connections
includeNamespaces	""	Comma-separated string or array of exact namespaces to include
includeNamespacesRegex	""	Comma-separated string or array of RE2 regex patterns for namespaces to include
excludeNamespaces	"kube-system,kubescape"	Comma-separated string or array of exact namespaces to exclude
excludeNamespacesRegex	""	Comma-separated string or array of RE2 regex patterns for namespaces to exclude
namespaceFilterConfigMapName	""	Optional ConfigMap name in the operator namespace for live namespace filtering

Namespace Filtering (Exact & Regex)

The Operator supports filtering namespaces using exact names (includeNamespaces, excludeNamespaces) and RE2 regular expressions (includeNamespacesRegex, excludeNamespacesRegex):

• Precedence (Allow-List): If either includeNamespaces or includeNamespacesRegex is configured, inclusion mode is active. Only namespaces matching an exact entry in includeNamespaces OR a regex in includeNamespacesRegex will be processed. All other namespaces are skipped, and excludeNamespaces / excludeNamespacesRegex are ignored.
• Exclusion (Deny-List): When no inclusion rules are set, any namespace matching an exact entry in excludeNamespaces OR a regex in excludeNamespacesRegex will be skipped.
• Anchoring & Blast Radius:

  [!WARNING] Unanchored regex patterns match as substrings anywhere within the namespace name. For example, an unanchored pattern team- matches team-prod, team-staging, and my-team-dev. To match exact prefixes, suffixes, or full namespace names, anchor the patterns using ^ and $, such as ^team-.*-prod$.

• RE2 Limitations: Patterns use Go's standard regexp engine (RE2), which runs in guaranteed linear time (immune to ReDoS). Features like backreferences (\1), lookaheads ((?=...)), and lookbehinds ((?<=...)) are not supported. Invalid patterns fail fast with a clear error when configuration is loaded.
• Commas in Patterns: If a regex pattern contains commas (for example, quantifiers like {1,3} or character classes like [a,b]), provide the configuration as a JSON array (["^team-[a,b]-.*$"]) rather than a comma-separated string to prevent splitting.

Live namespace filtering

To enable live updates, set "namespaceFilterConfigMapName": "namespace-filters" in the operator's startup config.json. An empty name keeps startup-only filtering and requires no additional permissions. Enabling this option initially requires deploying the updated operator configuration; subsequent filter edits do not.

Create the ConfigMap in the same namespace as the operator (kubescape below):

apiVersion: v1
kind: ConfigMap
metadata:
  name: namespace-filters
  namespace: kubescape
data:
  namespaceFilters.json: |
    {
      "includeNamespaces": [],
      "excludeNamespaces": ["kube-system", "kubescape"],
      "includeNamespacesRegex": [],
      "excludeNamespacesRegex": []
    }

Grant the operator service account permission to list and watch this ConfigMap. The watcher includes a metadata.name field selector, allowing a Role restricted to this resource name. Replace the service account name below with the one used by your operator Deployment.

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: operator-namespace-filters
  namespace: kubescape
rules:
  - apiGroups: [""]
    resources: ["configmaps"]
    resourceNames: ["namespace-filters"]
    verbs: ["list", "watch"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: operator-namespace-filters
  namespace: kubescape
subjects:
  - kind: ServiceAccount
    name: operator
    namespace: kubescape
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: operator-namespace-filters

Edit namespaceFilters.json with kubectl -n kubescape edit configmap namespace-filters. Each valid document replaces all namespace filters together. includeNamespaces and excludeNamespaces are required; omitted regex fields become empty lists. Values accept comma-separated strings or arrays of strings. Empty lists allow all namespaces, and inclusion rules still take precedence over exclusions. Malformed JSON, unknown fields, wrong value types (including null), and invalid regex are rejected without changing the active rules. Other operator settings remain startup-only.

When enabled, the operator waits for the first valid document before starting scan processing or reporting ready. Missing data and API/RBAC failures leave it waiting; correct the ConfigMap or permissions to let startup continue. After a valid document has loaded, invalid updates, ConfigMap deletion, or API outages retain the last valid rules. The informer reconnects automatically and accepts valid updates or a recreated ConfigMap. Applied changes are logged as namespace filters updated.

Updates affect subsequent namespace checks and queued work when it is processed. They do not cancel dispatched scans, trigger rescans of existing workloads, clear deduplication state, or delete existing results. Newly allowed namespaces become eligible on their next event or request, subject to existing deduplication. Findings and remediation paths that already use the operator's namespace filter also see the new rules. SBOM scan dispatch checks the resolved workload namespace, not the namespace where an SBOM is stored.

This uses the Kubernetes API directly, so it does not depend on ConfigMap volume refresh or the chart's existing subPath mounts. Helm wiring and live filtering inside other components are separate changes: this feature only partially addresses helm-charts#664. Cluster-wide requests forwarded to downstream scanners and registry-only scans retain their existing behavior.

Smoke test in a test cluster

1. Create the ConfigMap and RBAC above, and start an operator built with this feature and namespaceFilterConfigMapName configured. Record its pod UID and restart count with kubectl -n kubescape get pod <operator-pod> -o json.
2. Create a workload in payments and trigger the relevant scan event/request. Confirm the operator dispatches the scan.
3. Add payments to excludeNamespaces, leaving inclusion lists empty. Wait for the applied-update log, then generate a new workload event/request and confirm no scan is dispatched for it.
4. Remove payments and generate a fresh event/request (use a new workload to avoid deduplication). Confirm scanning resumes.
5. Submit an invalid regex and confirm the rejection log and unchanged filtering. Restore valid JSON. Check that the operator pod UID and restart count match step 1 throughout these edits.

---

API Documentation

The Operator provides an HTTP REST API on port 4002 (configurable).

Interactive API documentation is available at:

UI	Endpoint
SwaggerUI	/openapi/v2/swaggerui
RapiDoc	/openapi/v2/rapi
Redoc	/openapi/v2/docs

Access via port-forward:

kubectl port-forward -n kubescape svc/operator 4002:4002
# Then open: http://localhost:4002/openapi/v2/swaggerui

---

API Examples

All examples assume you have port-forwarded the Operator:

kubectl port-forward -n kubescape svc/operator 4002:4002 &

Kubescape Configuration Scans

Trigger a Kubescape scan (all frameworks)

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "kubescapeScan",
      "args": {
        "scanV1": {
          "submit": true
        }
      }
    }]
  }'

Trigger a scan for specific frameworks

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "kubescapeScan",
      "args": {
        "scanV1": {
          "submit": true,
          "targetType": "framework",
          "targetNames": ["nsa", "mitre"]
        }
      }
    }]
  }'

Create a scheduled Kubescape scan (CronJob)

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "setKubescapeCronJob",
      "args": {
        "kubescapeJobParams": {
          "cronTabSchedule": "0 0 * * *"
        },
        "scanV1": {
          "submit": true,
          "targetType": "framework",
          "targetNames": ["nsa"]
        }
      }
    }]
  }'

Update a scheduled Kubescape scan

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "updateKubescapeCronJob",
      "args": {
        "kubescapeJobParams": {
          "cronTabSchedule": "0 6 * * *",
          "name": "kubescape-scheduler"
        }
      }
    }]
  }'

Delete a scheduled Kubescape scan

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "deleteKubescapeCronJob",
      "args": {
        "kubescapeJobParams": {
          "name": "kubescape-scheduler"
        }
      }
    }]
  }'

Vulnerability Scans

Trigger an image vulnerability scan

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "scan",
      "wlid": "wlid://cluster-my-cluster/namespace-default/deployment-nginx"
    }]
  }'

Create a scheduled vulnerability scan (CronJob)

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "setVulnScanCronJob",
      "wlid": "wlid://cluster-my-cluster/namespace-default",
      "args": {
        "jobParams": {
          "cronTabSchedule": "0 2 * * *"
        }
      }
    }]
  }'

Update a scheduled vulnerability scan

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "updateVulnScanCronJob",
      "args": {
        "jobParams": {
          "cronTabSchedule": "0 4 * * *",
          "name": "vuln-scan-scheduled-123456789"
        }
      }
    }]
  }'

Delete a scheduled vulnerability scan

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "deleteVulnScanCronJob",
      "args": {
        "jobParams": {
          "name": "vuln-scan-scheduled-123456789"
        }
      }
    }]
  }'

Registry Scans

Scan a container registry

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "scanRegistry",
      "args": {
        "registryInfo-v1": {
          "registryName": "ghcr.io/kubescape",
          "registryProvider": "ghcr.io",
          "depth": 1,
          "kind": "ghcr.io",
          "isHTTPS": true,
          "skipTLSVerify": false,
          "authMethod": {
            "type": "public"
          }
        }
      }
    }]
  }'

Create a scheduled registry scan (CronJob)

curl -X POST http://localhost:4002/v1/triggerAction \
  -H 'Content-Type: application/json' \
  -d '{
    "commands": [{
      "commandName": "setRegistryScanCronJob",
      "args": {
        "jobParams": {
          "cronTabSchedule": "0 0 * * *"
        },
        "registryInfo-v1": {
          "registryName": "ghcr.io/kubescape",
          "registryProvider": "ghcr.io",
          "depth": 1,
          "kind": "ghcr.io",
          "isHTTPS": true,
          "skipTLSVerify": false,
          "authMethod": {
            "type": "public"
          }
        }
      }
    }]
  }'

---

Private Registry Authentication

To scan images from private container registries, create a Kubernetes Secret with your credentials.

Step 1: Create base64-encoded credentials

echo -n 'registry.example.com' | base64
# Output: cmVnaXN0cnkuZXhhbXBsZS5jb20=

echo -n 'myusername' | base64
# Output: bXl1c2VybmFtZQ==

echo -n 'mypassword' | base64
# Output: bXlwYXNzd29yZA==

Step 2: Create the Secret

Create a file named registry-secret.yaml:

apiVersion: v1
kind: Secret
metadata:
  name: my-registry-credentials
  namespace: kubescape
  labels:
    kubescape.io/registry: creds
type: Opaque
data:
  registry: cmVnaXN0cnkuZXhhbXBsZS5jb20=   # registry.example.com
  username: bXl1c2VybmFtZQ==                # myusername
  password: bXlwYXNzd29yZA==                # mypassword

Apply the secret:

kubectl apply -f registry-secret.yaml

Step 3: Automatic Discovery

Kubescape automatically discovers secrets with the label kubescape.io/registry=creds in the kubescape namespace and uses them for registry authentication during image scans.

Note: The registry field should contain the registry hostname without the http:// or https:// prefix.

---

Features

Continuous Scanning

When enabled, the Operator watches for changes to Kubernetes resources and automatically triggers rescans when configurations change.

Enable via Helm:

helm upgrade kubescape kubescape/kubescape-operator \
  -n kubescape \
  --set capabilities.continuousScan=enable

Configure matching rules to specify which resources to watch:

{
  "match": [
    {
      "apiGroups": ["apps"],
      "apiVersions": ["v1"],
      "resources": ["deployments"]
    }
  ],
  "namespaces": ["default", "production"]
}

Admission Controller

The admission controller validates workloads against security policies before they are admitted to the cluster.

Enable via Helm:

helm upgrade kubescape kubescape/kubescape-operator \
  -n kubescape \
  --set capabilities.admissionController=enable

When enabled, the Operator runs an HTTPS webhook server on port 8443 that integrates with Kubernetes admission control.

---

Development

Building from Source

# Clone the repository
git clone https://github.com/kubescape/operator.git
cd operator

# Build
go build -o operator .

# Build for Linux (cross-compile)
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o operator .

# Build Docker image
make docker-build TAG=dev

VS Code Configuration

.vscode/launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch Operator",
      "type": "go",
      "request": "launch",
      "mode": "auto",
      "program": "${workspaceRoot}",
      "env": {
        "CONFIG": "${workspaceRoot}/.vscode/clusterData.json"
      },
      "args": ["-alsologtostderr", "-v=4"]
    }
  ]
}

.vscode/clusterData.json

{
  "kubevulnURL": "127.0.0.1:8081",
  "kubescapeURL": "127.0.0.1:8080",
  "accountID": "",
  "clusterName": "dev-cluster"
}

Remember to port-forward the required services:

kubectl port-forward -n kubescape service/kubescape 8080:8080 &
kubectl port-forward -n kubescape service/kubevuln 8081:8080 &

Generating Swagger Documentation

go generate ./...

This updates docs/swagger.yaml with the latest API specification.

---

Troubleshooting

Common Issues

Operator pod is not starting

Check the pod logs:

kubectl logs -n kubescape -l app.kubernetes.io/name=operator

Common causes:

• Missing ConfigMaps (kubescape-config, kubescape-capabilities)
• Unable to connect to Kubernetes API server
• Invalid configuration files

Scans are not being triggered

1. Verify the Operator is running:

   kubectl get pods -n kubescape -l app.kubernetes.io/name=operator

2. Check that Kubescape/Kubevuln services are accessible:

   kubectl get svc -n kubescape

3. Check Operator logs for errors:

   kubectl logs -n kubescape -l app.kubernetes.io/name=operator --tail=100

REST API returns errors

1. Ensure you're using the correct port (default: 4002)
2. Verify the request body matches the expected schema (see API Documentation)
3. Check that the target components (Kubescape, Kubevuln) are enabled in capabilities

Continuous scanning not working

1. Verify continuous scanning is enabled:

   kubectl get configmap -n kubescape kubescape-capabilities -o yaml | grep continuousScan

2. Check that matchingRules.json is properly configured

3. Verify the watched namespaces contain the expected resources

Debug Mode

Enable debug logging by setting the log level:

kubectl set env deployment/operator -n kubescape LOG_LEVEL=debug

When debug mode is enabled, a pprof server starts on port 6060 for profiling.

Getting Help

• 📖 Kubescape Documentation
• 💬 Slack Community
• 🐛 GitHub Issues

---

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

• Code of Conduct
• Governance
• Security Policy

---

License

Copyright 2021-2024 Kubescape Authors

Licensed under the Apache License, Version 2.0. See LICENSE for the full license text.