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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
description: "Manageemail notifications and APIkeys"
title: "UserSettings"
description: "ManageEmail Notifications and APIKeys"
group: administration
toc: true
---
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.
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.
## Emailnotifications forbuilds
## EmailNotifications forBuilds
In the part section of the screen you can choose what email notifications you want to be active.
The options are:
Expand All
@@ -29,13 +29,13 @@ max-width="50%"
The last option is especially useful in big teams, where multiple people commit on the same Git repository.
## Weeklyupdates forbuild usage
## WeeklyUpdates forBuild Usage
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.
If you don't want to receive these emails, you can disable them by toggling the checkbox and clicking the *Save* button.
## Enable Access forsupport personnel
## Enable Access forSupport Personnel
If you have an issue with the Codefresh platform, our support personnel can log into your account and look at running
builds, inspect your docker images, run pipelines for you etc.
Expand All
@@ -57,15 +57,15 @@ If you don't enable this checkbox, our support staff have **zero visibility** in
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).
## Gitprovider private access
## GitProvider Private Access
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.
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.
Note that options available highly depend on what Git provider you are using with Codefresh.
## APIkey creation
## APIKey Creation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
description: "Manage your Helmenvironments with the Codefresh UI"
description: "Manage your HelmEnvironments with the Codefresh UI"
group: new-helm
toc: true
---
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).
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).
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.
This board has3 environments that correspond to Kubernetes clusters:
This board hasthree environments that correspond to Kubernetes clusters:
* A Load-testing environment where applications are stress-tested
* A Staging environment where smoke tests are performed
* The production environment where applications go live
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.
## Using the Helmenvironment board
## Using the HelmEnvironment Board
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.
Expand All
@@ -44,14 +44,14 @@ max-width="80%"
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:
* Column 1 - dev cluster showing all namespaces (DEV).
* Column 2 - namespace qa from cluster staging (QA).
* Column 3 - namespace staging from cluster staging (STAGING).
* Column 4 - namespace production from cluster prod (PRODUCTION).
* Column 1 - dev cluster showing all namespaces (DEV)
* Column 2 - namespace qa from cluster staging (QA)
* Column 3 - namespace staging from cluster staging (STAGING)
* Column 4 - namespace production from cluster prod (PRODUCTION)
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)
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)
## Creatingyour own Helmboard
## CreatingYour Own HelmBoard
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.
Expand All
@@ -68,14 +68,14 @@ max-width="80%"
To create a new board click the *Add board* button from the top right corner.
There are two fields in the dialog that will appear
* *board name* - the title of your board.
* *release name regex* - if present, this board will automatically filter all its environments to show only Helm releases that match this regular expression.
* *board name* - the title of your board
* *release name regex* - if present, this board will automatically filter all its environments to show only Helm releases that match this regular expression
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.
You can edit both options for an existing board if you change your mind later.
### Definingclusters/namespaces for eachenvironment
### DefiningClusters/Namespaces for eachEnvironment
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:
Expand All
@@ -96,7 +96,7 @@ For each environment you can select
* One or more namespaces that define this environment (You can even toggle the switch for a regex match)
* A custom pipeline that will be used when a Helm release is installed for the first time in this column
* A custom pipeline that will be used when a Helm release is dragged in this column (promoted from another column)
* A presentation color to easily identify the environment on the board (For example, a "production" environment should have a red color).
* A presentation color to easily identify the environment on the board (For example, a "production" environment should have a red color)
You can also select no namespace at all. In that case the column will show Helm releases for all namespaces in that cluster.
You can change all these options after creation, so feel free to change your mind.
Expand All
@@ -106,7 +106,7 @@ Repeat the same process for additional environments. Remember that you can name
You don't have to define the environments in order. You can drag-n-drop columns to change their order after the initial creation.
### Installing Helmreleases on eachenvironment
### Installing HelmReleases on eachEnvironment
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.
Expand All
@@ -127,11 +127,11 @@ You can even install manually a Helm release from any external repository by cli
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).
## Movingreleases betweenenvironments
## MovingReleases betweenEnvironments
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.
### Promoting Helmreleases with the GUI
### Promoting HelmReleases with the GUI
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.
Expand DownExpand Up
@@ -182,6 +182,9 @@ By default Codefresh will use a built-in install/upgrade pipeline for performing
* `CF_HELM_SET` - Additional values there were overriden
* `CF_HELM_CHART_JSON_GZIP` - Gzipped JSON of Helm chart (only for Helm 3)
* `CF_HELM_CHART_JSON` - JSON of Helm chart (only for Helm 2)
* `CF_HELM_TARGET_SECTION` - Name of the Source Environment that you are promoting from
* `CF_HELM_SOURCE_SECTION` - Name of the Target Environment that you are promoting to
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`
Expand All
@@ -191,7 +194,7 @@ Once you click the *update* button, a new build will run that will perform the d
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.
### Promoting Helmreleases programmatically
### Promoting HelmReleases Programmatically
You can also promote Helm releases with the [Codefresh CLI](https://codefresh-io.github.io/cli/predefined-pipelines/promote-helm-release/).
Expand DownExpand Up
@@ -222,7 +225,7 @@ steps:
{% endhighlight %}
## Editing your Helmboards
## Editing your HelmBoards
For any existing Helm board, you have the following options:
Expand All
@@ -237,16 +240,16 @@ max-width="80%"
%}
1. The refresh button will update the board with the current state of the clusters.
1. The filtering menu can be used to further constrain the Helm releases shown on each column.
1. The *edit properties* button allows you to change again the title of the board as well as a global filter for Helm releases.
1. The *remove board* completely deletes the present board from the Codefresh UI.
1. The refresh button will update the board with the current state of the clusters
1. The filtering menu can be used to further constrain the Helm releases shown on each column
1. The *edit properties* button allows you to change again the title of the board as well as a global filter for Helm releases
1. The *remove board* completely deletes the present board from the Codefresh UI
1. The environment details on the environment header are:
* The edit button to change again the options for this column (shown on mouse hover)
* The delete button to remove this column from the board (shown on mouse hover)
* The plus button to install a new chart
* A numeric value that shows how many releases are contained on this environment
1. The delete button allows you to uninstall a Helm release for an environment.
1. The delete button allows you to uninstall a Helm release for an environment
The filtering options allow you to further constrain the Helm release shown for the whole board.
Expand Down
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.