Skip to content

puzzle/goff

Folders and files

NameName
Last commit message
Last commit date
Jan 3, 2024
Dec 30, 2023
Jan 29, 2024
Apr 8, 2024
May 30, 2024
Jun 30, 2023
Jan 29, 2024
Apr 8, 2024
Jul 19, 2023
May 24, 2023
Jan 29, 2024
May 27, 2023
Jul 19, 2023
Jun 28, 2023
Aug 7, 2024
Aug 7, 2024
Jun 10, 2023
Dec 30, 2023
May 25, 2023
Jun 30, 2023
May 25, 2023

Repository files navigation

ci

GOFF

Inspired from Kostis Kapelonis (Codefresh.io) talk at the KubeCon about How to Preview and Diff Your Argo CD Deployments we relased our own GitOps Diff tool (Goff). This tool helps you to preview your changes in your GitOps Repository.

How it works

Checkout the examples

Kustomize example

Example for Kustomization diff

#Build base and all overlays from source branch
goff kustomize build ./source/kustomize --output-dir /tmp/source/out
#Build base and all overlays from target branch
goff kustomize build ./target/kustomize --output-dir /tmp/target/out
#Diff rendered manifests
goff diff "/tmp/source" "/tmp/target" --title=Preview --output-dir .
  1. Create a new branch and commit your changes in your Kustomize deployment GitHub Diff
  2. Run your pipeline, Goff renders the Base and the Overlays and calculate the diff between the source and target branch.
  3. Check the auto generated comment in your Pull request and review the changes GitHub Diff

ArgoCD Application

Usage

GitOps Diff Tool

Usage:
  goff [command]

Available Commands:
  argocd      Render manifests from ArgoCD resources
  completion  Generate the autocompletion script for the specified shell
  diff        Diff files [sourceDir] [targetDir]
  help        Help about any command
  kustomize   Generate a DOT file to visualize the dependencies between your kustomize components
  split       Split manifests [manifestFile]

Flags:
  -h, --help              help for goff
  -l, --logLevel string   Set loglevel [debug, info, error] (default "error")

Use "goff [command] --help" for more information about a command.

Supported Tools

Tooling Support
Plain manifests
Helm ✅ Supported through plain manifests
Kustomize
ArgoCD Application ✅ Needs a local ArgoCD Repo server instance
ArgoCD ApplicationSet 🚧 Not yet fully supported (List generators only)

Documentation