Kargo Examples

Welcome! This repository is a curated collection of Kargo examples, each carefully annotated to guide you through specific features and functionalities.

Each example is contained in its own directory. You’ll find additional information about individual examples in their respective README.md files.

Getting Started

These examples are designed to work alongside the example application GitOps repository found at kargo-demo-gitops. To set up:

1. Fork the kargo-demo repository:

   • Uncheck the Copy the main branch only option when forking.
   • You do not need to clone that repository locally—cloning this repository is sufficient.

2. Set Up Variables: In these example manifests, substitute the following placeholders:

   • <github-username> → Your GitHub username
   • <github-pat> → A GitHub personal access token with read/write access to your fork
   • <dockerhub-username> → Your Docker Hub username
   • <dockerhub-pat> → A Docker Hub personal access token with read-only permissions

   ⚠️ Tip: Use your favorite text editor's search-and-replace feature to make these substitutions across files quickly.

Structure and Usage

Each example is divided into two main manifests:

1. argocd.yaml – Apply this first. It includes foundational setup elements not specific to Kargo.
2. kargo.yaml – Apply this after argocd.yaml. It contains Kargo-specific configurations.

This separation highlights which components are unique to Kargo within each example.