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.

Sign up for GitHub

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

chore(docs): update installation-chart documentation #1970

Merged
merged 3 commits into from
Feb 7, 2025
Merged

chore(docs): update installation-chart documentation #1970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3796221
chore(docs): update installation-chart documentation
bot-targa Feb 5, 2025
4412c07
chore(docs): update installation-chart documentation
bot-targa Feb 6, 2025
8fe8f2e
chore(docs): update installation-chart documentation
bot-targa Feb 7, 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
8 changes: 8 additions & 0 deletions docs/infrastructure/self-hosted/installation-chart/100_how-to-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ The Chart version follows [semver](https://semver.org/) policy so any breaking c

## Console v13 - version upgrades

### Upgrade from last Console v13.5.3 to v13.6.0

With v13.6.0 a new microservice has been added to the Console application, you can configure it using the `catalogService` value to better suite your scaling needs

:::tip
Refer to the [Service Specific configuration](./helm-values/30_service-specific-configurations.md) documentation page for further details on available values.
:::

### Upgrade from last Console v12 to v13.0.0

With v13 a new microservice has been added to the Console application, you can configure it using the `extensibilityManagerService` value to better suite your scaling needs
Expand Down
67 changes: 34 additions & 33 deletions ...elf-hosted/installation-chart/helm-values/30_service-specific-configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,39 +18,40 @@ Mia-Platform Console architecture is composed by several microservices, to bette
All of the following values are root values for the `mia-console` chart values.
:::

| Name | Type | Description | Default | Optional |
|:----:|:----:|:-----------:|:-------:|:--------:|
| `apiGateway` | [Service Conf](#service-conf) | The configurations for the API Gateway Service | | ✅ |
| `rateLimitEnvoy` | [Service Conf](#service-conf) | The configurations for the API Gateway Rate Limit Service | | ✅ |
| `apiPortal` | [Service Conf](#service-conf) | The configurations for the API Portal Service | | ✅ |
| `authenticationService` | [Service Conf](#service-conf) | The configurations for the Authentication Service | | ✅ |
| `authorizationService` | [Service Conf](#service-conf) | The configurations for the Authorization Service | | ✅ |
| `backendService` | [Service Conf](#service-conf) | The configurations for the Console Backend Service | | ✅ |
| `crudService` | [Service Conf](#service-conf) | The configurations for the CRUD Service | | ✅ |
| `deployService` | [Service Conf](#service-conf) | The configurations for the Deploy Service | | ✅ |
| `environmentsVariables` | [Service Conf](#service-conf) | The configurations for the Environment Variables Service | | ✅ |
| `extensibilityManagerService` | [Service Conf](#service-conf) | The configurations for the Extensibility Manager Service | | ✅ |
| `filesService` | [Service Conf](#service-conf) | The configurations for the Files Service | | ✅ |
| `kubernetesService` | [Service Conf](#service-conf) | The configurations for the Kubernetes Service | | ✅ |
| `loginSite` | [Service Conf](#service-conf) | The configurations for the Login website Service | | ✅ |
| `notificationProvider` | [Service Conf](#service-conf) | The configurations for the Notification Provider Service | | ✅ |
| `swaggerAggregator` | [Service Conf](#service-conf) | The configurations for the Swagger Aggregator Service | | ✅ |
| `websites` | [Service Conf](#service-conf) | The configurations for the Console website Service | | ✅ |
| `miaCraftBff` | [Service Conf](#service-conf) | The configurations for the mia-craft backend for frontend | | ✅ |
| `rbacManagerBff` | [Service Conf](#service-conf) | The configurations for the rbac-manager backend for frontend to handle users and iam | | ✅ |
| `rbacStandalone` | [Service Conf](#service-conf) | The configurations for a rbac service standalone | | ✅ |
| `tenantOverviewBff` | [Service Conf](#service-conf) | The configurations for the tenant overview service | | ✅ |
| `bindingsCleaner` | [Service Conf](#service-conf) | The configurations for the bindings cleaner cronjob | | ✅ |
| `configurationsCleaner` | [Service Conf](#service-conf) | The configurations for the configurations history cleaner cronjob | | ✅ |
| `mailService` | [Service Conf](#service-conf) | The configurations for the mail service | | ✅ |
| `featureToggleService` | [Service Conf](#service-conf) | The configurations for the feature toggle service | | ✅ |
| `licenseManager` | [Service Conf](#service-conf) | The configurations for the license manager service | | ✅ |
| `backoffice` | [Service Conf](#service-conf)| The configurations for Backoffice service | | ✅ |
| `eventsManager` | [Service Conf](#service-conf)| The configurations for the events-manager service | | ✅ |
| `licenseMetricsGenerator` | [CronJob Conf](#cronjob-conf)| The configurations for the license metrics generator CronJob | | ✅ |
| `rbac` | [Annotation Conf](#annotations-conf)| The configurations for the RBAC resources | | ✅ |
| `updateScripts.marketplaceCategories` | [Job](#job)| The configurable part of the marketplace categories hook | | ✅ |
| `updateScripts.consoleVersionUpgrader` | [Job](#job)| The configurable part of the console-version-upgrader hook | | ✅ |
| Name | Type | Description | Default | Optional |
|:--------------------------------------:|:------------------------------------:|:------------------------------------------------------------------------------------:|:-------:|:--------:|
| `apiGateway` | [Service Conf](#service-conf) | The configurations for the API Gateway Service | | ✅ |
| `rateLimitEnvoy` | [Service Conf](#service-conf) | The configurations for the API Gateway Rate Limit Service | | ✅ |
| `apiPortal` | [Service Conf](#service-conf) | The configurations for the API Portal Service | | ✅ |
| `authenticationService` | [Service Conf](#service-conf) | The configurations for the Authentication Service | | ✅ |
| `authorizationService` | [Service Conf](#service-conf) | The configurations for the Authorization Service | | ✅ |
| `backendService` | [Service Conf](#service-conf) | The configurations for the Console Backend Service | | ✅ |
| `crudService` | [Service Conf](#service-conf) | The configurations for the CRUD Service | | ✅ |
| `catalogService` | [Service Conf](#service-conf) | The configurations for the Catalog Service | | ✅ |
| `deployService` | [Service Conf](#service-conf) | The configurations for the Deploy Service | | ✅ |
| `environmentsVariables` | [Service Conf](#service-conf) | The configurations for the Environment Variables Service | | ✅ |
| `extensibilityManagerService` | [Service Conf](#service-conf) | The configurations for the Extensibility Manager Service | | ✅ |
| `filesService` | [Service Conf](#service-conf) | The configurations for the Files Service | | ✅ |
| `kubernetesService` | [Service Conf](#service-conf) | The configurations for the Kubernetes Service | | ✅ |
| `loginSite` | [Service Conf](#service-conf) | The configurations for the Login website Service | | ✅ |
| `notificationProvider` | [Service Conf](#service-conf) | The configurations for the Notification Provider Service | | ✅ |
| `swaggerAggregator` | [Service Conf](#service-conf) | The configurations for the Swagger Aggregator Service | | ✅ |
| `websites` | [Service Conf](#service-conf) | The configurations for the Console website Service | | ✅ |
| `miaCraftBff` | [Service Conf](#service-conf) | The configurations for the mia-craft backend for frontend | | ✅ |
| `rbacManagerBff` | [Service Conf](#service-conf) | The configurations for the rbac-manager backend for frontend to handle users and iam | | ✅ |
| `rbacStandalone` | [Service Conf](#service-conf) | The configurations for a rbac service standalone | | ✅ |
| `tenantOverviewBff` | [Service Conf](#service-conf) | The configurations for the tenant overview service | | ✅ |
| `bindingsCleaner` | [Service Conf](#service-conf) | The configurations for the bindings cleaner cronjob | | ✅ |
| `configurationsCleaner` | [Service Conf](#service-conf) | The configurations for the configurations history cleaner cronjob | | ✅ |
| `mailService` | [Service Conf](#service-conf) | The configurations for the mail service | | ✅ |
| `featureToggleService` | [Service Conf](#service-conf) | The configurations for the feature toggle service | | ✅ |
| `licenseManager` | [Service Conf](#service-conf) | The configurations for the license manager service | | ✅ |
| `backoffice` | [Service Conf](#service-conf) | The configurations for Backoffice service | | ✅ |
| `eventsManager` | [Service Conf](#service-conf) | The configurations for the events-manager service | | ✅ |
| `licenseMetricsGenerator` | [CronJob Conf](#cronjob-conf) | The configurations for the license metrics generator CronJob | | ✅ |
| `rbac` | [Annotation Conf](#annotations-conf) | The configurations for the RBAC resources | | ✅ |
| `updateScripts.marketplaceCategories` | [Job](#job) | The configurable part of the marketplace categories hook | | ✅ |
| `updateScripts.consoleVersionUpgrader` | [Job](#job) | The configurable part of the console-version-upgrader hook | | ✅ |

### Service Conf

Expand Down