Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 2.87 KB

README.md

File metadata and controls

69 lines (51 loc) · 2.87 KB
Raw

deployKF - Command Line Interface (CLI)

Check Commit Downloads Latest Release

This repo contains the command line interface (CLI) for deployKF.

Install

To install the deploykf CLI, please follow the installation instructions on the deployKF website.

Usage

The simplest usage of the deploykf CLI is to run the following command:

deploykf \
  --source-version 0.1.1 \
  --values ./custom-values.yaml \
  --output-dir ./GENERATOR_OUTPUT

This command will generate deployKF manifests in the ./GENERATOR_OUTPUT directory using the v0.1.1 source version and the values specified in your ./custom-values.yaml file. Note that the --source-version flag must correspond to a tag from a deployKF release.

TIP:

The version of the CLI does NOT need to match the --source-version you are generating manifests for. If a breaking change is ever needed, the CLI will fail to generate with newer source versions, and will print message telling you to upgrade the CLI.

Container Image

We publish the deploykf CLI as a container image on the following registries:

Registry Image Pull Command
GitHub Container Registry ghcr.io/deploykf/cli docker pull ghcr.io/deploykf/cli:TAG_NAME

To use the container image, you need to mount your local filesystem into the container:

CONTAINER_IMAGE="ghcr.io/deploykf/cli:0.1.2"

docker run \
  --rm \
  --volume "$(pwd):/home/deploykf" \
  --volume "${HOME}/.deploykf:/home/deploykf/.deploykf" \
  "${CONTAINER_IMAGE}" \
    generate \
    --source-version "0.1.1" \
    --values ./sample-values.yaml \
    --output-dir ./GENERATOR_OUTPUT

Development

Here are some helpful commands when developing the CLI:

  • make build: Builds the binary for your local platform and outputs it to ./bin/deploykf.
  • make install: Installs the binary to /usr/local/bin.
  • make lint: Runs golangci-lint against the codebase to check for errors.
  • make lint-fix: Attempts to automatically fix any linting errors found.