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

Commit340d067

Browse files
committed
Update pipeline topics
Fixed links after QA
1 parentfd96cb0 commit340d067

File tree

8 files changed

+48
-47
lines changed

8 files changed

+48
-47
lines changed

‎_docs/pipelines/annotations.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ see [hooks in pipelines]({{site.baseurl}}/docs/pipelines/hooks/).
2424

2525
##Adding annotations
2626

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:
2828

2929
`codefresh.yml`
3030
{% highlight yaml %}

‎_docs/pipelines/configuration/build-status.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Click on it and you will get a new dialog where you can select
5252
{% include
5353
image.html
5454
lightbox="true"
55-
file="/images/a0c4aed-codefresh_badges_2.png"
56-
url="/images/a0c4aed-codefresh_badges_2.png"
55+
file="/images/pipeline/badges/codefresh_badges.png"
56+
url="/images/pipeline/badges/codefresh_badges.png"
5757
alt="Codefresh badges syntax"
5858
caption="Codefresh badges syntax"
5959
max-width="70%"

‎_docs/pipelines/configuration/pipeline-settings.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ redirect_from:
88
toc:true
99
---
1010

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.
1211

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.
1413

1514
{% include image.html
1615
lightbox="true"
@@ -21,6 +20,9 @@ caption="Pipeline settings"
2120
max-width="80%"
2221
%}
2322

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+
2426

2527
##Pause pipeline executions
2628

@@ -45,18 +47,18 @@ max-width="80%"
4547

4648
Here you can define global template behavior. The options are:
4749

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).
5052

5153
Note that templates are simply normal pipelines “marked” as a template. There is no technical difference between templates and actual pipelines.
5254

5355
##Pipeline YAML section
5456

