https://github.com/mia-platform/mlp
cli for easier deployment of Mia-Platform Console projects
https://github.com/mia-platform/mlp
golang kubernetes kustomize
Last synced: 12 months ago
JSON representation
cli for easier deployment of Mia-Platform Console projects
- Host: GitHub
- URL: https://github.com/mia-platform/mlp
- Owner: mia-platform
- License: apache-2.0
- Created: 2021-12-27T09:03:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-06-12T07:44:26.000Z (about 1 year ago)
- Last Synced: 2025-06-12T08:35:42.969Z (about 1 year ago)
- Topics: golang, kubernetes, kustomize
- Language: Go
- Homepage: https://docs.mia-platform.eu/docs/runtime_suite_tools/mlp/overview
- Size: 695 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# mlp
[![Build Status][github-actions-svg]][github-actions]
[![Go Report Card][go-report-card]][go-report-card-link]
[![GoDoc][godoc-svg]][godoc-link]
`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](./docs/10_overview.md).
## 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:
```sh
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:
```sh
make docker-build
```
## Testing `mlp`
To run the tests use the command:
```sh
make test
```
Or add the `DEBUG_TEST` flag to run the test with debug mode enabled:
```sh
make test DEBUG_TEST=1
```
Before sending a PR be sure that all the linter pass with success:
```sh
make lint
```
[github-actions]: https://github.com/mia-platform/mlp/actions
[github-actions-svg]: https://github.com/mia-platform/mlp/workflows/Continuous%20Integration%20Pipeline/badge.svg
[godoc-svg]: https://godoc.org/github.com/mia-platform/mlp?status.svg
[godoc-link]: https://godoc.org/github.com/mia-platform/mlp
[go-report-card]: https://goreportcard.com/badge/github.com/mia-platform/mlp
[go-report-card-link]: https://goreportcard.com/report/github.com/mia-platform/mlp