Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2 KB

README.md

File metadata and controls

73 lines (50 loc) · 2 KB
Raw

mlp

Build Status Go Report Card GoDoc

mlp is a command line tool responsible for creating, updating and deleting kubernetes resources based on files generated by Mia-Platform Console. The main subcommands that the tool has are:

  • interpolate: fill placeholders in kubernetes files with the values of ENV variables
  • generate: create files for kubernetes ConfigMap and Secret based on files and/or ENV values
  • deploy: create and/or update resources in a kubernetes namespace with the intepolated/generated files
  • kustomize: run kustomize build
  • hydrate: helper to fill kustomization.yml with resources and patches
  • completion: generate the autocompletion

To Start Using mlp

Read the documentation here.

To Start Developing mlp

To start developing the CLI you must have this requirements:

  • golang 1.22
  • make

Once you have pulled the code locally, you can build the code with make:

make build

make will download all the dependencies needed and will build the binary for your current system that you can find in the bin folder.

To build the docker image locally run:

make docker-build

Testing mlp

To run the tests use the command:

make test

Or add the DEBUG_TEST flag to run the test with debug mode enabled:

make test DEBUG_TEST=1

Before sending a PR be sure that all the linter pass with success:

make lint