Skip to content

Commit 4eb238d

Browse files
committed
Merge branch 'development' of https://github.com/mendix/docs into development
2 parents 3fa4eff + 4d3e3a3 commit 4eb238d

17 files changed

Lines changed: 580 additions & 28 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/governance/user-identifiers-api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ The User Identifiers API is available for Mendix Admins.
1616

1717
The User Identifiers API allows Mendix admins to perform operations related to user identifiers within their company, such as obtaining the user UUIDs of specific email addresses.
1818

19+
{{% alert color="info" %}}
20+
The User Identifiers API supports a maximum of 100 users per request/response.
21+
{{% /alert %}}
22+
1923
## Authentication{#authentication}
2024

2125
Authentication for the User Identifiers API uses a personal access token (PAT).

content/en/docs/deployment/mendix-cloud-deploy/pipelines.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,8 @@ To trigger pipelines based on Teamserver push (Git), Mendix automatically create
332332

333333
Pipelines is in public beta and is undergoing optimizations. Initial stages may involve occasional slowness, leading to pipeline failures. Mendix is committed to resolving these issues swiftly and appreciates your understanding.
334334

335+
Pipeline runs will not be picked up and executed if Pipelines is undergoing maintenance.
336+
335337
It is not currently possible to add the same pipeline step more than once in a pipeline. This will be improved in the future.
336338

337339
## Read More

content/en/docs/deployment/private-cloud/private-cloud-cluster/_index.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,13 +194,13 @@ kind: OperatorConfiguration
194194
# omitted lines for brevity
195195
# ...
196196
spec:
197-
baseOSImageTagTemplate: 'ubi8-1-jre{{.JavaVersion}}-entrypoint'
197+
baseOSImageTagTemplate: 'ubi9-1-jre{{.JavaVersion}}-entrypoint'
198198
```
199199
200200
At the moment, the `baseOSImageTagTemplate` can be set to one of the following values:
201201

202-
* `ubi8-1-jre{{.JavaVersion}}-entrypoint` - to use Red Hat UBI 8 Micro images; this is the default option.
203-
* `ubi9-1-jre{{.JavaVersion}}-entrypoint` - to use Red Hat UBI 9 Micro images; this option can be used to use a newer OS and improve security scores.
202+
* `ubi8-1-jre{{.JavaVersion}}-entrypoint` - to use Red Hat UBI 8 Micro images; this option can be used for some cases where backward compatibility is needed.
203+
* `ubi9-1-jre{{.JavaVersion}}-entrypoint` - to use Red Hat UBI 9 Micro images; this is the default option.
204204

205205
{{% alert color="info" %}}
206206

@@ -964,6 +964,10 @@ In addition to internal Mendix Runtime paths, `/tmp` is mounted for any temporar
964964
If your app works without issues when read-only root filesystem is enabled, it is best to enable it wherever possible. We recommend using a non-production environment to validate that your app keeps working correctly with a read-only RootFS.
965965
{{% /alert %}}
966966

967+
{{% alert color="warning" %}}
968+
Enabling the `runtimeReadOnlyRootFilesystem` option causes the `model/resources` directory to be empty. If your app (or a Marketplace module such as SAML) uses the `model/resources` directory for resources such as configuration data, consider moving those resources to another location (for example, `model/userlib`) or loading them from FileDocument entities.
969+
{{% /alert %}}
970+
967971
### GKE Autopilot Workarounds {#gke-autopilot-workarounds}
968972

969973
In GKE Autopilot, one of the key features is its ability to automatically adjust resource settings based on the observed resource utilization of the containers. GKE Autopilot verifies the resource allocations and limits for all containers, and makes adjustments to deployments when the resources are not as per its requirements.

content/en/docs/refguide/general/mx-command-line-tool/analyze-mpr.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ The `OPTIONS` are described in the table below:
3636

3737
To identify which types of documents (pages, microflows, etc.) have the largest contribution to the MPR file size, you can focus on the **Size by unit type** section, where the number of occurrences and file size contribution are displayed in percentage.
3838

39+
You can use the MPR Tool to get more details. You can find it at *C:\Program Files\Mendix\<version>\modeler\MprTool.exe* (where <version> should be replaced with your installed Mendix version). After opening the *.mpr* file for your app, use **Search** > **Find unit by ID** to find the name and module for a particular unit.
40+
3941
### Examples
4042

4143
Valid examples are given below:

content/en/docs/refguide/modeling/domain-model/oql/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ The Mendix Object Query Language (OQL) is a relational query language inspired b
1010

1111
In addition, OQL can use predefined relations (associations) to easily join objects without having to calculate which columns should be coupled. Despite these differences, many SQL keywords also work in OQL.
1212

13+
{{% alert color="info" %}}
14+
OQL can only be used on persistable and view entities and the associations between them. It cannot be used with non-persistable or external [entities](/refguide/entities/).
15+
{{% /alert %}}
16+
1317
Some examples of OQL queries are:
1418

1519
* `SELECT LastName FROM Sales.Customer` – retrieves the family names of all customers

content/en/docs/refguide/modeling/menus/version-control-menu/commit-dialog.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,14 @@ weight: 20
88

99
The commit dialog is used for committing changes to the Team Server. You can enter a message and, if applicable, select related stories.
1010

11-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-stories.png" alt="Version Control Menu" class="no-border" width="400" >}}
12-
1311
## Branch
1412

1513
At the top of the dialog box you will see the branch which you are committing. This will be one of the following:
1614

1715
| Branch Description | Notes |
1816
| --- | --- |
19-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-main.png" alt="Version Control Menu" class="no-border" >}} | you are committing the main line |
20-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-branch.png" alt="Version Control Menu" class="no-border" >}} | you are committing the specified branch |
17+
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-main.png" alt="Main line icon" class="no-border" >}} | you are committing the main line |
18+
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-branch.png" alt="Commit branch icon" class="no-border" >}} | you are committing the specified branch |
2119

2220
## Message
2321

@@ -27,20 +25,44 @@ Enter a message describing the changes you have made. This message may contain m
2725

2826
### Related Stories {#stories}
2927

30-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-stories.png" alt="Version Control Menu" class="no-border" width="400" >}}
31-
3228
Tick the boxes next to the stories that are related to your commit. Mendix recommends committing a small number of changes at a time, so there is usually just one related story.
3329

3430
### Changes in Model
3531

36-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-model-changes.png" alt="Version Control Menu" class="no-border" width="400" >}}
37-
3832
If there are changes in the model this tab shows a summary of those changes. For more information on how changes are reported in Studio Pro, see [Changes Pane](/refguide/changes-pane/).
3933

40-
### Changes on Disk
34+
There are several scenarios and options that you can choose when committing. Two of these options are represented in the image below:
35+
36+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-options.jpg" alt="Several options when committing" >}}
37+
38+
#### Commit and Push
39+
40+
{{% alert color="info" %}}
41+
42+
**Commit and Push** is the recommended flow to stay in-sync with your team and avoid conflicts.
43+
44+
{{% /alert %}}
45+
46+
Your changes are committed and pushed to the server.
4147

42-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-disk-changes.png" alt="Version Control Menu" class="no-border" width="400" >}}
48+
#### Commit Locally
49+
50+
Changes are committed to your local working copy and are not pushed to the sever.
51+
52+
#### Commit and Combine {#combine}
53+
54+
If someone else committed a change since the last time you pulled your branch, you will have to pull and merge their changes before you can push to the server. This process is called **Commit and Combine** in the [Commit](/refguide/commit-dialog/) dialog box. **Commit and Combine** will first create a local commit and then automatically do a pull. After resolving any conflicts, you can push the combined version to the server.
55+
56+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-and-combine.jpg" alt="Commit and combine changes" >}}
57+
58+
{{% alert color="warning" %}}
59+
60+
After you reviewed the changes, you will need to push your changes, as **Commit and Combine** only updates your local copy and does not push your changes to the server.
61+
62+
{{% /alert %}}
63+
64+
### Changes on Disk
4365

44-
If there are changes on disk this page shows a summary of those changes. Click **Open containing folder** to open the folder containing the selected file in Windows Explorer.
66+
If there are changes on disk this tab shows a summary of those changes. Click **Open containing folder** to open the folder containing the selected file in Windows Explorer.
4567

4668
The tab page is hidden if there are no disk changes. Often, there are model changes but the only change on disk is the app file (*.mpr*) reflecting these model changes. In this case, it is also hidden, because it does not add useful information.

content/en/docs/refguide/version-control/on-premises-git.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ Make sure you have completed the following prerequisites:
3434

3535
## Supported Authentication Mechanisms
3636

37-
Currently, Mendix only supports HTTP Basic authentication for Git service providers. With most providers, this takes the form of using of personal access tokens (PATs).
37+
Currently, Mendix only supports [HTTP Basic authentication](#http) and [Windows Authentication](#windows) for Git service providers.
38+
39+
### HTTP Basic Authentication {#http}
40+
41+
With most providers, HTTP basic authentication takes the form of using of personal access tokens (PATs).
3842

3943
To use PAT (or another equivalent), you need to specify it in the **Password** field when Studio Pro requests credentials for the version control server:
4044

@@ -45,6 +49,13 @@ Currently Mendix keeps PAT using operating system supported solutions:
4549
* For Windows, Mendix uses a credential locker mechanism, accessible to users by using Credential Manager.
4650
* For MacOs, Mendix uses keychains, accessible to users by using Keychain Access.
4751

52+
### Windows Authentication {#windows}
53+
54+
Studio Pro can use Windows Authentication for Git service providers that support it. When you use Windows Authentication, you do not need to provide a password.
55+
56+
You can enable Windows Authentication in [Git Preferences settings](/refguide/preferences-dialog/#enable-windows-authentication).
57+
58+
4859
## Setting Up the Environment
4960

5061
This section describes how to configure a Git versioned app in Studio Pro. You need a Git server and an initially unversioned Mendix app.

content/en/docs/refguide/version-control/using-version-control-in-studio-pro/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ A tool you can consider using is TortoiseGitMerge, shipped as part of [TortoiseG
143143
Comparing files on disk with the original is currently not supported on macOS.
144144
{{% /alert %}}
145145

146-
Committing is only allowed if your working copy is up to date with the repository. If someone else committed a change since the last time you pulled, you will have to pull first. This is because the revision you create with the commit should incorporate both your changes and the changes by the other person. Updating will combine the latest changes in the repository with your changes. After reviewing the result and fixing any conflicts, you can commit again.
146+
Committing is only allowed if your working copy is up to date with the repository. If someone else committed a change since the last time you pulled, you will have to pull first (this process is called **Commit and Combine** in the [Commit](/refguide/commit-dialog/#combine) dialog box). This is because the revision you create with the commit should incorporate both your changes and the changes by the other person. Updating will combine the latest changes in the repository with your changes. After reviewing the result and fixing any conflicts, you can commit again.
147147

148148
### Pushing {#pushing}
149149

content/en/docs/releasenotes/deployment/mendix-for-private-cloud.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ For information on the current status of deployment to Mendix for Private Cloud
1212

1313
## 2025
1414

15+
### March 10, 2025
16+
17+
#### License Manage CLI v0.10.1
18+
19+
* We have updated this component to use the latest dependency versions in order to improve security score ratings for container images. This update will allow us to address CVE-2024-45337 and CVE-2024-45338.
20+
21+
#### Mendix Operator v2.21.1 {#2.21.1}
22+
23+
* We have updated components to use the latest dependency versions in order to improve security score ratings for container images.
24+
* For new installations, the Operator now uses ubi9 as the base image for Mendix apps. Existing installations will keep their configuration and stay on ubi8. For more information on base image versions, see the [Runtime Base Image](/developerportal/deploy/private-cloud-cluster/#runtime-base-image) section.
25+
* We have fixed a regression that caused the `model/resources` directory to appear empty and caused problems with some Marketplace modules, such as SAML (Ticket 242648).
26+
* Upgrading to Mendix Operator v2.21.0 from a previous version now restarts environments managed by that version of the Operator. Environments with 2 or more replicas and a **PreferRolling** update strategy are restarted without downtime.
27+
1528
### March 6, 2025
1629

1730
#### Portal Improvements
@@ -40,6 +53,12 @@ For information on the current status of deployment to Mendix for Private Cloud
4053

4154
With the introduction of ephemeral storage requests and limits, building an app requires at least 2 GB of ephemeral storage available on the Kubernetes node. If your nodes do not have enough temporary storage, the build pods cannot start and their status remains **Pending**. To resolve this issue, you can lower the values for `ephemeral-storage` in the [buildResources](/developerportal/deploy/private-cloud-cluster/#resource-definition-ocm) configuration.
4255

56+
#### Known Issue
57+
58+
This issue has been fixed in Mendix Operator [version 2.21.1](#2.21.1).
59+
60+
* The `model/resources` directory is empty when starting the app, causing issues with some Marketplace modules (such as SAML) that use that location to store configuration data and other resources.
61+
4362
### February 12, 2025
4463

4564
#### Documentation Updates

0 commit comments

Comments
 (0)