Updates to PMP install - #11060
Conversation
Clarified the components involved in installation and upgrade tasks, and updated the installation instructions for the Mendix Operator.
| * **Marketplace** - Recommended. Enables you to use the Private Platform's Marketplace capabilities to upload, import and manage Marketplace contents. The Marketplace enabled here is hosted entirely within your Private Mendix Platform. | ||
| * **Marketplace Approvals** - Optional. If enabled, contents that users publish to the private Marketplace require administrator approval before publishing. | ||
| * **Marketplace Import** - Optional. Enables content import with an external source. | ||
| * **IDP** - Optional. Enable users to login using SSO by configuring your IdP integration. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''IdP'' (capitalized)
| * **Marketplace Approvals** - Optional. If enabled, contents that users publish to the private Marketplace require administrator approval before publishing. | ||
| * **Marketplace Import** - Optional. Enables content import with an external source. | ||
| * **IDP** - Optional. Enable users to login using SSO by configuring your IdP integration. | ||
| * **Webhook** - Optional. Webhooks allow to send information between platform and external systems, and can be triggered by events around Apps, Users, Groups, Marketplace and CI/CD. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.ProductNames] Use 'Projects' instead of 'Apps'
| * `authenticator-db-user` - The Authenticator database username, for example, `auth_user` | ||
| * `authenticator-db-pass` - The Authenticator database password, for example, `StrongPassword123` | ||
| * `collector-db-name` - The Collector database name, for example, `collector` | ||
| * `collector-db-host` - The Collector database host, for example, `postgres.example.com |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Postgres'' (capitalized)
|
|
||
| # Component Configurations | ||
|
|
||
| ## mx-privatecloud-license-manager (PCLM) |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.HeadingTitleCase] Use title case capitalization for 'mx-privatecloud-license-manager (PCLM)'.
| | Field | Type | Required | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | **db.type** | string | Yes | "postgres" or "sqlserver" | | ||
| | **db.strict_tls** | boolean | No | Enable strict TLS for database | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Boolean'' (capitalized)
| diff 3.11.0 ← This is REQUIRED | ||
| ``` | ||
|
|
||
| ### Installing the Helm-diff Plugin |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.HeadingTitleCase] Use title case capitalization for 'Installing the Helm-diff Plugin'.
| password: "operatorpass" # Must match pclm bootstrap operator_password | ||
| ``` | ||
|
|
||
| #### Helmfile Values for Mx-privatecloud-license-manager |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.HeadingTitleCase] Use title case capitalization for 'Helmfile Values for Mx-privatecloud-license-manager'.
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1302 col 1| [Mendix.Capitalization] Use ''Boolean'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1308 col 1| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1328 col 3| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1328 col 14| [Mendix.Capitalization] Use ''PostgreSQL'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1348 col 3| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1348 col 14| [Mendix.Capitalization] Use ''PostgreSQL'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1354 col 3| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1354 col 14| [Mendix.Capitalization] Use ''PostgreSQL'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1372 col 5| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1372 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'postgres ignored when using Secret Provider'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1385 col 1| [Mendix.Capitalization] Use ''PostgreSQL'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1403 col 1| [Mendix.Capitalization] Use ''Boolean'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1419 col 1| [Mendix.Capitalization] Use ''Boolean'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1488 col 60| [Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1621 col 1| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1645 col 6| [Mendix.Capitalization] Use ''PostgreSQL'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1645 col 19| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1727 col 1| [Mendix.Capitalization] Use ''Boolean'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1765 col 1| [Mendix.Capitalization] Use ''Boolean'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1781 col 39| [Mendix.Capitalization] Use ''Mendix'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1782 col 12| [Mendix.Capitalization] Use ''Mendix'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1814 col 3| [Mendix.HeadingTitleCase] Use title case capitalization for 'Attach ECR policy to node role'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1827 col 3| [Mendix.HeadingTitleCase] Use title case capitalization for 'Create secret in each namespace'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1881 col 3| [Mendix.HeadingTitleCase] Use title case capitalization for 'Install provider plugin'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1908 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Step 1: Configure identity authentication (REQUIRED)'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1955 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Global Secret Provider configuration'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1961 col 3| [Mendix.HeadingTitleCase] Use title case capitalization for 'Each component uses a different Managed Identity (different clientID)'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1963 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Identity for mx-privatecloud'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1970 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Identity for svix-server'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|1977 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Identity for mxplatform'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2051 col 64| [Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2088 col 4| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2093 col 3| [Mendix.HeadingTitleCase] Use title case capitalization for '3. Create database user with Managed Identity'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2094 col 21| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2094 col 80| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2105 col 47| [Mendix.Capitalization] Use ''Mendix'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2120 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Database configuration without password'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2122 col 12| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2123 col 5| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2124 col 23| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2144 col 3| [Mendix.HeadingTitleCase] Use title case capitalization for '2. Create database users (same steps as above, but for authenticator and collector databases)'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2145 col 21| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2145 col 80| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2170 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Database configuration without passwords'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2173 col 23| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2180 col 23| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2241 col 54| [Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2282 col 3| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2289 col 25| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2291 col 20| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2292 col 16| [Mendix.Capitalization] Use ''Mendix'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2323 col 27| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2425 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Installation secrets still in values file'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2433 col 27| [Mendix.Capitalization] Use ''Postgres'' (capitalized)
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2453 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'No StoragePlan workload identity'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2455 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'All credentials from Key Vault (empty values = injected from vault)'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2468 col 5| [Mendix.HeadingTitleCase] Use title case capitalization for 'Managed Identity to ACCESS Key Vault (not for database/storage)'.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2541 col 34| [Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
content/en/docs/private-platform/quickstart/pmp-quickstart-helm.md|2556 col 1| [Microsoft.DateFormat] Use 'July 31, 2016' format, not '23 Jul 2026'.
|
|
||
| The following configurations are component-specific. | ||
|
|
||
| ### Mx-privatecloud-license-manager |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.HeadingTitleCase] Use title case capitalization for 'Mx-privatecloud-license-manager'.
|
|
||
| | Field | Type | Required | Description | | ||
| | --- | --- | --- | --- | | ||
| | `enable` | boolean | Yes | Enable PCLM deployment | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Boolean'' (capitalized)
| * Mendix Operator (for obtaining licenses) | ||
| * `mxplatform` (configured through the `pclm.serviceUrl` field) | ||
|
|
||
| ### Mx-privatecloud |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.HeadingTitleCase] Use title case capitalization for 'Mx-privatecloud'.
|
|
||
| enable | ||
|
|
||
| boolean |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Boolean'' (capitalized)
| server_addr: "nats://nats.nats.svc:4222" | ||
| authenticator: | ||
| database: | ||
| host: "postgres-auth.example.com" |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Postgres'' (capitalized)
| className: "nginx" | ||
| hostName: "bridge.mendix.example.com" | ||
| certSecret: "bridge-tls-cert" | ||
| # Agent connection URL: wss://bridge.mendix.example.com/agent |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Mendix'' (capitalized)
|
|
||
| enable | ||
|
|
||
| boolean |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Boolean'' (capitalized)
|
|
||
| enable | ||
|
|
||
| boolean |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Boolean'' (capitalized)
|
|
||
| Set when ingress is enabled with hostname | ||
|
|
||
| You don't need to configure anything — integration happens automatically when you enable the component. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
|
|
||
| Basic production | ||
|
|
||
| Set postgres, optionally redis + useRedis: true |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Postgres'' (capitalized)
No description provided.