Core Features
Cloud Server v3.x Server v2.x This document provides a summary of differentiating features of CircleCI for Developers and Operators.
Developer features
Following are the most popular features CircleCI offers that Developers are interested in.
SSH into builds
Often the best way to troubleshoot problems is to SSH into a job and inspect things like log files, running processes, and directory paths. CircleCI gives you the option to access all jobs via SSH.
Note: When CircleCI runs your pipeline, the run command executes shell commands in a non-interactive shell. When SSH-ing into a build, you are using an interactive shell (see the section on Invocation in the bash manual for more information). An interactive bash shell loads a series of startup files (such as ~/.bash_profile), which may or may not change the outcome of SSH debugging process.
Parallelism
If your project has a large number of tests, it will need more time to run them on one machine. To reduce this time, you can run tests in parallel by spreading them across multiple machines. This requires specifying a parallelism level.
Use either the CircleCI CLI to split test files or use environment variables to configure each parallel machine individually.
Resource class
It is possible to configure CPU and RAM resources for each job, allowing for efficient use of your resources. The resource class will need to be specified in the .circleci/config.yml file.
Cache
Another popular feature is caching. Caching is one of the most effective ways to make jobs faster on CircleCI by reusing the data from expensive fetch operations from previous jobs.
Workflows
CircleCI Workflows are a great feature that can increase the speed of your software development through faster feedback, shorter reruns, and more efficient use of resources.
Operator features
These are the most frequently asked about features CircleCI offers that Operators are interested in.
Monitoring
System Administrators are able to gather metrics for monitoring their CircleCI installation for various environment variables including installed Nomad Clients and Docker metrics.
Nomad cluster
CircleCI uses Nomad as the primary job scheduler. Refer to the basic introduction to Nomad for understanding how to operate the Nomad Cluster in your CircleCI server installation.
APIs
The CircleCI API is a full-featured RESTful API that allows you to access all information and trigger all actions in CircleCI.
Basic troubleshooting
There are some initial troubleshooting steps to take if you are having problems with your CircleCI installation on your private server.
If your issue is not addressed in the above article, generate a support bundle for your installation and open a support ticket.
Insights
The Insights page in the CircleCI UI is a dashboard showing the health of all repositories you are following including median build time, median queue time, last build time, success rate, and parallelism.
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.
Need support?
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.
