Configure a GitOps Runtime

Configure Git credentials, Git Sources, and more for Runtimes

Configure GitOps Runtime

After installing a Runtime, complete its configuration to enable GitOps operations.
Configuration includes:

• Defining Git credentials
• Configuring Runtime as an Argo CD Application
• Adding a Git source

You can configure the Runtime immediately after installation by following the Configuration and Management steps in the installation wizard, or at any time later through the Codefresh UI. If any configuration steps are pending, the Runtime’s status in the UI list view indicates it through the Complete installation .

Configure Git credentials for Runtime

Git credentials for the Runtime include defining:

• Git Runtime token
  Required for every GitOps Runtime.
  It must be provided during the Runtime installation, and is typically associated with a service/robot account.
• Git user token
  A personal access token unique to every Codefresh user.
  It is required after installation for every Runtime which the user has access to.

See Git Runtime tokens versus Git user tokens.

Why tokens are required

Git tokens are used both during installation and for ongoing GitOps operations, such as Argo CD syncing repositories, deploying templates, and performing Git actions.

Tokens are always securely stored on your cluster and never in the Codefresh platform.

Scopes for Git tokens

Create personal access tokens in GitHub with the required scopes. GitHub supports Classic and Fine-Grained tokens.
See Git Runtime token scopes and Git user token scopes.

Using the Git Runtime token as the Git user token

To simplify setup, you can use the Git Runtime token as the Git user token if it includes the additional scopes required for user access.

Configure Runtime as an Argo CD Application

Configure the GitOps Runtime as an Argo CD Application to view Runtime components, monitor health and sync statuses, and ensure that Git is the single source of truth for the Runtime.

Click Configure as Argo CD Application in the installation wizard to complete this step automatically.

Configuring the GitOps Runtime as an Argo CD Application ensures:

• Git as the single source of truth
  The Runtime’s configuration is managed declaratively in Git, ensuring consistency, traceability, and version control over all its configurations.
• Automated reconciliation
  Argo CD continuously monitors the Runtime’s desired state in Git and corrects any drift, ensuring alignment with the cluster.
• Visibility and monitoring
  The Runtime appears in the GitOps Apps dashboard, where you can monitor and manage it as any other Argo CD application.

Add Git Source to Runtime

A Git Source is a critical component in GitOps Runtimes, connecting a Git repository to the cluster, enabling deployment and configuration management of Argo CD applications.

The Git repository referenced by the Git Source stores application manifests and other resources which are always synced to the cluster. Codefresh manages the Git Source itself as an Argo CD application.

Git Source settings

Setting	Description
Git Source Name	A unique name for the Git Source within the cluster. Must follow Kubernetes naming conventions.
Git Source Type	Select Standard Git Source to create the Git Source as an Argo CD application in the Runtime’s namespace. It belongs to the default or user-defined Application Project, without deployment or repo restrictions.
Git Repository Source	The Git repository which stores the application manifests, including the Git Source application manifest. Choose one of the following: Use an existing repository: - Repository (Required): The URL of the Git repository. - Branch (Optional): The branch in which to create the Git Source application manifest. - Path (Optional): The directory within the repo where the manifest will be stored. Create a new repository: - Organization Name: Select the organization for which to create the repository. - Repository Name: The name of the new repository.
Included and Excluded Files	Define patterns to specify which files should be included or excluded when syncing the repository to the cluster. Use GLOB patterns to define paths: - workflows/**/*.yaml → Includes all YAML files in workflows and its subdirectories. - **/images/**/* → Excludes all directories named images. For GLOB guidelines, see this guide.

Related articles

Managing Git Sources in GitOps Runtimes
Managing external clusters in GitOps Runtimes
Shared Configuration Repository
Monitoring GitOps Runtimes
Managing GitOps Runtimes