Skip to content

Commit 7ecb4c7

Browse files
committed
Update specifications.md
Added descriptions for git, cron, options schema etc
1 parent d4faa0b commit 7ecb4c7

File tree

1 file changed

+110
-0
lines changed

1 file changed

+110
-0
lines changed

_docs/pipelines/specifications.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,26 +91,136 @@ toc: true
9191

9292
### spec.triggers
9393

94+
{: .table .table-bordered .table-hover}
95+
| Field | Description | Type | Required/Optional |
96+
| -------------- | ---------------------------- |-----------| -------------------------|
97+
| `spec.triggers.type` | Always set to `git`. | string | Required |
98+
| `spec.triggers.id` | ???? | ??? | Optional |
99+
| `spec.triggers.createdFromRepositoryMigration` | Determines if the trigger was automatically created when migrating repositories. Deprecated??? | boolean | Optional |
100+
| `spec.triggers.name` | The user-defined name of the Git trigger. Can have a minimum of one and maximum of 200 characters, including these special characters `/`, `^`, `\`, `S`, `*`, `$`, and without spaces. Regex expressions are also supported. | string | Required|
101+
| `spec.triggers.description` | A meaningful of the Git trigger. Can have a minimum of one and maximum of 150 characters. | string | Optional|
102+
| `spec.triggers.commitStatusTitle` | The title of the commit message when the Git trigger is activated. ????Can have a minimum of one and maximum of 200 characters. | string | Optional???|
103+
| `spec.triggers.contexts` | The variable sets imported from [shared configuration]({{site.baseurl}}/docs/pipelines/configuration/shared-configuration/). |array | Optional |
104+
| `spec.triggers.verified` | ?? |boolean | Optional |
105+
| `spec.triggers.status` | ?? |string | Optional |
106+
| `spec.triggers.repo` | The Git repo to track for this trigger, in the format `<git_repo_owner>/<git_repo_name>`. |string | Optional |
107+
| `spec.triggers.provider` | The name of the Git provider as defined in the Git integrations set up for pipelines. See [Git provider pipeline integrations]({{site.baseurl}}/docs/integrations/git-providers/| string |Optional |
108+
| `spec.triggers.disabled` | Determines if the Git trigger is enabled for activation or always disabled.<br> When set to `true`, the trigger is always disabled and never activated. (NIMA: assum default is False; why or when would you set it to true?) | boolean | Optional |
109+
| `spec.triggers.skipCommentAuthorAssociationValidation` | ???| boolean | Optional |
110+
| `spec.triggers.events` | The possible list of Git events that can be configured to activate the trigger depending on the Git provider. See [spec.triggers.events](#spectriggersevents). | array | Required |
111+
| `spec.triggers.commentRegex` | Defines if to activate the trigger only if the pull request (PR) comment matches a specific pattern defined by a regular expression (regex). ??? NIMA: see what the special characters mean int he schema | string | Optional |
112+
| `spec.triggers.branchRegex ` | Defines if to activate the trigger only if the regex expression/string matches the branch name as defined by `branchRegexInput`. ???| string | Optional|
113+
| `spec.triggers.branchRegexInput` | Defines the type of content used in `branchRegex`, and can be one of the following: {::nomarkdown}<ul><li><code class="highlighter-rouge">regex</code>: Match branch names based on specific patterns.<br>For example, `feature/.*` would match any branch that starts with `feature/`. </li><li><code class="highlighter-rouge">multiselect</code>: Match one or more of the predefined list of branch names.</li><li><code class="highlighter-rouge">multiselect-exclude</code>: Does <i>not match</i> any of the predefined branch names in the list. </li></ul>{:/} | string | Optional |
114+
| `spec.triggers.pullRequestTargetBranchRegex` | ??? | string | Optional |
115+
| `spec.triggers.pullRequestAllowForkEvents` | Determines if the Git trigger is also valid for Git forks.<br>When set to `true`, the default???, the trigger is also activated for Git repos forked from `spec.triggers.repo`. | boolean | Optional |
116+
| `modifiedFilesGlob` | Defines if to activate the trigger when the changed files match glob expression. Glob expressions can have maximum of 65500/65536 characters, including `' '`| string | Optional |
117+
| `spec.triggers.gerritCIStatusLabels` | ?????| array | Optional |
118+
| `spec.triggers.context` | The name of the Git integration to use????. NIMA what happens when not specified? | string | Optional |
119+
| `spec.triggers.concurrency` | The maximum number of concurrent builds for this trigger, and can range from `1` (the default), to `15`, or unlimited). Define the trigger concurrency when your pipeline has multiple triggers. | string | Optional |
120+
| `spec.triggers.priority` | ??? Default 0, min -100, max 100 | integer | Optional |
121+
| `spec.triggers.terminationPolicy` | ??? | integer | Optional |
122+
123+
124+
125+
126+
Build Termination: Options that determine when a build from the pipeline should terminate:
127+
Once a build is created terminate previous builds from the same branch
128+
Once a build is created terminate previous builds only from a specific branch (name matches a regular expression)
129+
Once a build is created, terminate all other running builds
130+
Once a build is terminated, terminate all child builds initiated from it
131+
132+
94133
### spec.triggers.events
95134

96135
### spec.cronTriggers
136+
{: .table .table-bordered .table-hover}
137+
| Field | Description | Type | Required/Optional |
138+
| -------------- | ---------------------------- |-----------| -------------------------|
139+
| `spec.cronTriggers.type` | Always set to `cron`. | string | Required |
140+
| `spec.cronTriggers.id` | ???? | ??? | Optional |
141+
| `spec.cronTriggers.event` | Leave empty. Automatically generated by Codefresh for internal use. | string | Optional |
142+
| `spec.cronTriggers.name` | The user-defined name of the Cron trigger. Can have a minimum of one and maximum of 200 characters. ???? including these special characters `/`, `^`, `\`, `S`, `*`, `$`, and without spaces. Regex expressions are also supported. | string | Required|
143+
| `spec.cronTriggers.message` | The free-text message to be sent as an additional event payload every time the Cron trigger is activated. For example, `Successful ingress tests`.| string | Required|
144+
| `spec.cronTriggers.expression` | The Cron expression that defines the time and frequency of the Cron trigger.<br>For example, `0 3 * * 1-5` triggers the pipeline at _3:00 AM every weekday (Monday to Friday)_. | string | Required|
145+
| `spec.cronTriggers.verified` | ?? |boolean | Optional |
146+
| `spec.cronTriggers.disabled ` | Determines if the Cron trigger is enabled for activation. <br>By default, set to `false` meaning that it is always enabled. <br>To disable the trigger, set to `true`. | boolean | Optional |
147+
| `spec.cronTriggers.status` | ?? |string | Optional |
148+
| `spec.cronTriggers.lastExecutionDate` | T???? |date | Optional |
149+
| `spec.cronTriggers.gitTriggerId` |The ID of the Git trigger to simulate for the pipeline, retrieved from the pipeline for which it is defined.<br>To simulate a Git trigger, the pipeline must have at least one Git trigger defined for it.<br>See [Git triggers](#git-triggers) in this article.| string |Optional |
150+
| `spec.cronTriggers.branch` | Valid only when a Git trigger is simulated.<br> The branch of the repo retrieved from the Git trigger defined in `spec.cronTriggers.gitTriggerId`. | string | Optional |
151+
152+
153+
154+
155+
156+
157+
97158

98159
### spec.runtimeEnvironment
160+
{: .table .table-bordered .table-hover}
161+
| Field | Description | Type | Required/Optional |
162+
| -------------- | ---------------------------- |-----------| -------------------------|
163+
| `spec.runtimeEnvironment.name` | The name of the runtime environment to use for the pipeline. NIMA: does this override the account-level setting? Or must it one of those REs allowed for the pipeline? Should I add it's also based on permissions? |string | Required |
164+
| `spec.runtimeEnvironment.memory` | The memory threshold for the pipeline. memory share using Kubernetes notation NIMA: does this override the account-level setting? Must it one of those in the UI? |string | Optional |
165+
| `spec.runtimeEnvironment.cpu` | The number of CPUs to use for the pipeline. CPU share using Kubernetes notation ??? NIMA: does this override the account-level setting? Or must it one of those in the UI?|string | Optional |
166+
| `spec.runtimeEnvironment.dindStorage` | storage size using Kubernetes notation |string | Optional |
99167

100168
### spec.lowMemoryWarningThreshold
169+
part of param description
101170

102171
### spec.requiredAvailableStorage
172+
???
103173

104174
### spec.clustersInfo
175+
in parameter description; need to decide if to move here with more details
105176

106177
### spec.variables
107178

179+
{: .table .table-bordered .table-hover}
180+
| Field | Description | Type | Required/Optional |
181+
| -------------- | ---------------------------- |-----------| -------------------------|
182+
| `spec.variables.key` | The name of the variabl. |string | Required |
183+
| `spec.variables.value` | ????| string | Raw value |
184+
| `spec.variables.encrypted` | Determines if to encrypt the stored value of the variable. When set to `false`, the default, variable values are not encrypted.<br>To encrypt, set to `true`. | boolean | Optional |
185+
108186
### spec.specTemplate
109187

188+
{: .table .table-bordered .table-hover}
189+
| Field | Description | Type | Required/Optional |
190+
| -------------- | ---------------------------- |-----------| -------------------------|
191+
| `spec.specTemplate.location` | ??? |string | Required |
192+
| `spec.specTemplate.context` | ????| string | |
193+
| `spec.specTemplate.url` | ?????| string | Optional |
194+
| `spec.specTemplate.repo` | ?????| string | Optional |
195+
| `spec.specTemplate.path` | ?????| string | Optional |
196+
| `spec.specTemplate.revision` | ?????| string | Optional |
197+
110198
### spec.options
111199

200+
{: .table .table-bordered .table-hover}
201+
| Field | Description | Type | Required/Optional |
202+
| -------------- | ---------------------------- |-----------| -------------------------|
203+
| `spec.options.noCache` | When set to `false`, the default, use the last build's cache. <br>To ignore the last build's cache, set to `true`. Selecting this option may slow down your build.<br>See [Last build cache]({{site.baseurl}}/docs/kb/articles/disabling-codefresh-caching-mechanisms/). |boolean | Optional |
204+
| `spec.options.noCfCache` | When set to `false`, the default, uses Docker engine cache for build. <br> To ignore Docker engine cache for build, set to `true`. <br>See [Docker engine cache]({{site.baseurl}}/docs/kb/articles/disabling-codefresh-caching-mechanisms/). |boolean | Optional |
205+
| `spec.options.resetVolume` | When set to `false`, the default, does not reset the pipeline volume. <br>To reset the pipeline volume, set to `true`. This is useful for troubleshooting a build that hangs on the first step. <br>See [Hangs on restoring data from pre-existing image]({{site.baseurl}}/docs/kb/articles/restoring-data-from-pre-existing-image-hangs-on/). |boolean | Optional |
206+
| `spec.options.enableNotifications` | When set to `false`, the default, only sends status updates to your Git provider. <br>To send email and Slack notifications, in addition to status updates, set to `true`. <br>See [Slack notifications]({{site.baseurl}}//docs/integrations/notifications/slack-integration/). |boolean | Optional |
207+
| `spec.options.keepPVCsForPendingApproval` | Determines if PVC volumes are retained when the pipeline is waiting for approval. ????? |boolean | Optional |
208+
| `spec.options.pendingApprovalConcurrencyApplied` | Determines if the pipeline build that is pending approval is counted against the number of concurrent builds defined for the pipeline. By default, left empty. NIMA: what happns then? <br>See [Define concurrency limits]({{site.baseurl}}/docs/pipelines/steps/approval/#define-concurrency-limits) |boolean | Optional |
209+
210+
112211
### spec.terminationPolicy
113212

213+
{: .table .table-bordered .table-hover}
214+
| Field | Description | Type | Required/Optional |
215+
| -------------- | ---------------------------- |-----------| -------------------------|
216+
| `spec.terminationPolicy.type` |??? |boolean | Optional |
217+
| `spec.terminationPolicy.event` |??? |boolean | Optional |
218+
| `spec.terminationPolicy.ignoreBranch` |??? |boolean | Optional |
219+
| `spec.terminationPolicy.ignoreTrigger` |??? |boolean | Optional |
220+
| `spec.terminationPolicy.branchName` |??? |boolean | Optional |
221+
| `spec.terminationPolicy.key` |??? |boolean | Optional |
222+
| `spec.terminationPolicy.value` |??? |boolean | Optional |
223+
114224
### spec.externalResources
115225

116226
See [External resources]({{site.baseurl}}/docs/pipelines/pipelines/#external-resources).

0 commit comments

Comments
 (0)