5557
Here you can restrict the sources of pipeline YAML that users can select. The options are:
5658

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
5860
* Enable/disable pipeline YAML from connected Git repositories
59-
* Enable/disable pipeline YAML from[external URLs]({{site.baseurl}}/docs/docs/pipelines/pipelines/#loading-codefreshyml-from-version-control)
61+
* Enable/disable pipeline YAML from[external URLs]({{site.baseurl}}/docs/pipelines/pipelines/#loading-codefreshyml-from-version-control)
6062

6163
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.
6264

‎_docs/pipelines/configuration/secrets-store.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Once you have [connected Codefresh to your secrets storage]({{site.baseurl}}/doc
1717
The syntax for using the secret is {% raw %}`${{secrets.NAME_IN_CODEFRESH.KEY}}`{% endraw %}.
1818

1919
>If you did not include the resource-name as a part of your secret store context creation, the syntax for using your secret differs slightly:
20-
{% raw %}${{secrets.NAME_IN_CODEFRESH.RESOURCE-NAME@KEY}}{% endraw %}
20+
{%highlight yaml %}{%raw %}${{secrets.NAME_IN_CODEFRESH.RESOURCE-NAME@KEY}}{% endraw %}{% endhighlight %
2121
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.
2222

2323
To use the secret in your pipeline, you have two options:
@@ -71,7 +71,7 @@ steps:
7171

7272
You can also use secrets in the GUI screens that support them. Currently you can use secrets in:
7373

74-
* Values in[shared configuration]({{site.baseurl}}/docs/pipelines/shared-configuration/)
74+
* Values in[shared configuration]({{site.baseurl}}/docs/pipelines/configuration/shared-configuration/)
7575
* Integration with[cloud storage]({{site.baseurl}}/docs/testing/test-reports/#connecting-your-storage-account)
7676

7777
Where secret integration is supported, click on the lock icon and enable the toggle button. You will get a list of your connected secrets:
@@ -92,8 +92,7 @@ If you didn't include a resource name during secret creation then enter the full
9292

9393

9494
##Related articles
95-
[Shared Configuration]({{site.baseurl}}/docs/pipelines/shared-configuration/)
9695
[Git triggers]({{site.baseurl}}/docs/pipelines/triggers/git-triggers/)
9796
[Running pipelines locally]({{site.baseurl}}/docs/pipelines/running-pipelines-locally/)
98-
[DebuggingPipelines]({{site.baseurl}}/docs//yaml-examples/examples/trigger-a-k8s-deployment-from-docker-registry/)
97+
[Debuggingpipelines]({{site.baseurl}}/docs//example-catalog/cd-examples/trigger-a-k8s-deployment-from-docker-registry/)
9998

‎_docs/pipelines/docker-image-metadata.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ This article explains how to create advanced view of your images and enrich them
2020
max-width="65%"
2121
%}
2222

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/).
2524
2625
##Metadata types
2726

@@ -37,14 +36,14 @@ Metadata values may be of the following types:
3736
| Percentage bar| use 0-100 value ending with %| 85%|
3837
| Link| use url| {% raw %}`${{CF_COMMIT_URL}}`{% endraw %}|
3938
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.
4140

4241
##Annotate your images using Codefresh YAML
4342
You can annotate an image as part of its build process and also on post build steps.
4443

4544
{:.text-secondary}
4645
###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/):
4847
1. The`metadata` attribute
4948
2. The`set` operation
5049
3. An array of key-value metadata
@@ -65,7 +64,7 @@ build_step:
6564

6665
{:.text-secondary}
6766
###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/).
6968
To annotate a built image, configure any step with:
7069
1. The post-step operation
7170
2. The`metadata` attribute
@@ -170,7 +169,7 @@ In addition, you can add selected annotations to the images table on images page
170169

171170
##Annotating images programmatically
172171

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"}.
174173

175174
First find the id of an image that you wish to annotate with the command
176175

@@ -185,17 +184,17 @@ $ codefresh get images --image-name custom
185184
ID NAME TAG CREATED SIZE PULL
186185
b5f103a87856 my-custom-docker-image bla Fri Feb 01 2019 91.01 MB r.cfcr.io/kostis-codefresh/my-custom-docker-image:bla
187186
```
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:
189188

190189
```
191190
codefresh annotate image b5f103a87856 -l coverage=75
192191
```
193192

194193
##Using custom metadata in Codefresh pipelines
195194

196-
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"}.
197196

198-
Here is an example
197+
Here is an example:
199198
```
200199
$ codefresh get image b5f103a87856 --output=yaml | yq -r .annotations.coverage
201200
75
@@ -223,5 +222,5 @@ in order to process them in a Codefresh pipeline.
223222

224223

225224
##Related articles
226-
[ExternalDockerRegistries]({{site.baseurl}}/docs/docker-registries/external-docker-registries/)
227-
[Accessing a Docker registry from your Kubernetes cluster]({{site.baseurl}}/docs/deploy-to-kubernetes/access-docker-registry-from-kubernetes/)
225+
[Dockerregistries for pipeline integrations]({{site.baseurl}}/docs/integrations/docker-registries/)
226+
[Accessing a Docker registry from your Kubernetes cluster]({{site.baseurl}}/docs/ci-cd-guides/access-docker-registry-from-kubernetes/)

‎_docs/pipelines/service-containers.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ steps:
3838

3939
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).
4040

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.
4242
4343

44-
##ViewingService containers
44+
##Viewingservice containers
4545

46-
The service containers have their own output tab in Codefresh UI
46+
The service containers have their own output tab in Codefresh UI.
4747

4848
{% include image.html
4949
lightbox="true"
@@ -129,7 +129,7 @@ caption="Using an existing composition"
129129
max-width="70%"
130130
%}
131131

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.
133133

134134

135135
##Running services for the duration of the pipeline
@@ -283,7 +283,7 @@ steps:
283283
{% endraw %}
284284
{% endhighlight %}
285285

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"}).
287287

288288

289289
##Launching a custom service
@@ -334,7 +334,7 @@ We then run a `curl` command against the sidecar container to verify the correct
334334

335335
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.
336336

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*.
338338

339339
With a readiness block you can guarantee that a sidecar service will be actually up before the pipeline will continue. Here is an example:
340340

@@ -384,7 +384,7 @@ This is an improvement over the previous example because the healthcheck of the
384384
*`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.
385385
*`failureThreshold`: failureThreshold times before giving up. In case of readiness probe the Pod will be marked Unready. Defaults to 3. Minimum value is 1
386386

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.
388388

389389
Here is another example where we use the`pg_isready` command to make sure that a PostgreSQL database is ready to accept connections
390390
before we run the integration tests.
@@ -558,10 +558,10 @@ Service containers are not compatible with [custom pipeline steps]({{site.baseur
558558

559559

560560
##Related articles
561-
[Unittests]({{site.baseurl}}/docs/testing/unit-tests/)
562-
[Integrationtests]({{site.baseurl}}/docs/testing/integration-tests/)
563-
[Integration test with database]({{site.baseurl}}/docs/example-catalog/ci-examples/integration-tests-with-database/)
564-
[CreatingCompositions]({{site.baseurl}}/docs/on-demand-test-environment/create-composition/)
561+
[Unittesting]({{site.baseurl}}/docs/testing/unit-tests/)
562+
[Integrationtesting]({{site.baseurl}}/docs/testing/integration-tests/)
563+
[Integration test with database]({{site.baseurl}}/docs/example-catalog/ci-examples/integration-tests-with-mysql/)
564+
[Creatingcompositions]({{site.baseurl}}/docs/testing/create-composition/)
565565

566566

567567

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp