Hybrid runtime requirements

The requirements listed are the minimum requirements to provision hybrid runtimes in the Codefresh platform.

Hosted runtimes are managed by Codefresh. To provision a hosted runtime as part of Hosted GitOps setup, see Provision a hosted runtime in Set up a hosted (Hosted GitOps) environment.

In the documentation, Kubernetes and K8s are used interchangeably.

Kubernetes cluster requirements

This section lists cluster requirements.

Cluster version

Kubernetes cluster, server version 1.18 and higher, without Argo Project components.

Tip:
To check the server version, run kubectl version --short.

Ingress controller

Configure your Kubernetes cluster with an ingress controller component that is exposed from the cluster.

Supported ingress controllers

Ingress controller requirements

• Valid external IP address
  Run kubectl get svc -A to get a list of services and verify that the EXTERNAL-IP column for your ingress controller shows a valid hostname.

• Valid SSL certificate
  For secure runtime installation, the ingress controller must have a valid SSL certificate from an authorized CA (Certificate Authority).

• AWS ALB
  In the ingress resource file, verify that spec.controller is configured as ingress.k8s.aws/alb.

apiVersion: networking.k8s.io/v1
kind: IngressClass
metadata:
  name: alb
spec:
  controller: ingress.k8s.aws/alb

• Report status
  The ingress controller must be configured to report its status. Otherwise, Argo’s health check reports the health status as “progressing” resulting in a timeout error during installation.

  By default, NGINX Enterprise and Traefik ingress are not configured to report status. For details on configuration settings, see the following sections in this article:
  NGINX Enterprise ingress configuration
  Traefik ingress configuration

NGINX Enterprise version ingress configuration

The Enterprise version of NGINX (nginx.org/ingress-controller), both with and without the Ingress Operator, must be configured to report the status of the ingress controller.

Installation with NGINX Ingress

• Pass the - -report-ingress-status to deployment.

    spec:                                                                                                                                                                 
      containers: 
       - args:                                                                                                                                              
       - -report-ingress-status
  

Installation with NGINX Ingress Operator

1. Add this to the Nginxingresscontrollers resource file:

   ...
   spec:
     reportIngressStatus:
       enable: true
   ...
   

2. Make sure you have a certificate secret in the same namespace as the runtime. Copy an existing secret if you don’t have one.
   You will need to add this to the ingress-master when you have completed runtime installation.

NGINX Community version provider-specific ingress configuration

Codefresh has been tested and is supported in major providers. For your convenience, here are provider-specific configuration instructions, both for supported and untested providers.

The instructions are valid for k8s.io/ingress-nginx, the community version of NGINX.

Traefik ingress configuration

To enable the the Traefik ingress controller to report the status, add publishedService to providers.kubernetesIngress.ingressEndpoint.

The value must be in the format "<namespace>/<service-name>", where:
<service-name> is the Traefik service from which to copy the status

   ...
   providers:
    kubernetesIngress:
      ingressEndpoint:
        publishedService: "<namespace>/<traefik-service>" # Example, "codefresh/traefik-default" ...
   ...

Node requirements

• Memory: 5000 MB
• CPU: 2

Runtime namespace permissions for resources

Git repository requirements

This section lists the requirements for Git installation repositories.

Git installation repo

If you are using an existing repo, make sure it is empty.

Git access tokens

Codefresh requires two access tokens, one for runtime installation, and the second, a personal token for each user to authenticate Git-based actions in Codefresh.

Git runtime token

The Git runtime token is mandatory for runtime installation.

The token must have valid:

• Expiration date: Default is 30 days
• Scopes: repo and admin-repo.hook

Git user token for Git-based actions

The Git user token is the user’s personal token and is unique to every user. It is used to authenticate every Git-based action of the user in Codefresh. You can add the Git user token at any time from the UI.

The token must have valid:

• Expiration date: Default is 30 days
• Scope: repo

For detailed information on GitHub tokens, see Creating a personal access token.

What to read next

Installing hybrid runtimes