Skip to content

Commit 590833a

Browse files
Merge branch 'development' of https://github.com/mendix/docs into development
2 parents 77fca11 + c7c01f9 commit 590833a

12 files changed

Lines changed: 61 additions & 18 deletions

File tree

content/en/docs/appstore/use-content/platform-supported-content/modules/document-generation.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The [PDF Document Generation](https://marketplace.mendix.com/link/component/2115
2626

2727
* The maximum file size is 25 MB per document. If your document exceeds this limit, the action will result in an exception. We recommend compressing high-resolution images to reduce their file size.
2828
* If your app is configured to [restrict access for incoming requests](/developerportal/deploy/access-restrictions/) using client certificates, our cloud service will not be able to reach your app and the module will not work properly.
29+
* If your app uses a custom domain, you must configure a custom SSL/TLS domain certificate signed by a trusted public authority, including all intermediate certificates if applicable. Self-signed certificates will cause the service to fail. For more information, see [Obtaining a new signed certificate](/developerportal/deploy/custom-domains/#obtaining-a-new-signed-certificate).
2930
* We use a fixed 30 second timeout for the page to finish loading and rendering. A timeout exception is thrown if the page content did not finish loading within 30 seconds.
3031
* Widgets or add-ons for your `index.html` file that perform long polling network requests are not supported. The document generation service waits until there are no more pending network requests.
3132
* Some widgets, such as the [Charts](/appstore/widgets/charts/) widget, might be rendered inconsistently in the generated PDF due to factors like animation.
@@ -194,10 +195,6 @@ Rule | Name | Pattern | Rewrite URL
194195

195196
{{% alert color="info" %}}Rule 1 is based on the default URL prefix (`p`) for page/microflow URLs. If you configured a different prefix in the runtime settings of your app, adjust the rule accordingly.{{% /alert %}}
196197

197-
#### Allowing the Document Generation Service IP Addresses
198-
199-
If you have set up inbound or outbound IP restriction rules, you must allow the [IP addresses of the DocGen service.](/developerportal/deploy/mendix-ip-addresses/#global-platform-ips)
200-
201198
## Usage
202199

203200
### Generating Documents for the Current User

content/en/docs/deployment/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@ The Docker buildpack is available at [Mendix Docker Buildpack](https://github.co
8282

8383
Deploying to Azure is possible from the [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/mendix.mendix-pro).
8484

85+
### Mendix on Azure
86+
87+
Mendix on Azure is a deployment option that makes use of some of the features of Mendix for Private Cloud in an opinionated way. For more information, see [Mendix on Azure](/developerportal/deploy/mendix-on-azure/).
88+
89+
{{% alert color="info" %}} This feature is currently available to participating customers. For more information, contact your Customer Success Manager. {{% /alert %}}
90+
8591
## On-Premises
8692

8793
To learn how to deploy your Mendix application on premises, see [How to Deploy Mendix on Microsoft Windows](/developerportal/deploy/deploy-mendix-on-microsoft-windows/) and [Unix-Like Deployment](/developerportal/deploy/unix-like/).

content/en/docs/deployment/mx-azure/mx-azure-installation.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Before starting the installation and implementation process, make sure that you
1717

1818
* Obtain and configure a Microsoft Azure account. For more information, refer to the the Microsoft Azure documentation.
1919
* Purchase the Mendix on Azure offering in the [Azure Marketplace](https://azuremarketplace.microsoft.com/).
20+
* Enable co-access permissions for the offering.
21+
22+
{{< figure src="/attachments/deployment/mx-azure/coadmin-permission.png" class="no-border" >}}
23+
2024
* Familiarize yourself with the [Private Cloud](https://docs.mendix.com/developerportal/deploy/private-cloud/) concepts.
2125
* Ensure that your Mendix Studio Pro is in version 10.10 or newer.
2226
* As an optional best practice, add multiple cluster manager to your clusters.
@@ -26,9 +30,9 @@ Before starting the installation and implementation process, make sure that you
2630
To create a cluster for your Mendix on Azure app, perform the following steps:
2731

2832
1. In the Mendix Portal, in Private Cloud Cluster Manager, click **Mendix on Azure**.
29-
2. Connect to your Azure account by clicking **Connect and Initialize**, and then logging in with the same account that you used to purchase the Mendix on Azure offering.
33+
2. Connect to your Azure account by clicking **Connect Azure Account**, and then logging in with the same account that you used to purchase the Mendix on Azure offering. If required, you can also purchase an Azure offering after you log in.
3034

31-
After you successfully connect the accounts, the Mendix Portal shows a list of available clusters (that is, any Azure clusters that you have already linked with Mendix) and initializable clusters (that is, any clusters that you have not yet linked with Mendix). For initialized clusters, means that the all the required resources are provisioned on the cluster. For uninitialized clusters, no resources are provisioned yet.
35+
After you successfully connect the accounts, the Mendix Portal shows a list of available clusters (that is, any Azure clusters that you have already linked with Mendix), initializable clusters (that is, any clusters that you have not yet linked with Mendix), and clusters that failed to initialize for any reason. For initialized clusters, means that the all the required resources are provisioned on the cluster. For uninitialized clusters, no resources are provisioned yet.
3236

3337
{{< figure src="/attachments/deployment/mx-azure/available-clusters.png" class="no-border" >}}
3438

@@ -46,21 +50,35 @@ To create a cluster for your Mendix on Azure app, perform the following steps:
4650

4751
The managed app that you created is now visible as a new initializable cluster.
4852

49-
{{< figure src="/attachments/deployment/mx-azure/initializable-clusters.png" class="no-border" >}}
53+
{{< figure src="/attachments/deployment/mx-azure/initializable-clusters.png" class="no-border" >}}
5054

51-
7. Click **Initialize**.
55+
7. In the **Actions** column, click the icon, and then select **Initialize**.
5256

5357
The preflight check launches to verify that the required resources can be registered in the cluster. Mendix apps are hosted with virtual images, so the preflight check determines whether the cluster contains the required type of virtual image. To view a list of the required resource providers, hover your cursor over the **Information** icon. If required, you can register any missing providers in the **Resource providers** section of the Microsoft Azure portal.
5458

59+
{{< figure src="/attachments/deployment/mx-azure/preflight-check.png" class="no-border" >}}
60+
5561
8. After the preflight check completes, click **Next**.
5662

57-
9. Select the **AKS Service Tier**.
63+
9. In the **Provision** screen, review the information in the **Advanced Settings** section, and adjust any settings as needed. Note that selecting higher service tiers will incur higher costs. The **Postgress Compute SKU** and **Postgress Storage Performance Tier for IOPS** cannot currently be adjusted.
64+
65+
{{% alert color="info" %}}If you plan to use [virtual network peering](#network-peering), you must set the **Load Balancer Type** to **Private (Internal)**.{{% /alert %}}
66+
67+
10. In the **Review & Initialize** screen, review the information and click **Initialize**.
68+
69+
The initialization process takes approximately 15 minutes. It creates a resource group in the managed app that you created in step 3 above. Once the cluster is initialized successfully, a corresponding cluster is created in the the Private Cloud portal. The namespace is also created and configured automatically, as described in [Standard Operator: Running the Tool](https://docs.mendix.com/developerportal/deploy/standard-operator/#running-the-tool). You cannot create additional namespaces for a Mendix on Azure cluster. You also cannot use APIs to create or modify the cluster.
70+
71+
The cluster cannot be deleted from the Private Cloud portal or the Mendix on Azure portal. If you want to remove it, you must delete it in the Microsoft Azure portal.
72+
73+
## Rerunning Failed Clusters
74+
75+
If a cluster fails for any reason, its status in the Mendix Portal changes to **Failed**. To view more information about the issue, click the icon in the **Actions** column, and then select **Details**.
5876

59-
You can choose any tier that suits your requirements. Higher tiers will incur higher costs.
77+
{{< figure src="/attachments/deployment/mx-azure/failed-cluster.png" class="no-border" >}}
6078

61-
10. Click **Initialize**.
79+
To fix the issue, you can click **Rerun** to manually re-run the cluster. If a cluster still fails after a manual rerun, a support ticket is automatically opened with Mendix Support. For more information, see [Support Policy for Mendix on Azure: Automatic Support Tickets](/developerportal/deploy/mendix-on-azure/support/#tickets-automatic).
6280

63-
The initialization process takes approximately 15 minutes. It creates a resource group in the managed app that you created in step 3 above. Once the cluster is initialized successfully, a corresponding cluster and namespace are created in the the Private Cloud portal. The namespace is also configured automatically, as described in [Standard Operator: Running the Tool](https://docs.mendix.com/developerportal/deploy/standard-operator/#running-the-tool). The cluster cannot be deleted from the Private Cloud portal or the Mendix on Azure portal. If you want to remove it, you must delete it in the Microsoft Azure portal.
81+
{{% alert color="warning" %}}Do not initialize a cluster while it is in a Failed status.{{% /alert %}}
6482

6583
## Editing the Cluster in the Mendix on Azure Portal
6684

@@ -84,7 +102,7 @@ The following diagram shows two managed resource groups. One of them contains th
84102

85103
{{< figure src="/attachments/deployment/mx-azure/separate-access-groups.png" class="no-border" >}}
86104

87-
#### Potential Solution 1: Virtual Network Peering
105+
#### Potential Solution 1: Virtual Network Peering {#network-peering}
88106

89107
The following diagram shows one potential solution to the access issue. Bi-directional [virtual network peering](https://learn.microsoft.com/en-us/azure/virtual-network/virtual-network-peering-overview) has been configured between the two resource groups.
90108

content/en/docs/deployment/mx-azure/mx-azure-support.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ weight: 30
1111

1212
This document describes the technical support policies and limitations for Mendix on Azure, based on the shared responsibility model underlying the offering.
1313

14-
## Shared Responsibility Model
14+
{{% alert color="info" %}}Before you begin, familiarize yourself with the general Mendix support policies, as outlined in [Mendix Support](/support/).{{% /alert %}}
15+
16+
## Shared Responsibility Model for Mendix on Azure
1517

1618
Under the shared responsibility model for Mendix on Azure deployments, Mendix, Microsoft, and customer organizations all have their own responsibilities in the deployment process and business-as-usual operations. Familiarize yourself with the responsibilities listed below:
1719

@@ -97,7 +99,11 @@ Your tickets can have the following statuses:
9799

98100
The status is updated based on the current status of the ticket in the Zendesk. To see the latest status of the ticket, click the **Refresh** button.
99101

100-
### Automatic Support Tickets
102+
{{% alert color="info" %}}
103+
If you delete a cluster, all support tickets opened for that cluster are also deleted.
104+
{{% /alert %}}
105+
106+
### Automatic Support Tickets {#tickets-automatic}
101107

102108
Mendix on Azure can also automatically create support tickets for you. If a cluster fails to initialize and rerunning it manually does not resolve the issue, a support request is automatically created in the Support Center. Mendix Support is notified about the issue through Zendesk. You can follow the link from the support ticket to Zendesk to view its status or add additional comments.
103109

@@ -149,3 +155,5 @@ The solution is being benchmarked against SOC2 Azure Policy Compliance controls.
149155

150156
* Mendix on Azure only supports hosting apps on Mendix versions 10.10 or later. Any app on an earlier version will fail to deploy successfully.
151157
* Due to the managed nature of this product, not all Private Cloud APIs are available to the customer. Refer to the Build and Deploy API documentation to find out which API calls are out of scope for Mendix on Azure.
158+
* Currently, even after a cluster manager is deleted from the Private Cloud portal for a specific cluster, users can still access the cluster in the Mendix on Azure portal.
159+
* Because Mendix on Azure is directly dependent on Mendix for Private Cloud, issues that affect the Private Cloud may also affect Mendix on Azure deployments. For example, if the Private Cloud is down, it is not possible to create new Mendix on Azure clusters.

content/en/docs/refguide/mobile/building-efficient-mobile-apps/logging.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,17 @@ The native client stores logs on the device's memory. When **Enable sending logs
9898

9999
When the app goes to the background or closes, the native client will save buffered log messages on the file system and will restore them once the app is active again.
100100

101-
In this scenario, it will discard older messages so that it will not overflow with too many logs. An additional `info` log message will be added with the number of discarded logs and the timestamps of when these log messages were ignored.
101+
In this scenario, it will discard older messages so that it will not overflow with too many logs. An additional `info` log message will be added with the number of discarded logs and the time stamps of when these log messages were ignored.
102102

103-
The body of the log message consists of the timestamp in which the message was logged (which differs from the timestamp that is normally shown in the Cloud Portal as that one refers to the timestamps the log messages were collected), a unique session id so that the log messages can be grouped by device or origin, and the main content of the log message itself.
103+
The body of the log message consists of the time stamp in which the message was logged (which differs from the time stamp that is normally shown in the Cloud Portal as that one refers to the time stamps the log messages were collected), a unique session ID so that the log messages can be grouped by device or origin, and the main content of the log message itself.
104+
105+
Example:
106+
107+
```
108+
ERROR - Client: [2024-11-20 12:55:44.313 ][5261732040035738] Performing simultaneous synchronizations is not supported. Please try again after the current synchronization is completed.
109+
^ ^ ^ ^ ^
110+
Log Level Log Node Time Stamp Session ID Log Message
111+
```
104112

105113
## Extending Logging
106114

content/en/docs/refguide/runtime/monitoring-mendix-runtime.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ The request needs to be of the **POST** type with **No Authorization** and the f
2727
* Content-Type: **application/json**
2828
* X-M2EE-Authentication: **yourM2EEPassword_Base64Encoded**
2929

30-
The M2EE password is NOT the super administrator password, but a separate password. If you have the application deployed *on premises*, you can set this password in the **settings.yaml** file, which is located in the **Apps/YourProject** folder. If you are *running the application from Studio Pro*, the M2EE password is set automatically by Mendix, and you can retrieve it from the environment variables of your application process.
30+
The M2EE password is NOT the super administrator password, but a separate password. This can be retrieved from the `M2EE_ADMIN_PASS` environment variable in your `javaw.exe` or `java` process.
31+
32+
Remember to Base64 encode the password before passing it as the value for `X-M2EE-Authentication`
3133

3234
The next sections explain which monitoring actions are supported.
3335

content/en/docs/support/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,10 @@ Mendix Support does not have access to app health, logs, graphs and monitoring.
185185

186186
{{< figure src="/attachments/support/private-cloud.png" width="75%" class="no-border" >}}
187187

188+
### Mendix on Azure
189+
190+
[Mendix on Azure](/developerportal/deploy/mendix-on-azure/) is a deployment option that makes use of some of the features of Mendix for Private Cloud in an opinionated way. For detailed information about the support policy in place for Mendix on Azure, see [Support Policy for Mendix on Azure](/developerportal/deploy/mendix-on-azure/support/).
191+
188192
### Private Mendix Platform
189193

190194
Private Mendix Platform provides a platform experience in on-premises or (virtual) private cloud environments. It is dependent on Mendix for Private Cloud and Kubernetes, and integrates with tooling in the customer's landscape. Please refer to [Private Mendix Platform](/private-mendix-platform/) documentation for [prerequisites](/private-mendix-platform-prerequisites/) to install the platform and set up [configurations](/private-mendix-platform-configuration/), as well as [Mendix for Private Cloud](/developerportal/deploy/private-cloud/) documentation for [supported environments](/developerportal/deploy/private-cloud-supported-environments/).
-58.9 KB
Loading
286 KB
Loading
144 KB
Loading

0 commit comments

Comments
 (0)