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

Commitb8dc10a

Browse files
committed
Merge branch 'classic-runner-rewrite' ofhttps://github.com/codefresh-io/docs.codefresh.io into classic-runner-rewrite
2 parentsad47e50 +d263627 commitb8dc10a

File tree

15 files changed

+245
-43
lines changed

15 files changed

+245
-43
lines changed

‎_docs/administration/cf-ip4.txt‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,12 @@
1616
44.239.141.205/32
1717
44.228.66.171/32
1818
44.238.167.159/32
19-
44.237.63.217/32
19+
44.237.63.217/32
20+
52.6.148.44/32
21+
52.73.90.9/32
22+
52.72.0.154/32
23+
52.73.76.60/32
24+
3.228.62.77/32
25+
44.205.132.73/32
26+
34.235.30.144/32
27+
54.160.88.80/32

‎_docs/administration/codefresh-on-prem-upgrade.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -426,8 +426,6 @@ From version **1.3.0 and higher**, we have deprecated Codefresh-managed `nats` c
426426
> Because `cf-nats` is a StatefulSet and has some immutable fields in its spec, both the old and new charts have the same names, preventing a direct upgrade.
427427
Direct upgrade will most likely fail with:
428428
`helm.go:84:[debug] cannot patch "cf-nats" with kind StatefulSet: StatefulSet.apps "cf-nats" is invalid: spec: Forbidden: updates to statefulset spec for fields other than 'replicas', 'template', 'updateStrategy' and 'minReadySeconds' are forbidden`
429-
After backing up existing data, you must delete the old StatefulSet.
430-
431429

432430
* **Delete the old** `cf-nats` stateful set.
433431

‎_docs/administration/codefresh-runner.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ codefresh runner init --token <my-token> <--dry-run>
8383
* Saves all the Kubernetes manifests used by the installer locally in the folder`./codefresh_manifests`.
8484
* Installs the Agent and YAML file describing the runtime.
8585

86+
8687
1. Reply to the prompts as needed:
8788

