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/getting-started/cd-codefresh.md
+38-31Lines changed: 38 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Dashboards -->
22
22
23
23
24
24
##Connecting to Kubernetes
25
-
Connecting your Kubernetes cluster to the CI/CD platform is the first step in continuous deployment. Codefresh integrates with any known cluster provider for Kubernetes through a few simple steps. Connect your Google, Azure, or Amazon Kubernetes cluster to Codefresh through simple integration steps. If your Kubernetesclusters is not our list of cluster providers, you can manually enter your cluster settings and add it as a generic Kubernetes cluster.
25
+
Connecting your Kubernetes cluster to the CI/CD platform is the first step in continuous deployment. Codefresh integrates with any known cluster provider for Kubernetes through a few simple steps. Connect your Google, Azure, or Amazon Kubernetes cluster to Codefresh through simple integration steps. If your Kubernetescluster is not in our list of cluster providers, you can manually enter your cluster settings and add it as a generic Kubernetes cluster.
26
26
27
27
See[Connecting a Kubernetes cluster]({{site.baseurl}}/docs/integrations/kubernetes/#connect-a-kubernetes-cluster).
28
28
@@ -31,10 +31,10 @@ Codefresh offers a variety of options for you to choose from when deploying to K
31
31
Deploy to Kubernetes from the Codefresh UI, or programmatically through dedicated steps in pipelines avoiding the need for`kubectl` commands.
32
32
33
33
**On-demand deployment**
34
-
For quick and easy deployment, deploy on-demand from the Codefresh UI.
34
+
For quick and easy deployment,you candeploy on-demand from the Codefresh UI.
35
35
36
36
**Dedicated steps in pipelines**
37
-
Wehave the`deploy` step, and the more advanced`cf-deploy-kubernetes`stepthat enables simple templating on Kubernetes manifests.
37
+
For more flexibility, wehavededicated steps for pipelines,the`deploy` step, and the more advanced`cf-deploy-kubernetes`stepwhich enables simple templating on Kubernetes manifests.
38
38
39
39
Codefresh pipelines also support Kustomize and Helm for deployments through freestyle steps.
40
40
@@ -52,59 +52,66 @@ Because Codefresh automatically sets up your `kubeconfig` files with the informa
Codefresh supplies a built-in Helm repository with every Codefresh account. And supports, besides public HTTP repositories, several private, authenticated Helm repositories.
57
57
58
58
**Connect to Helm repositories**
59
-
In addition to the official Helm repositories which are displayed in the Helm charts, Codefresh allows you connect with any external Helm repository through simple integrations. You can then inject the Helm repository context into your pipelines by selecting the repository name.
59
+
In addition to the official Helm repositories which are displayed in the Helm charts, Codefresh allows youtoconnect with any external Helm repository through simple integrations. You can then inject the Helm repository context into your pipelines by selecting the repository name.
60
60
61
61
**Build Helm charts**
62
-
Install Helm charts from Helm repositories, or build a new one.
62
+
Install Helm charts from Helm repositories, or build a new one.
63
63
64
-
<!--Codefresh has a dedicated step for Helm step to easily integrate Helm in Codefresh pipelines, and authenticate, configure, and execute Helm commands.
65
-
The Helm step can operate in one of three modes covering most scenarios:
64
+
65
+
As with steps for Kubernetes deployments, Codefresh has a dedicated step for Helm deployments. The Helm step easily integrates Helm in Codefresh pipelines, and can authenticate, configure, and execute Helm commands.
66
+
The Helm step can operate in one of three modes covering most scenarios:
66
67
* Install the chart into a Kubernetes cluster. This is the default mode if not explicitly set.
67
68
* Package the chart and push it to the defined repository.
68
-
Authentication to setup authentication and add the repo to Helm. This is useful if you want to write your ownhelm commands using the freestyle step’s commands property, but you still want the step to handle authentication.-->
69
+
* Setup authentication and add the repo to Helm. This is useful if you want to write your ownHelm commands using the freestyle step’s commands property, but you still want the step to handle authentication.
69
70
70
-
Deploy Helm charts
71
+
**Deploy Helm charts**
71
72
Deploy the Helm chart to a Kubernetes cluster, Helm repo, or both.
72
73
74
+
See[Using Helm in Codefresh pipelines]({{site.baseurl}}/docs/deployments/helm//using-helm-in-codefresh-pipeline/),[Using managed Helm repos]({{site.baseurl}}/docs/deployments/helm//managed-helm-repository/), and Helm[charts and repositories]({{site.baseurl}}/docs/deployments/helm/helm-charts-and-repositories/).
73
75
74
76
##Dashboards
75
-
Dashboards are key to providing the right information at the right time. Codefresh makes it easy to both access and visualize critical information for any CI/CD resource at any stage, at any level, and for anyone, from managers to DevOps engineers.
76
-
77
-
Kubernetes
77
+
Dashboards are key to providing the right information at the right time. Codefresh makes it easy to both access and visualize critical information for any resource at any stage, at any level, and for anyone, from managers to DevOps engineers. Our operational dashboards expose the most critical application and environmental information to developers for troubleshooting without needing assistance from the DevOps teams. Our analytics dashboards expose key statistics and metrics around builds and deployments for product owners and management alike.
78
78
79
-
Helm dashboards
80
79
81
-
Helm Releases
82
-
The Helm Releases dashboard provides a unique view into your production Kubernetes cluster, and actions for deployed releases. See the current status of your cluster, including the currently deployed releases, their previous revisions with change tracking, and even roll back to a previous release.
80
+
You can customize all dashboards to display just the information most relevant to your business issues.
83
81
84
-
Helm promotions
85
-
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).
82
+
**Kubernetes**
83
+
The Kubernetes (Kubernetes Services) dashboard displays the clusters in your environments, their state, and actions if you have the required access privileges.
84
+
The dashboard is a centralized location from which to view, add, modify, and remove Kubernetes services. You can deploy services with images from the Codefresh registry or from external Docker registries.
85
+
See[Accessing the Kubernetes dashboard]({{site.baseurl}}/docs/deployments/kubernetes/manage-kubernetes/#accessing-the-kubernetes-dashboard).
86
86
87
-
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.
87
+
**Helm dashboards**
88
+
For Helm we have a Helm Board, and a Helm Releases dashboard.
88
89
89
-
**DORA metrics**
90
+
* Helm Boards
91
+
The Helm Board is a special environment board that allows you to track one or more applications as they move within your infrastructure. For example, between Dev, QA and Prod environments.
92
+
Here you can see the lifecycle of the application, and at the same time, use it as a tool shift Helm releases between environments.
90
93
94
+
You can create as many Helm Boards as you want, and customize the Helm Boards with the columns to display, each column being a Helm-enabled Kubernetes cluster.
95
+
See[Using the Helm Board]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion/#using-the-helm-environment-board).
91
96
92
-
<!--
97
+
* Helm Releases
98
+
The Helm Releases dashboard provides a unique view into your production Kubernetes cluster, and options to manage deployed releases. See the current status of your cluster, including the currently deployed releases, their previous revisions with change tracking. If needed, you can even roll back to a previous release.
99
+
See[View Helm releases and release information]({{site.baseurl}}/docs/deployments/helm/helm-releases-management/#view-helm-releases-and-release-information).
93
100
94
-
Helm Boards
95
101
102
+
**Environment dashboard**
96
103
97
-
Helm Releases
98
-
The Helm Releases dashboard provides a unique view into your production Kubernetes cluster, and actions for . You can see the current status of your cluster, including the currently deployed releases, their previous revisions including change tracking, and even roll back to a previous release.
104
+
The Kubernetes dashboard shows cluster status and focuses more on the service aspects such as pods and Docker images. The Helm Board offers an application-level view of your cluster, as it applies to Helm deployments.
99
105
100
-
perational Dashboards ~ Exposing the most commonly needed application and environmentalinformationto developers so that theycantroubleshoot without needing assistance fromtheDevOps teams; even in production
106
+
To bridge this gap, Codefresh also offers an Environment dashboard that combinesinformationfor both Kubernetes and Helm releases. Youcansee cluster status in the context ofthepipeline builds that run on and affect the cluster. It links between the status of the cluster and the status of the builds.
101
107
102
-
Analytical Dashboards ~ Developers often need to reach out to the DevOps team to get statistics and metrics around builds anddeployments. Codefresh automatically generates DORA metrics as well as many other key indicators of build and deployment efficiency, which can be easily viewed in seconds by product owners and management alike.
The DORA (DevOps Research and Assessment) metrics dashboard pulls out critical metrics for our GitOps deployments. The metrics include deployment frequency, lead time for changes, mean time to recovery, and change failure rate. The metric graphs show performance by default for the last 90 days, with the option to select daily/weekly/monthly granularity views.
Second, we’re announcing The Universal Dashboard with DORA metrics. User’s of Codefresh’s GitOps Control Plane have enjoyed being able to navigate across many instances of GitOps runtimes (an enterprise version of Argo CD/Rollouts). We’re greatly amplifying those capabilities with the Universal Dashboard by automatically pulling out critical metrics. The holy grail of DevOps metrics are DORA (DevOps Research and Assessment) which include deployment frequency, lead time for changes, mean time to recovery, and change failure rate.
115
+
##Related articles
116
+
[Codefresh for CI]({{site.baseurl}}/docs/getting-started/ci-codefresh/)
117
+
[Concepts in Codefresh]({{site.baseurl}}/docs/getting-started/concepts/)
Copy file name to clipboardExpand all lines: _docs/getting-started/ci-codefresh.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ See:
53
53
##Unit testing
54
54
Codefresh supports all testing frameworks, including mocking frameworks, for all popular programming languages. Easily run unit tests on the source code of the application for every commit or pull request (PR) through our freestyle step in pipelines.
55
55
56
-
Run any type of unit tests in Codefresh pipelines, from smoke tests in a dockerfile, to tests with external or application images for simple applications, andevenrun them on a special testing image for complex applications.
56
+
Run any type of unit tests in Codefresh pipelines, from smoke tests in a dockerfile, to tests with external or application images for simple applications, andeven run them on a special testing image for complex applications.
57
57
You can create test reports and view them whenever you need.
Good quality code is central to any CI platform or tool. Codefresh integrates with the top code quality platforms/tools in the market to track code coverage, inspect codequailty, and generate code-coverage analysis reports.
72
+
Good quality code is central to any CI platform or tool. Codefresh integrates with the top code quality platforms/tools in the market to track code coverage, inspect codequality, and generate code-coverage analysis reports.
73
73
74
74
Implement code quality coverage in Codefresh pipelines through these steps:
75
75
* Set up integrations with the platforms/tools (Coverall, SonarQube, Codecov, for example).
@@ -81,7 +81,7 @@ See:
81
81
82
82
##Linting/validating
83
83
84
-
Linting and validation tools which perform static analysis on source code or other resources are also integralpart of pipelines. Codefresh pipelines can use any linter tool that is bundled with a Docker image. Codefresh can also validate files that are not source-code, such as markup-language files (XML/YAML/JSON), infrastructure files (Terraform, or Kubernetes resource files).
84
+
Linting and validation tools which perform static analysis on source code or other resources are also integralparts of pipelines. Codefresh pipelines can use any linter tool that is bundled with a Docker image. Codefresh can also validate files that are not source-code, such as markup-language files (XML/YAML/JSON), infrastructure files (Terraform, or Kubernetes resource files).
85
85
86
86
Most static analysis tools are CLI-based, and can be easily used in a Codefresh pipeline.
87
87
@@ -98,7 +98,7 @@ The security scan is implemented through a freestyle step, inserted anywhere in
98
98
As with any scan, the final step is viewing the scan results. Make the scan results available in Codefresh release dashboards (Test Report button) by attaching analysis reports to the pipeline build.
99
99
100
100
**Security annotations**
101
-
Correlate the Docker images in Codefresh with the results of the security scanning platform by adding annotations for custommetatdata. For example, you can add annotations such as the number of issues or the URL of the full report.
101
+
Correlate the Docker images in Codefresh with the results of the security scanning platform by adding annotations for custommetadata. For example, you can add annotations such as the number of issues or the URL of the full report.
See[Jira notifications in Codefresh]({{site.baseurl}}/docs/integrations/notifications/jira-integration/) and[examples for Jira notification]({{site.baseurl}}/docs/example-catalog/ci-examples/sending-the-notification-to-jira/).
128
128
129
129
130
-
##Continue with
131
-
[Codefresh for CD]({{site.baseurl}}/docs/getting-started/cd-codefresh/)
130
+
##Related articles
131
+
[Codefresh for CD]({{site.baseurl}}/docs/getting-started/cd-codefresh/)
132
+
[Concepts in Codefresh]({{site.baseurl}}/docs/getting-started/concepts/)
Copy file name to clipboardExpand all lines: _docs/getting-started/concepts.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ See:
24
24
25
25
26
26
###Runner
27
-
The Runner is the hybrid installation option forCI/CDpipelines in your Codefresh account. The Runner is installed as a Kubernetes native application on any Kubernetes-compliant cluster. It allows you to run pipelines on your own Kubernetes cluster, including private clusters behind company firewalls.
27
+
The Runner is the hybrid installation option for pipelines in your Codefresh account. The Runner is installed as a Kubernetes native application on any Kubernetes-compliant cluster. It allows you to run pipelines on your own Kubernetes cluster, including private clusters behind company firewalls.
28
28
29
29
Codefresh Runner gives you:
30
30
* Access to secure services (such as Git repositories or databases) that are behind the firewall and normally not accessible to the public cloud.
@@ -41,10 +41,10 @@ See:
41
41
42
42
43
43
###Project
44
-
A project is a top-level entity in Codefresh for grouping related pipelines. Projects can group pipelines according to any criteria that is relevant to your enterprise. The criteria can be logical and based on teams, departments, or location for example, or funtional, and based microservices in applications.
44
+
A project is a top-level entity in Codefresh for grouping related pipelines. Projects can group pipelines according to any criteria that is relevant to your enterprise. The criteria can be logical and based on teams, departments, or location for example, or funtional, and basedonmicroservices in applications.
45
45
Projects centralize viewing and configuration settings for the pipelines that belong to them:
46
-
* Selecting a pipeline shows the other pipelines in the same project.
47
-
*Define accesscontrol and user-defined variables for the project, and they are inherited by all the pipelines assigned to the project
46
+
* Selecting a pipeline shows the other pipelines in the same project
47
+
*Accesscontrol and user-defined variables for the project are inherited by all the pipelines assigned to the project
48
48
49
49
There are no limits to the number of projects you can create in your account. You can also create standalone pipelines and assign them later to a project, or detach a pipeline assigned to a project.
50
50
@@ -81,7 +81,7 @@ See Delivery Pipelines. -->
81
81
TBW
82
82
83
83
###Applications
84
-
An application is a deployment to a Kubernetes, or any Kubernetes-compatiale cluster or clusters.
84
+
An application is a deployment to a Kubernetes, or any Kubernetes-compatible cluster or clusters.
85
85
Codefresh supports two types of applications:
86
86
* Containerized applications packaged as Docker images or
87
87
* Argo CD applications
@@ -109,7 +109,12 @@ Just as with Dockerized applications, you get full visibily into the application
109
109
110
110
111
111
###Triggers
112
-
TBD
112
+
Triggers are events that launch pipelines and Argo Workflows in Codefresh.
113
+
A trigger can define an event defines an event or events, mapped to one or more Git repositories.
114
+
Codefresh offers a rich set of triggers
115
+
116
+
117
+
and defines an event or event or events defined in pipelines and Argo Workflows that are mapped to one or more Git Codefresh offers a rich set of triggers that you can select and define through the Codefresh UI as part of creating an Argo Workflow. These include Git and Cron triggers. The triggers and the event that are mapped to sensors and
113
118
114
119
###Events
115
120
TBD
@@ -118,3 +123,6 @@ TBD
118
123
119
124
###Argo Workflow
120
125
126
+
##Related articles
127
+
[Codefresh for CI]({{site.baseurl}}/docs/getting-started/ci-codefresh/)
128
+
[Codefresh for CD]({{site.baseurl}}/docs/getting-started/cd-codefresh/)