Skip to content

Commit

Permalink
read me for generator code
Browse files Browse the repository at this point in the history
  • Loading branch information
Greyeye committed Jul 16, 2024
1 parent 9304b0b commit aed9764
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions pkg/generator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Argo CD Generators
This directory contains the code for Argo CD generators. Generators dynamically create Kubernetes resources from various sources of truth, such as Kustomize, Helm, Ksonnet, and others. They are a key component in Argo CD for automating resource creation and management.

## Overview
Generators in Argo CD enable the dynamic generation of Kubernetes manifests based on the desired state defined in different configurations. By leveraging these generators, Argo CD can efficiently manage and deploy resources across different environments.

## Why Forked?
This code is a fork of the Argo CD (v2.12) generator code. The fork was necessary due to an incompatibility between Kubechecks' use of the go-gitlab library and Argo CD's generator code. To resolve this, the generator code has been forked and adapted for compatibility with Kubechecks.

## Supported Generators
* Lists
* Clusters

## Unsupported Generators
* Git
* Pull Requests

## Usage
You can use these generators to automate the creation and management of Kubernetes resources in your environment, ensuring consistency and repeatability.

0 comments on commit aed9764

Please sign in to comment.