Troubleshooting and FAQs
DeepSource Enterprise has a built-in troubleshooting tool. On the admin console, click on the Troubleshoot tab, and you can download a support bundle. By default this will run through a series of prebuilt analyzers to help identify potential issues. If you’re unable to remediate the issue you can deliver the support bundle to our support team, we can help identify any problems with your DeepSource Enterprise installation.
Below are some of the general issues faced and their relevant steps for quick troubleshooting:
- The spinner keeps on spinning when the first analysis is performed
It is highly likely that the node selector labels haven't been set, and thus the analysis pods haven't been scheduled onto the nodes. To investigate this run
kubectl describe pod <pod-name> -n atlas-jobs, where
<pod-name> can be fetched by running
kubectl get pods -n atlas-jobs. Running the former command will return information about the pod. At the last section of the output, you will see something like as shown below
Type Reason Age From Message ---- ------ ---- ---- ------- Normal Created 20m (x352 over 7d7h) kubelet, gke-... Created container ... Normal Started 20m (x352 over 7d7h) kubelet, gke-... Started container ... Normal Pulled 20m (x351 over 7d7h) kubelet, gke-... Container image "..." already present on machine
In the case of missing labels, the output will notify you that it wasn't able to match any node selectors. To fix this, run
kubectl label nodes <node-name> A=B where
A=B is your label key pair which you had entered in the admin console during installation.
- Repositories are not visible when attempting to sync
This can be attributed to misconfiguration in the admin console. To fix this, recreate a new GitHub app private key and upload the same to the admin console, and then redeploy.
- Unable to view logs for some of the pods
This clearly indicates a firewall issue between the nodes (or VMs), as the CNI (Container Networking Interface) requires the pods to be resolvable with each other over the overlay network across all the nodes. When a firewall is blocking the network, pods from one node or for that matter, the Kubernetes master node, isn't able to communicate with the pods on the other node. To resolve this, please refer to this resource.
- All the pods are pending for more than a minute when running
kubectl get pods
You will need to add the node selector labels which you had entered in the admin console onto the nodes. Please refer to this resource.
- Logging in for the first time shows
Social Login Failure
Please make sure all the configuration values in the GitHub/GitLab app are appropriately entered. An incorrect value usually results in this error.
- Can I use the same app for Autofix configuration in the admin console?
No, currently we do not support a singleton app for serving both the analysis and Autofix requests.
- Can I use a top level load balancer for routing requests to the deployment?
Yes, you can.
- Are backups supported?
Yes, backups are supported as Velero snapshots. Refer to this resource to create snapshots.
- I have used self-signed certificates for deployment, do I need to change any other configuration?
Yes, you will need to disable TLS verification from your GitHub app. Note that GitLab does not support TLS verification.
For Enterprise deployments, our team is available to help you answer any questions/suggestions/bugs at email@example.com. To assist the customer's team, if needed, we setup a shared Slack channel where DeepSource's engineering team hangs out.