Management

The Runtimes page displays the runtimes deployed across your environment, which you can view in List or Topology view formats. Work in the view mode of your choice to monitor and manage runtimes.

To recover a runtime for a failed cluster, see Recover runtimes.

Runtime views

View provisioned runtimes in List or Topology view formats.

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

To manage and monitor runtimes, see:

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 in the List View.

List View Item Description
Name The name of the provisioned Codefresh runtime.
Cluster/Namespace The K8s API server endpoint, as well as the namespace with the cluster.
Managed Cluster The number of managed clusters if any, for the runtime. To view list of managed clusters, select the runtime, and then the Managed Clusters tab. To work with managed clusters, see Runtime Management in this article.
Version The version of the runtime currently installed. Update Available! indicates there are later versions of the runtime. To see all the commits to the runtime, mouse over Update Available!, and select View Complete Change Log.
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 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 name is colored red.
  • indicates that the runtime is being synced to the cluster on which it is provisioned.

Topology view

The runtime hierarchy visualization in the Topology view makes it easy to identify key information such as versions, health and sync status, for both the runtime and the clusters managed by it.
Here is an example of the Topology view for runtimes.

Runtime Topology View

Runtime Topology View

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

Topology View Item Description
Runtime the provisioned Codefresh runtime. Below is 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 Add and manage external clusters.
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.

Runtime management

Work in either the List or Topology views to manage runtimes:

Upgrade runtimes

Upgrade existing runtimes to install critical security updates or to install the latest version of all components. Upgrade by running a silent upgrade or through the CLI wizard.

When there are security updates, the UI displays the alert, At least one runtime requires a security update. The Version column displays an Update Required! notification.

If you have managed clusters for the runtime, upgrading the runtime automatically updates runtime components within the managed cluster as well.

Before you begin
For both types of upgrades, make sure you have:

  • The latest version of the Codefresh CLI
  • A valid runtime Git token

Silent upgrade

  • Pass the mandatory flags in the upgrade command:

    cf runtime upgrade <runtime-name> --git-token <git-token> --silent
    where:
    <git-token> is a valid runtime token with the repo and admin-repo.hook scopes.

CLI wizard-based upgrade

  1. In the Codefresh UI, make sure you are in the Runtimes page.
  2. Switch to either the List View or to the Topology View.
  3. List view:
    • Select the runtime name.
    • To see all the commits to the runtime, in the Version column, mouse over Update Available!, and select View Complete Change Log.
    • On the top-right, select Upgrade.

List View: Upgrade runtime option

List View: Upgrade runtime option

Topology view:
Select the runtime cluster, and from the panel, select the three dots and then select Upgrade Runtime.

Topology View: Upgrade runtime option

Topology View: Upgrade runtime option
  1. If you have already installed the Codefresh CLI, in the Install Upgrades panel, copy the upgrade command.

Upgrade runtime

Upgrade runtime panel
  1. In your terminal, paste the command, and update the Git token value.
  2. Confirm to start the upgrade.

Uninstall runtimes

Uninstall Codefresh runtimes that are not in use. Uninstall a runtime by running a silent uninstall, or through the CLI wizard.

Uninstalling a runtime removes the Git Sources and managed clusters associated with the runtime.

Before you begin
For both types of uninstalls, make sure you have:

  • The latest version of the Codefresh CLI
  • A valid runtime Git token
  • The Kube context from which to uninstall the runtime

Silent uninstall
Pass the mandatory flags in the uninstall command:
cf runtime uninstall <runtime-name> --context <kube-context> --git-token <git-token> --silent
where:
--context is the Kube context from which to uninstall the runtime. If not passed, uninstalls the runtime from the current Kube context.
--git-token is a valid runtime token with the repo and admin-repo.hook scopes.

How to uninstall with the CLI wizard

  1. In the Codefresh UI, make sure you are in the Runtimes page.
  2. Switch to either the List View or to the Topology View.
  3. List view: On the top-right, select the three dots and then select Uninstall.

List View: Uninstall runtime option

List View: Uninstall runtime option

Topology view: Select the runtime node, and from the panel, select the three dots and then select Uninstall Runtime.

Topology View: Uninstall runtime option

Topology View: Uninstall runtime option
  1. If you already have the latest version of the Codefresh CLI, in the Uninstall Codefresh Runtime panel, copy the uninstall command.

Uninstall Codefresh runtime

Uninstall Codefresh runtime
  1. In your terminal, paste the command, and update the Git token value.
  2. Select the Kube context from which to uninstall the runtime, and then confirm the uninstall.
  3. If you get errors, run the uninstall command again, with the --force flag.

Runtime monitoring

Monitor runtimes for security, and health and sync errors:

  • Configure browsers to allow access to insecure runtimes
  • Monitor notifications in the Activity Log

How to configure browser to allow insecure runtimes

If at least one of your runtimes was installed in insecure mode (without an SSL certificate for the ingress controller from a CA), the UI alerts you that At least one runtime was installed in insecure mode.

Insecure runtime installation alert

Insecure runtime installation alert

All you need to do is to configure the browser to trust the URL and receive content.

  1. Select View Runtimes to the right of the alert.
    You are taken to the Runtimes page, where you can see insecure runtimes tagged as Allow Insecure.

Insecure runtimes in Runtime page

Insecure runtimes in Runtime page
  1. For every insecure runtime, select Allow Insecure, and when the browser prompts you to allow access, do as relevant:
    • Chrome: Click Advanced and then Proceed to site.
    • Firefox: Click Advanced and then Accept the risk and continue.
    • Safari: Click Show Certificate, and then select Always allow content from site.
    • Edge: Click Advanced, and then select Continue to site(unsafe).

How to view runtime notifications in Activity Log

The Activity Log is a quick way to monitor notifications for runtime events such as upgrades. A pull-down panel in the Codefresh toolbar, the Activity Log shows ongoing, success, and error notifications, sorted by date, starting with today’s date.

  1. In the Codefresh UI, on the top-right of the toolbar, select Activity Log.
  2. To see runtime notifications, filter by Runtime.

Activity Log filtered by Runtime events

Activity Log filtered by Runtime events
  1. To see more information on an error, select the + sign.

Troubleshoot health and sync errors

The icon with the runtime in red indicates either health or sync errors.

Health errors
Health errors are generated by Argo CD and by Codefresh for runtime components.

Sync errors
Runtimes with sync errors display an Out of sync status in Sync Status column. They are related to discrepancies between the desired and actual state of a runtime component or one of the Git sources associated with the runtime.

View errors
For both views, select the runtime, and then select Errors Detected.
Here is an example of health errors for a runtime.

Health errors for runtime example

Health errors for runtime example

Manage Git Sources
Managed clusters