Skip to content

Commit

Permalink
Move from @1debit to @chime
Browse files Browse the repository at this point in the history
  • Loading branch information
inga committed May 9, 2024
1 parent 1095de7 commit 40b0658
Show file tree
Hide file tree
Showing 15 changed files with 27 additions and 27 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# mani-diffy

![Tests](https://github.com/1debit/mani-diffy/actions/workflows/tests.yaml/badge.svg)
![Tests](https://github.com/chime/mani-diffy/actions/workflows/tests.yaml/badge.svg)

This program walks a hierarchy of Argo CD Application templates, renders Kubernetes manifests from the input templates, and posts the rendered files back for the user to review and validate.
This program walks a hierarchy of Argo CD Application templates, renders Kubernetes manifests from the input templates, and posts the rendered files back for the user to review and validate.

It is designed to be called from a CI job within a pull request, enabling the author to update templates and see the resulting manifests directly within the pull request before the changes are applied to the Kubernetes cluster.
It is designed to be called from a CI job within a pull request, enabling the author to update templates and see the resulting manifests directly within the pull request before the changes are applied to the Kubernetes cluster.

The rendered manifests are kept within the repository, making diffs between revisions easy to parse, dramatically improving safety when updating complex application templates.

Expand All @@ -19,8 +19,8 @@ The rendered manifests are kept within the repository, making diffs between revi

🫵 Submit a PR where you make a change to the overrides of the [`demo`](demo/README.md), and you'll see the [Github action]( [README](../../.github/workflows/generate-manifests-demos.yaml)) add a commit to your PR with the resulting changes.

<img width="1099" alt="1" src="https://github.com/1debit/mani-diffy/assets/9005904/6b6d9e45-57f7-43ff-906f-ebf4c0a03ad9">
<img width="1701" alt="2" src="https://github.com/1debit/mani-diffy/assets/9005904/03d4a49e-1fc9-40a1-9882-1c032b2d345b">
<img width="1099" alt="1" src="https://github.com/chime/mani-diffy/assets/9005904/6b6d9e45-57f7-43ff-906f-ebf4c0a03ad9">
<img width="1701" alt="2" src="https://github.com/chime/mani-diffy/assets/9005904/03d4a49e-1fc9-40a1-9882-1c032b2d345b">

# See it in action in a video !

Expand All @@ -29,7 +29,7 @@ In this screen recording a pull request is opened to make the following changes
1. Bump the count of pods for the `foo` service in the prod cluster
2. Add an annotation to all services

https://github.com/1debit/mani-diffy/assets/9005904/6c496996-f7af-4932-bf5d-01a5b57bbd99
https://github.com/chime/mani-diffy/assets/9005904/6c496996-f7af-4932-bf5d-01a5b57bbd99


## Post Renderers
Expand All @@ -44,7 +44,7 @@ The command will be called with the output directory as the first argument (e.g.

---

## Pre-requisites
## Pre-requisites

This is for a new user that is looking to use mani-diffy on a new repo.

Expand All @@ -55,7 +55,7 @@ In order to make use of mani-diffy on the repo that holds all of your ArgoCD app

`mani-diffy` itself makes no assumptions about how the repo is structured, as long as it can successfully render the charts it encounters while walking the Application tree.

However, you may find it useful to organize your repo similarly to the demo app, with 3 key directories :
However, you may find it useful to organize your repo similarly to the demo app, with 3 key directories :

1. a "root" or "bootstrap" directory that holds all the ArgoCD applications manifests.
2. a "charts" directory that contains all the helm charts needed for the ArgoCD applications.
Expand Down
4 changes: 2 additions & 2 deletions demo/.zz.auto-generated/prod-app-group-1/manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
path: charts/service
helm:
version: v3
Expand All @@ -34,7 +34,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
path: charts/service
helm:
version: v3
Expand Down
2 changes: 1 addition & 1 deletion demo/.zz.auto-generated/prod-cluster/manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
targetRevision: HEAD

path: charts/app-of-apps
Expand Down
6 changes: 3 additions & 3 deletions demo/.zz.auto-generated/test-app-group-1/manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
path: charts/service
helm:
version: v3
Expand All @@ -34,7 +34,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
path: charts/service
helm:
version: v3
Expand All @@ -58,7 +58,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
path: charts/service
helm:
version: v3
Expand Down
2 changes: 1 addition & 1 deletion demo/.zz.auto-generated/test-cluster/manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
targetRevision: HEAD

path: charts/app-of-apps
Expand Down
2 changes: 1 addition & 1 deletion demo/bootstrap/prod-cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
valueFiles:
- ../../overrides/bootstrap/prod-cluster.yaml
path: charts/app-of-apps
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
targetRevision: HEAD
syncPolicy:
syncOptions:
Expand Down
2 changes: 1 addition & 1 deletion demo/bootstrap/test-cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
valueFiles:
- ../../overrides/bootstrap/test-cluster.yaml
path: charts/app-of-apps
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
targetRevision: HEAD
syncPolicy:
syncOptions:
Expand Down
2 changes: 1 addition & 1 deletion demo/charts/app-of-apps/templates/app-of-apps.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
targetRevision: HEAD

path: charts/app-of-apps
Expand Down
2 changes: 1 addition & 1 deletion demo/charts/app-of-apps/templates/service.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ spec:
server: https://kubernetes.default.svc
project: default
source:
repoURL: https://github.com/1debit/mani-diffy.git
repoURL: https://github.com/chime/mani-diffy.git
path: charts/service
helm:
version: v3
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/1debit/mani-diffy
module github.com/chime/mani-diffy

go 1.20

Expand Down
4 changes: 2 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ import (
"strings"
"time"

"github.com/1debit/mani-diffy/pkg/helm"
"github.com/1debit/mani-diffy/pkg/kustomize"
"github.com/chime/mani-diffy/pkg/helm"
"github.com/chime/mani-diffy/pkg/kustomize"

"github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
)
Expand Down
2 changes: 1 addition & 1 deletion pkg/helm/helm.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
"strings"
"sync"

"github.com/1debit/mani-diffy/pkg/kustomize"
"github.com/chime/mani-diffy/pkg/kustomize"

Check failure on line 20 in pkg/helm/helm.go

View workflow job for this annotation

GitHub Actions / lint

File is not `gofmt`-ed with `-s` (gofmt)

Check failure on line 20 in pkg/helm/helm.go

View workflow job for this annotation

GitHub Actions / lint

File is not `gofmt`-ed with `-s` (gofmt)
"github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
yamlutil "k8s.io/apimachinery/pkg/util/yaml"
)
Expand Down
4 changes: 2 additions & 2 deletions pkg/helm/test_files/crdData_multiple_crd_testfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
valueFiles:
- ../../overrides/bootstrap/prod-cluster.yaml
path: charts/app-of-apps
repoURL: https://github.com/1debit/mani-diffy
repoURL: https://github.com/chime/mani-diffy
targetRevision: HEAD
syncPolicy:
syncOptions:
Expand All @@ -45,7 +45,7 @@ spec:
valueFiles:
- ../../overrides/bootstrap/test-cluster.yaml
path: charts/app-of-apps
repoURL: https://github.com/1debit/mani-diffy
repoURL: https://github.com/chime/mani-diffy
targetRevision: HEAD
syncPolicy:
syncOptions:
Expand Down
2 changes: 1 addition & 1 deletion pkg/helm/test_files/crdData_testfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ spec:
valueFiles:
- ../../overrides/bootstrap/prod-cluster.yaml
path: demo/charts/app-of-apps
repoURL: https://github.com/1debit/mani-diffy
repoURL: https://github.com/chime/mani-diffy
targetRevision: HEAD
syncPolicy:
syncOptions:
Expand Down
2 changes: 1 addition & 1 deletion pkg/helm/test_files/crdData_testfile_2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
- ../../overrides/bootstrap/prod-cluster.yaml
- ../../overrides/bootstrap/fake_file.yaml
path: charts/app-of-apps
repoURL: https://github.com/1debit/mani-diffy
repoURL: https://github.com/chime/mani-diffy
targetRevision: HEAD
syncPolicy:
syncOptions:
Expand Down

0 comments on commit 40b0658

Please sign in to comment.