Skip to content

Commit db8fc13

Browse files
Merge branch 'development' into PCLM_release_0.10.4and0.10.5
2 parents daf564d + 9338ea2 commit db8fc13

11 files changed

Lines changed: 484 additions & 22 deletions

File tree

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Private Mendix Platform Pipeline API"
3+
url: /apidocs-mxsdk/apidocs/private-platform-pipeline-api/
4+
type: swagger
5+
description: "This API allows you to manage pipelines in Private Mendix Platform."
6+
restapi: true
7+
weight: 60
8+
linktitle: "Pipeline API"
9+
---
10+
11+
{{% alert color="info" %}}
12+
This document is about [Private Mendix Platform](/private-mendix-platform/) API. This API is only available on instances of Private Mendix Platform. For [Mendix on Kubernetes](/developerportal/deploy/private-cloud/) API, see [Mendix on Kubernetes Build API](/apidocs-mxsdk/apidocs/private-cloud-build-api/) and [Mendix on Kubernetes Deploy API](/apidocs-mxsdk/apidocs/private-cloud-deploy-api/).
13+
{{% /alert %}}
14+
15+
## Introduction
16+
17+
The Private Mendix Platform Project API allows you to manage pipelines in Private Mendix Platform. You can use the API to do the following:
18+
19+
* Get pipeline running information.
20+
* Set the current step status of the pipeline.
21+
* Create a pipeline for build or deployment.
22+
* Approve or reject a manual step of a waiting pipeline.
23+
24+
## API Reference
25+
26+
{{< swaggerui src="/openapi-spec/openapi-pipeline.yaml" >}}

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

Lines changed: 112 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,37 @@ description: "Provides information about the support model for Mendix on Azure."
55
weight: 30
66
---
77

