Troubleshooting and support
This document describes an initial set of troubleshooting steps to take if you are experiencing problems with your CircleCI server v4.x installation. If your issue is not addressed below, you can generate a support bundle or contact your CircleCI account team.
Generate support bundle
A support bundle is used by CircleCI engineers to diagnose and fix any issues you are experiencing. They are typically requested when you open a ticket.
To generate a support bundle, follow the steps below.
First, make sure circleci-server is deployed and you have access to the cluster/namespace through kubectl.
# To check if you have access to cluster/namespace kubectl -n <namespace> get pods
Next, install krew.
Install support-bundle (kubectl plugin) to your local development machine.
# To install support-bundle plugin kubectl krew install support-bundle
Generating support bundle
When ready, run the support bundle from the current directory and wait for it to finish.
kubectl support-bundle https://raw.githubusercontent.com/CircleCI-Public/server-scripts/main/support/support-bundle.yaml
Verify pod readiness and status
| Check the |
kubectl get pods -n <namespace> NAME READY STATUS RESTARTS AGE api-service-5c8f557548-zjbsj 1/1 Running 0 6d20h audit-log-service-77c478f9d5-5dfzv 1/1 Running 0 6d20h builds-service-v1-5f8568c7f5-62h8n 1/1 Running 0 6d20h circleci-mongodb-0 1/1 Running 0 6d20h circleci-nomad-0 1/1 Running 6 6d20h …
To show only pods with a status besides
Running, you can use the
kubectl get pods --field-selector status.phase!=Running -n <namespace> NAME READY STATUS RESTARTS AGE nomad-server 0/1 Error 0 5d22h
Verify pod settings and status
To show detailed settings and status of pods, use the following command:
kubectl describe pods <pod-name> -n <namespace>
Get pod logs
To show logs of pods, use the following command:
kubectl logs <pod-name> -n <namespace>
To restart specific pods, the easiest way is remove the pod. Kubernetes automatically recreates the pod:
kubectl delete pod <pod-name> -n <name-space> --now
Help make this document better
This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.
You can also visit our support site to find support articles, community forums, and training resources.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.