Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions _data/home-content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,22 @@
icon: images/home-icons/pipeline.svg
url: ''
links:
- title: Creation
- title: Create pipelines
localurl: /docs/pipelines/create-pipeline
- title: Nested workflows in pipelines
localurl: /docs/pipelines/nested-workflows
- title: Manage pipelines
localurl: /docs/pipelines/managing-pipelines
- title: Manage workflows
localurl: /docs/pipelines/workflows
- title: Configure artifact repository
localurl: /docs/pipelines/configure-artifact-repository/
- title: Selectors for concurrency synchronization
localurl: /docs/pipelines/concurrency-limit/
- title: Sharing file systems
localurl: /docs/pipelines/sharing-file-system/
localurl: /docs/pipelines/sharing-file-system/




- title: Deployment
Expand Down
11 changes: 8 additions & 3 deletions _data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,21 @@
- title: Pipelines
url: "/pipelines"
pages:
- title: Creation
- title: Create pipelines
url: "/create-pipeline"
- title: Manage pipelines
url: "/managing-pipelines"
- title: Manage workflows
url: "/workflows"
- title: Nested workflows
url: "/nested-workflows"
- title: Configure artifact repository
url: "/configure-artifact-repository"
- title: Selectors for concurrency synchronization
url: "/concurrency-limit"
- title: Sharing file systems
url: "/sharing-file-system"
- title: Nested workflows
url: "/nested-workflows"



- title: Deployment
Expand Down
439 changes: 439 additions & 0 deletions _docs/deployment/applications-dashboard 2.md

Large diffs are not rendered by default.

327 changes: 327 additions & 0 deletions _docs/deployment/create-application 2.md

Large diffs are not rendered by default.

113 changes: 113 additions & 0 deletions _docs/deployment/images 2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
title: "Images in Codefresh"
description: ""
group: pipelines
toc: true
---

Building Docker images is one of the most basic requirements for creating Delivery Pipelines.
Once you create an image, push the image to a registry, and report it to Codefresh, image information is continually updated in the Images page.

### Requirements for Images in Codefresh
Complete the mandatory steps to see your Images in the Codefresh UI. Each step has links to examples in the Codefresh Hub for Argo.

