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
Copy file name to clipboardExpand all lines: _docs/administration/codefresh-on-prem.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -357,7 +357,7 @@ The following table displays the list of databases created as part of the instal
357
357
358
358
| Database | Purpose | Latest supported version |
359
359
|----------|---------| ---------------|
360
-
| mongoDB | storing all account data (account settings, users, projects, pipelines, builds etc.) | 3.6.x |
360
+
| mongoDB | storing all account data (account settings, users, projects, pipelines, builds etc.) | 4.2.x |
361
361
| postgresql | storing data about events that happened on the account (pipeline updates, deletes, etc.). The audit log uses the data from this database. | 9.6.x |
362
362
| redis | mainly used for caching, but also used as a key-value store for our trigger manager. | 3.2.x |
|`title`| The free-text display name of the step. | Optional |
52
53
|`description`| A basic, free-text description of the step. | Optional |
53
-
|`timeout`| Defines an automatic approval/rejection if a specified amount of time has passed. The `duration` field is hours. By default it is set to 168 (i.e. 7 days). The `finalState` field defines what will happen after the duration time has elapsed. Possible values are `approved`/`denied`/`terminated`| Optional |
54
+
| `timeout` | Defines an automatic approval/rejection if a specified amount of time has passed. The `duration` field is hours. By default it is set to 168 (i.e.
55
+
, 7 days). The `finalState` field defines what will happen after the duration time has elapsed. Possible values are `approved`/`denied`/`terminated` | Optional |
56
+
| `timeUnit` | This field defines possible options of `minutes`, or `hours`. If the field is not set, the default is `hours` | Optional
54
57
|`fail_fast`| If set to false, the pipeline will continue even when the step is rejected | Optional |
55
58
|`stage`| Parent group of this step. See [using stages]({{site.baseurl}}/docs/codefresh-yaml/stages/) for more information. | Optional |
56
59
|`when`| Define a set of conditions that need to be satisfied in order to execute this step. You can find more information in the [Conditional Execution of Steps]({{site.baseurl}}/docs/codefresh-yaml/conditional-execution-of-steps/) article. | Optional |
57
60
58
61
59
-
## Pausing the pipeline
62
+
## Pausing the Pipeline
60
63
61
64
Once the pipeline reaches an approval step it will stop. At this point it **does not** consume any resources.
62
65
In the Codefresh UI you will see the *Approve/Reject* buttons.
@@ -74,7 +77,7 @@ max-width="80%"
74
77
Once you click any of them the pipeline will continue. Further steps in the pipeline can be enabled/disabled
75
78
according to the approval result.
76
79
77
-
## Automatic approvals/rejections
80
+
## Automatic Approvals/Rejections
78
81
79
82
By default, a pipeline that contains an approval step will pause for 7 days (168 hours) onces it reaches that step. If you want some automatic action to happen after a specified time period you can define it in advance with the `timeout` property:
80
83
@@ -127,7 +130,7 @@ max-width="80%"
127
130
128
131
For more details on access control and users see also the [access control page]({{site.baseurl}}/docs/administration/access-control/).
129
132
130
-
## Keeping the shared volume after an approval
133
+
## Keeping the Shared Volume after an Approval
131
134
132
135
As soon as a pipeline starts waiting for an approval, all contents of the [shared Codefresh volume]({{site.baseurl}}/docs/configure-ci-cd-pipeline/introduction-to-codefresh-pipelines/#sharing-the-workspace-between-build-steps) are lost. Once the pipeline continues running all files that were created manually inside the volume are not available any more.
133
136
@@ -150,7 +153,7 @@ max-width="90%"
150
153
>Notice also that you if you use the [Hybrid version]({{site.baseurl}}/docs/administration/behind-the-firewall/) of Codefresh and your [Runner]({{site.baseurl}}/docs/administration/codefresh-runner/) is setup with local volumes, then the volume will only be present if the dind pod
151
154
is scheduled in the same node once the pipeline resumes. Otherwise the volume will not be reused.
152
155
153
-
## Controlling the rejection behavior
156
+
## Controlling the Rejection Behavior
154
157
155
158
By default if you reject a pipeline, it will stop right away and it will be marked as failed. All subsequent steps after the approval one will not run at all.
156
159
@@ -171,7 +174,7 @@ steps:
171
174
In this case you can also read the approval result and make the pipeline work differently according to each choice (demonstrated in the following section).
172
175
173
176
174
-
## Getting the approval result
177
+
## Getting the Approval Result
175
178
176
179
As also explained in [step dependencies]({{site.baseurl}}/docs/codefresh-yaml/advanced-workflows/#custom-steps-dependencies) all steps in the Codefresh pipeline belong to a global object
177
180
called `steps` (indexed by name). You can read the `result` property for an approval step to see if it was approved or rejected.
@@ -291,7 +294,7 @@ max-width="80%"
291
294
You can see that only two steps were ignored. If you rerun the pipeline and approve
292
295
it, the other two steps will be ignored.
293
296
294
-
## Define concurrency limits
297
+
## Define Concurrency Limits
295
298
296
299
Codefresh has the ability to limit the amount of running builds for a specific pipeline with several concurrency policies in the pipeline settings. You can choose if a build that is in a pending approval state will count against the concurrency limits or not.
297
300
@@ -305,7 +308,7 @@ There isn't a correct or wrong way to set this option. It depends on your organi
305
308
You can either set this option [differently per pipeline]({{site.baseurl}}/docs/configure-ci-cd-pipeline/pipelines/#policies), or globally in your account at your [account settings](https://g.codefresh.io/account-admin/account-conf/pipeline-settings).
306
309
307
310
308
-
## Slack integration
311
+
## Slack Integration
309
312
310
313
If you also enable [Slack integration]({{site.baseurl}}/docs/integrations/notifications/slack-integration/) in Codefresh you will have the choice of approving/rejecting a pipeline
0 commit comments