elyesbenamor / myks

🧙‍♂️

Myks

Manage (my) yaml for Kubernetes simply. Or something like that.

Myks helps to maintain configuration of many applications for multiple Kubernetes clusters.

Development

Prerequisites

For building and contributing:

• Go 1.20+
• goreleaser 1.18+
• optional:
  • task 3.27+
  • lefthook 1.4+
  • gofumpt 0.5+
  • golangci-lint 1.53+
  • commitlint 17.6+

For running:

• ytt 0.44+
• vendir 0.34+
• helm 3.12+

Build

$ task go:build
$ # or, if task or goreleaser aren't installed, just
$ go build -o myks ./cmd/myks

Test

$ # Switch to an empty directory
$ cd $(mktemp -d)
$ # Initialize a new project
$ myks init
$ # Optionally, check the generated files
$ find
$ # Sync and render everything
$ myks all envs --log-level debug

Run

Running sync against protected repositories and registries

Vendir uses secret resources to authenticate against protected repositories. These are references by the vendir.yaml with the secretRef key.

Myks dynamically creates these secrets based on environment variables prefixed with VENDIR_SECRET_. For example, if you reference a secret named "mycreds" in your vendir.yaml, you need to define the environment variables VENDIR_SECRET_MYCREDS_USERNAME and VENDIR_SECRET_MYCREDS_PASSWORD. The secrets are cleaned up automatically after the sync is complete.