1. (Mandatory) Build the Docker image, and push the image to any registry.
See [Create a Docker image using Kaniko](https://codefresh.io/argohub/workflow-template/kaniko){:target="\_blank"}.
1. (Optional) Enrich image information with annotations and metadata.
For Git and Jira image enrichment examples, see [Codefresh-metadata image enrichment](https://codefresh.io/argohub/workflow-template/CSDP-metadata){:target="\_blank"}.
1. (Mandatory) Report image information to Codefresh.
See the [report-image-info](https://github.com/codefresh-io/argo-hub/blob/main/workflows/codefresh-csdp/versions/0.0.6/docs/report-image-info.md){:target="\_blank"} example.

> If you are using an external GitHub Actions-based pipeline, we have a new template that combines image reporting and enrichment. See [Image enrichment with integrations]({{site.baseurl}}/docs/integrations/image-enrichment-overview/).

### Image views in Codefresh
* In the Codefresh UI, go to [Images](https://g.codefresh.io/2.0/images){:target="\_blank"}.

Image views are layered to show three levels of data:
* Repository and application deployment
* Tags
* Summary with metadata and binary information

#### Filters for Image views
As with any resource in Codefresh, image views support filters that allow you focus on the data that's important to you.
Most image filters support multi-selection. Unless otherwise indicated, the filters are common to all view levels.

{: .table .table-bordered .table-hover}
| Filter | Description|
| -------------- | -------------- |
| **Repository Names** | The Git repository or repositories that contain the image. |
| **Tag** | The tag by which to filter. |
| **Registry Types** | The registry which stores your image. To filter by registries that are not listed, select **Other types**.|
| **Git branch** | The Git branch to which the image is pushed.|
| **Git repositories** | The Git provider you use.|
| **Deployed in application**| The application or applications in which the image is currently deployed.|
| **Sorted by** | List images by **Name**, or by the most recent update, **Last update**.



#### Image repository and deployment view
The default view for image resources shows repository and deployment information.

{% include
image.html
lightbox="true"
file="/images/image/application-level.png"
url="/images/image/application-level.png"
alt="Repository & deployment info for Images in Codefresh"
caption="Repository & deployment info for Images in Codefresh"
max-width="30%"
%}

{: .table .table-bordered .table-hover}
| Legend | Description|
| -------------- | -------------- |
| **1** | The name of the image. |
| **2** | The applications in which the image is currently deployed. Select the application to go to the Applications dashboard.|
| **3** | The details on the most recent commit associated with the image. Select the commit to view the changes in the Git repository.|
| **4** | Binary information on the image.|
| **5** | The registry to which the image is pushed, and from which it is distributed.|

### Image tag view
Drilldown on the repository shows tag information for the image.
{% include
image.html
lightbox="true"
file="/images/image/tag-view.png"
url="/images/image/tag-view.png"
alt="Tag info for Images in Codefresh"
caption="Tag info for Images in Codefresh"
max-width="30%"
%}

{: .table .table-bordered .table-hover}
| Legend | Description|
| -------------- | -------------- |
| **1** | The image tag. |
| **2** | The comment describing the commit or change, with the name of the Git provider and the corresponding PR. To view details of the commit changes in the Git repository, select the commit text.|
| **3** | The hash of the Docker image, generated as sha256. A change in the digest indicates that something has changed in the image.|
| **4** | The registry to which the image is pushed (stored), and from which it is distributed.|
| **5** | The OS and architecture in which the image was created. The date and time of the most recent update is in the local time zone|
| **6** | Additional information on the image. To view the Summary, select **more details**.|

### Image summary view
The Summary view shows metadata for the image.
Selecting **more details** for an image tag.

{% include
image.html
lightbox="true"
file="/images/image/summary-view.png"
url="/images/image/summary-view.png"
alt="Summary info for Images in Codefresh"
caption="Summary info for Images in Codefresh"
max-width="30%"
%}

{: .table .table-bordered .table-hover}
| Legend | Description|
| -------------- | -------------- |
| **1** | The bugs or fix requests opened and being worked on for this image tag. |
| **2** | The pull request or requests pending commit.|
| **3** | The Git details for this image tag, such as the Git hash, the Jira issue number, Git Pull Request, commit information, the name of the user who performed the commit. |
| **4** | The workflow for the image step. Select to go to the Workflow.|
| **5** | The log information for the build image step in the relevant workflow. Select to view Logs panel. |
2 changes: 1 addition & 1 deletion _docs/pipelines/create-pipeline.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Pipeline creation"
title: "Create pipelines"
description: ""
group: pipelines
toc: true
Expand Down
163 changes: 163 additions & 0 deletions _docs/pipelines/managing-pipelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
---
title: "Manage pipelines"
description: ""
group: pipelines
toc: true
---

Once a Delivery Pipeline is [created and triggered]({{site.baseurl}}/docs/pipelines/create-pipeline/), Codefresh continuously collects and displays real-time analytics on the pipeline and the workflows submitted for that pipeline.
>This article focuses on pipeline management. For information on managing workflows in pipelines, see [Managing workflows]({{site.baseurl}}/docs/pipelines/workflows/).


Manage Delivery Pipelines in Codefresh by monitoring pipeline performance and analytics, and by optimizing pipeline configurations and manifests.


**Monitoring pipeline performance and analytics**
Monitor pipelines performance at the global and individual levels. Both levels provide metrics for KPIs for insights into trends and performance.

* At the global level (Home dashboard), Codefresh aggregates performance analytics for all pipelines with active workflows.
* At the individual level (Delivery Pipelines list), Codefresh aggregates performance based on the pipeline's workflows, including step analytics across all the workflows in the pipeline. Step analytics allow you to analyze the resources consumed by a pipeline.
* Monitoring sensor and event-source errors for


**Optimizing pipeline configuration**
Use insights and trends from performance and KPI metrics to optimize the pipeline's Workflow Template, trigger conditions, and arguments.

### Monitor sensor and event source notifications for pipelines in Activity Log
Monitor logs for sensors and event-sources in pipelines in the Activity Log. A pull-down panel in the Codefresh toolbar, the Activity Log shows ongoing, success, and error notifications, by date, starting with today's date. Syntax errors that prevent the sensor from triggering the pipeline are displayed here.

1. In the Codefresh UI, on the top-right of the toolbar, select ![](/images/pipeline/monitoring/pipeline-activity-log-toolbar.png?display=inline-block) **Activity Log**.
1. To see pipeline activity, select **Event Source** and **Sensor** filters.

{% include image.html
lightbox="true"
file="/images/pipeline/monitoring/monitor-activity-log.png"
url="/images/pipeline/monitoring/monitor-activity-log.png"
alt="Activity Log filtered by Event Source and Sensor"
caption="Activity Log filtered by Event Source and Sensor"
max-width="40%"
%}

{:start="3"}
1. To see more information on an error, select the **+** sign.

### Monitor global pipeline performance
Monitor performance of all active pipelines in the Home dashboard. Active pipelines are those that have at least one active or complete workflow.
The KPI metrics provides insights into trends for pipelines. Analytics are derived by comparing the selected time range to the corresponding reference period. If your time range is the last seven days, the reference period is the seven days that precede the time range.


1. In the Codefresh UI, go to the [Home](https://g.codefresh.io/2.0/){:target="\_blank"} page.
1. Set the **Time** frame for which to show pipeline data, as the **Last 7 days** (the default), **Last 30 days**, or **Last 90 days**.
1. Scroll down to Delivery Pipelines:
1. To customize the view, select **Filters**.
2. To switch to individual pipeline view, select **View**.
3. To get day-to-day data for a metric, select the line-chart.

Here is an example of the global pipeline view in the Home page.

{% include image.html
lightbox="true"
file="/images/pipeline/monitoring/monitor-aggregated-view.png"
url="/images/pipeline/monitoring/monitor-aggregated-view.png"
alt="Global analytics for Delivery Pipelines in Home page"
caption="Global analytics for Delivery Pipelines in Home page"
max-width="70%"
%}


#### Filters for global pipeline view
Filters narrow the scope of aggregated data, allowing you to focus on the information you want to see. Unless otherwise indicated, all filters support multi-selection.

{: .table .table-bordered .table-hover}
| Filter | Description|
| -------------- | --------------|
| **Status** | {::nomarkdown}<ul><li><b>Succeeded</b>: Pipelines with workflows completed successfully.</li> <li><b>Failed</b>: Pipelines with workflows that failed. </li><li><b>Error</b>: Pipelines with workflows that resulted in errors.</li> {:/}|
| **Repository** |The Git repository or repositories tracked, with the events that triggered or ran the pipelines. |
| **Event Type** | The Git or Calendar event or events by which to view pipelines. If you select Git push, only those pipelines configured to be run on Git push are displayed. |
| **Initiator** | The user who made the commit that triggered the event and caused the pipeline to run.|

#### Metrics in global pipeline view

Pipeline metrics (KPIs), are displayed as line charts and in list formats.
* Line charts
Quick views of KPIs for the selected time frame. To see detailed day-to-day values, select a line chart.
* List formats
Display the average values for the same KPIs, sorted by activity and duration. The different perspectives illustrate both the fluctuations in the KPIs compared to the reference time range, and trending pipelines. The reference time range is the period of time that corresponds to and precedes the selected time range.

{::nomarkdown}<ul><li>Pipelines without numbers prefixing the names indicate new pipelines within the selected time frame.</li><li>Pipelines prefixed with numbers (encircled in the image above) indicate existing pipelines. </br> The number indicates the change in position of the pipeline compared to the reference period. </li><li>To drill down into a specific pipeline, select the pipeline.</li></ul>{:/}

{: .table .table-bordered .table-hover}
| Metric | Description|
| -------------- | --------------|
| **Success Rate** | The average number of successful executions, in percentage. |
| **Average Duration** | The average length of time to complete execution, in mm:ss. |
| **Executions** | The average number of times the pipeline was triggered, in percentage. |
| **Committers** | The number of users whose commits on the repository or repositories triggered the pipelines. User count is aggregated per user, so multiple commits from the same user are counted as a single commit.|


### Monitor individual pipeline performance

Monitor and compare KPIs for all pipelines in your cluster, including those that are not active, meaning pipelines for which workflows have not been submitted.

View pipeline activity for the last seven days, the status and the sync state. Compare KPIs for all the pipelines in the cluster, and identify inactive pipelines.

1. In the Codefresh UI, go to the [Delivery Pipelines](https://g.codefresh.io/2.0/pipelines){:target="\_blank"} page.
1. To find specific pipelines, in the search field, enter a part of the pipeline name. For example, to find all CI-based pipelines, enter `ci`.

Here is an example of the list view of individual pipelines.

{% include image.html
lightbox="true"
file="/images/pipeline/monitoring/pipeline-list-view.png"
url="/images/pipeline/monitoring/pipeline-list-view.png"
alt="List view with individual Delivery Pipelines"
caption="List view with individual Delivery Pipelines"
max-width="70%"
%}

The table describes the information for each pipeline in the list view.
> The list view displays data for the last seven days.


{: .table .table-bordered .table-hover}
| Item | Description|
| --------------| -------------- |
| **Name** | The name of the pipeline. Select the name to drill down into step analytics, workflows, and configuration.|
| **Recent Activity**| Bar chart of up to ten of the most recent workflows submitted for the pipeline. {::nomarkdown}<ul><li>Each bar represents a workflow that is color-coded to indicate the workflow's status: Green for completed, red for failed, and blue for ongoing workflows. </li><li> Mouse over a bar to see a pop-up with the metadata for the workflow. </li> <li>Selecting View Workflow Details takes you to the Workflow tab where you have several options to manage the workflow and view logs. For more information, see <a href="https://codefresh.io/csdp-docs/docs/pipelines/workflows">Managing workflows</a>.</li></ul> {:/}|
| **Last Run**| The time of the most recent run of the pipeline, when a workflow was submitted. The time is also color-coded to indicate the status of the workflow. Empty Last Run columns identify pipelines that have not been triggered to submit workflows.|
| **Success Rate**| The number of workflows that completed successfully in the last seven days, and the comparison to the reference period in percentage. |
| **Avg. Duration**| The average length of time for the pipeline's workflows to complete execution, in mm:ss. |
| **Weekly Runs**| The number of times the pipeline was run and its workflows submitted in the last seven days, and the difference in percentage compared to the reference period. |
| **Runtime**| The runtime in which the pipeline is run. |
| **Last Modified**| The date and time that the pipeline was recently updated. The updates include changes in configuration and manifests.|
| **Sync Status**| The sync status of the live state in the cluster with the desired state in Git.|



### Update pipeline configuration settings or manifests
Update the pipeline's Workflow Template, arguments, sensor and event source manifests to optimize or fix performance issues.
You can update the settings in the Configuration tab or in the Manifests tab, working in the mode that you are comfortable with.
* The Configuration tab shows a modular view of the settings in form mode, and makes for easier editing.
* The Manifests tab shows the YAMLs generated on commit. Here you can see the Git, desired, and live states of each manifest in parallel.
The Git state is the state-of-truth and is the only editable state. The desired state is the state after the changes are committed, before they are synced to the cluster. The live state is the actual state currently in the cluster.

For information on the settings, review [Delivery Pipeline creation flow]({{site.baseurl}}/docs/pipelines/create-pipeline/#delivery-pipeline-creation-flow)

1. From either the **Home** or the **Delivery Pipelines** pages, select a pipeline.
1. Select the **Configuration** tab.
* Select the component, and modify settings as needed.
* For the Workflow Template, use the **Diff View** to see changes.

{:start="3"}
1. Select the **Manifests** tab.
* Check if there are Errors or Warnings for the manifest.
* To review the changes by manifest, from the drop-down list, select any YAML manifest.
* Compare the Git, desired, and actual versions if needed.
* To update, switch to the **Git State** and Select **Edit**.
* To view commit history, select **Sync History**.
Codefresh validates the settings in real-time alerting you to errors and warnings.

> If there are Errors, Commit is disabled until you resolve the errors.

### What to read next
[Manage workflows]({{site.baseurl}}/docs/pipelines/workflows/)
Loading