You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
|`metadata.id`| The ID of the pipeline.| string|`????'`|
32
+
|`metadata.id`| The ID of the pipeline.| string|Optional|
29
33
|`metadata.name`| The full path to the pipeline, including the name of the project to which the pipeline belongs, in the format`project_name/pipeline_name`.| string| Required|
30
34
|`metadata.shortName`| The name of the pipeline ???.| string| Optional|
31
35
|`metadata.revision`| The ???.| integer| Optional|
32
-
|`metadata.isPublic`| Determines if public logs are enabled or disabled for the pipeline. By default, public logs are disabled.<br>When set to`true`, clicking the build badge allows all users with access to the pipeline to also view the build logs, even if they are not logged into Codefresh. See[Public build logs]({{site.baseurl}}//docs/pipelines/configuration/build-status/#public-build-logs).| boolean| Optional|
36
+
|`metadata.isPublic`| Determines if public logs are enabled or disabled for the pipeline. By default, public logs are disabled.<br>When set to`true`, clicking the build badge allows all users with access to the pipeline to also view the build logs, even if they are not logged into Codefresh. See[Public build logs]({{site.baseurl}}//docs/pipelines/configuration/build-status/#public-build-logs).| boolean| Optional|
33
37
|`metadata.description`| A meaningful description of the pipeline. (NIMA: is there a a max limit)| string| Optional|
34
38
|`metadata.labels`| The parent object for`metadata.labelKeys` defining the`tags` assigned to the pipeline. ????| object| Optional|
35
-
|`metadata.labelKeys`| The tags ????/ is this the same as`tags`? A list of[access control tags]({{site.baseurl}}/docs/administration/account-user-management/access-control/#marking-pipelines-with-policy-attributes) for this pipeline||string| Optional|
39
+
|`metadata.labelKeys`| The tags ????/ is this the same as`tags`? A list of[access control tags]({{site.baseurl}}/docs/administration/account-user-management/access-control/#marking-pipelines-with-policy-attributes) for this pipeline| string| Optional|
36
40
|`metadata.created_at`| The date and time at which the pipeline was created in the format ????/| date| Optional|
37
41
|`metadata.updated_at`| The date and time at which the pipeline YAML was updated, in the format ????/| date| Optional|
38
42
|`metadata.accountId`| The ID of the account to which the pipeline belongs. ????/| obejctId| Optional|
39
43
|`metadata.originalYamlString`| ?????the full contents of the pipeline editor. Only kept for archival purposes| string| Optional|
40
44
|`metadata.projectId`| The ID of the project to which the pipeline belongs.| obejctId| Optional|
41
45
|`metadata.project`| The name of the project to which the pipeline belongs.| string| Optional|
42
-
|`metadata.template`| ????Determines if the pipeline is available as a template when creating a new pipeline. <br>When set to`true`, the pipeline name is displayed in the Pipeline Template list.| boolean| Optional|
46
+
|`metadata.template`| ????Determines if the pipeline is available as a template when creating a new pipeline. <br>When set to`true`, the pipeline name is displayed in the Pipeline Template list.| boolean| Optional|
43
47
|`metadata.template.isTemplate`| When set to`true`, the pipeline name is displayed in the Pipeline Template list.| boolean| Optional|
44
48
|`metadata.template.generatedFrom`|????? When set to`true`, the pipeline name is displayed in the Pipeline Template list.| boolean| Optional|
45
-
|`metadata.executionContextId`| ???The ID of the specific execution context to use for the pipeline to makes API calls to the pipeline.<br>If there are no execution contexts created for the pipeline, the default execution context is used. (NIMA: is this the CF provided one? what are the implications - that it allows all API calls or minimal ones?).<br>See[Pipeline execution context]({{site.baseurl}}/docs/administration/account-user-management/pipeline-execution-context/).| string| Required????|
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
49
+
|`metadata.executionContextId`| ???The ID of the specific execution context to use for the pipeline to makes API calls to the pipeline.<br>If there are no execution contexts created for the pipeline, the default execution context is used. (NIMA: is this the CF provided one? what are the implications - that it allows all API calls or minimal ones?).<br>See[Pipeline execution context]({{site.baseurl}}/docs/administration/account-user-management/pipeline-execution-context/).| string| Optional|
|`spec.scopeSnapshot`| The ID of the pipeline.| string|`????'`|
57
+
|`spec.scopes`| ???| string|Optional|
58
+
|`spec.scopeSnapshot`| The ID of the pipeline.| string|Optional|
63
59
|`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
60
|`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??|
61
+
|`spec.triggers`| The list of Git triggers defined for the pipeline. For details, see[`spec.triggers](#spectriggers).| array|Optional|
62
+
|`spec.cronTriggers`| The list of Cron or timer-based triggers defined for the pipeline. For details, see[`spec.cronTriggers](#speccrontriggers).| array|Optional|
63
+
|`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
64
|`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|`????'`|
65
+
|`spec.packId`|SAAS Only (`5cd1746617313f468d669013` for Small,`5cd1746717313f468d669014` for Medium,`5cd1746817313f468d669015` for Large,`5cd1746817313f468d669017` for XL,`5cd1746817313f468d669018` for XXL,`5cd1746817313f468d669020` for 4XL)| string|Required for SAAS<br />Optional for Hybrid|
70
66
|`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 IDof the pipeline.|string|`????'`|
67
+
|`spec.contexts`|A list of strings representing the namesofthat[shared configuration]({{site.baseurl}}/docs/pipelines/configuration/shared-configuration/) to be added tothe pipeline|Array of strings| Optional|
72
68
|`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
69
|`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
70
|`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|
@@ -93,36 +89,22 @@ toc: true
93
89
|`spec.debug`| The ID of the pipeline.| string|`????'`|
94
90
|`spec.serviceAccount`| The ID of the pipeline.| string|`????'`|