Skip to content

Add project infrastructure tutorial #2150

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

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
33dce33
Add project infrastructure tutorial
akelity May 23, 2025
58a8da4
Update docs/console/tutorials/project-infrastructure/project-configur…
akelity Jun 5, 2025
7fb9346
Update project-configuration.md
akelity Jun 5, 2025
0e03add
Update project-configuration.md
akelity Jun 5, 2025
e9bc4d7
edit examples
akelity Jun 5, 2025
31b2586
update
jacoposte May 26, 2025
28dcaf9
Update self-hosted-requirements.md
jacoposte May 26, 2025
1fd333a
update versions in self hosted req (#2156)
TheRusCompass May 27, 2025
c1bf4af
chore(docs): update User Manager Service documentation (#2158)
bot-targa May 29, 2025
d9fbaa0
chore(docs): update Device Manager documentation (#2151)
bot-targa May 29, 2025
ab923b2
chore(docs): update FHIR Adapter documentation (#2138)
bot-targa May 29, 2025
134605a
chore(docs): update MCP Server documentation (#2161)
bot-targa Jun 3, 2025
5dca5a9
chore(docs): update miactl documentation (#2162)
bot-targa Jun 3, 2025
9b3ee18
chore(docs): update mlp documentation (#2054)
bot-targa Jun 3, 2025
e6db393
chore(docs): update MCP Server documentation (#2163)
bot-targa Jun 4, 2025
49e8fc2
added: new 13.7.4 release (#2165)
Danielecina Jun 4, 2025
78a29a1
added: new 13.7.4 release sidebar item
Jun 4, 2025
c53a6a8
docs: enhance environment configuration management documentation with…
Danielecina Jun 5, 2025
1530185
chore(docs): update Flow Manager Service documentation (#2164)
bot-targa Jun 5, 2025
4a2b4e3
added redirect for audit trails (#2166)
marcofilippi Jun 5, 2025
4886637
update requirements table (#2159)
jacoposte Jun 5, 2025
4778891
fixed extension SSO /authorize path (#2171)
danielemarostica Jun 5, 2025
333823e
add details sections
akelity Jun 5, 2025
52cb506
chore(docs): update Flow Manager Service documentation (#2172)
bot-targa Jun 6, 2025
1faf4fa
update with collapse
akelity Jun 6, 2025
6dfb724
remove repo link
akelity Jun 6, 2025
7b54aff
remove duplicates
akelity Jun 6, 2025
aa01324
update links
akelity Jun 6, 2025
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
7 changes: 4 additions & 3 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
"language": "en",
// words - list of words to be always considered correct
"words": [
"agentic",
"Agentic",
"reinit",
"ABAC",
"Additionals",
"Adyen",
"affordance",
"affordances",
"agentic",
"Agentic",
"Agricolo",
"AKHQ",
"ANIA",
Expand Down Expand Up @@ -128,6 +127,7 @@
"kustomize",
"Linkerd",
"locustfile",
"LOINC",
"Lucene",
"luxon",
"makeitapp",
Expand Down Expand Up @@ -201,6 +201,7 @@
"servlet",
"sharded",
"signup",
"SNOMED",
"stato",
"storer",
"struct",
Expand Down
16 changes: 16 additions & 0 deletions 301redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -2006,5 +2006,21 @@
"/docs/tools/overview_service_tools": {
"destination": "/docs/runtime_suite_tools/mlp/overview",
"addedOn": "2025-05-21"
},
"/docs/runtime_suite/audit-trail/security": {
"destination": "/docs/runtime_suite_sidecars/audit-trail/security",
"addedOn": "2025-06-05"
},
"/docs/runtime_suite/audit-trail/overview": {
"destination": "/docs/runtime_suite_sidecars/audit-trail/overview",
"addedOn": "2025-06-05"
},
"/docs/runtime_suite/audit-trail/configuration": {
"destination": "/docs/runtime_suite_sidecars/audit-trail/configuration",
"addedOn": "2025-06-05"
},
"/docs/runtime_suite/audit-trail/changelog": {
"destination": "/docs/runtime_suite_sidecars/audit-trail/changelog",
"addedOn": "2025-06-05"
}
}
1 change: 1 addition & 0 deletions check-content.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const filesToExcludeFromSidebarCheck = [
"monitoring/paas_alerting_rules",
"info/licenses-reports/.gitkeep",
'cli/miactl/*',
'mcp/mcp-server/*',
"info/licenses/*",
"runtime_suite/*",
"runtime_suite_applications/*",
Expand Down
10 changes: 5 additions & 5 deletions docs/cli/miactl/20_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ 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.17.3
go install github.com/mia-platform/miactl/cmd/miactl@v0.18.0
```

Or like this if the `install` command is not available
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 --proto '=https' --tlsv1.2 https://github.com/mia-platform/miactl/releases/download/v0.17.3/miactl-linux-amd64 -o /tmp/miactl
curl -fsSL --proto '=https' --tlsv1.2 https://github.com/mia-platform/miactl/releases/download/v0.18.0/miactl-linux-amd64 -o /tmp/miactl
```

```sh
wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/miactl/releases/download/v0.17.3/miactl-linux-amd64 -O /tmp/miactl
wget -q --https-only --secure-protocol=TLSv1_2 https://github.com/mia-platform/miactl/releases/download/v0.18.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.17.3 miactl
docker run ghcr.io/mia-platform/miactl:v0.18.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.17.3/checksums.txt "miactl checksums"
[url]: https://github.com/mia-platform/miactl/releases/download/v0.18.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
15 changes: 10 additions & 5 deletions docs/cli/miactl/40_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,33 +82,38 @@ 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.
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`.
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.
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
Expand All @@ -133,7 +138,7 @@ Finally, you can group the commands above and run them inside a pipeline, e.g. a
# Insert that after your pipeline stages
delivery:
stage: deploy
image: ghcr.io/mia-platform/miactl:v0.17.3
image: ghcr.io/mia-platform/miactl:v0.18.0

script:
- miactl version
Expand Down
18 changes: 17 additions & 1 deletion docs/cli/miactl/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ 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).

## [v0.18.0] - 2025-06-03

### Changed

- deprecated `marketplace` when console version is greater than or equal 14.0.0
- update go version to 1.24.3
- update mergo to 1.0.2
- update oauth2 to 0.30.0
- update sync to 0.14.0
- update text to 0.25.0

### Added

- new command: `catalog`

## [v0.17.3] - 2025-03-20

### Changed
Expand Down Expand Up @@ -363,7 +378,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.17.3...HEAD
[unreleased]: https://github.com/mia-platform/miactl/compare/v0.18.0...HEAD
[v0.18.0]: https://github.com/mia-platform/miactl/compare/v0.17.3...v0.18.0
[v0.17.3]: https://github.com/mia-platform/miactl/compare/v0.17.2...v0.17.3
[v0.17.2]: https://github.com/mia-platform/miactl/compare/v0.17.1...v0.17.2
[v0.17.1]: https://github.com/mia-platform/miactl/compare/v0.17.0...v0.17.1
Expand Down
6 changes: 4 additions & 2 deletions docs/console/console-extensibility/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ It doesn't matter which of these techniques you will choose. What matters is tha

The Console endpoint that handles extension authorization is the following one, preceded by the Console base URL:

`/tenants/{tenantId}/extension/{extensionId}/authz?state={state}`
`/oauth/authorize?tenantId={tenantId}&extensionId={extensionId}&state={state}`

Here an example of a frontend page that starts the login flow when the user clicks on a Login button:

Expand All @@ -95,7 +95,9 @@ function performExtensionLogin() {
// Remember to store the state and validate it throughout the login flow
const state = crypto.randomUUID()

window.location.replace(`https://<CONSOLE_URL>/tenants/${tenantId}/extension/${extensionId}/authz?state=${state}`)
window.location.replace(
`https://<CONSOLE_URL>/oauth/authorize?tenantId=${tenantId}&extensionId=${extensionId}&state=${state}`
)
}
```

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading