diff --git a/_data/argohub-home-content.yml b/_data/argohub-home-content.yml index b070562c7..6f6bf09d3 100644 --- a/_data/argohub-home-content.yml +++ b/_data/argohub-home-content.yml @@ -35,6 +35,23 @@ - title: Advanced Promotion Flow with environment dependencies localurl: /gitops/gitops-quick-start/dependency-multi-env-promotion +- title: GitOps Runtimes + icon: ../images/home-icons/installation.svg + url: "" + links: + - title: About GitOps Runtimes + localurl: /gitops/gitops-runtimes/gitops/ + - title: Install GitOps Runtime with existing Argo CD + localurl: /gitops/gitops-runtimes/runtime-install-with-existing-argo-cd/ + - title: Install GitOps Runtime with new Argo CD + localurl: /gitops/gitops-runtimes/runtime-install-with-new-argo-cd/ + - title: Monitoring GitOps Runtimes + localurl: /gitops/gitops-runtimes/monitor-runtimes/ + - title: Runtime Status Panel + localurl: /gitops/gitops-runtimes/runtime-status-panel/ + - title: Managing GitOps Runtimes + localurl: /gitops/gitops-runtimes/manage-runtimes/ + - title: Environments icon: ../images/home-icons/environments.svg url: "" diff --git a/_data/argohub-nav.yml b/_data/argohub-nav.yml index 3ac7d16b5..b72219e5b 100644 --- a/_data/argohub-nav.yml +++ b/_data/argohub-nav.yml @@ -91,6 +91,8 @@ url: "/configuration-runtime" - title: Monitoring GitOps Runtimes url: "/monitor-runtimes" + - title: Runtime Status Panel + url: "/runtime-status-panel" - title: Managing GitOps Runtimes url: "/manage-runtimes" - title: Managing external clusters in GitOps Runtimes diff --git a/_data/home-content.yml b/_data/home-content.yml index cc4ef997f..70250fafb 100644 --- a/_data/home-content.yml +++ b/_data/home-content.yml @@ -196,6 +196,23 @@ - title: Quay Registry for GitOps localurl: /docs/gitops-integrations/container-registries/quay/ +- title: GitOps Runtimes + icon: images/home-icons/installation.svg + url: "" + links: + - title: About GitOps Runtimes + localurl: /docs/installation/gitops/gitops-runtime/ + - title: Install GitOps Runtime with existing Argo CD + localurl: /docs/installation/gitops/runtime-install-with-existing-argo-cd/ + - title: Install GitOps Runtime with new Argo CD + localurl: /docs/installation/gitops/runtime-install-with-new-argo-cd/ + - title: Monitoring GitOps Runtimes + localurl: /docs/installation/gitops/monitor-runtimes/ + - title: Runtime Status Panel + localurl: /docs/installation/gitops/runtime-status-panel/ + - title: Managing GitOps Runtimes + localurl: /docs/installation/gitops/manage-runtimes/ + - title: Installation icon: images/home-icons/installation.svg url: "" diff --git a/_data/nav.yml b/_data/nav.yml index 53b340db6..124d564be 100644 --- a/_data/nav.yml +++ b/_data/nav.yml @@ -639,6 +639,8 @@ url: "/configuration-runtime" - title: Monitoring GitOps Runtimes url: "/monitor-runtimes" + - title: Runtime Status Panel + url: "/runtime-status-panel" - title: Managing GitOps Runtimes url: "/manage-runtimes" - title: Managing external clusters in GitOps Runtimes diff --git a/_docs/installation/gitops/git-sources.md b/_docs/installation/gitops/git-sources.md index 90ddbc5cf..f671828a3 100644 --- a/_docs/installation/gitops/git-sources.md +++ b/_docs/installation/gitops/git-sources.md @@ -7,8 +7,9 @@ toc: true ## Git Sources in GitOps Runtimes A Git Source is a unique entity created for use with GitOps Runtimes in Codefresh. -The Git Source connects to a Git repository within your organization, serving as an easy way to manage the deployment and configuration of Argo CD applications on clusters. +The Git Source connects to a Git repository within your organization, serving as an easy way to manage the deployment and configuration of Argo CD applications on clusters. The Git repository referenced by the Git Source stores application manifests and other resources which are always synced to the cluster. Codefresh manages the Git Source itself as an Argo CD application. +To monitor sync status for all Git Sources across your runtime in one place, see [Runtime Status Panel]({{site.baseurl}}/docs/installation/gitops/runtime-status-panel/). @@ -364,21 +365,7 @@ Delete a Git Source from a GitOps Runtime whenever needed. You may want to delet Only account administrators can delete Git Sources. ##### Effect on applications and resources -Deleting a Git Source impacts all applications and resources associated with it. -Whether an application or a resource is deleted depends on the presence of the `resources-finalizer.argocd.argoproj.io` finalizer in its **_parent application manifest_**. - -* **Git Source and linked applications** - By default, the Git Source includes the `resources-finalizer.argocd.argoproj.io` finalizer. This means that when you delete the Git Source, all linked applications and their manifests are removed from both the Codefresh UI and the cluster. - -* **Resources associated with applications** - Resources associated with applications are deleted **_only if the manifests of their parent applications_** contain the `resources-finalizer.argocd.argoproj.io` finalizer. If the finalizer is absent, the resources remain in the cluster even after the application is deleted. - -##### How to -1. In the Codefresh UI, on the toolbar, click the **Settings** icon. -1. From the sidebar, select **GitOps Runtimes**. -1. From the **List View** (the default), select the Runtime with the Git Source, and then click the **Git Sources** tab. -1. From the context menu of the Git Source, select **Delete**. -1. To confirm, click **Delete**. +Deleting a Git Source does not delete the applications defined in the Git Source. The applications and their manifests will remain in the cluster. However, the Git Source will no longer manage these applications, and you will need to manage them manually if required. ## Example YAMLs of Git Source resources @@ -522,6 +509,6 @@ spec: ## Related articles [Monitoring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-runtimes/) [Managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/) -[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) +[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) diff --git a/_docs/installation/gitops/manage-runtimes.md b/_docs/installation/gitops/manage-runtimes.md index 6d0b82d4f..2a29142f6 100644 --- a/_docs/installation/gitops/manage-runtimes.md +++ b/_docs/installation/gitops/manage-runtimes.md @@ -9,8 +9,9 @@ toc: true ## Managing GitOps Runtimes -This article describes the options and actions to manage GitOps Runtimes after installation, including configuring the Runtime as an application, updating Git credentials, and more. +This article describes the options and actions to manage GitOps Runtimes after installation, including configuring the Runtime as an application, updating Git credentials, and more. For options on monitoring GitOps Runtimes, see [Monitoring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-runtimes/). +For a unified health overview with actionable issue cards, see [Runtime Status Panel]({{site.baseurl}}/docs/installation/gitops/runtime-status-panel/). diff --git a/_docs/installation/gitops/managed-cluster.md b/_docs/installation/gitops/managed-cluster.md index 9e302eaed..67dbfb8b9 100644 --- a/_docs/installation/gitops/managed-cluster.md +++ b/_docs/installation/gitops/managed-cluster.md @@ -7,6 +7,7 @@ toc: true Once you have an Argo CD installation as part of a [Hybrid]({{site.baseurl}}/docs/installation/gitops/runtime-install-with-new-argo-cd/) GitOps Runtime, you can add external clusters to them. You can then deploy applications to those clusters without having to install Argo CD on the clusters in order to do so. When you add an external cluster to a provisioned GitOps Runtime, the cluster is registered as a managed cluster. A managed cluster is treated as any other managed K8s resource, meaning that you can monitor its health and sync status, deploy applications to it, view information in the Applications dashboard, and remove the cluster from the Runtime's managed list. +To monitor connection status for all managed clusters in one place, see [Runtime Status Panel]({{site.baseurl}}/docs/installation/gitops/runtime-status-panel/). Adding a managed cluster via Codefresh ensures that Codefresh applies the required RBAC resources (`ServiceAccount`, `ClusterRole` and `ClusterRoleBinding`) to the target cluster, creates a `Job` that updates the selected Runtime with the information, registers the cluster in Argo CD as a managed cluster, and updates the platform with the new cluster information. diff --git a/_docs/installation/gitops/monitor-runtimes.md b/_docs/installation/gitops/monitor-runtimes.md index 027e50436..645b21b14 100644 --- a/_docs/installation/gitops/monitor-runtimes.md +++ b/_docs/installation/gitops/monitor-runtimes.md @@ -1,11 +1,13 @@ --- title: "Monitoring GitOps Runtimes" -description: "Explore List and Topology view for GitOps Runtimes" +description: "View and navigate all provisioned GitOps Runtimes in List and Topology views" toc: true --- ## Monitoring GitOps Runtimes -This article describes the options and actions to monitor GitOps Runtimes after installation through the List and Topology view formats. +This article describes the List and Topology views for GitOps Runtimes — your starting point for navigating provisioned runtimes, checking versions, and reviewing high-level sync status across runtimes and managed clusters. + +For a deeper health view with per-runtime connectivity, component status, and actionable issue cards, see [Runtime Status Panel]({{site.baseurl}}/docs/installation/gitops/runtime-status-panel/). For options on managing GitOps Runtimes, see [Managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/). ## GitOps Runtime views @@ -98,7 +100,8 @@ Here is a description of the information and options in the Topology view. |**Search and View options** | {::nomarkdown} {:/}| ## Related articles -[Managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/) -[Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/) -[Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/) -[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) \ No newline at end of file +[Runtime Status Panel]({{site.baseurl}}/docs/installation/gitops/runtime-status-panel/) +[Managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/) +[Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/) +[Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/) +[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) \ No newline at end of file diff --git a/_docs/installation/gitops/runtime-status-panel.md b/_docs/installation/gitops/runtime-status-panel.md new file mode 100644 index 000000000..c2f643c58 --- /dev/null +++ b/_docs/installation/gitops/runtime-status-panel.md @@ -0,0 +1,190 @@ +--- +title: "Runtime Status Panel" +description: "Monitor GitOps Runtime health from a single pane — connectivity, applications, components, Git Sources, and managed clusters" +toc: true +--- + +## Runtime Status Panel + +The Runtime Status Panel provides a single-pane view of your GitOps Runtime health, surfacing issues that previously required navigating multiple screens. + +**To open the Runtime Status Panel:** +1. In the Codefresh UI, on the toolbar, click the **Settings** icon. +1. From the sidebar, select **GitOps Runtimes**. +1. Click on the name of the runtime to open it. +1. Select the **Runtime Status Panel** tab. + +The panel is organized into three main sections: +1. **[Status Summary Bar](#status-summary-bar)** — Quick color-coded health overview across five categories +2. **[Runtime Health Report](#runtime-health-report)** — Actionable issues that need attention +3. **[Detail Tabs](#detail-tabs)** — Deep-dive into connectivity, applications, and components + +{% include + image.html + lightbox="true" + file="/images/runtime/runtime-status-panel.jpeg" + url="/images/runtime/runtime-status-panel.jpeg" + alt="Runtime Status Panel overview" + caption="Runtime Status Panel overview" + max-width="80%" +%} + +## Status Summary Bar + +Five color-coded boxes at the top of the panel give an at-a-glance health overview of your runtime. + +{: .table .table-bordered .table-hover} +| Category | Description | +|---|---| +| **Connectivity** | Network paths between browser, app-proxy, and control plane | +| **Runtime Applications** | Sync status of runtime applications | +| **Runtime Components** | Health of core components (redis, reporters, argo-gateway, etc.) | +| **Git Sources** | Sync status of configured Git Sources | +| **Managed Clusters** | Connection status of managed clusters | + +### Color coding + +{: .table .table-bordered .table-hover} +| Color | Icon | Meaning | +|---|---|---| +| Green | ✓ checkmark | All healthy — number shows total count | +| Orange | △ warning | Has warnings — number shows warning count | +| Red | ⊗ error | Has errors — number shows error count | + +> **Note:** The status boxes are indicators only and are not clickable. + +## Runtime Health Report + +This section displays actionable issues that require attention. Each issue card includes: +- **Issue type and affected resource** — e.g., "Runtime application OUT_OF_SYNC: cf-gitops-runtime" +- **Description** — Explains what went wrong +- **Quick actions** — Clickable buttons such as **Sync** or **View Application** + +### Common issues + +{: .table .table-bordered .table-hover} +| Issue | Description | Available Actions | +|---|---|---| +| Runtime application OUT_OF_SYNC | Automated sync was not able to complete | Sync, View Application | +| Git Source sync Failed | Git Source failed to synchronize (e.g., conflicting options) | View Application | +| Cluster connection Failed | Argo CD cannot communicate with the target cluster | View Application | + +## Detail Tabs + +Three tabs provide detailed information for troubleshooting specific areas of your runtime. + +### Connectivity tab + +Displays the status of all connection paths between runtime components. + +{% include + image.html + lightbox="true" + file="/images/runtime/runtime-status-panel-connectivity.jpeg" + url="/images/runtime/runtime-status-panel-connectivity.jpeg" + alt="Runtime Status Panel - Connectivity tab" + caption="Runtime Status Panel - Connectivity tab" + max-width="80%" +%} + +{: .table .table-bordered .table-hover} +| Connection Path | Description | +|---|---| +| Browser → app-proxy | Connection from your browser to the app proxy | +| app-proxy → Control Plane | Connection from app proxy to Codefresh control plane | +| runtime-event-reporter → Control Plane | Reporter sending application and resource events | +| cluster-event-reporter → Control Plane | Reporter sending cluster events | + +**Columns:** Connection Path \| Status \| Last Activity + +#### Status behavior + +- Connectivity checks **retry every 10 seconds** +- App-proxy shows **Unreachable** after a **1-minute** timeout +- Reporters are flagged as non-reporting after **20 minutes** + +#### Connectivity warning + +When connectivity issues are detected, a warning banner appears above the connection table. + +{% include + image.html + lightbox="true" + file="/images/runtime/runtime-status-panel-connectivity-warning.jpeg" + url="/images/runtime/runtime-status-panel-connectivity-warning.jpeg" + alt="Runtime Status Panel - Connectivity warning banner" + caption="Runtime Status Panel - Connectivity warning banner" + max-width="80%" +%} + +> _"This often indicates an ingress or network configuration problem. Please verify network (VPN/Proxy settings and Ad-blocker status.)"_ + +A link to the Troubleshooting Guide is provided within the banner for the most common resolution steps. + +### Runtime Applications tab + +Lists all runtime applications with their sync and health status. + +{% include + image.html + lightbox="true" + file="/images/runtime/runtime-status-panel-applications.jpeg" + url="/images/runtime/runtime-status-panel-applications.jpeg" + alt="Runtime Status Panel - Runtime Applications tab" + caption="Runtime Status Panel - Runtime Applications tab" + max-width="80%" +%} + +**Columns:** Name \| Description \| Sync Status \| Health Status \| Actions + +{: .table .table-bordered .table-hover} +| Field | Description | +|---|---| +| **Name** | Application name — click to open the application details page | +| **Sync Status** | Synced / Out of Sync | +| **Health Status** | Healthy / Progressing / Degraded | + +**Row actions** (⋮ context menu): +- Quick view +- Synchronize +- Refresh +- Hard refresh + +### Runtime Components tab + +Lists all runtime components with their descriptions and health status. Health statuses are aggregated from the underlying deployments and StatefulSets. + +{% include + image.html + lightbox="true" + file="/images/runtime/runtime-status-panel-components.jpeg" + url="/images/runtime/runtime-status-panel-components.jpeg" + alt="Runtime Status Panel - Runtime Components tab" + caption="Runtime Status Panel - Runtime Components tab" + max-width="80%" +%} + +**Columns:** Name \| Description \| Status \| Actions + +{: .table .table-bordered .table-hover} +| Component | Description | +|---|---| +| **redis** | High-performance data caching used by the Codefresh runtime | +| **runtime-event-reporter** | Sends application and managed resource events to Codefresh | +| **cluster-event-reporter** | Sends K8s events for rollouts, analysis runs, and replicasets | +| **argo-gateway** | Handles Codefresh-specific API requests (e.g., rollout rollback) | +| **workflow-reporter** | Sends in-cluster K8s events of Argo Workflows to Codefresh | +| **rollout-reporter** | Sends in-cluster K8s events of Argo Rollouts, analysis runs, and replicasets | +| **gitops-operator** | Codefresh controller for restricted Git Sources and promotions | +| **argo-rollouts** | Kubernetes controller and set of CRDs for advanced deployment strategies | +| **sealed-secrets** | Encrypts integration credentials for safe storage in Git repositories | + +**Row actions:** +- **View Logs** icon — opens component logs for troubleshooting + +## Related articles +[Monitoring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-runtimes/) +[Managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/) +[Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/) +[Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/) +[Troubleshooting GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/runtime-troubleshooting/) diff --git a/_gitops/gitops-runtimes/runtime-status-panel.md b/_gitops/gitops-runtimes/runtime-status-panel.md new file mode 120000 index 000000000..7cadcef15 --- /dev/null +++ b/_gitops/gitops-runtimes/runtime-status-panel.md @@ -0,0 +1 @@ +../../_docs/installation/gitops/runtime-status-panel.md \ No newline at end of file diff --git a/_posts/2025-11-30-nov-release-notes.md b/_posts/2025-11-30-nov-release-notes.md index 9a064eabc..d89b1e08e 100644 --- a/_posts/2025-11-30-nov-release-notes.md +++ b/_posts/2025-11-30-nov-release-notes.md @@ -1,5 +1,5 @@ --- -\title: "Release Notes: November 2025" +title: "Release Notes: November 2025" description: "Release Notes for Codefresh Pipelines and GitOps" --- ## Features & enhancements diff --git a/assets/js/argohub-redirect/argohub-redirect-mapping.json b/assets/js/argohub-redirect/argohub-redirect-mapping.json index 5869e5c2c..bd28ed9db 100644 --- a/assets/js/argohub-redirect/argohub-redirect-mapping.json +++ b/assets/js/argohub-redirect/argohub-redirect-mapping.json @@ -122,5 +122,6 @@ "/docs/promotions/service-accounts-promotion-workflows/": "/gitops/promotions/service-accounts-promotion-workflows/", "/docs/installation/gitops/runtime-install-with-new-argo-cd/": "/gitops/gitops-runtimes/runtime-install-with-new-argo-cd/", "/docs/promotions/promotion-limitations/": "/gitops/promotions/promotion-limitations/", - "/docs/installation/gitops/runtime-install-namespace-scope/": "/gitops/gitops-runtimes/runtime-install-namespace-scope/" + "/docs/installation/gitops/runtime-install-namespace-scope/": "/gitops/gitops-runtimes/runtime-install-namespace-scope/", + "/docs/installation/gitops/runtime-status-panel/": "/gitops/gitops-runtimes/runtime-status-panel/" } diff --git a/images/runtime/runtime-status-panel-applications.jpeg b/images/runtime/runtime-status-panel-applications.jpeg new file mode 100644 index 000000000..f0cf17313 Binary files /dev/null and b/images/runtime/runtime-status-panel-applications.jpeg differ diff --git a/images/runtime/runtime-status-panel-components.jpeg b/images/runtime/runtime-status-panel-components.jpeg new file mode 100644 index 000000000..067c09094 Binary files /dev/null and b/images/runtime/runtime-status-panel-components.jpeg differ diff --git a/images/runtime/runtime-status-panel-connectivity-warning.jpeg b/images/runtime/runtime-status-panel-connectivity-warning.jpeg new file mode 100644 index 000000000..3e98a603c Binary files /dev/null and b/images/runtime/runtime-status-panel-connectivity-warning.jpeg differ diff --git a/images/runtime/runtime-status-panel-connectivity.jpeg b/images/runtime/runtime-status-panel-connectivity.jpeg new file mode 100644 index 000000000..90ebf6c56 Binary files /dev/null and b/images/runtime/runtime-status-panel-connectivity.jpeg differ diff --git a/images/runtime/runtime-status-panel.jpeg b/images/runtime/runtime-status-panel.jpeg new file mode 100644 index 000000000..6fac96f0f Binary files /dev/null and b/images/runtime/runtime-status-panel.jpeg differ