Improve this page on GitHub

Installation

Codefresh runtime installs the Codefresh platform, comprising Argo CD components and Codefresh-specific components. The Argo CD components are derived from a fork of the Argo ecosystem, and do not correspond to the open-source versions available.

There are two parts to installing runtimes:

  1. Installing the Codefresh CLI
  2. Installing the Codefresh runtime from the CLI, either through the CLI wizard or a silent install. The runtime is installed in a specific namespace on your cluster. You can install more runtimes on different clusters in your deployment.
    Every runtime installation makes commits to two Git repos:
    • Runtime install repo: The installation repo that manages the runtime itself with Argo CD. If the repo URL does not exist, runtime creates it automatically.
    • Git Source repo: Created automatically during runtime installation. The repo where you store manifests to run CodefreshCodefresh pipelines.

See Codefresh architecture.

Where do you install runtimes?

  • If this is your first Codefresh installation, in the Welcome page, select + Install Runtime.
  • To install additional runtimes, in the Codefresh UI, go to the Runtimes page, and select + Add Runtimes.

Installing the Codefresh CLI

Install the Codefresh CLI using the option that best suits you: curl, brew, or standard download.
If you are not sure which OS to select for curl, simply select one, and we automatically identify and select the right OS for CLI installation.

Installing the Codefresh runtime

Install Codefresh runtime through the CLI wizard, or by running a silent install:

  • CLI wizard: Run cf runtime install, and follow the prompts to enter the required values.
  • Silent install: Pass the mandatory flags in the install command:
    cf runtime install <runtime-name> --repo <git-repo> --git-token <git-token> --silent

Note:
Runtime installation starts by checking network connectivity and the K8s cluster server version.
To skip these tests, pass the --skip-cluster-checks flag.

Runtime prerequisites

Before you start installing the Codefresh runtime, verify that:

  • Your deployment conforms to our system requirements.

  • You have a Git runtime token: Authenticates to the Git installation repo that you will create or select during runtime installation.
    To create a Git token, see Creating a personal access token.

    When you create the Git token for runtime installation, set the correct expiration date and scope: Expiration: Default is 30 days
    Scope: repo and admin-repo.hook

Runtime installation flags

Runtime name
The runtime name must start with a lower-case character, and can include up to 62 lower-case characters and numbers.

Silent install: Mandatory parameter.

Kube context
If you have more than one Kube context, the current context, which is the cluster currently the default for kubectl, is selected by default.

  • CLI wizard: Select the Kube context from the list displayed.
  • Silent install: Explicitly specify the Kube context with the --context flag.

Ingress class

  • If you have more than one ingress class configured on your cluster:
    • CLI wizard: Select the ingress class for runtime installation from the list displayed.
    • Silent install:
      Explicitly specify the ingress class through the --ingress-class flag. Otherwise, runtime installation fails.

Ingress host

  • The IP address or host name of the ingress controller component.
    • CLI wizard: Automatically selects and displays the host, either from the cluster or the ingress controller associated with the Ingress class.
    • Silent install: Add the --ingress-host flag. If a value is not provided, takes the host from the ingress controller associated with the Ingress class.
  • If the ingress host does not have a valid SSL certificate, you can continue with the installation in insecure mode, which disables certificate validation.
    • CLI wizard: Prompts you to confirm continuing with the installation in insecure mode.
    • Silent install: To continue with the installation in insecure mode, add the --insecure-ingress-host flag.

Ingress resources
If you have a different routing service (not NGINX), bypass installing ingress resources with the --skip-ingress flag.
In this case, after completing the installation, manually configure the following:

  • Cluster’s routing service with path to '/app-proxy' and '/webhooks/<RUNTIME-NAME>/push-github'.
  • Create and register Git integrations using the commands:
    cf integration git add default --runtime <RUNTIME-NAME> --api-url <API-URL>
    cf integration git register default --runtime <RUNTIME-NAME> --token <RUNTIME-AUTHENTICATION-TOKEN>

Insecure flag
For on-premises installations, if the Ingress controller does not have a valid SSL certificate, to continue with the installation, add the --insecure flag to the installation command.

Repository URLs
The GitHub repository to house the installation definitions. If the repo doesn’t exist, Codefresh creates it during runtime installation.

Silent install: Mandatory. Add the --repo flag.

Git runtime token
The Git token authenticating access to the GitHub installation repository.

Silent install: Mandatory. Add the --git-token flag.

Codefresh demo resources
Optional. Install demo pipelines to use as a starting point to create your own pipelines. We recommend installing the demo resources as these are used in our quick start tutorials.

Silent install: Optional. Add the --demo-resources flag. By default, set to true.

Post-installation configuration

Optional. Required only for NGINX Enterprise installations, both with and without NGINX Ingress Operator.
You need to patch the certificate secret in spec.tls of the ingress-master resource.

Configure the ingress-master with the certificate secret. The secret must be in the same namespace as the runtime.

  1. Go to the runtime namespace with the NGINX ingress controller.

  2. In ingress-master, add to spec.tls:

     tls:                                                                                                                                                                    
  - hosts:                                                                                                                                                                
  - <host_name>                                                                                             
  secretName: <secret_name>

Runtime components

Git repositories

  • Runtime install repo: The installation repo contains three folders: apps, bootstrap and projects, to manage the runtime itself with Argo CD.
  • Git source repository: Created with the name [repo_name]_git-source. This repo stores manifests to run pipelines with sources, events, workflow templates.

Argo CD components

  • Project, comprising an Argo CD AppProject and an ApplicationSet
  • Installations of the following applications in the project:
    • Argo CD
    • Argo Workflows
    • Argo Events
    • Argo Rollouts

Codefresh-specific components

  • Codefresh Applications in the Argo CD AppProject:
    • App-proxy facilitating behind-firewall access to Git
    • Git Source entity that references the[repo_name]_git-source

Once the runtime is successfully installed, it is provisioned on the Kubernetes cluster, and displayed in the Runtimes page.

Manage runtimes
Manage Git Sources
Troubleshooting runtime installation