Monitoring GitOps Runtimes

Explore List and Topology view for GitOps Runtimes

Monitoring GitOps Runtimes

This article describes the options and actions to monitor GitOps Runtimes after installation through the List and Topology view formats.
For options on managing GitOps Runtimes, see Managing GitOps Runtimes.

GitOps Runtime views

The Runtimes page displays the provisioned GitOps Runtimes in your account.

View Runtime components and information in List or Topology view formats to monitor them.

  • List view: The default view, displays the list of provisioned Runtimes, the clusters managed by them, and Git Sources associated with them.
  • Topology view: Displays a hierarchical view of Runtimes and the clusters managed by them, with health and sync status of each cluster.

Runtime List View

Runtime List View

GitOps Runtimes List view

The List view is a grid-view of the provisioned Runtimes.

Here is an example of the List view for runtimes.

Runtime List View

Runtime List View

Here is a description of the information and options in the List View.

List View Item Description
Name The name of the provisioned GitOps Runtime.
Hybrid GitOps Runtimes installed with Helm show the status as either Online (green dot) or Offline (red dot).
Type The type of GitOps Runtime provisioned, and is Helm.
Config Runtime indicates that the Runtime has been designated to store platform resources. See Designating Configuration Runtimes.
Cluster/Namespace The K8s API server endpoint, as well as the namespace with the cluster.
Modules The modules installed based on the type of provisioned Runtime. Hybrid GitOps Runtimes include CI and CD Ops modules.
Managed Cluster The number of managed clusters, if any, registered with the GitOps Runtime. To view list of managed clusters, click the runtime name, and then the Managed Clusters tab. To work with managed clusters, see Managing external clusters in GitOps Runtimes.
Version The version of the Runtime currently installed, and the version of the Helm chart in parentheses.

Update Available! indicates there are newer versions of the Runtime, Helm chart, or both.
To see all the commits and changes for the version, mouse over Update Available!, and select View Complete Change Log.
See:
Upgrade GitOps Runtimes
View changelogs for GitOps Runtimes
Rollback GitOps Runtimes
Last Updated The most recent update information from the runtime to the Codefresh platform. Updates are sent to the platform typically every few minutes. Longer update intervals may indicate networking issues.
Sync Status The sync status of the GitOps Runtime. The sync status is displayed only when you have completed installation and configured the GitOps Runtime as an Argo CD Application.
  • Synced
  • Syncing.
  • Out-of-sync.
  • N/A: Codefresh could not get the sync status. This could be because the Runtime is not configured as an Argo CD Application.
  • Complete Installation: Git credentials are not configured for the Runtime. Click the three-dot context menu and select Update Git Runtime Credentials. See Update Git credentials for GitOps Runtimes.
Actions The possible actions to manage the selected runtime.
  • Set as Configuration Runtime: Designate the selected Runtime to store platform resources which are runtime-agnostic. See Designating Configuration Runtimes.
  • Upgrade: Upgrade to the latest version. See Upgrade GitOps Runtimes.
  • Download All Logs:Download logs for the Runtime or for its components. See View/download logs for GitOps Runtimes.
  • Update Git Runtime Credentials: Update Git token for Runtime. See Update Git credentials for GitOps Runtimes.
  • Runtimes as applications: Options to view and monitor GitOps Runtimes as applications in the Current State tab of the GitOps Apps dashboard. For details on monitoring appplication resources, see Monitoring resources for Argo CD applications.
    • Runtime Application: Available only when the GitOps Runtime is configured as an Argo CD application. For configuration steps, see Configuring GitOps Runtime as an Argo CD application.
    • Runtime ISC Application: Available when a Hybrid GitOps Runtime is installed. Displays the resources of the Shared Configuration Repository (referred to internally as ISC/isc).
    • Runtime Resources Application: Available when a Hybrid GitOps Runtime is installed. Displays the resources in the local cluster (in-cluster).
  • Delete Runtime: Available only when the Hybrid GitOps Runtime is Offline.
    Delete the GitOps Runtime from the Codefresh platform, retaining it on the cluster. See Delete GitOps Runtimes.
  • Uninstall Runtime: Uninstall the runtime from the cluster on which it is provisioned. See Uninstall GitOps Runtimes.

GitOps Runtimes Topology view

A hierarchical visualization of the provisioned GitOps Runtimes, the Topology view makes it easy to identify key information such as versions, health and sync status, for both the provisioned Runtime and the clusters managed by it. Here is an example of the Topology view for GitOps Runtimes.

Runtime Topology View

Runtime Topology View

Here is a description of the information and options in the Topology view.

Topology View Item Description
Runtime the provisioned Runtime.
Hybrid Runtimes display the name of the K8s API server endpoint with the cluster.
Cluster The local, and managed clusters if any, for the Runtime.
  • indicates the local cluster, always displayed as `in-cluster`. The in-cluster server URL is always set to `https://kubernetes.default.svc/`.
  • indicates a managed cluster.
  • select to add a new managed cluster.
To view cluster components, select the cluster. To add and work with managed clusters, see Managing external clusters in GitOps Runtimes.
Health/Sync status The health and sync status of the Runtime or cluster.
  • indicates health or sync errors in the Runtime, or a managed cluster if one was added to the runtime.
    The runtime or cluster node is bordered in red and the name is colored red.
  • indicates that the Runtime is being synced to the cluster on which it is provisioned.
Search and View options
  • Find a Runtime or its clusters by typing part of the Runtime/cluster name, and then navigate to the entries found.
  • Topology view options: Resize to window, zoom in, zoom out, full screen view.

Managing GitOps Runtimes
Managing Git Sources in GitOps Runtimes
Managing external clusters in GitOps Runtimes
Shared Configuration Repository