Skip to content

Commit 8aa1e60

Browse files
authored
Add note on max concurrency recomendation (#791)
Added note on max concurrency recommendation per runtime env for classic pipelines
1 parent 6d6973b commit 8aa1e60

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

_docs/pipelines/monitoring-pipelines.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ max-width="80%"
2828

2929
In addition, the [Pipelines Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/#pipelines-dashboard) serves as a centralized location to track pipelines performance by KPIs.
3030

31+
32+
## Concurrency recommendation per Runtime Environment
33+
34+
Concurrency limits control the number of simultaneous builds for Codefresh pipelines. Concurrency limits are set at both the account and specific pipeline levels.
35+
36+
**Balancing concurrency and performance**
37+
While a single Runtime Environment technically supports concurrent build executions in the hundreds, it is essential to be aware of the actual number of concurrent builds that are initiated at the same point in time. To prevent potential slowdowns due to extremely large build-bursts, we recommend capping the number of concurrent builds initiated for a Runtime Environment to a maximum of 500.
38+
39+
40+
3141
## Starring projects and pipelines as favorites
3242

3343
Mark frequently used or high-priority pipelines as favorites in the Projects and Pipelines pages. This allows for easy and quick access to important projects or pipelines.

_docs/pipelines/pipelines.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,8 @@ Once you create your pipeline you can also click on the top tab called *Settings
206206

207207

208208
- **Pipeline Concurrency**: The maximum number of concurrent builds (0-14 or unlimited). Set the concurrency when your pipeline has only one trigger.
209-
> A Pipeline Concurrency of **0** freezes execution of the pipeline, switching it to maintenance mode. Use this concurrency setting to modify existing pipelines and freeze execution until you complete the changes.
209+
> **TIP**:
210+
A Pipeline Concurrency of **0** freezes execution of the pipeline, switching it to maintenance mode. Use this concurrency setting to modify existing pipelines and freeze execution until you complete the changes.
210211
- **Trigger Concurrency**: The maximum number of concurrent builds per trigger (1-15 or unlimited). Define the trigger concurrency when your pipeline has multiple triggers.
211212
- **Branch Concurrency**: The maximum number of concurrent builds per branch (1-15 or unlimited). Define this when your pipeline can build different branches.
212213
- **Build Termination**: Options that determine when a build from the pipeline should terminate:
@@ -275,12 +276,23 @@ max-width="60%"
275276

276277
The **Pipeline and Trigger Concurrency** limits are very important as they allow you to define how many instances of a pipeline can run in parallel when multiple commits or multiple pull requests take place.
277278

278-
> Notice that these limits are *unrelated* to [parallelism within a single pipeline]({{site.baseurl}}/docs/pipelines/advanced-workflows/).
279+
280+
**Balancing concurrency and performance**
281+
While a single Runtime Environment technically supports concurrent build executions in the hundreds, it is essential to be aware of the actual number of concurrent builds that are initiated at the same point in time. To prevent potential slowdowns due to extremely large build-bursts, we recommend capping the number of concurrent builds initiated for a Runtime Environment to a maximum of 500.
282+
283+
> **NOTE**:
284+
Pipeline and trigger concurrency limits are *unrelated* to [parallelism within a single pipeline]({{site.baseurl}}/docs/pipelines/advanced-workflows/).
279285

280286
Some common scenarios are:
281287

282288
* a pipeline that uses a shared resource such as a database or queue and you want to limit how many pipelines can access it
283-
* a pipeline that deploys to a single production environment (in most cases you only want one active pipeline touching production
289+
* a pipeline that deploys to a single production environment (in most cases you only want one active pipeline touching production)
290+
291+
**Concurrency recommendation per Runtime Environment**
292+
293+
Concurrency limits control the number of simultaneous builds for Codefresh pipelines. Concurrency limits are set at both the account and specific pipeline levels.
294+
295+
284296

285297
#### Build termination
286298
The **Build Termination** settings are useful for pipelines where you commit too fast (i.e. faster then the actual runtime of the pipeline).

0 commit comments

Comments
 (0)