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

Commitc2b6361

Browse files
entered two variables to the list (codefresh-io#268)
1 parent52299e1 commitc2b6361

File tree

2 files changed

+35
-32
lines changed

2 files changed

+35
-32
lines changed

‎_docs/administration/user-settings.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title:"Usersettings"
3-
description:"Manageemail notifications and APIkeys"
2+
title:"UserSettings"
3+
description:"ManageEmail Notifications and APIKeys"
44
group:administration
55
toc:true
66
---
77

8-
To access your individual user settings navigate to[https://g.codefresh.io/user/settings](https://g.codefresh.io/user/settings) or click on*Usersettings* on the left sidebar.
8+
To access your individual user settings navigate to[https://g.codefresh.io/user/settings](https://g.codefresh.io/user/settings) or click on*UserSettings* on the left sidebar.
99

10-
##Emailnotifications forbuilds
10+
##EmailNotifications forBuilds
1111

1212
In the part section of the screen you can choose what email notifications you want to be active.
1313
The options are:
@@ -29,13 +29,13 @@ max-width="50%"
2929
The last option is especially useful in big teams, where multiple people commit on the same Git repository.
3030

3131

32-
##Weeklyupdates forbuild usage
32+
##WeeklyUpdates forBuild Usage
3333

3434
Codefresh will send you every week a summary of your builds across your pipelines along with other statistical data. This information can be useful if you want to understand your overall project build health and capacity usage.
3535

3636
If you don't want to receive these emails, you can disable them by toggling the checkbox and clicking the*Save* button.
3737

38-
##Enable Access forsupport personnel
38+
##Enable Access forSupport Personnel
3939

4040
If you have an issue with the Codefresh platform, our support personnel can log into your account and look at running
4141
builds, inspect your docker images, run pipelines for you etc.
@@ -57,15 +57,15 @@ If you don't enable this checkbox, our support staff have **zero visibility** in
5757
All actions performed by Codefresh personnel on your account are audited and they will also confirm with you before performing any action with side effects (such as running a pipeline).
5858

5959

60-
##Gitprovider private access
60+
##GitProvider Private Access
6161

6262
When you connect your[Git provider]({{site.baseurl}}/docs/integrations/git-providers/) during sign-up, you may choose to let Codefresh access only your public Git repositories.
6363

6464
To allow Codefresh to also add[Git triggers]({{site.baseurl}}/docs/configure-ci-cd-pipeline/triggers/git-triggers/) on private repositories you need to explicitly enable it in this section.
6565

6666
Note that options available highly depend on what Git provider you are using with Codefresh.
6767

68-
##APIkey creation
68+
##APIKey Creation
6969

7070
In this section you can create API keys so that you can access Codefresh features from your scripts or applications outside the UI. To create a new token click the*Generate* button as described in the[API documentation page]({{site.baseurl}}/docs/integrations/codefresh-api/#authentication-instructions) and select the appropriate scopes.
7171

‎_docs/new-helm/helm-environment-promotion.md‎

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title:"Helm Environment Promotion"
3-
description:"Manage your Helmenvironments with the Codefresh UI"
3+
description:"Manage your HelmEnvironments with the Codefresh UI"
44
group:new-helm
55
toc:true
66
---
7-
Apart from the[basic Helm board]({{site.baseurl}}/docs/new-helm/helm-releases-management) that shows your Kubernetes clusters at the application level, Codefresh also comes with a special environment board that allows you to track one or more applications as they move within your infrastructure (e.g. Dev, QA, Prod).
7+
Apart from the[basic Helm board]({{site.baseurl}}/docs/new-helm/helm-releases-management) that shows your Kubernetes clusters at the application level, Codefresh also comes with a special environment board that allows you to track one or more applications as they move within your infrastructure (e.g., Dev, QA, Prod).
88

99
The environment board can function both as an overview of the whole lifecycle of the application as well as a tool to shift-left/right Helm releases between environments.
1010

@@ -20,15 +20,15 @@ caption="Helm Environment Dashboard"
2020
max-width="80%"
2121
%}
2222

23-
This board has3 environments that correspond to Kubernetes clusters:
23+
This board hasthree environments that correspond to Kubernetes clusters:
2424
* A Load-testing environment where applications are stress-tested
2525
* A Staging environment where smoke tests are performed
2626
* The production environment where applications go live
2727

2828
You can see that a Python example app at version 0.2.0 is already in production. Version 0.3.0 is awaiting in the staging environment for smoke tests. Once it is tested it can be dragged to the production column therefore*promoting* it to production status.
2929

3030

31-
##Using the Helmenvironment board
31+
##Using the HelmEnvironment Board
3232

3333
You can create and manage as many Helm promotion boards as you want. For each board you define how many columns it will contain, where each column is a Helm-enabled Kubernetes cluster.
3434

@@ -44,14 +44,14 @@ max-width="80%"
4444

4545
You can use different clusters for each column or different namespaces from the same cluster. You can even mix and match both approaches. As an example, you could create a Helm board with the following environments:
4646

47-
* Column 1 - dev cluster showing all namespaces (DEV).
48-
* Column 2 - namespace qa from cluster staging (QA).
49-
* Column 3 - namespace staging from cluster staging (STAGING).
50-
* Column 4 - namespace production from cluster prod (PRODUCTION).
47+
* Column 1 - dev cluster showing all namespaces (DEV)
48+
* Column 2 - namespace qa from cluster staging (QA)
49+
* Column 3 - namespace staging from cluster staging (STAGING)
50+
* Column 4 - namespace production from cluster prod (PRODUCTION)
5151

52-
Once you have your columns in place, you can move Helm releases between clusters/namespaces by drag-n-drop. Each Helm release can be dragged to any other column either promoting it (e.g. qa toproduction) or shifting it left (e.g. prod to qa)
52+
Once you have your columns in place, you can move Helm releases between clusters/namespaces by drag-n-drop. Each Helm release can be dragged to any other column either promoting it (e.g., QA toProduction) or shifting it left (e.g. prod to qa)
5353

54-
##Creatingyour own Helmboard
54+
##CreatingYour Own HelmBoard
5555

5656
To create your own boards, select*Helm -> Boards* from the left sidebar. You can have as many boards as you want. Each board can deal with a single or multiple Helm applications.
5757

@@ -68,14 +68,14 @@ max-width="80%"
6868
To create a new board click the*Add board* button from the top right corner.
6969
There are two fields in the dialog that will appear
7070

71-
**board name* - the title of your board.
72-
**release name regex* - if present, this board will automatically filter all its environments to show only Helm releases that match this regular expression.
71+
**board name* - the title of your board
72+
**release name regex* - if present, this board will automatically filter all its environments to show only Helm releases that match this regular expression
7373

7474
The second option is very helpful if you want your environment board to only focus on a single Helm application (or set of applications that match). For the most usual case leave it empty, so that you can see all Helm releases of your clusters.
7575

7676
You can edit both options for an existing board if you change your mind later.
7777

78-
###Definingclusters/namespaces for eachenvironment
78+
###DefiningClusters/Namespaces for eachEnvironment
7979

8080
Once your Helm environment board is created, you are ready to define its columns. To add a column click the*Add environment* button on the top right corner. You will see the environment details dialog:
8181

@@ -96,7 +96,7 @@ For each environment you can select
9696
* One or more namespaces that define this environment (You can even toggle the switch for a regex match)
9797
* A custom pipeline that will be used when a Helm release is installed for the first time in this column
9898
* A custom pipeline that will be used when a Helm release is dragged in this column (promoted from another column)
99-
* A presentation color to easily identify the environment on the board (For example, a "production" environment should have a red color).
99+
* A presentation color to easily identify the environment on the board (For example, a "production" environment should have a red color)
100100

101101
You can also select no namespace at all. In that case the column will show Helm releases for all namespaces in that cluster.
102102
You can change all these options after creation, so feel free to change your mind.
@@ -106,7 +106,7 @@ Repeat the same process for additional environments. Remember that you can name
106106
You don't have to define the environments in order. You can drag-n-drop columns to change their order after the initial creation.
107107

108108

109-
###Installing Helmreleases on eachenvironment
109+
###Installing HelmReleases on eachEnvironment
110110

111111
If you already have[pipelines that deploy Helm releases]({{site.baseurl}}/docs/new-helm/using-helm-in-codefresh-pipeline/), you should see your columns get populated automatically with information.
112112

@@ -127,11 +127,11 @@ You can even install manually a Helm release from any external repository by cli
127127
You will be able to select the target cluster and namespace as well as the chart values[as any other Helm release]({{site.baseurl}}/docs/new-helm/add-helm-repository/#install-chart-from-your-helm-repository).
128128

129129

130-
##Movingreleases betweenenvironments
130+
##MovingReleases betweenEnvironments
131131

132132
A Helm environment board can be used by different stakeholders in order to get the detailed status of all defined environments. In that aspect it can act as a read-only tool that simply shows the results of Codefresh pipelines that deploy Helm applications.
133133

134-
###Promoting Helmreleases with the GUI
134+
###Promoting HelmReleases with the GUI
135135

136136
You can also use the board as an action tool in order to promote/demote a Helm release between individual environments. To move a Helm release between environments just drag-n-drop it to a different column.
137137

@@ -182,6 +182,9 @@ By default Codefresh will use a built-in install/upgrade pipeline for performing
182182
*`CF_HELM_SET` - Additional values there were overriden
183183
*`CF_HELM_CHART_JSON_GZIP` - Gzipped JSON of Helm chart (only for Helm 3)
184184
*`CF_HELM_CHART_JSON` - JSON of Helm chart (only for Helm 2)
185+
*`CF_HELM_TARGET_SECTION` - Name of the Source Environment that you are promoting from
186+
*`CF_HELM_SOURCE_SECTION` - Name of the Target Environment that you are promoting to
187+
185188

186189
Note that the variable`CF_HELM_CHART_JSON_GZIP` is both compressed and base64 encoded. To get the raw value you need a command like`echo $CF_HELM_CHART_JSON_GZIP | base64 -d | gunzip`
187190

@@ -191,7 +194,7 @@ Once you click the *update* button, a new build will run that will perform the d
191194

192195
Note that you can move releases to any column both on the right and on the left of the current column. This is helpful if for example you find a bug in your production environment and you want to bring it back to a staging environment for debugging.
193196

194-
###Promoting Helmreleases programmatically
197+
###Promoting HelmReleases Programmatically
195198

196199
You can also promote Helm releases with the[Codefresh CLI](https://codefresh-io.github.io/cli/predefined-pipelines/promote-helm-release/).
197200

@@ -222,7 +225,7 @@ steps:
222225
{% endhighlight %}
223226

224227

225-
##Editing your Helmboards
228+
##Editing your HelmBoards
226229

227230
For any existing Helm board, you have the following options:
228231

@@ -237,16 +240,16 @@ max-width="80%"
237240
%}
238241

239242

240-
1. The refresh button will update the board with the current state of the clusters.
241-
1. The filtering menu can be used to further constrain the Helm releases shown on each column.
242-
1. The*edit properties* button allows you to change again the title of the board as well as a global filter for Helm releases.
243-
1. The*remove board* completely deletes the present board from the Codefresh UI.
243+
1. The refresh button will update the board with the current state of the clusters
244+
1. The filtering menu can be used to further constrain the Helm releases shown on each column
245+
1. The*edit properties* button allows you to change again the title of the board as well as a global filter for Helm releases
246+
1. The*remove board* completely deletes the present board from the Codefresh UI
244247
1. The environment details on the environment header are:
245248
* The edit button to change again the options for this column (shown on mouse hover)
246249
* The delete button to remove this column from the board (shown on mouse hover)
247250
* The plus button to install a new chart
248251
* A numeric value that shows how many releases are contained on this environment
249-
1. The delete button allows you to uninstall a Helm release for an environment.
252+
1. The delete button allows you to uninstall a Helm release for an environment
250253

251254
The filtering options allow you to further constrain the Helm release shown for the whole board.
252255

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp