Skip to content

Commit 10c7754

Browse files
feat: addressing feedback and adding anchor tags
1 parent e8f4bb3 commit 10c7754

File tree

1 file changed

+31
-26
lines changed

1 file changed

+31
-26
lines changed

content/en/docs/deployment/mendix-cloud-deploy/environments-details.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ url: /developerportal/deploy/environments-details/
44
weight: 7
55
description: "Describes the environmental details of your app and how to manage the environment."
66
#To update these screenshots, you can log in with credentials detailed in How to Update Screenshots Using Team Apps.
7-
#The anchor #connection-safelist below is mapped from the Mendix Portal (Mendix Cloud Environment Details), so it should not be removed or changed.
8-
#The anchor #services below is mapped from the Mendix Portal (Mendix Cloud Environment Details), so it should not be removed or changed.
7+
#Do not remove any of the anchor tags. They are mapped to other documents.
98
---
109

1110
## Introduction
@@ -50,7 +49,7 @@ On the right side of the screen in the **General** tab, there are buttons that y
5049

5150
{{% alert color="info" %}}Depending on your permissions, you may see only some of the action buttons described below. You can adjust your permissions settings on the [Permissions](/developerportal/deploy/node-permissions/) tab of your app's **Environments** page.{{% /alert %}}
5251

53-
#### Running App Actions
52+
#### Running App Actions {#running-app-actions}
5453

5554
When your app is running, you can see the following action buttons:
5655

@@ -62,7 +61,7 @@ When your app is running, you can see the following action buttons:
6261
* **Show Debugger Information** – This shows the settings needed to connect the debugger in Studio Pro to your app. For more information on debugging in the cloud, see [How To Debug Microflows Remotely](/refguide/debug-microflows-remotely/).
6362
* **Show Running Now** – You can use this to monitor all actions that are currently running in your environment. For more information, see [Running Now](/developerportal/deploy/mxcloud-runningnow/).
6463

65-
#### Stopped App Actions
64+
#### Stopped App Actions {#stopped-app-actions}
6665

6766
When your app is stopped, you see this set of action buttons instead:
6867

@@ -136,7 +135,7 @@ If you have 1 GiB RAM of total allocated memory, you have one instance to use yo
136135

137136
For more information, see [Scaling Your Environment](/developerportal/deploy/scale-environment/).
138137

139-
### Deployment Package Details
138+
### Deployment Package Details {#deployment-package-details}
140139

141140
In this section, you can find information about the deployment package that is loaded into the environment:
142141

@@ -146,7 +145,7 @@ In this section, you can find information about the deployment package that is l
146145
* **Size (MB)** of the deployment package
147146
* **Upload date** of the deployment package
148147

149-
### Plan Details
148+
### Plan Details {#plan-details}
150149

151150
This section shows details of the plan that applies to this environment:
152151

@@ -159,7 +158,7 @@ This section shows details of the plan that applies to this environment:
159158
* **Backup Storage** – total size available for database backup files
160159
* **Multi-AZ Enabled** – a **Yes** or **No** value indicating whether multiple availability zones are enabled
161160

162-
### License {#license)
161+
### License {#license}
163162

164163
The license overview contains the following information:
165164

@@ -173,7 +172,7 @@ On this tab, you can edit the model options for constants and scheduled events.
173172

174173
{{< figure src="/attachments/deployment/mendix-cloud-deploy/environments-details/model-options.png" class="no-border" >}}
175174

176-
### Scheduled Events
175+
### Scheduled Events {#scheduled-events}
177176

178177
In this section, you can view your configured scheduled events.
179178

@@ -193,7 +192,7 @@ Constants are used to define configuration values that can differ per environmen
193192

194193
To fill in a new value, select the constant and click **Edit** to bring up the **Edit Constant** dialog box.
195194

196-
{{< figure src="/attachments/deployment/mendix-cloud-deploy/environments-details/edit-constant.png" alt="Edit Constants Pop-up window" width="80%" >}}
195+
{{< figure src="/attachments/deployment/mendix-cloud-deploy/environments-details/edit-constant.png" width="80%" >}}
197196

198197
In the **Edit Constant** dialog box, you can change the constant value using the **New Value** field.
199198

@@ -266,7 +265,7 @@ The changes to the headers are implemented when the app is redeployed.
266265

