git-update-services

README

git-update-services

This is to be used either as a Git extension or as a standalone tool. It's purpose is to generate a kustomization.yaml file for a particular environment stage (i.e., production, beta, development, etc.) that lists all of the particular services or applications that reside in a GitOps directory structure that should be synced and deployed by a tool like Flux or Argo CD.

The reason this exists is because kustomize doesn't currently have support for globbing, which makes maintaining a kustomization.yaml that references other "kustomized" directories potentially painstaking and error prone.

This is especially helpful in a multi-cluster environment where all services for a particular environment stage like production, beta, development, etc. are located in a location with kustomize overlays for each service.

How It Works

git-update-services will recurse down the directory structure underneath the --appDir location (defaults to applications), looking for an overlays directory. If it finds one, it will determine if it has a child directory that matches the string given to env (i.e., overlays/production`).

If one exists, it will add it to the kustomization.yaml file for that particular environment only if kustomization.yaml doesn't yet contain the path for that particular application.

Installation

Compile the binary for your system architecture:

$ go build

Then, move this anywhere in your PATH.

If you want to build and install this in a file in your GOBIN, simply:

$ go install

This is probably the easiest method, as that directory will already be in your PATH.

To use as an extension to Git, move the git-kustomize file anywhere in your path after you've compiled the binary.

Examples

git-update-services

$ git-update-services --project devops --env beta

git-kustomize

$ git kustomize --project devops --env beta

Miscellaneous

Currently, it's not possible to add every project (and every app in a project) under the --appDir at once (is this even a viable use case?).

License

GPLv3

Author

Benjamin Toll