diff --git a/docs/continuous-delivery/x-platform-cd-features/executions/execution-history.md b/docs/continuous-delivery/x-platform-cd-features/executions/execution-history.md index 9817c1e3779..1a1e1fb70f7 100644 --- a/docs/continuous-delivery/x-platform-cd-features/executions/execution-history.md +++ b/docs/continuous-delivery/x-platform-cd-features/executions/execution-history.md @@ -4,6 +4,9 @@ description: Learn more about the execution history of a pipeline. Where to find sidebar_position: 7 --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + This topic describes how to navigate to the execution history of pipelines and what information is contained within. ## Where Can I Find Execution History? @@ -40,6 +43,9 @@ Select the **Execution History** option on the top right corner of the page to v Each pipeline execution displays the following information. + + + * **Pipeline Name** - The name of the pipeline and execution ID. - When expanded, this column also shows the name of each stage in the pipeline. @@ -69,7 +75,50 @@ Each pipeline execution displays the following information. - [Compare Pipeline](/docs/platform/pipelines/executions-and-logs/view-and-compare-pipeline-executions/#compare-executions) - [Download Logs](/docs/platform/pipelines/executions-and-logs/download-logs) -## Filter execution + + + +:::note + +The new UI is behind the feature flag `CDS_EXECUTION_LIST_CARD_VIEW`. Contact [Harness Support](mailto:support@harness.io) to enable this feature. + +::: + +* **Pipeline Name** + - The name of the pipeline and execution ID. + - When expanded, this column also shows the name of each stage in the pipeline. +* **Status** + - Shows the status of the execution. The options are `SUCCESS`, `FAILED`, `ABORTED`, `EXPIRED`. + - When expanded, this column shows the status of each stage as an emoji. You can hover over the emoji for more information. +* **Trigger Summary** + - This column shows the origin of each execution. +* **Update Summary** + - This column shows the module specific update information for the specific pipeline execution. + - For CD, it will show **Service** and **Environment** information. + * **Service** + - Shows the services used in the pipeline. For pipelines with more than one service, a `+X` modifier will be displayed where `X` is the number of additional services. + - When expanded, this column shows the services used in each individual stage of the pipeline. + - Hover over the service name to see the artifact attached to the service. + * **Environment** + - Shows the infrastructure used in the pipeline. For pipelines with more than one associated environment, a `+X` modifier will be displayed where `X` is the number of additional environments. + - When expanded, this column shows the environment for each individual stage of the pipeline. + - Hover over the environment name to see the infrastructure associated with the environment. +* **Execution Start Time** + - Shows the user, method, and start time of the execution. +* **More details** + The more details icon for each pipeline offers additional execution actions: + - Re-run from stage + - View Execution + - View Pipeline + - [Re-run Pipeline](/docs/platform/pipelines/failure-handling/resume-pipeline-deployments) + - [Abort Pipeline](/docs/platform/pipelines/failure-handling/abort-pipeline) + - [View Compiled YAML](/docs/platform/pipelines/executions-and-logs/view-and-compare-pipeline-executions/#view-compiled-yaml) + - [Compare Pipeline Executions](/docs/platform/pipelines/executions-and-logs/view-and-compare-pipeline-executions/#compare-executions) + - [Download Logs](/docs/platform/pipelines/executions-and-logs/download-logs) + + + +## Filter executions You can filter pipeline executions using the filters in the **Execution History** or **Execution** tabs. @@ -77,8 +126,36 @@ You can filter pipeline executions using the filters in the **Execution History* You can filter pipeline execution based on **Status**, **Execution Mode**, **Trigger Type**, **Trigger Identifier**, **Timeframe**, **Deployment Type**, **Services**, **Environments**, **Artifacts** or **Build Type**. +### Select your filters + + + + +You can use default filter options show at the top such as **Status**, **Pipelines**, or **Select Repository**, or use more filter options by clicking the filter icon next to **Select a Saved Filter**. + ![](./static/execution_filter_2.png) +Here you can click **+New Filter** to create and store filters for future use. + + + + +:::note + +You can use the new filter UI by enabling the feature flag `CDS_EXECUTION_LIST_FILTERS`. Contact [Harness Support](mailto:support@harness.io) to enable this feature. + +::: + +You can use default filter options such as **My Executions**, **Status**, or **Timeframe**, or use more filter options by clicking the **+Add Filter** button. + +![](./static/execution-filter-3.png) + +You can save your current filter settings by clicking **Save** and you can reference those saved filters by clicking the filter icon dropdown at the top right. + + + +--- + ### Status Filter pipeline execution based on Status of Pipeline Execution. @@ -91,7 +168,7 @@ It includes: - Failed - Not Started - Paused -- Queueud +- Queued - Running - Success - Suspended @@ -222,5 +299,4 @@ To avoid encountering this limitation: Apply additional filters, such as Status and Time Range, to narrow down the result set and reduce the number of executions listed. Refer to the [Pipeline Execution API](https://apidocs.harness.io/tag/Pipeline-Execution-Details#operation/getListOfExecutions) for more details. -As an alternate, you can use the [Pipeline Execution Outline API](https://apidocs.harness.io/tag/Pipeline-Execution-Details#operation/getListOfExecutionsOutline). - +As an alternate, you can use the [Pipeline Execution Outline API](https://apidocs.harness.io/tag/Pipeline-Execution-Details#operation/getListOfExecutionsOutline). \ No newline at end of file diff --git a/docs/continuous-delivery/x-platform-cd-features/executions/static/execution-filter-3.png b/docs/continuous-delivery/x-platform-cd-features/executions/static/execution-filter-3.png new file mode 100644 index 00000000000..1165bad02ce Binary files /dev/null and b/docs/continuous-delivery/x-platform-cd-features/executions/static/execution-filter-3.png differ