Skip to content

Commit 314d736

Browse files
marcofilippibot-targadavidebianchi
authored
RN from main to prod (#1982)
* chore(docs): update miactl documentation (#1975) * chore(docs): update miactl documentation * chore(docs): update miactl documentation * fix: cspell --------- Co-authored-by: Davide Bianchi <[email protected]> * update chart version * added import kubernetes via miactl feature (#1981) --------- Co-authored-by: Bot-targa <[email protected]> Co-authored-by: Davide Bianchi <[email protected]>
1 parent c6802b6 commit 314d736

File tree

6 files changed

+67
-17
lines changed

6 files changed

+67
-17
lines changed

.cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@
107107
"OWASP",
108108
"paas",
109109
"pbcopy",
110+
"pflag",
110111
"pino",
111112
"pkcs",
112113
"pointofsale",

docs/cli/miactl/20_setup.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ If you have [Golang] installed with a version >= 1.13 in your system and you hav
3838
install `miactl` like this:
3939

4040
```sh
41-
go install github.com/mia-platform/miactl/cmd/miactl@v0.16.0
41+
go install github.com/mia-platform/miactl/cmd/miactl@v0.17.0
4242
```
4343

4444
Or like this if the `install` command is not available
4545

4646
```sh
47-
go get -u github.com/mia-platform/miactl/cmd/miactl@0.16.0
47+
go get -u github.com/mia-platform/miactl/cmd/miactl@0.17.0
4848
```
4949

5050
#### Binary Download
@@ -53,11 +53,11 @@ You can install `miactl` with the use of `curl` or `wget` and downloading the la
5353
choosing the correct platform and operating system:
5454

5555
```sh
56-
curl -fsSL --proto '=https' --tlsv1.2 https://github.com/mia-platform/miactl/releases/download/v0.16.0/miactl-linux-amd64 -o /tmp/miactl
56+
curl -fsSL --proto '=https' --tlsv1.2 https://github.com/mia-platform/miactl/releases/download/v0.17.0/miactl-linux-amd64 -o /tmp/miactl
5757
```
5858

5959
```sh
60-
wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/miactl/releases/download/v0.16.0/miactl-linux-amd64 -O /tmp/miactl
60+
wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/miactl/releases/download/v0.17.0/miactl-linux-amd64 -O /tmp/miactl
6161
```
6262

6363
After you have downloaded the file you can validate it against the checksum you can find at this [url] running the
@@ -85,7 +85,7 @@ sudo mv /tmp/miactl /usr/local/bin
8585
If you want to run the cli in its environment or you want to test the cli you can use the Docker image:
8686

8787
```sh
88-
docker run ghcr.io/mia-platform/miactl:v0.16.0 miactl
88+
docker run ghcr.io/mia-platform/miactl:v0.17.0 miactl
8989
```
9090

9191
### Windows
@@ -184,7 +184,7 @@ only via APIs.
184184

185185
[Homebrew]: https://brew.sh "The Missing Package Manager for macOS (or Linux)"
186186
[Golang]: https://go.dev "Build simple, secure, scalable systems with Go"
187-
[url]: https://github.com/mia-platform/miactl/releases/download/v0.16.0/checksums.txt "miactl checksums"
187+
[url]: https://github.com/mia-platform/miactl/releases/download/v0.17.0/checksums.txt "miactl checksums"
188188
[`bash-completion`]: https://github.com/scop/bash-completion "Programmable completion functions for bash"
189189
[`oh-my-zsh`]: https://ohmyz.sh "Oh My Zsh is a delightful, open source, community-driven
190190
framework for managing your Zsh configuration"

docs/cli/miactl/30_commands.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ Available flags for the command:
5656
- `--environment`, to set the environment scope for the command
5757

5858
:::warning
59-
If you want to use `miactl` with a _Service Account_, **remember to specify** the `--auth-name` flag, otherwise _miactl_ will try to perform a _User Login_, opening the browser for authentication the user.
59+
If you want to use `miactl` with a _Service Account_, **remember to specify** the `--auth-name` flag, otherwise
60+
_miactl_ will try to perform a _User Login_, opening the browser for authentication the user.
6061
:::
6162

6263
### use
@@ -607,6 +608,32 @@ Available flags for the command:
607608
- `--entity-id`, the entity id to change
608609
- `--environment`, set the flag to the environment name for deleting the role for that environment
609610

611+
### import
612+
613+
The `project import` subcommand allows you to import kubernetes resource yaml definition in an empty Mia-Platform Console
614+
project.
615+
616+
The import function is lossy and some advanced configuration can be lost. We recommend to check the generated file
617+
before trying a deploy to check if anything is amiss.
618+
619+
Usage:
620+
621+
```sh
622+
miactl project import [flags]
623+
```
624+
625+
Available flags for the command:
626+
627+
- `--filename`, file or folder path containing the resource definitions to import
628+
- `--project-id`, to set the ID of the desired Project
629+
- `--revision`, to specify the revision of the commit to deploy
630+
- `--auth-name`, the name of the miactl auth to use
631+
- `--endpoint`, to set the Console endpoint
632+
- `--certificate-authority`, to provide the path to a custom CA certificate
633+
- `--insecure-skip-tls-verify`, to disallow the check the validity of the certificate of the remote endpoint
634+
- `--context`, to specify a different context from the currently selected one
635+
- `--company-id`, to set the ID of the desired Company
636+
610637
## deploy
611638

612639
The `deploy` command allows you to manage the deployment of your Projects.
@@ -813,7 +840,8 @@ miactl extensions activate [flags]
813840
Available flags for the command:
814841

815842
- `--company-id` to set the ID of the desired Company
816-
- `--project-id` to set the ID of the desired project, if specified, the extension will be activated only for this project only
843+
- `--project-id` to set the ID of the desired project, if specified, the extension will be activated only for this
844+
project only
817845
- `--extension-id` **required** to set the ID of the extension
818846

819847
### deactivate
@@ -834,7 +862,8 @@ miactl extensions deactivate [flags]
834862
Available flags for the command:
835863

836864
- `--company-id` to set the ID of the desired Company
837-
- `--project-id` to set the ID of the desired project, if specified, the extension will be deactivated only for this project only
865+
- `--project-id` to set the ID of the desired project, if specified, the extension will be deactivated only for this
866+
project only
838867
- `--extension-id` **required** to set the ID of the extension.
839868

840869
### delete

docs/cli/miactl/40_examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Finally, you can group the commands above and run them inside a pipeline, e.g. a
133133
# Insert that after your pipeline stages
134134
delivery:
135135
stage: deploy
136-
image: ghcr.io/mia-platform/miactl:v0.16.0
136+
image: ghcr.io/mia-platform/miactl:v0.17.0
137137

138138
script:
139139
- miactl version

docs/cli/miactl/changelog.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ All notable changes to this project will be documented in this file.
1515
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
1616
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
1717

18+
## [v0.17.0] - 2025-02-05
19+
20+
### Changed
21+
22+
- update go version to 1.23.4
23+
- update oauth2 to v0.25.0
24+
- update pflag to v1.0.6
25+
- update sync to v0.10.0
26+
- update testify to v1.10.0
27+
- update text to v0.21.0
28+
- update `deploy trigger` command to handle deployment pipeline failure
29+
30+
### Added
31+
32+
- `project import` command
33+
1834
## [v0.16.0] - 2024-11-21
1935

2036
### Added
@@ -319,7 +335,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
319335
- create cli sdk
320336
- create cli renderer
321337

322-
[unreleased]: https://github.com/mia-platform/miactl/compare/v0.16.0...HEAD
338+
[unreleased]: https://github.com/mia-platform/miactl/compare/v0.17.0...HEAD
339+
[v0.17.0]: https://github.com/mia-platform/miactl/compare/v0.16.0...v0.17.0
323340
[v0.16.0]: https://github.com/mia-platform/miactl/compare/v0.15.0...v0.16.0
324341
[v0.15.0]: https://github.com/mia-platform/miactl/compare/v0.14.0...v0.15.0
325342
[v0.14.0]: https://github.com/mia-platform/miactl/compare/v0.13.0...v0.14.0

docs/release-notes/v13.6.0.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,14 @@ Please make sure to update the items you are utilizing to this new version to en
9191

9292
## Console
9393

94+
## Kubernetes Import via miactl
95+
96+
Seamlessly onboard pre-existing Kubernetes workloads into your Console Projects using the new `miactl project import` command!
97+
98+
This feature simplifies the integration of Kubernetes resources by allowing you to import YAML definitions directly into an empty Project. While some advanced configurations may require manual adjustments, this process accelerates migration and saves time by avoiding the need to recreate resources from scratch.
99+
100+
For more details, check the [miactl commands documentation](/cli/miactl/30_commands.md).
101+
94102
### Improvements
95103

96104
#### GitHub App as new authentication type
@@ -101,15 +109,10 @@ You will only need to configure the provider by selecting the respective credent
101109

102110
For more information, visit the [documentation page](/console/company-configuration/providers/configure-provider.mdx#supported-credential-types).
103111

104-
105112
#### New Shapes and Notes features in Flow Manager Configurator
106113

107114
You can now add and customize shapes and notes on the canvas. Create, resize, name, and change the color of shapes, and add notes with customizable content and colors directly from the canvas.
108115

109-
#### Import from Kubernetes via miactl
110-
111-
You can now import a Kubernetes namespace into an existing Console project using miactl. This makes it seamless to onboard pre-existing workloads without needing to recreate them from scratch.
112-
113116
#### `mlp`
114117

115118
A new version of the Mia-Platform CLI, `mlp`, `v2.0.0` is available! It comes with the following new features:
@@ -259,4 +262,4 @@ We have released a new application, called _AI RAG Chat Template_: it is identic
259262

260263
## How to update your Console
261264

262-
For self-hosted installations, please head to the [self hosted upgrade guide](/infrastructure/self-hosted/installation-chart/100_how-to-upgrade.md) or contact your Mia-Platform referent and upgrade to _Console Helm Chart_ `v13.10.0-beta.0`.
265+
For self-hosted installations, please head to the [self hosted upgrade guide](/infrastructure/self-hosted/installation-chart/100_how-to-upgrade.md) or contact your Mia-Platform referent and upgrade to _Console Helm Chart_ `v13.10.0-beta.1`.

0 commit comments

Comments
 (0)