8-
{{% alert color="info" %}}
8+
{{% alert color="info" %}}
99
To facilitate sharing this information with internal stakeholders, a downloadable PDF version is available [here](https://blob.mendix.technology/mxonazure/MXonAzure-Support-Policy-for-Mendix-on-Azure.pdf). If discrepancies arise between this document and the PDF, the PDF version takes precedence.
1010
{{% /alert %}}
1111

1212
## Introduction
1313

1414
This document outlines the technical support policies and limitations for Mendix on Azure, based on the shared responsibility model that underpins the offering.
1515

16+
## Managed Nature of Mendix on Azure
17+
18+
With Mendix on Azure, you get a managed service to host Mendix apps in an Azure subscription you own. The Mendix on Azure service is comprised of several underlying Azure services combined with three Mendix-specific components (the Mendix Runtime, Operator and Agent). Mendix deploys and operates all services and components within the scope of the Mendix on Azure service for you.
19+
20+
Hosting Mendix apps on underlying Azure services you deploy and operate yourself (as can be done by adopting our Mendix on Kubernetes offering) provides you with the most low-level choice, control, and customization options with regards to these underlying services. By contrast, Mendix on Azure only provides you a relatively limited set of customization options with regards to these underlying services.
21+
22+
In exchange, you do not need to worry about deploying or managing these underlying Azure services yourself. In this manner, Mendix onAzure provides you a turnkey solution for hosting Mendix apps on Azure.
23+
24+
Mendix deploys and manages the following components and services as part of Mendix on Azure:
25+
26+
* Azure Kubernetes Service with Managed NGINX Ingress Controller (app routing add-on)
27+
* Azure PostgreSQL Flexible Server and Azure PostgreSQL Flexible Server replica (if enabled)
28+
* Azure Container Registry
29+
* Azure Blob Storage
30+
* Azure Managed Grafana
31+
* Azure Managed Prometheus
32+
* Azure Virtual Network including Private Endpoints
33+
* Mendix Runtime
34+
* Mendix Operator
35+
* Mendix Agent
36+
1637
{{% alert color="info" %}}
17-
Before proceeding, familiarize yourself with the general Mendix support policies available in [Mendix Support](/support/).
38+
These components are managed in the sense that Mendix deploys and operates them in such a manner that they work together to form a Mendix app hosting service. As a consequence, customers cannot alter these underlying components themselves beyond what is described in the next paragraphs.
1839
{{% /alert %}}
1940

2041
## Shared Responsibility Model for Mendix on Azure
@@ -27,7 +48,7 @@ Microsoft manages and secures the Azure services that underlie Mendix on Azure.
2748

2849
* Compute - Azure Kubernetes Service (AKS)
2950
* Storage - Azure Blob Storage, Azure Container Registry
30-
* Database - PostgreSQL Flexible Server
51+
* Database - PostgreSQL Flexible Server, Postgres replica
3152
* Networking - Virtual Networks, Load Balancer, Private Endpoints
3253
* Monitoring - Managed Grafana and Prometheus
3354

@@ -51,13 +72,42 @@ Customers are accountable for developing, deploying, operating, integrating, and
5172
* Integrating - Securing integrations with backend services and IAM
5273
* Securing - Following Mendix best practices for secure apps
5374

54-
## Available Customizations
75+
## Limited Customizabilty
76+
77+
When a Mendix on Azure cluster is initialized, all components that are required to host Mendix apps are automatically deployed inside an Azure resource group in the subscription of your choosing. Regularly, Mendix and Microsoft will push all required updates to this resource group to ensure it remains compliant and secure.
78+
79+
In order to be able to push these updates to all Mendix on Azure customers in an automated, predictable and consistent manner, you as a customer are not able to modify any of these components directly in Azure nor can you influence this upgrade process. As a consequence, any customization beyond what is described below is not possible.
80+
81+
The following customizations are offered as self-service in the Mendix on Azure portal:
82+
83+
* Apply custom tags to deployed Azure resources.
84+
* Set the Azure Kubernetes Service tier.
85+
* Set the VM type for the Azure Kubernetes agent node.
86+
* Set the maximum node pool size (that is, the upper autoscaling limit) for the AKS agent.
87+
* Set the Azure for PostgreSQL Flexible server computing SKU and storage performance tier.
88+
* Switch to internal load balancer exposure to enable apps that can only be reached privately.
89+
* Switch to internal Grafana exposure to prevent exposure to the public internet.
90+
* Change IP address prefix of the subnet hosting AKS nodes (only at initial deployment).
91+
92+
The following customizations are related to establishing connectivity to and from other networks and Azure services. They can be done by the customer directly in the Microsoft Azure Portal:
93+
94+
* Configure virtual network peerings with the subnet hosting AKS nodes.
95+
* Override DNS configuration on the subnet hosting AKS nodes.
96+
* Configure Private Link Service to expose Mendix apps in other Azure virtual networks.
97+
* Configure Private Endpoints to establish connectivity between Mendix apps and other services.
98+
99+
Mendix limits customization to what is described above to ensure a consistent, predictable, and scalable customer experience.
100+
101+
## Access to your Environment by Mendix
55102

56-
During cluster initialization, all components needed to host Mendix apps are deployed automatically inside an Azure Resource Group you select. Mendix and Microsoft regularly apply mandatory automated updates to keep clusters compliant and secure.
103+
By deploying Mendix on Azure from the Azure Marketplace, you provide consent for Mendix to deploy and operate the resources required for Mendix on Azure in the chosen resource group. The mechanism used by Mendix to fulfil this access is provided by Microsoft - that is, publisher access to a Managed Application - and by definition limits the access Mendix has to your Azure subscription to the resources deployed.
57104

58-
Due to this automation, direct modification of these components in Azure or control over the upgrade process is not possible. Customizations are limited to options exposed via the Mendix on Azure, Microsoft Azure, and Mendix on Kubernetes portals. Current allowed customizations include those documented in the [Configuration section](/developerportal/deploy/mendix-on-azure/configuration/).
105+
Mendix will use this access for the following purposes:
59106

60-
Any modifications outside this documented scope are not supported.
107+
* Initial initialisation of the cluster (as initiated by the customer from Mendix on Azure portal)
108+
* Pushing regular service updates (automatically, see description in the next paragraph)
109+
* Pushing ad-hoc emergency updates or configuration changes to avoid service disruptions (by exception and at discretion of Mendix)
110+
* Troubleshooting incidents on behalf of the customer (after raising of a support ticket by the customer)
61111

62112
## Support Tickets
63113

@@ -110,17 +160,25 @@ These automated upgrade cadences cannot be modified by customers.
110160

111161
## Mendix Support Coverage Examples
112162

113-
The following scenarios are supported:
163+
### Example Supported Scenarios
114164

115-
* Cluster initialization fails despite passing pre-flight checks.
116-
* Service availability issues are not resolvable through self-service recovery.
165+
Mendix provides technical support for the following example scenarios:
117166

118-
The following scenarios are not supported:
167+
* Cluster initialization fails despite passing pre-flight validation checks.
168+
* The customer is experiencing service availability issues and is unable to recover the situation using the self-service recovery option.
119169

120-
* Consultations on integrations with other Azure services outside the Mendix on Azure scope; consider Mendix Expert Services or partners for consultancy.
121-
* Configuration changes to Azure services beyond self-service options; Mendix on Kubernetes may offer more flexibility.
122-
* Customizations to Azure subscription resources beyond the supported scope.
123-
* Manual fixes for security vulnerabilities beyond the automated update cycles.
170+
### Example Unsupported Scenarios
171+
172+
Mendix does not provide technical support in the following example scenarios:
173+
174+
* Requests about how to integrate with other Azure Services that are beyond the scope of the product. Such requests can be supported by Mendix Expert Services or Mendix (infra) partners as part of (paid) consultancy engagements.
175+
* Requests to make configuration changes to underlying Azure services beyond what is offered as self-service in the Mendix on Azure and Mendix on Kubernetes Portal. Since such changes are not possible with this service, customer may consider to adopt Mendix on Kubernetes (formerly Mendix for Private Cloud) instead.
176+
* Requests for any other type of customization on the resources deployed in the customer's Azure subscription. Since such customization is not possible with this service, customer may consider to adopt Mendix for Kubernetes (formerly Mendix for Private Cloud) instead.
177+
* Requests to fix security vulnerabilities in one of the managed components beyond what is automatically pushed during the weekly and quarterly update cycles.
178+
179+
{{% alert color="warning" %}}
180+
The state of the resources in the customer subscription nor overall service availability are proactively monitored by Mendix. As a consequence, any degradation in service will only reactively be addressed by Mendix after customer has notified Mendix of such degradation by filing a support ticket.
181+
{{% /alert %}}
124182

125183
## Customer Responsibilities for Mendix on Azure Resources
126184

@@ -138,12 +196,49 @@ Mendix mitigates these impacts by:
138196
* Collaboration with Microsoft Support and engineering for upstream fixes
139197
* Transparent communication and guidance on workarounds for affected customers
140198

199+
## Backup, Restore, Data Migration and Disaster Recovery
200+
201+
Mendix on Azure provides the following features to allow customers to self-service their needs with regards to backup, restore, data migration, and disaster recovery:
202+
203+
* Mendix on Azure provides per-app environment snapshotting capabilities that allow customers to backup and restore all relevant app data from/to an environment via selfservice on the Mendix on Kubernetes Portal.
204+
* Mendix on Azure creates automated nightly backup snapshots for every Mendix app environment.
205+
* All backup snapshots are stored in an Azure Storage Account hosted on the customer's Azure subscription. Mendix has prepared an emergency procedure which can be performed in collaboration with the customer in case the Azure Storage Account holding the backup snapshots is accidentally deleted from Azure.
206+
* Individual backup snapshots can be downloaded and uploaded from and into a customer's Mendix on Azure environment by the customer under self-service through the Mendix on Kubernetes Portal. This provides the customer the ability to use such snapshots for disaster recovery scenarios as well as data migration scenarios to and from other deployment models. Mendix Expert Services is available to support customers in such scenarios, when desired.
207+
141208
## Compliance Frameworks
142209

143210
Mendix on Azure aligns with SOC 2 Azure Policy automated controls. For more information, see [SOC 2 Type 2 Compliance Exceptions](/developerportal/deploy/mendix-on-azure/security-and-compliance/#soc2).
144211

212+
| Service | Exception | Rationale |
213+
| --- | --- | --- |
214+
| Azure Kubernetes Service | [Azure Policy Addon for Kubernetes service (AKS) should be installed and enabled on your clusters](https://www.azadvertizer.net/azpolicyadvertizer 0a15ec92-a229-4763-bb14-0ea34a568f8d.html) | The cluster and all workloads are deployed and managed by Mendix so enforcing policy does not add any value. |
215+
| Azure Kubernetes Service | [Azure Kubernetes Service clusters should have Defender profile enabled](https://www.azadvertizer.net/azpolicyadvertizer/a1840de2-8088-4ea8-b153-b4c723e9cb01.html) | Defender is not enabled for costsaving reasons. |
216+
| Azure Kubernetes Service | [All Internet traffic should be routed via your deployed Azure Firewall](https://www.azadvertizer.net/azpolicyadvertizer/fc5e4038-4584-4632-8c85-c0448d374b2c.html) | This is not part of the product scope but can be added by the customer postdeployment. |
217+
| Azure Container Registry | [Container registries should be encrypted with a customer-managed key](https://www.azadvertizer.net/azpolicyadvertizer/5b9159ae-1701-4a6f-9a7a-aa9c8ddd0580.html) | The standard Microsoft key is used to enable deployment without key creation in Azure. |
218+
| Storage Account | [Storage accounts should use customer-managed key for encryption](https://www.azadvertizer.net/azpolicyadvertizer/6fac406b-40ca-413b-bf8e-0bf964659c25.html) | The standard Microsoft key is used to enable deployment without key creation in Azure. |
219+
220+
## Severity Baselines for Support Tickets
221+
222+
To ensure consistent and prioritised support, we classify issues based on the following severity levels:
223+
224+
| SeverityLevel | Response Time | Resolution Time | Examples |
225+
| --- | --- | --- | --- |
226+
| Critical | Less than 2 office hours | Best effort | Production environment is inaccessible or severely impaired, preventing critical changes. Core application functionality is completely unavailable. |
227+
| High | Less than 8 office hours | Best effort | Inability to provision new clusters. Inability to modify existing clusters via the Mx on Azure portal. |
228+
| Medium | Next business day | Best effort | Non-production environments (Test or Acceptance) experience significant disruption to operational functionality. Operational functionality in production is moderately impacted but not critical. |
229+
| Low | Reasonable effort | Best effort | Minor issues with minimal impact on operational functionality. Cosmetic issues, minor performance degradation, or general inquiries. |
230+
231+
## Off-boarding from the Service
232+
233+
Customers can completely off-board from the service by deleting the Managed Application from their Azure subscription (for example by using the Azure Portal). This will immediately perform the following actions:
234+
235+
* Remove all resources related to Mendix on Azure from the customer's subscription.
236+
* Remove any access Mendix has to the customer's environment.
237+
* Delete the cluster registration from the Mendix on Azure and Mendix on Kubernetes Portals.
238+
* While Mendix does have an emergency procedure available to help revive an environment and restore data in case the Managed Application gets deleted by accident, it is a higheffort manual process requiring close collaboration between Mendix and the customer. Given this, we advise customers to exercise extreme caution when deleting the Managed Application from their Azure subscription to avoid the need of this emergency procedure to be executed.
239+
145240
## Known Limitations
146241

147-
* Only apps on Mendix version 10.10 or later are supported; deployment for earlier versions will fail.
242+
* Only apps on Mendix version 10.10 or later are supported. Deployment for earlier versions will fail.
148243
* Certain Mendix on Kubernetes APIs (Create, Edit, or Delete cluster and namespace operations) are unavailable in Mendix on Azure due to managed architecture. Other APIs function normally.
149-
* Downtime or issues with Mendix on Kubernetes may affect Mendix on Azure availability (for example, cluster creation may notbe possible).
244+
* Downtime or issues with Mendix on Kubernetes may affect Mendix on Azure availability (for example, cluster creation may not be possible).

content/en/docs/marketplace/platform-supported-content/modules/snowflake/snowflake-rest-sql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To use the Snowflake REST SQL connector, you must also install and configure the
5454

5555
* [Community Commons](https://marketplace.mendix.com/link/component/170) – This module is a required dependency for the Snowflake REST SQL connector.
5656
* [Encryption](https://marketplace.mendix.com/link/component/1011) – This module is a required dependency for the Snowflake REST SQL connector. The EncryptionKey constant must be set up in your application settings.
57-
* GenAI Commons module ver. 3.x from the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle – This module is a required dependency for the Snowflake Cortex Analyst.
57+
* GenAI Commons module ver. 3.x from the [GenAI For Mendix](https://marketplace.mendix.com/link/component/227931) bundle – Only required for the Snowflake REST Connector version 2.x. This module is a required dependency for the Snowflake Cortex Analyst.
5858

5959
{{% alert color="info" %}}
6060
The Snowflake REST SQL connector currently requires version 3.x of the GenAI Commons module. Newer versions of the module are not supported yet.

content/en/docs/partners/siemens/3d-viewer/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ aliases:
1010

1111
## Introduction
1212

13-
The [3D Viewer](https://marketplace.mendix.com/link/component/118345) service lets you upload, visualize, and operate on 3D files (JT, OBJ, glTF, and STL formats) in your web applications, using Mendix file storage to store models. The app service contains out-of-the-box Java actions, JavaScript actions, [domain models](/refguide/domain-model/), [nanoflows](/refguide/nanoflows/), [microflows](/refguide/microflows/), and a set of 3D widgets that enable you to build apps to work with 3D models. Also included are whole functionalities and integrations that can be very helpful when building your own 3D applications. All you need to do is drag and drop items and configure them.
13+
The [3D Viewer](https://marketplace.mendix.com/link/component/118345) service lets you upload, visualize, and operate on JT files in your web applications, using Mendix file storage to store models. The app service contains out-of-the-box Java actions, JavaScript actions, [domain models](/refguide/domain-model/), [nanoflows](/refguide/nanoflows/), [microflows](/refguide/microflows/), and a set of 3D widgets that enable you to build apps to work with 3D models. Also included are whole functionalities and integrations that can be very helpful when building your own 3D applications. All you need to do is drag and drop items and configure them.
1414

1515
This app service does the heavy-lifting for you so you do not have to build a 3D-rendering engine from scratch.
1616

@@ -63,7 +63,7 @@ The 3D Viewer app service includes a few 3D widgets. These are some limitations
6363

6464
* One **Container3D** widget can only contain one **Viewer** widget. If multiple Viewer widgets are placed inside a Container3D widget, you will see error message in **Design mode**.
6565
* The **Viewer** widget is used to display a 3D model. All other 3D widgets (except the **Uploader** and **Container3D** widgets) need a Viewer widget present on the page to interact with.
66-
* Currently, supports glTF, STL, OBJ, and JT (JT version 9 and above) formats.
66+
* Supports the JT format (version 9 and above).
6767
* Before uploading a shattered JT *.zip* file, make sure you are using UTF-8 encode to zip the JT files. For example, if you are using 7-Zip, make sure you enter *cu* in **Parameters**.
6868

6969
{{< figure src="/attachments/partners/siemens/3d-viewer/shatteredjt-utf8.png" alt="shatteredjt-utf8" class="no-border" >}}

0 commit comments

Comments
 (0)