From 2c083e31f229f4714703218650350a2d6b0ea8da Mon Sep 17 00:00:00 2001 From: Jacopo Andrea Giola Date: Tue, 3 Feb 2026 11:59:33 +0100 Subject: [PATCH] docs: update mlp docs --- .../tools/mlp/10_overview.md | 8 ++-- docs/runtime-components/tools/mlp/20_setup.md | 12 ++--- .../runtime-components/tools/mlp/changelog.md | 46 ++++++++++++++++--- 3 files changed, 49 insertions(+), 17 deletions(-) diff --git a/docs/runtime-components/tools/mlp/10_overview.md b/docs/runtime-components/tools/mlp/10_overview.md index dce1ee7488..27e6e60b01 100644 --- a/docs/runtime-components/tools/mlp/10_overview.md +++ b/docs/runtime-components/tools/mlp/10_overview.md @@ -23,14 +23,14 @@ the ability to use different configuration for different runtime environments. ## Functionalities - `deploy`: the main command, is used for creating, updating and pruning resources in a kubernetes - environment using the resource files created by the Mia-Platform Console + environment using the resource files created by the Mia-Platform Console - `generate`: create kubernetes `ConfigMap` and `Secret` based on a configuration file - `hydrate`: is an helper function for configuring correctly the kustomization files inside the target folder - with all the files and patches found + with all the files and patches found - `interpolate`: will run through all the files passed and run through a templating function for render the final - manifests + manifests - `kustomize`: is the same command of `kustomize build` and can be used if you project is using the kustomize structure - to render the resources to pass to the `interpolate` command + to render the resources to pass to the `interpolate` command For more information about the various options available to the various commands you can always run `mlp --help` to see the helpers. diff --git a/docs/runtime-components/tools/mlp/20_setup.md b/docs/runtime-components/tools/mlp/20_setup.md index 06f8a62279..21379c422f 100644 --- a/docs/runtime-components/tools/mlp/20_setup.md +++ b/docs/runtime-components/tools/mlp/20_setup.md @@ -35,13 +35,13 @@ If you have [Golang] installed with a version >= 1.13 in your system and you hav install `mlp` like this: ```sh -go install github.com/mia-platform/mlp@v2.4.1 +go install github.com/mia-platform/mlp@v2.6.0 ``` Or like this if the `install` command is not available ```sh -go get -u github.com/mia-platform/mlp@v2.4.1 +go get -u github.com/mia-platform/mlp@v2.6.0 ``` #### Binary Download @@ -50,11 +50,11 @@ You can install `mlp` with the use of `curl` or `wget` and downloading the lates choosing the correct platform and operating system: ```sh -curl -fsSL --proto '=https' --tlsv1.2 https://github.com/mia-platform/mlp/releases/download/v2.4.1/mlp-linux-amd64 -o /tmp/mlp +curl -fsSL --proto '=https' --tlsv1.2 https://github.com/mia-platform/mlp/releases/download/v2.6.0/mlp-linux-amd64 -o /tmp/mlp ``` ```sh -wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/mlp/releases/download/v2.4.1/mlp-linux-amd64 -O /tmp/mlp +wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/mlp/releases/download/v2.6.0/mlp-linux-amd64 -O /tmp/mlp ``` After you have downloaded the file you can validate it against the [checksum] running the command: @@ -74,7 +74,7 @@ sudo install -g root -o root /tmp/mlp /usr/local/bin If you want to run the cli in its environment or you want to test the cli you can use the Docker image: ```sh -docker run ghcr.io/mia-platform/mlp:v2.4.1 +docker run ghcr.io/mia-platform/mlp:v2.6.0 ``` ### Windows @@ -152,7 +152,7 @@ enable the autocompletion. [Homebrew]: https://brew.sh "The Missing Package Manager for macOS (or Linux)" [Golang]: https://go.dev "Build simple, secure, scalable systems with Go" -[checksum]: https://github.com/mia-platform/mlp/releases/download/v2.4.1/checksums.txt "mlp checksums" +[checksum]: https://github.com/mia-platform/mlp/releases/download/v2.6.0/checksums.txt "mlp checksums" [`bash-completion`]: https://github.com/scop/bash-completion "Programmable completion functions for bash" [`oh-my-zsh`]: https://ohmyz.sh "Oh My Zsh is a delightful, open source, community-driven framework for managing your Zsh configuration" diff --git a/docs/runtime-components/tools/mlp/changelog.md b/docs/runtime-components/tools/mlp/changelog.md index 9bc33472d0..6dac4b1504 100644 --- a/docs/runtime-components/tools/mlp/changelog.md +++ b/docs/runtime-components/tools/mlp/changelog.md @@ -9,6 +9,35 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [v2.6.0] - 2026-01-30 + +### ย Changed + +- update to go 1.25.6 +- update jlp to v0.10.0 +- update kubernetes libraries to 0.34.3 +- update cobra to v1.10.2 +- update kustomize/api to v0.21.0 +- update kyaml to v0.21.0 +- update yaml to v1.6.0 + +## [v2.5.0] - 2025-11-04 + +### Changed + +- update to go 1.25.3 + +### Added + +- `allow-missing-filenames` flag to `interpolate` command for ignoring errors when paths + are not found + +## [v2.4.2] - 2025-09-29 + +### Fixed + +- interpolate command now actually interpolate files inside a folder path + ## [v2.4.1] - 2025-09-26 ### Fixed @@ -90,7 +119,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - hydrate command now add metadata to kustomize file to avoid "empty kubernetes file" - errors during deploy + errors during deploy ## [v2.0.0-rc.1] - 2025-01-23 @@ -108,7 +137,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - hanging if no resources has been applied successfully in a step - error if a group/kind of a resource saved in the old inventory format is not availbale anymore in the cluster - now we skip the resource because we cannot retrieve it + now we skip the resource because we cannot retrieve it ## [v2.0.0-beta.2] - 2024-10-04 @@ -119,7 +148,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - hydrate command now add metadata to kustomize file to avoid "empty kubernetes file" - errors during deploy + errors during deploy ## [v2.0.0-beta.1] - 2024-09-19 @@ -166,7 +195,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - default order for `SecretProviderClass` resource kind - new annotation `mia-platform.eu/apply-before-kinds` to override default resources application order - support for jobs annotation `mia-platform.eu/await-completion` for waiting job completion after it has been applied - on the cluster + on the cluster - support for resource `ExternalSecrets` for the annotation `mia-platform.eu/await-completion` - add some debugging logs - add support to kubernetes version 1.23 @@ -174,7 +203,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - fixed a bug in `createPatch` that caused all annotations to be deleted in the resulting patch if the target resource - was annotated with `kubectl.kubernetes.io/last-applied-configuration` + was annotated with `kubectl.kubernetes.io/last-applied-configuration` - fixed a bug that will panic if multiple patch files would be filtered out when hydrating kustomize files ## [v1.1.0] - 2022-03-17 @@ -231,8 +260,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - fix annotation length by using an unique name, - `mia-platform.eu/dependenciesChecksum`, for all dependencies and its value is a object of key-values of all - the dependencies. + `mia-platform.eu/dependenciesChecksum`, for all dependencies and its value is a object of key-values of all + the dependencies. ## v0.4.0 - 2021-03-17 @@ -282,6 +311,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Initial Release ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰ +[v2.6.0]: https://github.com/mia-platform/mlp/compare/v2.5.0...v2.6.0 +[v2.5.0]: https://github.com/mia-platform/mlp/compare/v2.4.2...v2.5.0 +[v2.4.2]: https://github.com/mia-platform/mlp/compare/v2.4.1...v2.4.2 [v2.4.1]: https://github.com/mia-platform/mlp/compare/v2.4.0...HEAD [v2.4.0]: https://github.com/mia-platform/mlp/compare/v2.3.0...v2.4.0 [v2.3.0]: https://github.com/mia-platform/mlp/compare/v2.2.0...v2.3.0