scanner

Khulnasoft Security Scanner Helm Chart

These are Helm charts for installation and maintenance of Khulnasoft Container Security Platform Scanner CLI.

Contents

• Khulnasoft Security Scanner Helm Chart
  • Contents
  • Prerequisites
    • Container Registry Credentials
    • Scanner User Credentials
  • Installing the Chart
    • Installing Khulnasoft Scanner from Github Repo
    • Installing Khulnasoft Scanner from Helm Private Repository
    • (Optional) Configure SSL communication with Khulnasoft Server
    • (Optional) Configure mTLS communication with offline Khulnasoft CyberCenter in air-gap environment
  • Configurable Variables
    • Scanner
  • Issues and feedback

Prerequisites

Container Registry Credentials

Link

Scanner User Credentials

Before installing scanner chart the recommendation is to create user with scanning permissions, Link to documentations

Installing the Chart

Follow the steps in this section for production grade deployments. You can either clone khulnasoft-helm git repo or you can add our helm private repository (https://helm.khulnasoft.com)

Installing Khulnasoft Scanner from Helm Private Repository

• Add Khulnasoft Helm Repository

helm repo add khulnasoft-helm https://helm.khulnasoft.com
helm repo update

• Check for available chart versions either from Changelog or by running the below command

helm search repo khulnasoft-helm/scanner --versions

• Install Khulnasoft

helm upgrade --install --namespace khulnasoft scanner khulnasoft-helm/scanner --set imageCredentials.username=<>,imageCredentials.password=<>,user=<>,password=<>,scannerToken=<>

(Optional) Configure SSL communication with Khulnasoft Server

To enable SSL communication from the Scanner to the Khulnasoft Server. Perform these steps:

1. enable serverSSL.enabled to true in values.yaml or use --set 'serverSSL.enabled=true' for inline argument

2. You need to encode the certificate into base64 for server.crt using this command:

   cat <file-name> | base64 | tr -d '\n'

3. Provide the certificates previously obtained in the fields of the serverSSL.serverSSLCert in values.yaml or use --set serverSSL.serverSSLCert=<cert base64 value>

(Optional) Configure mTLS communication with offline Khulnasoft CyberCenter in air-gap environment

1. To establish mTLS with offline cybercenter, create secret using the below command

kubectl create secret generic khulnasoft-grpc-scanner --from-file=<rootCA.crt> --from-file=<khulnasoft_scanner.crt> --from-file=<khulnasoft_scanner.key> -n khulnasoft

2. Enable cyberCenter.mtls.enabled to true in values.yaml
3. Add previously created secret name cyberCenter.mtls.secretName in values.yaml
4. Add respective certificate file names to cyberCenter.mtls.publicKey_fileName, cyberCenter.mtls.privateKey_fileName, cyberCenter.mtls.rootCA_fileName(Add rootCA if certs are self-signed)

KHULNASOFT_PRIVATE_KEY, KHULNASOFT_PUBLIC_KEY, KHULNASOFT_ROOT_CA(if using self-signed certs), OFFLINE_CC_MTLS_ENABLE in 003_scanner_configmap.yaml and uncomment khulnasoft-grpc-scanner certs vloumemount and volumes block from 004_scanner_deploy.yaml file before applying the kubectl commands.

Before installing scanner chart the recommendation is to create user with scanning permissions, Link to documentations

Configurable Variables

The following table lists the configurable parameters of the Console and Enforcer charts with their default values.

Scanner

Parameter	Description	Default	Mandatory
imageCredentials.create	enables to create image credentials	false	NO
imageCredentials.name	if imageCredentials.create is enabled sets imageCredentials name		NO
imageCredentials.registry	the registry that the credentials will be created for. mandatory if imageCredentials.create is enabled	registry.khulnasoft.com	NO
imageCredentials.username	the username for the registry mandatory if imageCredentials.create is enabled		NO
imageCredentials.password	the password for the registry mandatory if imageCredentials.create is enabled		NO
dockerSocket.mount	boolean parameter if to mount docker socket	unset	NO
dockerSocket.path	docker socket path	/var/run/docker.sock	NO
platform	Orchestration platform name for OpenShift deployment (use platform=openshift)	unset	NO
directCC.enabled	scanner talk to the cybercenter directly	yes	NO
serviceAccount.create	Enable to create serviceaccount if not exist in the k8s	false	NO
serviceAccount.name	K8 service-account name either existing one or new name if create is enabled	khulnasoft-sa	YES
server.scheme	scheme for server to connect	http	NO
server.serviceName	service name for server to connect	khulnasoft-console-svc	YES
server.port	service port for server to connect	8080	YES
serverSSl.enable	To establish SSL communication with Khulnasoft Server	false	NO
serverSSl.createSecret	Change to false if you're using existing server certificate secret	true	YES if serverSSl.enable is set to true
serverSSL.secretName	secret name for the SSL cert	scanner-web-cert	YES if serverSSl.enable is set to true
serverSSL.cert_file	If serverSSL createSecret enable to true, add base64 value of the the server public certificate or add filename of certificate if loading from custom secret	Nill	YES if serverSSl.enable is set to true
cyberCenter.mtls.enabled	If require secure channel communication	false	NO
cyberCenter.mtls.secretName	certificates secret name	nil	NO
cyberCenter.mtls.publicKey_fileName	filename of the public key eg: khulnasoft_scanner.crt	nil	YES if cyberCenter.mtls.enabled is set to true
cyberCenter.mtls.privateKey_fileName	filename of the private key eg: khulnasoft_scanner.key	nil	YES if cyberCenter.mtls.enabled is set to true
cyberCenter.mtls.rootCA_fileName	filename of the rootCA, if using self-signed certificates eg: rootCA.crt	nil	NO if using self-signed certificates for mTLS
image.repository	the docker image name to use	scanner	YES
image.tag	The image tag to use.	2022.4	YES
image.pullPolicy	The kubernetes image pull policy.	IfNotPresent	NO
user	scanner username	unset	YES
password	scanner password	unset	YES
nameOverride	scanner name	khulnasoft-scanner	NO
scannerUserSecret.enable	change it to true for loading scanner user, scanner password from secret	false	YES If password is not declared
scannerUserSecret.secretName	secret name for the scanner user, scanner password secret	null	YES If password is not declared
scannerUserSecret.userKey	secret key of the scanner user	null	YES If password is not declared
scannerUserSecret.passwordKey	secret key of the scanner password	null	YES If password is not declared
scannerTokenSecret.enable	change it to true for loading the scanner token from secrets	false	YES If scannerToken and username and password are not declared
scannerTokenSecret.secretName	secret name for the scanner token secret	null	YES If scannerToken and username and password are not declared
scannerTokenSecret.tokenKey	scanner token key name	null	YES If scannerToken and username and password are not declared
replicaCount	replica count	1	NO
resources	Resource requests and limits	{}	NO
nodeSelector	Kubernetes node selector	{}	NO
tolerations	Kubernetes node tolerations	[]	NO
affinity	Kubernetes node affinity	{}	NO
podAnnotations	Kubernetes pod annotations	{}	NO
extraEnvironmentVars	is a list of extra environment variables to set in the scanner deployments.	{}	NO
extraSecretEnvironmentVars	is a list of extra environment variables to set in the scanner deployments, these variables take value from existing Secret objects.	[]	NO
rbac.create	to create default cluster-role and cluster-role bindings according to the platform	true	NO
clusterRole.roleRef	cluster role reference name for cluster rolebinding	unset	NO

Issues and feedback

If you encounter any problems or would like to give us feedback on deployments, we encourage you to raise issues here on GitHub.