8889
{% include image.html

‎_docs/administration/platform-ip-addresses.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ that the Codefresh platform is using. This will allow you to deploy to your clus
1111

1212
>Note that this is for paying customers and needed only for customers that use the[SAAS version of Codefresh]({{site.baseurl}}/docs/administration/installation-security/). If you use the[Codefresh runner]({{site.baseurl}}/docs/administration/codefresh-runner/), there is no need to open any IPs and ports in your firewall.
1313
14-
##Current IPs used by the Codefresh platform (updatedJuly 31st 2021)
14+
##Current IPs used by the Codefresh platform (updatedJanuary 2023)
1515

1616
- 107.21.238.215
1717
- 18.209.185.91
@@ -32,6 +32,14 @@ that the Codefresh platform is using. This will allow you to deploy to your clus
3232
- 44.228.66.171
3333
- 44.238.167.159
3434
- 44.237.63.217
35+
- 52.6.148.44
36+
- 52.73.90.9
37+
- 52.72.0.154
38+
- 52.73.76.60
39+
- 3.228.62.77
40+
- 44.205.132.73
41+
- 34.235.30.144
42+
- 54.160.88.80
3543

3644
All the IPs are NAT gateways, and therefore you only need to enable specific IPs instead of ranges.
3745

‎_docs/administration/user-settings.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ For each token you can also delete it or edit it and change its applicable scope
9090

9191
Note that tokens are visible only during creation. You cannot "view" an existing token. If you want to re-enable API access for an existing application you need to delete the old token and create a new one.
9292

93-
93+
>Note: The UI shows the first few characters in the second part of the key, after the`.`, and not the characters at the beginning of the key.
9494
9595
##What to read next
9696

‎_docs/codefresh-yaml/service-containers.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -544,8 +544,14 @@ steps:
544544
{% endraw %}
545545
{% endhighlight %}
546546

547-
Note: we do recommend you only use this option as a last resort. You should not hardcode "localhost" as a requirement in your services as
548-
it adds extra constraints with integration tests (and especially with dynamic test environments).
547+
>💡 Note
548+
>
549+
>We do recommend you only use this option as a last resort. You should not hardcode "localhost" as a requirement in your services as it adds extra constraints with integration tests (and especially with dynamic test environments).
550+
551+
>⚠️ Warning
552+
>
553+
>If`shared_host_network: true`, services will no longer be available by name.
554+
>This means that you cannot mix access by name and localhost within one service group, you have to choose one and use`shared_host_network` attribute accordingly.
549555
550556

551557
##Limitations
@@ -561,11 +567,3 @@ Service containers are not compatible with [custom pipeline steps]({{site.baseur
561567
*[Integration tests]({{site.baseurl}}/docs/testing/integration-tests/)
562568
*[Integration test with database]({{site.baseurl}}/docs/yaml-examples/examples/integration-tests-with-database/)
563569
*[Creating Compositions]({{site.baseurl}}/docs/on-demand-test-environment/create-composition/)
564-
565-
566-
567-
568-
569-
570-
571-

‎_docs/codefresh-yaml/steps/git-clone.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ toc: true
99
---
1010
Clones a Git repository to the filesystem.
1111

12-
A pipeline can have any number of git clone steps (even none). You cancheckout code from any private or public repository. Cloning a repository is not constrained to the trigger of a pipeline. You can trigger a pipeline from a commit that happened on Git repository A while the pipeline is checking out code from Git Repository B.
12+
A pipeline can have any number of git clone steps (even none). You cancheck out code from any private or public repository. Cloning a repository is not constrained to the trigger of a pipeline. You can trigger a pipeline from a commit that happened on Git repository A while the pipeline is checking out code from Git Repository B.
1313

14-
>Notice that if you are an existing customer before May 2019, Codefresh will automaticallycheckout the code from a[connected git repository]({{site.baseurl}}/docs/integrations/git-providers/) when a pipeline is created on that repository. In this case an implicit git clone step is included in your pipeline. You can still override it with your own git clone step as explained in this page
14+
>Notice that if you are an existing customer before May 2019, Codefresh will automaticallycheck out the code from a[connected git repository]({{site.baseurl}}/docs/integrations/git-providers/) when a pipeline is created on that repository. In this case an implicit git clone step is included in your pipeline. You can still override it with your own git clone step as explained in this page
1515
1616
##Usage
1717

@@ -23,6 +23,7 @@ step_name:
2323
description: Step description
2424
working_directory: /path
2525
repo: owner/repo
26+
depth: 3
2627
git: my-git-provider
2728
revision: abcdef12345'
2829
use_proxy: false
@@ -45,6 +46,7 @@ step_name:
4546

4647
##Fields
4748

49+
4850
{: .table .table-bordered .table-hover}
4951
| Field| Description| Required/Optional/Default|
5052
| ------------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------------------------|
@@ -53,8 +55,9 @@ step_name:
5355
|`stage`| Parent group of this step. See[using stages]({{site.baseurl}}/docs/codefresh-yaml/stages/) for more information.| Optional|
5456
|`working_directory`| The directory to which the repository is cloned. It can be an explicit path in the container's file system, or a variable that references another step. The default value is {% raw %}`${{main_clone}}`{% endraw %}, but note that the default will only be used if you name your step`main_clone`. See the example on[working inside the cloned directory]({{site.baseurl}}/docs/yaml-examples/examples/git-checkout/#working-inside-the-cloned-directory) for more information.| Default|
5557
|`git`| The name of the[git integration]({{site.baseurl}}/docs/integrations/git-providers/) you want to use. If left empty, Codefresh will attempt to use the git provider that was used during account sign-up. Note that this might have unexpected results if you are changing your Git integrations.| Required|
56-
|`repo`| path of the repository without the domain name in the form of`my_username/my_repo`| Required|
58+
|`repo`|Thepath of the repository without the domain name in the form of`my_username/my_repo`. {::nomarkdown} <br>Note: To clone a GitHub wiki, specify the full URL of the wiki,{:/} for example,`"https://github.com/wikis/examples.wiki"`.| Required|
5759
|`revision`| The revision of the repository you are checking out. It can be a revision hash or a branch name. The default value is the branch you have specified in your Git provider (e.g`master` or`main`).| Default|
60+
|`depth`| The number of commits to pull from the repo to create a shallow clone. Creating a shallow clone truncates the history to the number of commits specified, instead of pulling the entire history.| Optional|
5861
|`use_proxy`| If set to true the Git clone process will honor`HTTP_PROXY` and`HTTPS_PROXY` variables if present for[working via a proxy](#using-git-behind-a-proxy). Default value is`false`.| Default|
5962
|`credentials`| Credentials to access the repository, if it requires authentication. It can an object containing`username` and`password` fields. Credentials are optional if you are using the[built-in git integrations]({{site.baseurl}}/docs/integrations/git-providers/) .| Optional|
6063
|`fail_fast`| If a step fails and the process is halted. The default value is`true`.| Default|

‎_docs/configure-ci-cd-pipeline/pipelines.md‎

Lines changed: 59 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -115,17 +115,61 @@ Working with the inline editor is very convenient in the beginning, but it makes
115115

116116
You can click on the*Inline YAML* header and switch it to*Use YAML from URL* or*Use YAML from Repository*.
117117

118+
{% include
119+
image.html
120+
lightbox="true"
121+
file="/images/pipeline/create/pipeline-git-options.png"
122+
url="/images/pipeline/create/pipeline-git-options.png"
123+
alt="Pipeline resource options"
124+
caption="Pipeline resource options"
125+
max-width="60%"
126+
%}
127+
128+
###Using another Git repository
129+
130+
Loading the pipeline from a Git repository is the recommended way to associate a pipeline with a project once you are finished with it. Even though the inline editor is great for quick prototyping and experimentation, ideally all your pipelines should be under source control.
131+
132+
When you click this option from the drop-down menu you will can select any Git repository already connected to Codefresh along with a preview of the pipeline.
133+
134+
{% include
135+
image.html
136+
lightbox="true"
137+
file="/images/pipeline/create/pipeline-per-branch.png"
138+
url="/images/pipeline/create/pipeline-per-branch.png"
139+
alt="Load pipeline from Git"
140+
caption="Load pipeline from Git"
141+
max-width="60%"
142+
%}
143+
144+
Note that unlike other CI options the Git repository that contains the pipeline can be completely different from the Git repository that has the source code of your application.
145+
146+
The**Use branch from Git trigger** option is very important and defines from which branch of the Git repo the pipeline will be loaded from. In most cases you want to keep this enabled as it will make the pipeline load from the same branch that triggered the build.
147+
148+
For example if you open a new pull request for a branch named`feature-x` that has changes both in source code and in the pipeline definition itself, ideally you would want the pipeline responsible for the build to be the same one that contains the new changes in the`feature-x` branch.
149+
150+
If you disable this option then you can select a specific branch from the field directly above the switch. The option is great for organizations that want to lock down their pipelines.
151+
152+
For example, if you define`master` as the branch that will be used for this pipeline, then even if a developer creates a custom branch for their source code changes, they will not be able to change the pipeline itself to do something different. Their pipeline changes in their own branch will be ignored as all builds will always load the pipeline from`master`. This can be very useful for security sensitive pipelines.
153+
154+
155+
###Using any public URL
156+
157+
The URL option allows you to load the pipeline definition from any_public_
158+
118159
{% include
119160
image.html
120161
lightbox="true"
121162
file="/images/pipeline/create/pipeline-from-internal-repo.png"
122163
url="/images/pipeline/create/pipeline-from-internal-repo.png"
123164
alt="Pipeline from internal repo"
124165
caption="Pipeline from internal repo"
125-
max-width="60%"
166+
max-width="70%"
126167
%}
127168

128-
You can then copy and paste a URL to a raw Codefresh YAML file. This will allow you to load a Codefresh YAML from any public URL. Notice that a raw URL is needed in the case of GitHub.
169+
You can then copy and paste a URL to a raw Codefresh YAML file. This will allow you to load a Codefresh YAML from any URL.
170+
171+
172+
Notice that a raw URL is needed in the case of GitHub.
129173

130174
As an example, instead of using`https://github.com/codefresh-contrib/example-voting-app/blob/master/codefresh.yml` you should enter`https://raw.githubusercontent.com/codefresh-contrib/example-voting-app/master/codefresh.yml`
131175

@@ -147,10 +191,10 @@ Once you create your pipeline you can also click on the top tab called *Settings
147191

148192
###Policies
149193

150-
-**Pipeline Concurrency**: the maximum number of concurrent builds (0-14 or unlimited) -- set this when your pipeline has only one trigger
194+
-**Pipeline Concurrency**: the maximum number of concurrent builds (0-30 or unlimited) -- set this when your pipeline has only one trigger
151195
>A Pipeline Concurrency of**0** freezes execution of the pipeline, switching it to maintenance mode. Use this concurrency setting to modify existing pipelines and freeze execution until you complete the changes.
152-
-**Trigger Concurrency**: the maximum number of concurrent builds per trigger (1-15 or unlimited) -- set this when your pipeline has multiple triggers
153-
-**Branch Concurrency**: the maximum number of concurrent builds per branch (1-15 or unlimited) -- set this when your pipeline can build different branches
196+
-**Trigger Concurrency**: the maximum number of concurrent builds per trigger (1-31 or unlimited) -- set this when your pipeline has multiple triggers
197+
-**Branch Concurrency**: the maximum number of concurrent builds per branch (1-31 or unlimited) -- set this when your pipeline can build different branches
154198
-**Build Termination**: various toggles for when a build from the pipeline should terminate
155199
- Once a build is created terminate previous builds from the same branch
156200
- Once a build is created terminate previous builds only from a specific branch (name matches a regular expression)
@@ -218,16 +262,18 @@ You can define multiple external resources in a single pipeline.
218262
- Medium (recommended 3-4 steps)
219263
- Large (recommended 5-6 steps)
220264

221-
####Set disk space for pipeline builds
222-
Set the disk space you need for the pipeline's build volume. Configuring the disk space per pipeline build volume prevents out-of-space scenarios that lead to failed builds. The disk space set for the pipeline is inherited by all the builds run for the pipeline.
265+
####Set minimum disk space for a pipeline build
266+
To speed up builds and improve performance, Codefresh caches different types of data during pipeline execution for reuse across builds. Image-caching is one example of cached data, where Codefresh pulls the required images during the first build and caches them for reuse in future builds. For more info, see[Pipeline caching]({{site.baseurl}}docs/configure-ci-cd-pipeline/pipeline-caching).
267+
Because a portion of the disk space is already utilized by cache, a build can run out of disk space and fail with the 'no space left on device' error.
223268

224-
Codefresh calculates the available range according tothe disk size, and automatically sets the disk space for the build volume to 70% ofthetotal disk space. You caneitherretain the default allocationorchange as needed.
269+
To prevent out-of-space scenarios that lead tofailed builds, you can set theminimumdisk spaceyou needfor thepipeline'sbuild volume. Definingtheminimum disk space ensures that Codefresh assignseithera cached disk with sufficient disk spaceora new empty disk at the start of the build.
225270

226-
>You can also configure the disk space for a[specific trigger]({{site.baseurl}}/docs/configure-ci-cd-pipeline/triggers/git-triggers/#set-minimum-disk-space-for-build-volume-by-trigger) used by the pipeline or for a specific run, and override what's set for the pipeline.
271+
The disk space set for the pipeline is inherited by all the builds run for the pipeline.
272+
You can also configure the disk space for a[specific trigger]({{site.baseurl}}/docs/configure-ci-cd-pipeline/triggers/git-triggers/#set-minimum-disk-space-for-build-volume-by-trigger) used by the pipeline or for a specific run, and override what's set for the pipeline.
227273

228-
1. Select the pipeline for which to set the disk space.
274+
1. Select the pipeline for which to set theminimumdisk space.
229275
1. Select**Settings**, and then**Runtime**.
230-
1. Enable**Set minimum required disk space** and either retain the default displayed or change as needed.
276+
1. Enable**Set minimum required disk space**, and either retain the default displayed or change as needed.
231277

232278
{% include
233279
image.html
@@ -239,7 +285,8 @@ caption="Set disk space for pipeline builds"
239285
max-width="60%"
240286
%}
241287

242-
288+
>Track the actual disk usage in Builds > Metrics.
289+
243290
##Using Pipeline Templates
244291

245292
Codefresh also supports the creation of pipeline "templates" which are blueprints for creating new pipelines. To enable the creation of pipelines from templates first visit the global pipeline configuration at[https://g.codefresh.io/account-admin/account-conf/pipeline-settings](https://g.codefresh.io/account-admin/account-conf/pipeline-settings) and toggle the*Enable Pipeline Templates* button.

‎_docs/configure-ci-cd-pipeline/triggers.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ toc: true
99
---
1010

1111

12-
To create an effective CI/CD process, it should be possible to triggeraCodefreshpipeline execution not only on code repository events (like`push` or`PR`), but also on any "interesting" CD-related event, coming from some external system.
12+
To create an effective CI/CD process, it should be possible to trigger Codefreshpipelines not only on code repository events (like`push` or`PR`), but also on any "interesting" CD-related event, coming from some external system.
1313

14-
Codefresh not only allows you to define different pipelines on a single project butitalso offers you the capability to trigger them with completely separate mechanisms.
14+
Codefresh not only allows you to define different pipelines on a single project but also offers you the capability to trigger them with completely separate mechanisms. You can even skip triggering a pipeline by including predefined flags in the commit message.
1515

1616

1717
##Codefresh Trigger Types
@@ -95,6 +95,8 @@ For more information see:
9595
You can easily disable a trigger manually if you don't want to be active anymore.
9696
On the triggers tab click the gear icon on the top right (*Open advanced options*).
9797

98+
99+
98100
{% include image.html
99101
lightbox="true"
100102
file="/images/pipeline/triggers/enable-triggers.png"
@@ -108,6 +110,9 @@ max-width="70%"
108110
Then click the toggle switch on each trigger that you want to enable/disable. You can later enable the same trigger again
109111
by clicking the same switch.
110112

113+
>For Git triggers, you can also skip triggering the pipeline without disabling the trigger by adding a predefined string to the commit message. See[Skip triggering pipeline on commit]({{site.baseurl}}/docs/configure-ci-cd-pipeline/triggers/git-triggers/#skip-triggering-pipeline-on-commit).
114+
115+
111116
##What to read next
112117

113118
*[Creating pipelines]({{site.baseurl}}/docs/configure-ci-cd-pipeline/pipelines/)

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp