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/user-self-management/user-settings.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,11 @@ Note that options available highly depend on what Git provider you are using wit
83
83
Generate new API keys to access Codefresh functionality from your scripts or applications, outside the Codefresh UI. Edit scopes for existing keys, or revoke them when needed.
84
84
For details, see [Codefresh API]({{site.baseurl}}/docs/integrations/codefresh-api/#authentication-instructions).
85
85
86
-
>Tokens are visible only during creation. You cannot "view" an existing token. To re-enable API access for an existing application, you must delete the old token and create a new one.
86
+
>Tokens are visible only during creation. You cannot "view" an existing token. To re-enable API access for an existing application, you must delete the old token and create a new one.
87
+
88
+
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.
89
+
90
+
87
91
88
92
89
93
1. In **API Keys**, to generate a new API key, click **Generate**.
@@ -100,6 +104,7 @@ max-width="80%"
100
104
%}
101
105
102
106
107
+
103
108
## Related articles
104
109
105
110
<!--why do we need this? this is for admins; also SSO[Add users]({{site.baseurl}}/docs/administration/invite-your-team-member/) -->
#### The proper/secure way for Kubernetes Cluster 1.24+
378
+
379
+
For production environments, create a service account and/or role for Codefresh access.
380
+
381
+
Codefresh needs these minimum permissions to work with the cluster:
382
+
383
+
`codefresh-role.yml`
384
+
{% highlight yaml %}
385
+
{% raw %}
386
+
kind: ClusterRole
387
+
apiVersion: rbac.authorization.k8s.io/v1
388
+
metadata:
389
+
name: codefresh-role
390
+
rules:
391
+
- apiGroups: [“”]
392
+
resources: [“*”]
393
+
verbs: [“list”, “watch”, “get”]
394
+
{% endraw %}
395
+
{% endhighlight %}
396
+
397
+
Note that these permissions will only allow Codefresh to read the cluster resources and populate the respective dashboards. You need to give more privileges for actual deployments. For more information see the [Kubernetes RBAC documentation page](https://kubernetes.io/docs/reference/access-authn-authz/rbac/){:target="\_blank"}.
398
+
399
+
Here is an example with role + service account + binding.
You can then get the memory usage for the whole pipeline by clicking on the metrics tab at the bottom of the screen.
333
+
* To view memory and disk usage for running or completed pipeline builds, click the **Metrics** tab at the bottom of the Build page.
334
+
335
+
* Memory usage: View memory usage (Y-axis) by time (X-axis) for the duration of the build.
336
+
* Disk usage: View disk usage (Y-axis) by time (X-axis) for the duration of the build. The red line is set at 90% of the maximum disk space.
337
+
To see the precise usage at different points in time, mouse over the dots.
338
+
Viewing the actual disk usage for a build during its run allows you to better gauge and define the [minimum disk space required for the build volume]({{site.baseurl}}/docs/pipelines/pipelines/#runtime).
Copy file name to clipboardExpand all lines: _docs/pipelines/pipelines.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -218,12 +218,14 @@ You can define multiple external resources in a single pipeline.
218
218
- Medium (recommended 3-4 steps)
219
219
- Large (recommended 5-6 steps)
220
220
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.
221
+
#### Set minimum disk space for a pipeline build
222
+
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/pipelines/pipeline-caching).
223
+
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.
223
224
224
-
Codefresh calculates the available range according to the disk size, and automatically sets the disk space for the build volume to 70% of the total disk space. You can either retain the default allocation or change as needed.
225
+
To prevent out-of-space scenarios that lead to failed builds, you can set the minimum disk space you need for the pipeline's build volume. Defining the minimum disk space ensures that Codefresh assigns either a cached disk with sufficient disk space or a new empty disk at the start of the build.
225
226
226
-
>You can also configure the disk space for a [specific trigger]({{site.baseurl}}/docs/pipelines/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.
227
+
The disk space set for the pipeline is inherited by all the builds run for the pipeline.
228
+
You can also configure the disk space for a [specific trigger]({{site.baseurl}}/docs/pipelines/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.
227
229
228
230
1. Select the pipeline for which to set the disk space.
229
231
1. Select **Settings**, and then **Runtime**.
@@ -239,6 +241,8 @@ caption="Set disk space for pipeline builds"
239
241
max-width="60%"
240
242
%}
241
243
244
+
> Track the actual disk usage in Builds > Metrics.
Copy file name to clipboardExpand all lines: _docs/pipelines/steps/git-clone.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,7 @@ step_name:
55
55
|`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
56
|`repo`| path of the repository without the domain name in the form of `my_username/my_repo`| Required |
57
57
|`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 |
58
+
|`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 |
58
59
|`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 |
59
60
|`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 |
60
61
|`fail_fast`| If a step fails and the process is halted. The default value is `true`. | Default |
0 commit comments