Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitb4f502a

Browse files
committed
Update specifications.md
Started with descriptions for specs
1 parentd680f2f commitb4f502a

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

‎_docs/pipelines/specifications.md‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,46 @@ toc: true
5555

5656
##.spec
5757

58-
###.spec fields
58+
{: .table .table-bordered .table-hover}
59+
| Field| Description| Type| Required/Optional|
60+
| --------------| ----------------------------|-----------| -------------------------|
61+
|`spec.scopes`| ???| string|`????'`|
62+
|`spec.scopeSnapshot`| The ID of the pipeline.| string|`????'`|
63+
|`spec.permitRestartFromFailedSteps`| Determines if users can restart a failed pipeline from the failed step, instead of from the beginning of the pipeline.<br>When set to`true`, users can restart the pipeline from the failed step. <br>See[Restarting a failed pipeline]({{site.baseurl}}/docs/pipelines/monitoring-pipelines/#restarting-the-pipeline).| boolean| Optional|
64+
|`spec.build_version`| ???| string| Optional|
65+
|`spec.triggers`| The list of Git triggers defined for the pipeline. For details, see[`spec.triggers](#spectriggers).| array| ???|
66+
|`spec.cronTriggers`| The list of Cron or timer-based triggers defined for the pipeline. For details, see[`spec.cronTriggers](#speccrontriggers).| array|`????'`|
67+
|`spec.runtimeEnvironment`| The runtime environment selected for the pipeline and its configuration settings such as memory and CPU. For details, see[`spec.runtimeEnvironments](#specruntimeenvironment).| object| Optional??|
68+
|`spec.lowMemoryWarningThreshold`| The memory-usage threshold for the pipelines build exceeding which to display banner alerts. Useful to get timely warnings and prevent build failures. <br>Can be one of the following:{::nomarkdown}<ul><li><b>WARNING</b>: Displays a banner when memory usage exceeds 70% of the available memory. </li><li><b>CRITICAL</b>: Displays a banner when memory usage exceeds 90% of the available memory. </li><li><b>REACHED_LIMIT</b>: Displays a banner when memory usage exceeds 100% of the available memory. Setting this threshold means that the pipeline build has already failed when the banner is displayed.</li> {:/}See also[Set memory usage threshold for pipeline build]({{site.baseurl}}/docs/pipelines/pipelines/#set-memory-usage-threshold-for-pipeline-build).| string| Optional|
69+
|`spec.packId`| ???| string|`????'`|
70+
|`spec.requiredAvailableStorage`| ???The minimum disk space for the pipeline’s build volume. <br> When defined, Codefresh assigns either a cached disk with sufficient disk space or a new empty disk at the start of the build. Otherwise, only the space not allocated for caching is available for the build volume. <br>See[Set minimum disk space for a pipeline build]({{site.baseurl}}/docs/pipelines/pipelines/#set-minimum-disk-space-for-a-pipeline-build). (NIMA: is there a default min and max? is it the same as the UI?)| string| Optional|
71+
|`spec.contexts`| ?? The The ID of the pipeline.| string|`????'`|
72+
|`spec.clustersInfo`| Determines if all (`injectAll`) or specific (`clusters`) Kubernetes cluster contexts are available for the pipeline build.<br>See[Select Kubernetes cluster contexts]({{site.baseurl}}/docs/pipelines/pipelines/#select-kubernetes-cluster-contexts).| object| Optional|
73+
|`spec.clustersInfo.injectAll`| When set as`true` (NIMA is this the default?), injects all clusters integrated with Codefresh into the pipeline build.| boolean| Optional|
74+
|`spec.clustersInfo.clusters`| Applicable only when`injectAll`is set to`false`.<br>One or more comma-separated names of clusters to inject during the pipeline build. For example,`aws`,`eks-prod`.| array| Optional|
75+
|`spec.variablesSchema`| The ID of the pipeline.| string|`????'`|
76+
|`spec.variables`| The ID of the pipeline.| string|`????'`|
77+
|`spec.specTemplate`| The ID of the pipeline.| string|`????'`|
78+
|`spec.steps`| The steps to be executed by the pipeline, as a list of key-values pairs.<br>See[Steps in pipelines]({{site.baseurl}}/docs/pipelines/steps/).| object| Required|
79+
|`spec.services`| The ID of the pipeline.| string|`????'`|
80+
|`spec.hooks`| The ID of the pipeline.| string|`????'`|
81+
|`spec.stages`| The ID of the pipeline.| string|`????'`|
82+
|`spec.mode`| The ID of the pipeline.| string|`????'`|
83+
|`spec.fail_fast`| The ID of the pipeline.| string|`????'`|
84+
|`spec.strict_fail_fast`| The ID of the pipeline.| string|`????'`|
85+
|`spec.success_criteria`| The ID of the pipeline.| string|`????'`|
86+
|`spec.options`| The ID of the pipeline.| string|`????'`|
87+
|`spec.concurrency`| The ID of the pipeline.| string|`????'`|
88+
|`spec.triggerConcurrency`| The ID of the pipeline.| string|`????'`|
89+
|`spec.branchConcurrency`| The ID of the pipeline.| string|`????'`|
90+
|`spec.priority`| The ID of the pipeline.| string|`????'`|
91+
|`spec.terminationPolicy`| The ID of the pipeline.| string|`????'`|
92+
|`spec.externalResources`| The ID of the pipeline.| string|`????'`|
93+
|`spec.debug`| The ID of the pipeline.| string|`????'`|
94+
|`spec.serviceAccount`| The ID of the pipeline.| string|`????'`|
95+
96+
97+
5998

6099

61100
###spec.triggers

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp