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/pipelines/annotations.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
@@ -24,7 +24,7 @@ see [hooks in pipelines]({{site.baseurl}}/docs/pipelines/hooks/).
24
24
25
25
##Adding annotations
26
26
27
-
In the most basic scenario, you can use the[post operations]({{site.baseurl}}/docs/pipelines/post-step-operations/) of any Codefresh[step]({{site.baseurl}}/docs/pipelines/steps/) to add annotations:
27
+
In the most basic scenario, you can use the[post-step operations]({{site.baseurl}}/docs/pipelines/post-step-operations/) of any Codefresh[step]({{site.baseurl}}/docs/pipelines/steps/) to add annotations:
Copy file name to clipboardExpand all lines: _docs/pipelines/configuration/pipeline-settings.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,8 @@ redirect_from:
8
8
toc:true
9
9
---
10
10
11
-
To access your global pipeline settings navigate to[https://g.codefresh.io/account-admin/account-conf/pipeline-settings](https://g.codefresh.io/account-admin/account-conf/pipeline-settings) or click on*Account settings* on the left sidebar and then choose*Pipeline settings* item on the next screen.
12
11
13
-
On this page, youcan define global parameters for thewhole Codefresh account regarding pipeline options. Users can still override some of these options for individual pipelines.
12
+
Youcan define global parameters forallthepipelines in the account. Users can still override some of these options for individual pipelines.
14
13
15
14
{% include image.html
16
15
lightbox="true"
@@ -21,6 +20,9 @@ caption="Pipeline settings"
21
20
max-width="80%"
22
21
%}
23
22
23
+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon.
24
+
1. From Configuration in the sidebar, select[**Pipeline Settings**](https://g.codefresh.io/account-admin/account-conf/pipeline-settings){:target="\_blank"}.
25
+
24
26
25
27
##Pause pipeline executions
26
28
@@ -45,18 +47,18 @@ max-width="80%"
45
47
46
48
Here you can define global template behavior. The options are:
47
49
48
-
* Enable[pipeline templates]({{site.baseurl}}/docs/docs/pipelines/pipelines/#using-pipeline-templates) for users. If this is enabled some pipelines can be marked as templates and users can still select them when creating a new pipeline.
49
-
* Decide if users can clone an existing pipeline (along with its triggers and associated parameters) when[creating a new pipeline]({{site.baseurl}}/docs/docs/pipelines/pipelines/#creating-new-pipelines).
50
+
* Enable[pipeline templates]({{site.baseurl}}/docs/pipelines/pipelines/#using-pipeline-templates) for users. If this is enabled some pipelines can be marked as templates and users can still select them when creating a new pipeline.
51
+
* Decide if users can clone an existing pipeline (along with its triggers and associated parameters) when[creating a new pipeline]({{site.baseurl}}/docs/pipelines/pipelines/#creating-a-pipeline).
50
52
51
53
Note that templates are simply normal pipelines “marked” as a template. There is no technical difference between templates and actual pipelines.
52
54
53
55
##Pipeline YAML section
54
56
55
57
Here you can restrict the sources of pipeline YAML that users can select. The options are:
56
58
57
-
* Enable/Disable the[inline editor]({{site.baseurl}}/docs/docs/pipelines/pipelines/#using-the-inline-pipeline-editor) where YAML is stored in Codefresh SaaS
59
+
* Enable/Disable the[inline editor]({{site.baseurl}}/docs/pipelines/pipelines/#using-the-inline-pipeline-editor) where YAML is stored in Codefresh SaaS
58
60
* Enable/disable pipeline YAML from connected Git repositories
You need to allow at least one of these options so that users can create new pipelines. We suggest leaving the first option enabled when users are still learning about Codefresh and want to experiment.
The previous KEY portion is now made of two parts separated using @, where the left side is the name of the resource in the namespace, and the right side the key in that resource.
22
22
23
23
To use the secret in your pipeline, you have two options:
@@ -71,7 +71,7 @@ steps:
71
71
72
72
You can also use secrets in the GUI screens that support them. Currently you can use secrets in:
Copy file name to clipboardExpand all lines: _docs/pipelines/docker-image-metadata.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,7 @@ This article explains how to create advanced view of your images and enrich them
20
20
max-width="65%"
21
21
%}
22
22
23
-
>We have since expanded this feature and now you are able to add custom annotations to[pipelines and builds as well]({{site.baseurl}}/docs/pipelines/annotations/). Notice also that the syntax shown in this page is deprecated but still supported. For the new syntax
24
-
see[Hooks in pipelines]({{site.baseurl}}/docs/pipelines/hooks/).
23
+
>We have since expanded this feature, and now you can add custom annotations to[pipelines and builds as well]({{site.baseurl}}/docs/pipelines/annotations/). Notice also that the syntax shown in this page is deprecated but still supported. For the new syntax, see[Hooks in pipelines]({{site.baseurl}}/docs/pipelines/hooks/).
25
24
26
25
##Metadata types
27
26
@@ -37,14 +36,14 @@ Metadata values may be of the following types:
37
36
| Percentage bar| use 0-100 value ending with %| 85%|
38
37
| Link| use url| {% raw %}`${{CF_COMMIT_URL}}`{% endraw %}|
39
38
40
-
You can also use[Expression evaluations]({{site.baseurl}}/docs/pipelines/conditional-execution-of-steps/#condition-expression-syntax) to set metadata.
39
+
You can also use[conditional expressions]({{site.baseurl}}/docs/pipelines/conditional-execution-of-steps/#condition-expression-syntax) to set metadata.
41
40
42
41
##Annotate your images using Codefresh YAML
43
42
You can annotate an image as part of its build process and also on post build steps.
44
43
45
44
{:.text-secondary}
46
45
###Build step Image Metadata Annotation
47
-
You can annotate an image as part of its build process by declaring the metadata value on the[Build step]({{site.baseurl}}/docs/pipelines/steps/build/):
46
+
You can annotate an image as part of its build process by declaring the metadata value on the[`build` step]({{site.baseurl}}/docs/pipelines/steps/build/):
48
47
1. The`metadata` attribute
49
48
2. The`set` operation
50
49
3. An array of key-value metadata
@@ -65,7 +64,7 @@ build_step:
65
64
66
65
{:.text-secondary}
67
66
###Adding annotations to Built images on post-build steps
68
-
Any step in the YAML workflow can annotate built images by using[Post-Step Operations]({{site.baseurl}}/docs/pipelines/post-step-operations/).
67
+
Any step in the YAML workflow can annotate built images by using[post-step operations]({{site.baseurl}}/docs/pipelines/post-step-operations/).
69
68
To annotate a built image, configure any step with:
70
69
1. The post-step operation
71
70
2. The`metadata` attribute
@@ -170,7 +169,7 @@ In addition, you can add selected annotations to the images table on images page
170
169
171
170
##Annotating images programmatically
172
171
173
-
It is also possible to annotate images with the[Codefresh CLI](https://codefresh-io.github.io/cli/).
172
+
It is also possible to annotate images with the[Codefresh CLI](https://codefresh-io.github.io/cli/){:target="\_blank"}.
174
173
175
174
First find the id of an image that you wish to annotate with the command
176
175
@@ -185,17 +184,17 @@ $ codefresh get images --image-name custom
185
184
ID NAME TAG CREATED SIZE PULL
186
185
b5f103a87856 my-custom-docker-image bla Fri Feb 01 2019 91.01 MB r.cfcr.io/kostis-codefresh/my-custom-docker-image:bla
187
186
```
188
-
Then once you have the ID of the image you can use the[annotate command](https://codefresh-io.github.io/cli/images/annotate-image/) to add extra metadata:
187
+
Then once you have the ID of the image you can use the[annotate command](https://codefresh-io.github.io/cli/images/annotate-image/){:target="\_blank"} to add extra metadata:
You can also use the Codefresh CLI to fetch existing metadata from images. It is then very easy to extract and process specific fields with[yq](https://github.com/kislyuk/yq)
195
+
You can also use the Codefresh CLI to fetch existing metadata from images. It is then very easy to extract and process specific fields with[yq](https://github.com/kislyuk/yq){:target="\_blank"}.
197
196
198
-
Here is an example
197
+
Here is an example:
199
198
```
200
199
$ codefresh get image b5f103a87856 --output=yaml | yq -r .annotations.coverage
201
200
75
@@ -223,5 +222,5 @@ in order to process them in a Codefresh pipeline.
Copy file name to clipboardExpand all lines: _docs/pipelines/service-containers.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,12 +38,12 @@ steps:
38
38
39
39
This pipeline will run integration tests during the freestyle step called`my_integration_tests` and at that point a Redis instance will be available at hostname`my-redis-db-host` and port 6379. Note how in this example, the service container is placed at the root of the pipeline (as opposed to inside a specific step). This ensures that the Redis instance is running for[the duration of the pipeline]({{site.baseurl}}/docs/pipelines/service-containers/#running-services-for-the-duration-of-the-pipeline).
40
40
41
-
>Service Containers are based on Docker Compose. This document does not have the complete list of available options available. Please refer to Docker Compose versions[2](https://docs.docker.com/compose/compose-file/compose-file-v2/) and[3](https://docs.docker.com/compose/compose-file/), but not point releases such as 2.1.
41
+
>Service Containers are based on Docker Compose. This document does not have the complete list of available options available. Please refer to Docker Compose versions[2](https://docs.docker.com/compose/compose-file/compose-file-v2/){:target="\_blank"} and[3](https://docs.docker.com/compose/compose-file/){:target="\_blank"}, but not point releases such as 2.1.
42
42
43
43
44
-
##ViewingService containers
44
+
##Viewingservice containers
45
45
46
-
The service containers have their own output tab in Codefresh UI
46
+
The service containers have their own output tab in Codefresh UI.
47
47
48
48
{% include image.html
49
49
lightbox="true"
@@ -129,7 +129,7 @@ caption="Using an existing composition"
129
129
max-width="70%"
130
130
%}
131
131
132
-
This makes very easy to reuse compositions that you have already defined for other reasons[intheCodefresh UI](https://codefresh.io/docs/docs/testing/create-composition/).
132
+
This makes very easy to[reuse compositions]({{site.baseurl}}/docs/testing/create-composition/) that you have already defined for other reasons in Codefresh.
133
133
134
134
135
135
##Running services for the duration of the pipeline
@@ -283,7 +283,7 @@ steps:
283
283
{% endraw %}
284
284
{% endhighlight %}
285
285
286
-
Note that in this case the`docker-compose.yml` file must mention[specific images](https://docs.docker.com/compose/compose-file/#image) (and not use[build properties](https://docs.docker.com/compose/compose-file/#build)).
286
+
Note that in this case the`docker-compose.yml` file must mention[specific images](https://docs.docker.com/compose/compose-file/#image){:target="\_blank"} (and not use[build properties](https://docs.docker.com/compose/compose-file/#build){:target="\_blank"}).
287
287
288
288
289
289
##Launching a custom service
@@ -334,7 +334,7 @@ We then run a `curl` command against the sidecar container to verify the correct
334
334
335
335
When you launch multiple services in your pipelines, you don't know exactly when they will start. Maybe they will be ready once you expect them, but maybe they take too long to start. For example if you use a MySQL database in your integration tests, your integration tests need to know that the database is actually up before trying to use it.
336
336
337
-
This is the same issue that is present in[vanilla Docker compose](https://docs.docker.com/compose/startup-order/). You can use solutions such as[wait-for-it](https://github.com/vishnubob/wait-for-it) to overcome this limitation, but Codefresh offers a better way in the form of*service readiness*.
337
+
This is the same issue that is present in[vanilla Docker compose](https://docs.docker.com/compose/startup-order/){:target="\_blank"}. You can use solutions such as[wait-for-it](https://github.com/vishnubob/wait-for-it){:target="\_blank"} to overcome this limitation, but Codefresh offers a better way in the form of*service readiness*.
338
338
339
339
With a readiness block you can guarantee that a sidecar service will be actually up before the pipeline will continue. Here is an example:
340
340
@@ -384,7 +384,7 @@ This is an improvement over the previous example because the healthcheck of the
384
384
*`successThreshold`: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for readiness. Minimum value is 1.
385
385
*`failureThreshold`: failureThreshold times before giving up. In case of readiness probe the Pod will be marked Unready. Defaults to 3. Minimum value is 1
386
386
387
-
If you know already how[Kubernetes readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/) work, then these settings will be very familiar to you.
387
+
If you know already how[Kubernetes readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/){:target="\_blank"} work, then these settings will be very familiar to you.
388
388
389
389
Here is another example where we use the`pg_isready` command to make sure that a PostgreSQL database is ready to accept connections
390
390
before we run the integration tests.
@@ -558,10 +558,10 @@ Service containers are not compatible with [custom pipeline steps]({{site.baseur