Improve this page on GitHub

(Hybrid) Monitor provisioned runtimes

Monitor provisioned runtimes for security, health, and sync errors:

(Hybrid and hosted) View/download logs for runtimes and for runtime components
(Hybrid) Restore provisioned runtimes
(Hybrid) Configure browsers to allow access to insecure runtimes
(Hybrid) Monitor notifications in the Activity Log

View/download logs to troubleshoot runtimes

Logs are available for completed runtimes, both for the runtime and for individual runtime components. Download runtime log files for offline viewing and analysis, or view online logs for a runtime component, and download if needed for offline analysis. Online logs support free-text search, search-result navigation, and line-wrap for enhanced readability.

Log files include events from the date of the application launch, with the newest events listed first.

Download logs for runtimes

Download the log file for a runtime. The runtime log is downloaded as a .tar.gz file, which contains the individual log files for each runtime component.

In the Codefresh UI, go to Runtimes.
If needed, switch to List View, and then select the runtime for which to download logs.
From the list of Additional Actions, select Download All Logs.
The log file is downloaded to the Downloads folder or the folder designated for downloads, with the filename, <runtime-name>.tar.gz. For example, codefreshv2-production2.tar.gz.

To view the log files of the individual components, unzip the file.
Here is an example of the folder with the individual logs.

Open a log file with the text editor of your choice.

View/download logs for runtime components

View online logs for any runtime component, and if needed, download the log file for offline viewing and analysis.

Online logs show up to 1000 of the most recent events (lines), updated in real time. Downloaded logs include all the events from the application launch to the date and time of download.

In the Codefresh UI, go to Runtimes.
If needed, switch to List View, and then select the runtime.
Select the runtime component and then select View Logs.

View log option for individual runtime component

Do the following:
- Search by free-text for any string, and click the next and previous buttons to navigate between the search results.
- To switch on line-wrap for readability, click Wrap.

To download the log, click Download.
The file is downloaded as <component-name>.log.

(Hybrid) Restore provisioned runtimes

In case of cluster failure, restore the provisioned hybrid runtime from the existing runtime installation repository. For partial or complete cluster failures, you can restore the runtime to either the failed cluster or to a different cluster. Restoring the provisioned runtime reinstalls the runtime leveraging the resources in the existing runtime repo.

Restoring the runtime:

Applies argo-cd from the installation manifests in your repo to your cluster
Associates argo-cd with the existing installation repo
Applies the runtime and argo-cd secrets to the cluster
Updates the runtime config map (<runtime-name>.yaml in the bootstrap directory) with the new cluster configuration for these fields:
cluster
ingressClassName
ingressController
ingressHost

How to restore a hybrid runtime

Reinstall the hybrid runtime from the existing installation repository to restore it to the same or a different cluster.

Before you begin

Have the following information handy:

All values must be identical to the runtime to be restored.
- Runtime name
- Repository URL
- Codefresh context
- Kube context: Required if you are restoring to the same cluster

How to

Run:
cf runtime install --from-repo
Provide the relevant values when prompted.
If you are performing the runtime recovery in a different cluster, verify the ingress resource configuration for app-proxy, workflows, and default-git-source.
If the health status remains as Progressing, do the following:
- In the runtime installation repo, check if the ingress.yaml files for the app-proxy and workflows are configured with the correct host and ingressClassName:
  
  apps/app-proxy/overlays/<runtime-name>/ingress.yaml
  apps/workflows/overlays/<runtime-name>/ingress.yaml
- In the Git Source repository, check the host and ingressClassName in cdp-default-git-source.ingress.yaml:
  
  resources_<runtime-name>/cdp-default-git-source.ingress.yaml
See the example below.

If you have managed clusters registered to the hybrid runtime you are restoring, reconnect them.
Run the command and follow the instructions in the wizard:
cf cluster add
Verify that you have a registered Git integration:
cf integration git list --runtime <runtime-name>
If needed, create a new Git integration:
cf integration git add default --runtime <runtime-name> --provider github --api-url https://api.github.com

Ingress example

This is an example of the ingress.yaml for workflows.

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    ingress.kubernetes.io/protocol: https
    ingress.kubernetes.io/rewrite-target: /$2
    nginx.ingress.kubernetes.io/backend-protocol: https
    nginx.ingress.kubernetes.io/rewrite-target: /$2
  creationTimestamp: null
  name: runtime-name-workflows-ingress
  namespace: runtime-name
spec:
  ingressClassName: nginx
  rules:
  - host: your-ingress-host.com
    http:
      paths:
      - backend:
          service:
            name: argo-server
            port:
              number: 2746
        path: /workflows(/|$)(.*)
        pathType: ImplementationSpecific
status:
  loadBalancer: {}

(Hybrid) Configure browser to allow insecure hybrid runtimes

If at least one of your hybrid 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.

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

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.

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).

(Hybrid) View notifications for hybrid runtimes 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.

In the Codefresh UI, on the top-right of the toolbar, select Activity Log.
To see notifications for provisioned runtimes, filter by Runtime.

To see more information on an error, select the + sign.

(Hybrid) Troubleshoot health and sync errors for runtimes

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.

Manage provisioned runtimes
Add Git Sources to runtimes
Add external clusters to runtimes