Improve this page on GitHub

Manage provisioned runtimes

The Runtimes page displays the provisioned runtimes in your account, both hybrid, and the hosted runtime if you have one. View runtime components and information in List or Topology view formats. Managed provisioned runtimes in the view mode that suits you.

Unless specified otherwise, management options are common to both hybrid and hosted runtimes.

To monitor provisioned hybrid runtimes, including recovering runtimes for failed clusters, see Monitor provisioned hybrid runtimes.

Runtime views

View provisioned hybrid and hosted runtimes in List or Topology view formats.

List view: The default view, displays the list of provisioned 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.

List view

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

Here is an example of the List view for runtimes.

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

List View Item	Description
Name	The name of the provisioned Codefresh runtime.
Type	The type of runtime provisioned, and can be Hybrid or Hosted.
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 runtimes include CI amnd CD Ops modules. Hosted runtimes inlcude CD Ops.
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 Adding external clusters to runtimes.
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

A hierachical visualization of the provisioned 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 runtimes.

Here is a description of the information 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. Hosted runtimes display ‘hosted’.
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 Adding external clusters to 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.

Hybrid/hosted runtime management

Work in either the List or Topology views to manage provisioned runtimes. If an option is valid only for hybrid runtimes, it is indicated as such.

Add managed clusters to hybrid or hosted runtimes (see Adding & managing external clusters)
Add and manage Git Sources associated with hybrid or hosted runtimes (see Adding & managing Git Sources)
Upgrade provisioned hybrid runtimes
Uninstall hybrid or hosted runtimes

(Hybrid) Upgrade provisioned runtimes

Upgrade provisioned hybrid runtimes to install critical security updates or to install the latest version of all components. Upgrade a provisioned hybrid runtime by running a silent upgrade or through the CLI wizard.
If you have managed clusters for the hybrid runtime, upgrading the runtime automatically updates runtime components within the managed cluster as well.

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 older runtime versions, upgrade to manually define or create the shared configuration repo for your account. See Shared configuration repo.

Before you begin
For both silent or CLI-wizard based upgrades, make sure you have:

The latest version of the Codefresh CLI
Run cf version to see your version and click here to compare with the latest CLI version.
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

In the Codefresh UI, make sure you are in Runtimes.
Switch to either the List View or to the Topology View.
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.

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

If you have already installed the Codefresh CLI, in the Install Upgrades panel, copy the upgrade command.

In your terminal, paste the command, and do the following:
- Update the Git token value.
- To manually define the shared configuration repo, add the --shared-config-repo flag with the path to the repo.
Confirm to start the upgrade.

Uninstall provisioned runtimes

Uninstall provisioned hybrid and hosted 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 provisioned runtime

Silent uninstall
Pass the mandatory flags in the uninstall command:
cf runtime uninstall <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 uninstall

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

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

If you already have the latest version of the Codefresh CLI, in the Uninstall Codefresh Runtime panel, copy the uninstall command.

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

Monitor provisioned hybrid runtimes
Add Git Sources to runtimes
Add external clusters to runtimes