267266
For more information about HTTP headers, see [MDN's HTTP headers overview](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
268267

269-
#### HTTP Response Headers Inserted Automatically
268+
#### HTTP Response Headers Inserted Automatically {#http-response-headers}
270269

271270
Mendix and the deployment environment automatically add some non-configurable response headers. These are listed below.
272271

@@ -285,7 +284,7 @@ Most browsers have additional security to ensure that iframes are only allowed w
285284
There can be additional issues when using cookies in iframes for end-users using the Safari browser. Resolving these issues is outside the control of Mendix. For more information, see [Full Third-Party Cookie Blocking and More](https://webkit.org/blog/10218/full-third-party-cookie-blocking-and-more/).
286285
{{% /alert %}}
287286

288-
##### Using Custom Domains
287+
##### Using Custom Domains {#custom-domains}
289288

290289
To avoid security issues when you want to embed the app in an iframe, use [custom domains](/developerportal/deploy/custom-domains/). This way, you can ensure that the app you want to embed is part of the same domain. For example, if your page is `mainpage.domain.name`, then the app embedded in the iframe should be `appname.domain.name`.
291290

@@ -304,7 +303,7 @@ For Mendix 8.11 and below, there was no `SameSite` value set on cookies, and the
304303
The `SAMESITE_COOKIE_PRE_MX812` setting is implemented the next time your app is deployed after you apply the change.
305304
{{% /alert %}}
306305

307-
##### Using Custom Sign-In Pages
306+
##### Using Custom Sign-In Pages {#custom-signin-details}
308307

309308
If you use a custom sign-in page, the `originURI` cookie is normally set in the *index.html* file. If your Mendix app runs within an iframe, set this cookie with the `SameSite=None` and `Secure` attributes.
310309

@@ -340,7 +339,7 @@ You can add or edit multiple different IP address and port combinations. Any ran
340339
* To edit a range, select an existing range and click **Edit**.
341340
* To delete a range, select an existing range, click **Delete**, and then confirm that you want to delete it.
342341

343-
#### Managing a Safelist Range
342+
#### Managing a Safelist Range {#safelist-range}
344343

345344
For each range where you define safelisted IP addresses and ports, you can enter the following information:
346345

@@ -387,7 +386,7 @@ You can **Delete** a path or you can **Add** and **Edit** a path with the follow
387386

388387
For more information, see [How to Restrict Access for Incoming Requests](/developerportal/deploy/access-restrictions/).
389388

390-
### Outgoing Connections Certificates
389+
### Outgoing Connections Certificates {#outgoing-connections-certificates}
391390

392391
Add client certificates (in the PKCS12 format) or certificate authorities (in the PEM format). These are used when your application initiates SSL/TLS connections.
393392

@@ -502,33 +501,39 @@ There are two types of maintenance:
502501
* Regular weekly maintenance (which does not affect your app), during which you can change the preferred maintenance window
503502
* Planned maintenance (which affects your app in some ways), about which you will automatically receive an email
504503

505-
### Preferred Maintenance Window
504+
### Preferred Maintenance Window {#preferred-maintenance-window}
506505

507506
You can view and change the preferred maintenance. For more information about maintenance, see [Maintenance Windows: Configuration](/developerportal/deploy/maintenance-windows/).
508507

509-
### Planned Maintenance
508+
### Planned Maintenance {#planned-maintenance}
510509

511510
When a maintenance operation is planned, it appears under **Planned Maintenance**. Each task card will show the purpose of the maintenance, when it is scheduled, and its status.
512511

513512
{{% alert color="info" %}}
514513
Maintenance topics (for example, "PostgreSQL 14 Upgrade") have a predefined period (start date and deadline). Once the start date is reached, you will get the option to execute it immediately, regardless of the Maintenance Window configured for the environment, by clicking **Execute Now**.
515514
{{% /alert %}}
516515

517-
The status of a maintenance task can be one of:
516+
The status of a maintenance task can be one of the following:
518517

519518
* **Succeeded** – the maintenance task was successful
520-
* **Failed** – the maintenance task failed and the environment requires intervention
521-
* Our engineering team will have been notified about the failed task. If you are still experiencing issues, please create a support ticket with [Mendix Support](https://support.mendix.com/hc/en-us)
522-
* **Incomplete** – the maintenance task was unsuccessful and no changes were applied
523-
* You can operate the environment as usual. Our engineering team will have been alerted about the incomplete task and will take the appropriate action (which may involve rescheduling the task)
524-
* **Ineligible** – the maintenance task was unsuccessful because one or more starting criteria were not met
525-
* You can operate the environment as usual. This can happen, for example, if the database of your environment was scheduled to be upgraded but it is already on the target version
519+
* No further action is required
520+
* **Failed** – the maintenance task was unsuccessful
521+
* The environment requires intervention and our engineering team has been notified, they will recover the environment according to its SLA. If you are still experiencing issues, please create a support ticket with [Mendix Support](https://support.mendix.com/hc/en-us)
522+
* **Incomplete** – the maintenance task was unsuccessful
523+
* No changes were applied, you can operate the environment as usual
524+
* Our engineering team has been alerted and will take the appropriate action, which may include rescheduling the task
525+
* **Ineligible** – the task is not applicable to the environment
526+
* No changes were applied, you can operate the environment as usual
527+
* This can happen, for example, if the database of your environment was scheduled to be upgraded but it is already on the target version
528+
* **Canceled** – the task was canceled
529+
* No changes were applied, you can operate the environment as usual
530+
* This can happen if circumstances required us to remove the planned task, a new copy of the task will be scheduled at a later point in time
526531

527532
{{% alert color="info" %}}
528533
The application's Technical Contact will automatically receive email notifications about planned maintenance.
529534
{{% /alert %}}
530535

531-
## The Tags Tab{#tags}
536+
## The Tags Tab {#tags}
532537

533538
You can set tags on your environment. Tags are arbitrary strings that are not interpreted by the Mendix Portal.
534539

@@ -551,10 +556,10 @@ The [Technical Contact](/developerportal/general/app-roles/#technical-contact) m
551556

552557
{{< figure src="/attachments/deployment/mendix-cloud-deploy/environments-details/services-tab.png" >}}
553558

554-
### Available Services
559+
### Available Services {#available-services}
555560

556561
One custom service is available: Mendix Event Broker. This service is required to use [Mendix Business Events](/appstore/services/business-events/) on production apps.
557562

558-
### Enabling Custom Services
563+
### Enabling Custom Services {#enabling-custom-services}
559564

560565
Custom services are only available if the app's Technical Contact has enabled them. The custom services are enabled or disabled separately for each environment of each app. For more information, see [Services](/developerportal/deploy/environments/#services) in the *Environments* documentation.

0 commit comments

Comments
 (0)