kkpromote

Promotes a container image tag for an application from one Kustomize environment overlay to another in a GitOps repository.

Relationship to kustomize

Kustomize's native kustomize edit set image <name>=<newName>:<newTag> can write an image tag into a kustomization.yaml, but it has no command to read a tag from another overlay and no notion of promoting between environments.

kkpromote performs both the read and the write directly against the YAML, so it needs no kustomize binary installed and preserves comments and formatting in the edited file.

How it works

kkpromote reads the kustomization.yaml from the source environment and updates the image tag into the target environment.

Let's assume your gitops repo is laid out like this:

my-app/                     
├── dev/
│   └── kustomization.yaml
├── test/
│   └── kustomization.yaml
└── prod/
    └── kustomization.yaml

When you run kkpromote my-app dev test it will copy the newTag of the my-app image from the source overlay (dev) into the target overlay (test).

Path is optional: if omitted, the current directory is searched for the application to promote.

Install

Global install:

npm install -g kkpromote

Or run without installing via npx:

npx kkpromote my-app dev sit
npx kkpromote ~/my-gitops-repo/ my-app dev sit

Usage

kkpromote [path] <application> <source-env> <target-env> [options]

path defaults to the current directory. The application is then found as a subdirectory of that path, or as overlays already in the current directory.

| Option | Description | | --- | --- | | -d, --dry-run | Simulate the change without changing anything | | -h, --help | View help | | -v, --version | Check the version |

Examples:

kkpromote my-app dev test
# my-app (dev -> test): 1.0.0 -> 1.2.3

kkpromote ~/my-gitops-repo my-app dev sit
# using a path

Programmatic use

import { promote } from 'kkpromote';

const result = promote({
  application: 'my-app',
  sourceEnv: 'dev',
  targetEnv: 'sit',
});
// { changed: true, tag: '1.2.3', previousTag: '1.0.0', ... }

promote({
  path: '/path/to/my-gitops-repo/',
  application: 'my-app',
  sourceEnv: 'dev',
  targetEnv: 'sit',
});

Development

npm install
npm test
npm link

The example/ directory has a small GitOps layout you can use to test:

kkpromote --dry-run example my-app dev test
kkpromote example my-app dev test

Made with ❤️ for GitOps nerds.