Deploying Deepfactor Portal in a Kubernetes Cluster Follow

DeepFactor provides several ways of deploying the DeepFactor Portal on premises.

The following article describes how to deploy DeepFactor portal in your Kubernetes cluster including Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), Google Kubernetes Engine (GKE), and Rancher.

Note: Before you start the deployment, check the prerequisites for Kubernetes Cluster in Prerequisites for installing DeepFactor Portal.

Deploy DeepFactor Using Helm v3

1. Add the DeepFactor helm charts repo using the following commands.

helm repo add deepfactor https://static.deepfactor.io/helm-charts

Verify that the repo was successfully added by running the following command:

$ helm repo ls 

You should see the following output:

NAME deepfactor
URL http://staging-df-helm-charts.s3-website-us-west-2.amazonaws.com 

$ helm search repo -l deepfactor

2. Run the following command to update the Helm repo to the latest charts. This step is not required if you have just added the Helm repo the first time.

$ helm repo update 

3. You can now install DeepFactor Helm charts. You will need to supply an override.yaml file to the helm install command. This file can be used to customize the DeepFactor portal deployment. At a minimum, you must provide the following parameters:

Use a portalToken by logging into my.deepfactor.io.

Create a file override.yaml and paste the following into it:

# dfstartup values 

dfstartup: config: 
firstName: "<admin-first-name>" 
lastName: "<admin-last-name>" 
emailID: "<admin-email-id>" 
ttlDays: "<ttl-days>" 
portalToken: "<admin-portal-token>" 
password: <password> 

ingress: 
 hostName: <portal-endpoint> 

appsettings: 
 numberOfConcurrentWebScansAllowed: <max-number-of-concurrent-web-scans-allowed>

 $ helm install df-stable deepfactor/deepfactor -f override.yaml --namespace=deepfactor 

You should see the following output:

NAME: beta LAST DEPLOYED: Mon Apr 5 16:17:08 2021 
NAMESPACE: deepfactor 
STATUS: deployed 
REVISION: 1 
TEST SUITE: None 
NOTES: The DeepFactor portal has been installed check its status by running: $ kubectl get pods -n deepfactor

df-stable is the release name. You can provide a different string if you would like.

5. Execute the following command to get the public IP of the portal.

$ kubectl get svc -n deepfactor
 ... beta-ingress-nginx-controller LoadBalancer 10.100.43.157 abcdefghijklmnopq-545188163.us-east-2.elb.amazonaws.com 80:32013/TCP,443:30366/TCP,8443:30520/TCP 7m30s ...

Find the df-stable-ingress-nginx-controller service, copy the long DNS string, and set a DNS record to point <deepfactor_portal_hostname> to this domain (either using an ALIAS record in AWS or an A record).

You can now access the DeepFactor portal at <deepfactor_portal_hostname> and log in to the portal using the emailID and password entered in the override.yaml.

Uninstalling DeepFactor Portal

Run the following command to uninstall the portal:

$ helm uninstall df-stable --namespace=deepfactor

Delete the postgres and clickhouse pvc to free up the space. Note that you will lose all the telemetry and alerts data.

$ kubectl get pvc --namespace=deepfactor 
$ kubectl delete pvc <postgres-pvc-name> <clickhouse-pvc-name> <archivestore-pvc-name><symbolsvc-pvc-name> --namespace=deepfactor
$ kubectl get secrets -n deepfactor 
$ kubectl delete secrets regcred deepfactor-certs <ingress-secret-name> -n deepfactor