Guides, Manuals, and Tutorials Self Service Configuration Review
| Topic | Replies | Views | Activity | |
|---|---|---|---|---|
|
Overview: Self Service Configuration Review
Self Service Configuration Review What is a Configuration Review A configuration review is a service, performed by our DevOps Customer Engineers, where a project’s pipeline configuration is evaluated for improvement oppo… |
|
0 | 1008 | July 10, 2023 |
|
Configuration Review Preparation
Configuration Review Preparation 1) Select the Project Config reviews should be scoped to one project. In some cases scoping them to one larger workflow can be helpful, but some opportunities may be missed. Top 3 reason… |
|
0 | 427 | July 11, 2023 |
|
Document the Config Review
Configuration Review Preparation Document the Config Review 1) Create a Document for the Review Most organizations have more than one project on CircleCI and will most likely need to do more than one config review. Creat… |
|
0 | 346 | July 11, 2023 |
|
Review CircleCI Features
Configuration Review Preparation Review CircleCI Features 1) Look at New Features CircleCI releases features at a fast pace and there may be something new that can help your project. Check the changelog for new features … |
|
0 | 381 | July 11, 2023 |
|
Snapshot Project Metrics
Configuration Review Preparation Snapshot Project Metrics 1) Gather Project Metrics The UI can be used to gather metrics, but when doing multiple config reviews it is helpful to write a script that uses the CircleCI API.… |
|
1 | 513 | September 28, 2023 |
|
Review Each Job for Improvement Opportunities
Review Each Job for Improvement Opportunities Why Review Job by Job It is important to review a config file line by line and job by job to ensure no opportunities are missed. After gathering metrics and gathering pain po… |
|
0 | 326 | July 11, 2023 |
|
General Job Opportunities
Review Each Job for Improvement Opportunities General Job Opportunities 1) Review Step Outputs Review each step’s output to ensure it is completing as expected. This is important because steps can silently fail or not wo… |
|
0 | 384 | July 11, 2023 |
|
Execution Environment Opportunities
Review Each Job for Improvement Opportunities Execution Environment Opportunities 1) Resource Allocation Optimizing the resource classes of your jobs is an easy way to ensure credits aren’t being wasted. Each job has a r… |
|
0 | 343 | July 11, 2023 |
|
Opportunities for Jobs with High Duration
Review Each Job for Improvement Opportunities Opportunities for Jobs with High Duration 1) Resource Allocation Optimizing the resource classes of your jobs is an easy way to attempt to reduce the duration of a job. Each … |
|
0 | 392 | July 11, 2023 |
|
Review Each Workflow for Improvement Opportunities
Review Each Workflow for Improvement Opportunities 1) Review Job Placement Job order can be the largest impact on workflow duration. Review the workflow for opportunities to run jobs in parallel and note which jobs are b… |
|
0 | 348 | July 11, 2023 |
|
High Level Improvement Opportunities
High Level Improvement Opportunities Record High Level Recommendations High level recommendations are identified opportunities that affect more than one workflow. These opportunities typically exist throughout the organi… |
|
0 | 356 | July 11, 2023 |
|
Inside a Config File: Config Security Opportunities
Inside a Config File Config Security Opportunities 1) OIDC OIDC tokens are available in any job and is a great way to replace static credentials used to connect with cloud services. For example, a Vault instance in AWS. … |
|
0 | 415 | July 11, 2023 |
|
Inside a Config File: Reusable Config Opportunities
Inside a Config File Reusable Config Opportunities 1) Config SDK CircleCI config files are written in YAML but that doens’t mean they have to be built using YAML. The Config SDK is a javascript/typescript SDK that can be… |
|
0 | 514 | July 11, 2023 |
|
Inside a Config File: Dynamic Configuration
Inside a Config File Dynamic Configuration Why Dynamic Config Dynamic configuration is an easy way to not have to run a full pipeline when it’s not needed, saving credits and time. Most projects can benefit from dynamic … |
|
0 | 582 | July 11, 2023 |
|
Outside a Config File: Security Settings
Outside a Config File Security Settings Project Settings Review project settings to ensure they are set correctly, this can be done via the UI or API. Confirm that the following Advanced settings are toggled off unless … |
|
0 | 453 | July 11, 2023 |
|
Outside a Config File: Secrets Management
Outside a Config File Secrets Management OIDC Attempt to replace any static credentials used in CircleCI for connection to cloud environments with authentication using OIDC tokens. This is not available for all tools so … |
|
0 | 556 | July 11, 2023 |
|
Outside a Config File: Storage Usage
Outside a Config File Storage Usage Caching Inspect the output of caching steps in jobs to ensure cache keys are regularly being found. If not, consider changing the cache key to be less specific or use a fallback key. F… |
|
0 | 451 | July 11, 2023 |
|
Outside a Config File: Project Settings
Outside a Config File Project Settings Security Review project settings to ensure they are set correctly, this can be done via the UI or API. Confirm that the following Advanced settings are toggled off unless needed fo… |
|
0 | 388 | July 11, 2023 |
|
Finalize the Config Review
Finalize the Config Review Document Opportunities Document opportunities as they are found throughout the review. You will most likely find yourself referencing all sorts of documentation both internal and external in th… |
|
0 | 403 | July 11, 2023 |