Skip to content

Commit 66fd4fb

Browse files
NimRegevNimRegev
authored
Q2 s4 pipeline scopes (#792)
* Add pipeline scopes content Updated global and pipeline-specific settings with new Scopes feature * Update pipelines.md * Update pipeline scopes Added screenshot of scope in account settings,and added link to custom config option
1 parent d5f86ff commit 66fd4fb

File tree

5 files changed

+120
-26
lines changed

5 files changed

+120
-26
lines changed

‎_docs/administration/user-self-management/user-settings.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,10 @@ max-width="100%"
9090
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.
9191
For details, see [Codefresh API]({{site.baseurl}}/docs/integrations/codefresh-api/#authentication-instructions).
9292

93-
>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.
93+
>**IMPORTANT**:
94+
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.
9495

95-
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.
96+
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.
9697

9798

9899

@@ -110,7 +111,35 @@ caption="Generating a key for the API"
110111
max-width="80%"
111112
%}
112113

113-
114+
<!---
115+
### API scopes
116+
{: .table .table-bordered .table-hover}
117+
| Pipeline scope | Description |
118+
| ------------------------| ---------------- |
119+
| **General** | Row 1 |
120+
| **Agent**/**Agents** | Row 2 |
121+
| **Analytics** | Row 3 |
122+
| **API** | Row 4 |
123+
| **API keys** | Row 5 |
124+
| **Audit** | Row 6 |
125+
| **Board** | Row 7 |
126+
| **Build** | Row 8 |
127+
| **Chart** | Row 9 |
128+
| **Cluster**/**Clusters** | Row 10 |
129+
| **Environments-V2** | Control access to the Environment Dashboard with Kubernetes and Helm releases: <br>Read - View only access<br>Write - access . |
130+
| **Gen-AI** | Row 12 |
131+
| **GitHub Actions** | Row 13 |
132+
| **GitOps** | Row 14 |
133+
| **Helm** | Row 15 |
134+
| **Kubernetes** | Row 16 |
135+
| **Pipeline** | Row 17 |
136+
| **Project** | Row 18 |
137+
| **Repos** | Row 19 |
138+
| **Runner installation** | Row 20 |
139+
| **Step-Tyep**/**Step-Types** | Row 21 |
140+
| **Verification** | Row 22 |
141+
| **View** | Row 23 |
142+
-->
114143

115144
## Related articles
116145
[Managing Git PATs]({{site.baseurl}}/docs/administration/user-self-management/manage-pats/)

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

Lines changed: 45 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Global settings for pipelines"
3-
description: "Define global options for pipeline templates, yaml sources and approval behavior"
3+
description: "Configure settings for pipeline templates, YAML sources and build behavior for all pipelines in account"
44
group: pipelines
55
sub_group: configuration
66
redirect_from:
@@ -9,14 +9,31 @@ toc: true
99
---
1010

1111

12-
You can define global settings for all the pipelines in the account. Users can still override some settings for individual pipelines.
12+
As a Codefresh account administrator, you can define global settings for all the pipelines in the account. Users can still override some settings for individual pipelines.
1313

14+
{: .table .table-bordered .table-hover}
15+
| Account-level pipeline setting | Description |
16+
| ------------------------| ---------------- |
17+
|[Pause pipeline executions](#pause-pipeline-executions)| Define if users can pause builds for new and existing pipelines in the account. |
18+
|[New pipeline creation options](#new-pipeline-creation-options)| Define if users can new pipelines from templates or by cloning existing pipelines. |
19+
|[Configure pipeline scopes](#configure-pipeline-scopes)| Control access to endpoints exposed by the pipeline. |
20+
|[Auto-create projects for teams](#auto-create-projects-for-teams)| Enabled by default, automatically creates projects when adding teams to the account. |
21+
|[Enabling cluster-contexts for pipelines](#enabling-cluster-contexts-for-pipelines)| Define if users can select the clusters to which the pipeline has access. |
22+
|[Enabling cluster-contexts for pipelines](#enabling-cluster-contexts-for-pipelines)| Enable/disable sources for pipeline YAMLs. |
23+
|[Memory usage warning for pipeline builds](#memory-usage-warning-for-pipeline-builds)| Enable alerts when pipelines reach/exceed the threshold. |
24+
|[Advanced pipeline options](#advanced-pipeline-options)| Configure options for build approval and pipeline volumes. |
25+
|[Default behavior for build step](#default-behavior-for-build-step)| Configure push image options for build steps. |
26+
27+
28+
## Access global pipeline settings
29+
Global settings for pipelines are set for the account and inherited by all pipelines in the account.
1430

15-
## Access pipeline settings
1631
1. In the Codefresh UI, on the toolbar, click the **Settings** icon.
1732
1. From Configuration in the sidebar, select [**Pipeline Settings**](https://g.codefresh.io/account-admin/account-conf/pipeline-settings){:target="\_blank"}.
1833

1934

35+
36+
2037
## Pause pipeline executions
2138

2239
Pause builds for pipelines at the account level, for example, during maintenance.
@@ -36,14 +53,33 @@ caption="Pause Build Execution pipeline setting enabled"
3653
max-width="60%"
3754
%}
3855

39-
## New pipeline as templates
56+
## New pipeline creation options
57+
58+
Here you can define if users can [create pipelines]({{site.baseurl}}/docs/pipelines/pipelines/#creating-a-pipeline) from existing pipelines or from scratch:
59+
60+
* Create pipelines from a [pipeline template]({{site.baseurl}}/docs/pipelines/pipelines/#using-pipeline-templates).<br>
61+
Enabling this option allows users to select a pipeline marked as a template as the source for the new pipeline.
62+
Templates are simply pipelines “marked” as templates. There is no technical difference between templates and actual pipelines.
63+
64+
* Clone existing pipeline<br>
65+
Enabling this option allows users to create a pipeline by cloning an existing pipeline. Cloning an existing pipelines also copies its triggers and associated parameters.
66+
67+
## Configure pipeline scopes
68+
Define the account-level scopes for resources, inherited by all pipelines in the account, through full access, read/write access, or CRUD permissions. <!--- For a description of the available scopes, see [API scopes]({{site.baseurl}}/docs/administration/user-self-management/user-settings/#api-scopes). -->
69+
70+
{% include image.html
71+
lightbox="true"
72+
file="/images/pipeline/pipeline-settings/pipeline-scopes-setting.png"
73+
url="/images/pipeline/pipeline-settings/pipeline-scopes-setting.png"
74+
alt="Scopes for pipelines"
75+
caption="Scopes for pipelines"
76+
max-width="60%"
77+
%}
4078

41-
Here you can define global template behavior. The options are:
79+
>**TIP**:
80+
As a Codefresh administrator, you can override the account-level scopes for a specific pipeline by [configuring custom scopes]({{site.baseurl}}/docs/pipelines/pipelines/#scopes). The custom scopes are inherited by all the builds for that pipeline.
4281

43-
* 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.
44-
* 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).
4582

46-
Note that templates are simply pipelines “marked” as templates. There is no technical difference between templates and actual pipelines.
4783

4884
## Auto-create projects for teams
4985
Enabled by default, auto-create projects for teams, automatically creates projects whenever you create teams in your account. It also creates access-control rules for the same team to projects and pipeline, simplifying setup and saving time.
@@ -128,7 +164,7 @@ You can then select specific clusters for individual pipelines, through the **Ku
128164

129165

130166

131-
## Pipeline YAML section
167+
## Configure sources for pipeline YAMLs
132168

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

‎_docs/pipelines/pipelines.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ max-width="60%"
415415
> Track the actual disk usage in Builds > Metrics.
416416
417417
#### Set memory-usage threshold for pipeline build
418-
If needed, select a memory-usage threshold for the pipeline build to override that set at the account level. Codefresh displays a banner when memory usage has exceeded the selected threshold.
418+
If needed, select a memory-usage threshold for the pipeline build to override the account-level setting for the same. Codefresh displays a banner when memory usage has exceeded the selected threshold.
419419

420420
The global memory-usage threshold is set in **Pipeline Settings**, for all pipelines in the account.
421421
You can override the memory-usage threshold for individual pipelines, depending on the resources needed for pipeline execution. For example, if the account-level memory usage is set at 90%, and the specific pipeline is resource-intensive, you want to be warned when the usage exceeds 70%, instead of 90%.
@@ -431,13 +431,30 @@ caption="Memory-usage thresholds for pipeline"
431431
max-width="60%"
432432
%}
433433

434+
### Scopes
435+
If needed, Codefresh account administrators can override the scopes set at the account-level with custom scopes for ehe dividual pipeline. All the pipeline's builds inherit the custom scopes.
434436

435-
## Using Pipeline Templates
437+
{% include
438+
image.html
439+
lightbox="true"
440+
file="/images/pipeline/create/pipeline-create-scopes.png"
441+
url="/images/pipeline/create/pipeline-create-scopes.png"
442+
alt="Custom scopes for pipeline"
443+
caption="Custom scopes for pipeline"
444+
max-width="60%"
445+
%}
446+
447+
## Using pipeline templates
448+
449+
When enabled for the account, you can create a new pipeline from existing pipelines tagged as _Templates_.
450+
To do so, you need to first convert existing pipelines to pipeline templates.
436451

437-
Codefresh also supports the creation of pipeline "templates", which are blueprints for creating new pipelines.
438-
To enable the creation of pipelines from templates, first view global pipeline configuration in the [Codefresh UI](https://g.codefresh.io/account-admin/account-conf/pipeline-settings){:target="\_blank"} and toggle the *Enable Pipeline Templates* button.
452+
### Create a pipeline template
453+
Convert an existing pipeline into a pipeline template, by tagging it as such.
439454

440-
The easiest way to create a new template is by clicking the "3 dots menu" on the pipeline name:
455+
1. In the Codefresh UI, from the sidebar, select **Pipelines** to view all your pipelines.
456+
1. Select the pipeline to convert to a template.
457+
1. From the sidebar, mouse over the pipeline name, and from the context menu, select **Create Template**.
441458

442459
{% include
443460
image.html
@@ -449,7 +466,11 @@ caption="Create template from pipeline"
449466
max-width="30%"
450467
%}
451468

452-
From the dialog you can select if you want to copy this pipeline as a brand new template, or simply convert the pipeline itself to a template:
469+
{:start="4"}
470+
1. Do one of the following:
471+
* To convert the pipeline to a pipeline template, select **Convert the pipeline itself to a template**.
472+
* To create a copy of the pipeline and convert the copy into a pipeline template, select **Copy this pipeline to a pipeline template**.
473+
Define the template name, project and tags.
453474

454475
{% include
455476
image.html
@@ -458,10 +479,10 @@ file="/images/pipeline/create/template-dialog.png"
458479
url="/images/pipeline/create/template-dialog.png"
459480
alt="Template options"
460481
caption="Template options"
461-
max-width="80%"
482+
max-width="60%"
462483
%}
463484

464-
Once the template is created, you can edit it like any other pipeline. Pipeline templates are marked with the `template` tag and also have a special mark in the pipeline menu:
485+
In the Pipelines page, pipeline templates are marked **TEMPLATES**. On selecting a pipeline, pipeline templates in the sidebar are prefixed with a dot.
465486

466487
{% include
467488
image.html
@@ -473,21 +494,29 @@ caption="Identify pipelines used as templates"
473494
max-width="90%"
474495
%}
475496

497+
498+
499+
500+
### Create a pipeline from a pipeline template
476501
Now when you create a new pipeline, you can also select which pipeline template will be used as an initial pipeline definition:
477502

503+
>**NOTE**:
504+
Selecting a pipeline template, applies the template's settings when the pipeline is created. Subsequent changes to the pipeline template _do not_ impact pipelines already created from that template.
505+
478506
{% include
479507
image.html
480508
lightbox="true"
481509
file="/images/pipeline/create/use-template.png"
482510
url="/images/pipeline/create/use-template.png"
483-
alt="Using a template"
484-
caption="Using a template"
511+
alt="Create pipeline from a pipeline template"
512+
caption="Create pipeline from a pipeline template"
485513
max-width="70%"
486514
%}
487515

488-
>Notice that templates only take effect during pipeline creation. Changing a template afterwards, has no effect on pipelines that are already created from it.
516+
>**TIP**:
517+
You can also quickly convert a pipeline to a template, in the General tab of the pipeline's settings.
518+
489519

490-
You can also quickly convert a pipeline to a template, by visiting the pipeline settings and clicking the *template* button under the *General* tab.
491520

492521

493522
## Pipelines that do not belong to any project
@@ -511,8 +540,8 @@ Pipelines that belong to a project will mention it below their name so it is ver
511540

512541

513542
## Related articles
514-
[Global pipeline settings]({{site.baseurl}}/docs/pipelines/configuration/pipeline-settings/)
515-
[Codefresh YAML for pipeline definitions]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
543+
[Global pipeline settings]({{site.baseurl}}/docs/pipelines/configuration/pipeline-settings/)
544+
[Codefresh YAML for pipeline definitions]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
516545
[Steps in pipelines]({{site.baseurl}}/docs/pipelines/steps/)
517546
[Docker registry integrations]({{site.baseurl}}/docs/integrations/docker-registries/)
518547
[Example catalog]({{site.baseurl}}/docs/example-catalog/examples/)

‎images/pipeline/create/pipeline-create-scopes.png

124 KB
Loading

‎images/pipeline/pipeline-settings/pipeline-scopes-setting.png

83 KB
Loading

0 commit comments

Comments
 (0)