diff --git a/CODEOWNERS b/CODEOWNERS index 808736d..e571f0a 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1 +1 @@ -* @1debit/infrastructure-eng +* @chime/maintainers diff --git a/README.md b/README.md index 2acf33f..56b37b0 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. -1 -2 +1 +2 # See it in action in a video ! @@ -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 @@ -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. @@ -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. diff --git a/demo/.zz.auto-generated/prod-app-group-1/manifest.yaml b/demo/.zz.auto-generated/prod-app-group-1/manifest.yaml index ddd211d..68b58ee 100644 --- a/demo/.zz.auto-generated/prod-app-group-1/manifest.yaml +++ b/demo/.zz.auto-generated/prod-app-group-1/manifest.yaml @@ -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 @@ -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 diff --git a/demo/.zz.auto-generated/prod-cluster/manifest.yaml b/demo/.zz.auto-generated/prod-cluster/manifest.yaml index 389cd8d..7ab972b 100644 --- a/demo/.zz.auto-generated/prod-cluster/manifest.yaml +++ b/demo/.zz.auto-generated/prod-cluster/manifest.yaml @@ -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 diff --git a/demo/.zz.auto-generated/test-app-group-1/manifest.yaml b/demo/.zz.auto-generated/test-app-group-1/manifest.yaml index 3ad30ea..f0338bc 100644 --- a/demo/.zz.auto-generated/test-app-group-1/manifest.yaml +++ b/demo/.zz.auto-generated/test-app-group-1/manifest.yaml @@ -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 @@ -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 @@ -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 diff --git a/demo/.zz.auto-generated/test-cluster/manifest.yaml b/demo/.zz.auto-generated/test-cluster/manifest.yaml index 2d69a3b..536d0b6 100644 --- a/demo/.zz.auto-generated/test-cluster/manifest.yaml +++ b/demo/.zz.auto-generated/test-cluster/manifest.yaml @@ -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 diff --git a/demo/bootstrap/prod-cluster.yaml b/demo/bootstrap/prod-cluster.yaml index 06e7a91..de403f6 100644 --- a/demo/bootstrap/prod-cluster.yaml +++ b/demo/bootstrap/prod-cluster.yaml @@ -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: diff --git a/demo/bootstrap/test-cluster.yaml b/demo/bootstrap/test-cluster.yaml index 592a8cb..0e68868 100644 --- a/demo/bootstrap/test-cluster.yaml +++ b/demo/bootstrap/test-cluster.yaml @@ -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: diff --git a/demo/charts/app-of-apps/templates/app-of-apps.tpl b/demo/charts/app-of-apps/templates/app-of-apps.tpl index 21cb8bc..02dce6e 100644 --- a/demo/charts/app-of-apps/templates/app-of-apps.tpl +++ b/demo/charts/app-of-apps/templates/app-of-apps.tpl @@ -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 diff --git a/demo/charts/app-of-apps/templates/service.tpl b/demo/charts/app-of-apps/templates/service.tpl index fa8460f..35b1e41 100644 --- a/demo/charts/app-of-apps/templates/service.tpl +++ b/demo/charts/app-of-apps/templates/service.tpl @@ -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 diff --git a/go.mod b/go.mod index d611480..0691f33 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/1debit/mani-diffy +module github.com/chime/mani-diffy go 1.20 diff --git a/main.go b/main.go index b2381d8..212c071 100644 --- a/main.go +++ b/main.go @@ -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" ) diff --git a/pkg/helm/helm.go b/pkg/helm/helm.go index 02bf0aa..86f4a77 100644 --- a/pkg/helm/helm.go +++ b/pkg/helm/helm.go @@ -17,8 +17,8 @@ import ( "strings" "sync" - "github.com/1debit/mani-diffy/pkg/kustomize" "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1" + "github.com/chime/mani-diffy/pkg/kustomize" yamlutil "k8s.io/apimachinery/pkg/util/yaml" ) diff --git a/pkg/helm/helm_test.go b/pkg/helm/helm_test.go index 9d3d6d1..ed7ee7c 100644 --- a/pkg/helm/helm_test.go +++ b/pkg/helm/helm_test.go @@ -224,8 +224,8 @@ func TestGenerateHashOnCrd(t *testing.T) { crd := data[0] hash, err := generateHashOnCrd(crd) - if err != nil || hash != "fba38c4479874778a2e0bf38c2e94f83d57d9f24c9c7d71e123bc5c1961ed936" { - t.Error("Failed to generate correctly") + if err != nil || hash != "7bfd65e963e76680dc5160b6a55c04c3d9780c84aee1413ae710e4b5279cfe14" { + t.Errorf("Failed to generate correctly, got %s", hash) } } @@ -300,7 +300,7 @@ func TestDifferenceInTwoDifferentFiles(t *testing.T) { func TestGenerateHashOnChart(t *testing.T) { hash, _ := generalHashFunction("demo/charts/app-of-apps") h := hex.EncodeToString(hash) - actualHash := "95630c1ec9b835536a3056d4dcbbd6e023111c5e4340ac80b945c2e3a4f8fc42" + actualHash := "13aa148adefa3d633e5ce95584d3c95297a4417977837040cd67f0afbca17b5a" if h != actualHash { t.Errorf("Failed to generate a generic hash on a chart. got: %s wanted: %s", h, actualHash) } diff --git a/pkg/helm/test_files/crdData_multiple_crd_testfile.yaml b/pkg/helm/test_files/crdData_multiple_crd_testfile.yaml index 5baa6f2..febc003 100644 --- a/pkg/helm/test_files/crdData_multiple_crd_testfile.yaml +++ b/pkg/helm/test_files/crdData_multiple_crd_testfile.yaml @@ -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: @@ -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: diff --git a/pkg/helm/test_files/crdData_testfile.yaml b/pkg/helm/test_files/crdData_testfile.yaml index bbeb91c..5313106 100644 --- a/pkg/helm/test_files/crdData_testfile.yaml +++ b/pkg/helm/test_files/crdData_testfile.yaml @@ -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: diff --git a/pkg/helm/test_files/crdData_testfile_2.yaml b/pkg/helm/test_files/crdData_testfile_2.yaml index b377ba9..266a4de 100644 --- a/pkg/helm/test_files/crdData_testfile_2.yaml +++ b/pkg/helm/test_files/crdData_testfile_2.yaml @@ -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: