Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RN v13.0.4 preview in public docs #1518

Merged
merged 108 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
7f4c7c0
chore(docs): update Form Service Frontend documentation
bot-targa May 24, 2024
b16dd50
chore(docs): update Form Service Frontend documentation
bot-targa May 27, 2024
65f783a
chore(docs): update Form Service Frontend documentation
bot-targa May 28, 2024
2a4a0db
chore(docs): update Form Service Frontend documentation
bot-targa May 29, 2024
503ece2
chore(docs): update Form Service Frontend documentation
bot-targa May 30, 2024
e333e16
chore(docs): update Form Service Frontend documentation
bot-targa May 31, 2024
d4e925d
chore(docs): update Form Service Frontend documentation
bot-targa Jun 3, 2024
6f2598c
chore(docs): update Form Service Frontend documentation
bot-targa Jun 4, 2024
6d31a75
chore(docs): update Form Service Frontend documentation
bot-targa Jun 5, 2024
0d5df88
chore(docs): update Form Service Frontend documentation
bot-targa Jun 6, 2024
fad97e2
chore(docs): update Form Service Frontend documentation
bot-targa Jun 7, 2024
f280cdf
chore(docs): update Form Service Frontend documentation
bot-targa Jun 10, 2024
5c0c404
chore(docs): update Form Service Frontend documentation
bot-targa Jun 11, 2024
f3707c5
chore(docs): update Form Service Frontend documentation
bot-targa Jun 12, 2024
adfd7de
chore(docs): update Form Service Frontend documentation
bot-targa Jun 13, 2024
1737ecf
chore(docs): update installation-chart documentation
bot-targa Jun 13, 2024
27fa0c1
chore(docs): update Form Service Frontend documentation
bot-targa Jun 14, 2024
2887137
chore(docs): update installation-chart documentation
bot-targa Jun 14, 2024
97dd9e8
chore(docs): update Form Service Frontend documentation
bot-targa Jun 17, 2024
d0bbdbe
chore(docs): update installation-chart documentation
bot-targa Jun 17, 2024
6128509
chore(docs): update Form Service Frontend documentation
bot-targa Jun 18, 2024
d38f6f8
chore(docs): update installation-chart documentation
bot-targa Jun 18, 2024
30763a1
chore(docs): update Form Service Frontend documentation
bot-targa Jun 19, 2024
f2ca14b
chore(docs): update installation-chart documentation
bot-targa Jun 19, 2024
be1d613
chore(docs): update Form Service Frontend documentation
bot-targa Jun 20, 2024
d4150ab
chore(docs): update installation-chart documentation
bot-targa Jun 20, 2024
c5a682d
chore(docs): update API Portal documentation
bot-targa Jun 21, 2024
a4e24d2
chore(docs): update Form Service Frontend documentation
bot-targa Jun 21, 2024
9e326c8
chore(docs): update installation-chart documentation
bot-targa Jun 21, 2024
d3fcc87
chore(docs): update API Portal documentation
bot-targa Jun 24, 2024
d43ad80
chore(docs): update Form Service Frontend documentation
bot-targa Jun 24, 2024
2a5a07a
chore(docs): update installation-chart documentation
bot-targa Jun 24, 2024
5c788eb
chore(docs): update Swagger Aggregator documentation
bot-targa Jun 24, 2024
55400ea
Merge pull request #1469 from mia-platform/doc-aggregator/installatio…
jacoposte Jun 24, 2024
a4514eb
add whitelabeling
jacoposte Jun 24, 2024
5af2206
Update v13.0.3.md
jacoposte Jun 24, 2024
94f77f3
Update docs/release-notes/v13.0.3.md
marcofilippi Jun 24, 2024
4405174
Update v13.0.3.md
marcofilippi Jun 24, 2024
08addfd
Update docs/release-notes/v13.0.3.md
malta895 Jun 24, 2024
30d4d21
Update docs/release-notes/v13.0.3.md
malta895 Jun 24, 2024
4f3682b
Apply suggestions from code review
marcofilippi Jun 24, 2024
52c588c
Update docs/release-notes/v13.0.3.md
malta895 Jun 24, 2024
f460da3
Update v13.0.3.md
jacoposte Jun 24, 2024
c8e6dcd
chore(docs): update API Portal documentation
bot-targa Jun 25, 2024
129d86c
chore(docs): update Form Service Frontend documentation
bot-targa Jun 25, 2024
fe15281
chore(docs): update Swagger Aggregator documentation
bot-targa Jun 25, 2024
2263e02
Merge pull request #1497 from mia-platform/add_whitelabeling_RN
jacoposte Jun 25, 2024
d8bba0d
chore(deps-dev): bump @swc/core from 1.6.1 to 1.6.5 in the swc group …
dependabot[bot] Jun 25, 2024
33b09ec
chore(docs): update API Portal documentation
bot-targa Jun 26, 2024
360d995
chore(docs): update Form Service Frontend documentation
bot-targa Jun 26, 2024
ba91a93
chore(docs): update Swagger Aggregator documentation
bot-targa Jun 26, 2024
2d43565
update: 13.0.2 console version
fredmaggiowski Jun 26, 2024
90fdcf9
chore(docs): update AI RAG Template documentation (#1426)
bot-targa Jun 26, 2024
ceb19b4
chore(docs): update API Portal documentation
bot-targa Jun 27, 2024
cdc8833
chore(docs): update Form Service Frontend documentation
bot-targa Jun 27, 2024
b877877
chore(docs): update Swagger Aggregator documentation
bot-targa Jun 27, 2024
498cbab
chore(docs): update API Portal documentation
bot-targa Jun 28, 2024
488a7dc
chore(docs): update Form Service Frontend documentation
bot-targa Jun 28, 2024
10ad57a
chore(docs): update Swagger Aggregator documentation
bot-targa Jun 28, 2024
395d8d5
chore(docs): update miactl documentation (#1500)
bot-targa Jun 28, 2024
f70c603
chore(docs): update API Portal documentation
bot-targa Jul 1, 2024
398fd47
chore(docs): update Back Kit documentation
bot-targa Jul 1, 2024
c7aea34
chore(docs): update CRUD Service documentation
bot-targa Jul 1, 2024
327606b
chore(docs): update Form Service Frontend documentation
bot-targa Jul 1, 2024
4e7e9cf
chore(docs): update Microfrontend Composer On Prem Toolkit documentation
bot-targa Jul 1, 2024
92b8acc
chore(docs): update Microfrontend Composer Toolkit documentation
bot-targa Jul 1, 2024
bd2543e
chore(docs): update Swagger Aggregator documentation
bot-targa Jul 1, 2024
a48f73c
Merge pull request #1503 from mia-platform/doc-aggregator/back-kit
epessina Jul 1, 2024
a135607
Merge pull request #1506 from mia-platform/doc-aggregator/microfronte…
epessina Jul 1, 2024
de0c752
Merge pull request #1505 from mia-platform/doc-aggregator/microfronte…
epessina Jul 1, 2024
c7e41a6
Merge pull request #1496 from mia-platform/doc-aggregator/swagger-agg…
epessina Jul 1, 2024
1add26c
Merge pull request #1504 from mia-platform/doc-aggregator/crud-service
epessina Jul 1, 2024
f228714
RN v13.0.4 to preview
albertotessarotto Jul 1, 2024
00ca179
Fixed links
epessina Jul 1, 2024
7b884ef
Data fabric & composability RN
epessina Jul 1, 2024
5b98fcf
Merge pull request #1492 from mia-platform/doc-aggregator/api-portal
epessina Jul 1, 2024
9b6f4f0
chore(docs): update Composer documentation
bot-targa Jul 2, 2024
5305c33
chore(docs): update Back Kit documentation
bot-targa Jul 2, 2024
07d6b48
chore(docs): update Form Service Frontend documentation
bot-targa Jul 2, 2024
57342bd
Merge pull request #1511 from mia-platform/doc-aggregator/back-kit
epessina Jul 2, 2024
8bb7fae
Merge pull request #1510 from mia-platform/doc-aggregator/composer
epessina Jul 2, 2024
b5e6e22
chore(deps-dev): bump @swc/core from 1.6.5 to 1.6.6 in the swc group …
dependabot[bot] Jul 2, 2024
1593218
chore(docs): update Form Service Frontend documentation
bot-targa Jul 3, 2024
98ded20
Update v13.0.4.md
marcofilippi Jul 3, 2024
eefe095
Update v13.0.4.md
marcofilippi Jul 3, 2024
f019f14
rn v13.0.3
jacoposte Jul 3, 2024
73bcd95
bugfic plasma
jacoposte Jul 3, 2024
b883849
Update v13.0.4.md
marcofilippi Jul 3, 2024
f79533b
Update v13.0.4.md
jacoposte Jul 3, 2024
b919c1f
Update v13.0.4.md
marcofilippi Jul 3, 2024
3542f3e
Update v13.0.4.md
marcofilippi Jul 3, 2024
dd11368
Update v13.0.4.md
marcofilippi Jul 3, 2024
237b661
Added Mia Care marketplace updates
Jul 3, 2024
2e92a50
Merge pull request #1411 from mia-platform/doc-aggregator/form-servic…
albertotessarotto Jul 3, 2024
7a371bd
Update v13.0.4.md
marcofilippi Jul 3, 2024
07cbefd
chore(docs): update installation-chart documentation (#1512)
bot-targa Jul 3, 2024
6988104
added RN v12.3.5 and edited v13.0.1
marcofilippi Jul 4, 2024
92415a9
Update v13.0.3.md
marcofilippi Jul 4, 2024
c51d3c1
Update v13.0.4.md
marcofilippi Jul 4, 2024
3d89767
Update v13.0.4.md
marcofilippi Jul 4, 2024
0b0d025
Update v13.0.4.md
marcofilippi Jul 4, 2024
32306ac
next stable date
albertotessarotto Jul 4, 2024
dc8582f
Update docs/release-notes/stable versions.md
albertotessarotto Jul 4, 2024
d9ebd75
Update docs/release-notes/v13.0.4.md
albertotessarotto Jul 4, 2024
dee37a2
added chart on v13.0.4.md
marcofilippi Jul 4, 2024
9a14b3b
Update v13.0.4.md
marcofilippi Jul 4, 2024
3052828
Update chart v13.0.4.md
marcofilippi Jul 4, 2024
7198f80
Merge pull request #1507 from mia-platform/edit/RN-13.0.4
albertotessarotto Jul 4, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/cli/miactl/20_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ If you have [Golang] installed with a version >= 1.13 in your system and you hav
install `miactl` like this:

```sh
go install github.com/mia-platform/miactl/cmd/miactl@v0.12.2
go install github.com/mia-platform/miactl/cmd/miactl@v0.13.0
```

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

```sh
go get -u github.com/mia-platform/miactl/cmd/miactl@0.12.2
go get -u github.com/mia-platform/miactl/cmd/miactl@0.13.0
```

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

```sh
curl -fsSL https://github.com/mia-platform/miactl/releases/download/v0.12.2/miactl-linux-amd64 -o /tmp/miactl
curl -fsSL https://github.com/mia-platform/miactl/releases/download/v0.13.0/miactl-linux-amd64 -o /tmp/miactl
```

```sh
wget -q https://github.com/mia-platform/miactl/releases/download/v0.12.2/miactl-linux-amd64 -O /tmp/miactl
wget -q https://github.com/mia-platform/miactl/releases/download/v0.13.0/miactl-linux-amd64 -O /tmp/miactl
```

After you have downloaded the file you can validate it against the checksum you can find at this [url] running the
Expand Down Expand Up @@ -85,7 +85,7 @@ sudo mv /tmp/miactl /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/miactl:v0.12.2 miactl
docker run ghcr.io/mia-platform/miactl:v0.13.0 miactl
```

### Windows
Expand Down Expand Up @@ -184,7 +184,7 @@ only via APIs.

[Homebrew]: https://brew.sh "The Missing Package Manager for macOS (or Linux)"
[Golang]: https://go.dev "Build simple, secure, scalable systems with Go"
[url]: https://github.com/mia-platform/miactl/releases/download/v0.12.2/checksums.txt "miactl checksums"
[url]: https://github.com/mia-platform/miactl/releases/download/v0.13.0/checksums.txt "miactl 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"
Expand Down
182 changes: 181 additions & 1 deletion docs/cli/miactl/30_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,19 @@ miactl context set CONTEXT [flags]

Available flags for the command:

- `--auth-name`, to set the name of the authentication to use (discover more on the [dedicated documentation section](#auth))
- `--endpoint`, to set the Console endpoint
- `--certificate-authority`, to provide the path to a custom CA certificate
- `--insecure-skip-tls-verify`, to disallow the check the validity of the certificate of the remote endpoint
- `--company-id`, to set the ID of the desired Company
- `--project-id`, to set the ID of the desired Project
- `--environment`, to set the environment scope for the command


:::warning
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.
:::

### use

The `context use` subcommand allows you to select an existing context as the current one.
Expand Down Expand Up @@ -566,6 +572,180 @@ Available flags for the command:
- `--no-semver`, to force the deploy without `semver`
- `--revision`, to specify the revision of the commit to deploy

## extensions

The `extensions` command allows you to manage Company extensions.

Available subcommands are the following ones:

```sh
list List registered extensions
apply Create or update an extension
activate Activate an extension
deactivate Deactivate an extension
delete Delete extension
```

### list

The `extensions list` command helps you gathering available extension in your Company

Usage:

```sh
miactl extensions list [flags]
```

Available flags for the command:

- `--company-id` to set the ID of the desired Company

### apply

The `extensions apply` command can be used to register new extensions or update an existing one.

It accepts an Extension Manifest either in `yaml` or `json` format

<details>
<summary>Example JSON Manifest</summary>

```json
{
"name": "Extension 1",
"description": "My extension 1",
"entry": "https://example.com/",
"contexts": [
"project"
],
"routes": [
{
"id": "extension-1",
"parentId": "workloads",
"locationId": "runtime",
"renderType": "menu",
"labelIntl": {
"en": "SomeLabel",
"it": "SomeLabelInItalian"
},
"destinationPath": "/",
"order": 200.0,
"icon": {
"name": "PiHardDrives"
}
}
]
}
```

</details>

<details>
<summary>Example YAML Manifest</summary>

```yaml
name: "Extension 1"
description: "My extension 1"
entry: "https://example.com/"
contexts:
- project
routes:
- id: "extension-1"
parentId: "workloads"
locationId: "runtime"
labelIntl:
en: "SomeLabel"
it: "SomeLabelInItalian"
destinationPath: "/"
renderType: "menu"
order: 200
icon:
name: "PiHardDrives"
```

</details>

Usage:

```sh
miactl extensions apply [flags]
```

Available flags for the command:

- `--company-id` to set the ID of the desired Company
- `--file-path` (`-f`) **required** to specify the path to the extension manifest
- `--extension-id` to set the ID of the extension Company, required for updating an existing extension.

:::tip
In order to specify whether a create or an update is needed you have to use the `--extension-id`
flag or specify the `extensionId` property in the manifest file.

You can get the **extension id** by using the [extensions list](#list-5) command or
in the apply response after creating the extension.
:::

### activate

The `extensions activate` command can be used to activate an existing extension.

:::tip
Please note that, based on provided `contexts`, an extension can be activated for the whole Company or for specific Projects.

By using the `routes.locationId` option, you can specify where the extension is available, therefore
you can create an extension shown on the Project runtime and activate it for the whole Company context.
Such extension will be visible by all the Projects.

For further information checkout the [official documentation](../../console/console-extensibility/extension-activation).
:::

Usage:

```sh
miactl extensions activate [flags]
```

Available flags for the command:

- `--company-id` to set the ID of the desired Company
- `--project-id` to set the ID of the desired project, if specified, the extension will be activated only for this project only
- `--extension-id` **required** to set the ID of the extension

### deactivate

The `extensions deactivate` command can be used to deactivate an existing extension.

:::tip
Please note that if an extension has been activated on the whole Company it can't be deactivated on a specific Project;
you have to deactivate on the whole Company and activate it on the desired Projects.
:::

Usage:

```sh
miactl extensions deactivate [flags]
```

Available flags for the command:

- `--company-id` to set the ID of the desired Company
- `--project-id` to set the ID of the desired project, if specified, the extension will be deactivated only for this project only
- `--extension-id` **required** to set the ID of the extension.

### delete

The `extensions delete` command can be used to delete an existing extension.

Usage:

```sh
miactl extensions delete [flags]
```

Available flags for the command:

- `--company-id` to set the ID of the desired Company
- `--extension-id` **required** to set the ID of the extension, required for updating an existing extension.

## runtime

### environment list
Expand Down Expand Up @@ -701,7 +881,7 @@ View and manage Marketplace items

All the subcommands inherit the following flags:

```
```sh
--auth-name string the name of the miactl auth to use
--certificate-authority string path to a cert file for the certificate authority for the selected endpoint
--company-id string the ID of the Company
Expand Down
63 changes: 63 additions & 0 deletions docs/cli/miactl/40_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,66 @@ You can customize the way your Project is deployed:
```sh
miactl deploy development --no-semver --revision tags/v1.0.0
```

## Deploy Project using a service account from a CD pipeline

The commands are the same used above in the [Deploy Project](#deploy-project) section, but you need to use a _Service Account_ for that.
If you don't know how to create a _Service Account_, read the [dedicated documentation](../../development_suite/identity-and-access-management/manage-service-accounts).

The _Service Account_ can be created with [two different authentication methods](../../development_suite/identity-and-access-management/manage-service-accounts#adding-a-service-account):
* _Client Secret Basic_: the service account authenticates by presenting its `client_id` and `client_secret`;
* _Private Key JWT_: the service account authenticates by signing a `JWT` (JSON Web Token) using its private key.


After creating the _Service Account_, the first step to setup the `miactl` is **create an auth context**.
With an _auth context_ you can choose how to be authenticated with the Mia-Platform APIs in all your different contexts you create with the `miactl`.

Based on the authentication method of your _Service Account_, you can create the auth context with the following command:

* _Client Secret Basic_:
```sh
miactl context auth <miactl-auth-name> --client-id <sa-client-id> --client-secret <sa-client-secret>
```

* _Private Key JWT_:
```sh
miactl context auth <miactl-auth-name> --jwt-json <path-to-json-containing-the-json-config-of-a-jwt-service-account>
```

Now you can create the context you want use the `miactl` to.

:::warning
Remember to specify the auth context to be used with the `---auth-name` flag, otherwise the `miactl` will try to perform a user authentication through the default browser.
:::

```sh
miactl context set <my-context-name> --endpoint https://console.private --company-id <my-company-id> --project-id <my-project-id> --auth-name <miactl-auth-name>
```

After that, just set the context as the used one:

```sh
miactl context use <my-context-name>
```

and deploy the pipeline:

```sh
miactl deploy development --no-semver --revision main
```

Finally, you can group the commands above and run them inside a pipeline, e.g. a GitLab pipeline:

```yaml
# Insert that after your pipeline stages
delivery:
stage: deploy
image: ghcr.io/mia-platform/miactl:v0.13.0

script:
- miactl version
- miactl context auth deployer-sa --client-id sa-client-id --client-secret sa-super-secret
- miactl context set my-private-console --endpoint https://console.private --company-id id-of-my-company --project-id id-of-my-project --auth-name deployer-sa
- miactl use my-private-console
- miactl deploy DEV --no-semver --deploy-type smart_deploy --revision main
```
23 changes: 22 additions & 1 deletion docs/cli/miactl/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,26 @@ 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).

## [0.13.0] - 2024-06-26

### Added

- `extensions list` command
- `extensions apply` command
- `extensions delete` command
- `extensions activate` command
- `extensions deactivate` command
- `context use` autocomplete contexts with tab

### Changed

- update go version to 1.22.3
- update logr to v1.4.2
- update oauth2 to v0.20.0
- update sync to v0.7.0
- update text to v0.15.0
- introduced Printer interface with Table implementation

## [0.12.2] - 2024-03-07

## Changed
Expand Down Expand Up @@ -253,7 +273,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- create cli sdk
- create cli renderer

[unreleased]: https://github.com/mia-platform/miactl/compare/v0.12.2...HEAD
[unreleased]: https://github.com/mia-platform/miactl/compare/v0.13.0...HEAD
[0.13.0]: https://github.com/mia-platform/miactl/compare/v0.12.2...v0.13.0
[0.12.2]: https://github.com/mia-platform/miactl/compare/v0.12.1...v0.12.2
[0.12.1]: https://github.com/mia-platform/miactl/compare/v0.12.0...v0.12.1
[0.12.0]: https://github.com/mia-platform/miactl/compare/v0.11.0...v0.12.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
"urandom",
"CTYPE",
"uuidgen",
"micro-lc"
"micro-lc",
"microlc"
],
"flagWords": [],
"ignorePaths": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,11 @@ configurations:
keyRing: "<KMS_GCP_KEY_RING>"
keyName: "<KMS_GCP_KEY_NAME>"
privateKey: "<CRUD_ENCRYPTION_KEY>"
assistant:
enabled: true
keys:
llm: "<YOUR_OPENAI_API_KEY>"
embeddings: "<YOUR_OPENAI_API_KEY>"

apiGateway:
deploy:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,7 @@ mia-console:
| `configurations.enableFastData` | boolean | Enables Fast Data configurator | `true` | ✅ |
| `configurations.enableDebugArea` | boolean | Enables debug area in Console | `true` | ✅ |
| `configurations.enableMergeConfiguration` | boolean | Enables Merge Configuration | `true` | ✅ |
| `configurations.enableClustersAndEnvironmentsManagement` | boolean | Enables Clusters and Environments management | `true` | ✅ |
| `configurations.projectTemplateArchiveUrl` | string | New project template url | | ✅ |
| `configurations.enableRuntimeServiceClusterSelection` | boolean | Enable selection from supported runtime providers during cluster setup, if you disable it you will have to manually fill all the required information | `true` | ✅ |
| `configurations.enableBackofficeConfigurator` | boolean | Enable Backoffice Configurator | `true` | ✅ |
| `configurations.enableFlowManager` | boolean | Enable Flow Manager | `true` | ✅ |

Expand Down
Loading