Skip to content

Commit 6637125

Browse files
incorporating feeback on previous changes
1 parent cc9f6c1 commit 6637125

1 file changed

Lines changed: 71 additions & 59 deletions

File tree

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

Lines changed: 71 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,14 @@ The **Environment Details** page shows information about the selected environmen
2929

3030
## Actions {#actions}
3131

32-
On the top right side of the screen, there are buttons and a **More Options** menu that you can use to perform various actions. Some action buttons are visible when your app is running, some are visible when your app is stopped, and some are always visible.
32+
On the top right side of the screen, there are buttons and a **More Options** ({{% icon name="three-dots-menu-horizontal"%}}) menu that you can use to perform various actions. Some action buttons are visible when your app is running, some are visible when your app is stopped, and some are always visible.
3333

3434
{{% 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 %}}
3535

3636
{{< figure src="/attachments/deployment/mendix-cloud-deploy/environments-details-beta/actions.png" alt="The buttons and More Options menu" >}}
3737

38+
### Running App Actions
39+
3840
When your app is running, you can perform the following actions:
3941

4042
* **Deploy** – This deploys an application to the environment.
@@ -43,11 +45,13 @@ When your app is running, you can perform the following actions:
4345
* **More Options**:
4446
* **Show Logged in Users** – This shows all users who are logged in to your app.
4547
* **Change Admin Password** – This changes the password for the built-in [administrator](/refguide/administrator/) account. The new password is applied immediately, without the need for a restart, and forces the administrator to pick up any new [roles](/refguide/administrator/#user-role) assigned in the app deployment package.
46-
* **View Live Logs** – This shows a live log of your application. It is identical to the **View Live Log** action on the [Logs](/developerportal/operate/logs/) page.
48+
* **View Live Logs** – This shows a live log of your application and performs the same action as the **View Live Log** button on the [Logs](/developerportal/operate/logs/) page.
4749
* **Show Debugger Info** – 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/).
4850
* **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/).
4951

50-
When your app is stopped, you can perform these actions instead:
52+
### Stopped App Actions
53+
54+
When your app is stopped, you can perform these actions:
5155

5256
* **Deploy** – This deploys an application to the environment.
5357
* **Start App** – This starts the application.
@@ -59,29 +63,6 @@ When your app is stopped, you can perform these actions instead:
5963
During a [maintenance window](/developerportal/deploy/maintenance-windows/), you cannot start, restart, or stop your app.
6064
{{% /alert %}}
6165

62-
## The General Tab
63-
64-
In the **Application Status** section of the **General** tab, you can find the following information about your environment:
65-
66-
* **Status**
67-
* {{% icon name="checkmark-circle-filled" color="green" %}} – The application in this environment is running
68-
* {{% icon name="subtract-circle-filled" color="gray" %}} – No application has been started yet in this environment, or it has been turned off
69-
* {{% icon name="alert-circle-filled" color="yellow" %}} – The application in this environment is experiencing some difficulties; check the alerts page or logs for more information
70-
* {{% icon name="remove-circle-filled" color="red" %}} – The application in this environment is unstable and probably not usable anymore
71-
* **Project ID** – the unique identifier of the app
72-
* **Environment ID** – the unique identifier of the environment
73-
* **Running Since** – the date the app was started, if it is running
74-
* **Name** – the type of environment (Acceptance, Production, Test, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments)); for more information, see the [Naming of Environments](#naming) section below
75-
* **URL** – the URL of the app
76-
* **Custom Domains** – any [custom domains](/developerportal/deploy/custom-domains/) of the app; to add a new domain, click **Add Custom Domain**
77-
* **Studio Pro Target** – a **Yes** or **No** value indicating whether the environment is the designated deployment target from Studio Pro; for more information, see [Studio Pro Deployment Settings](/developerportal/deploy/studio-deployment-settings/)
78-
* **Java Version** – the JDK version selected for the MDA that is deployed to the environment
79-
* **Database Version** – the PostgreSQL version supporting the database
80-
* **Region** – the data center region where the app is hosted (for the full list of Mendix Cloud regions, see [Outgoing IP](/developerportal/deploy/mendix-ip-addresses/#outgoing))
81-
* **Data Backup Secondary Location** – the region where the backup is stored (for more information, see [Data Location](/developerportal/operate/backups/#data-location) in the *Backups* documentation)
82-
83-
At the bottom of the **General** tab, there are three additional sections, which are described in detail in the [Overviews](#overviews) section below.
84-
8566
#### Clearing an Environment {#clear-environment}
8667

8768
The **Clear Environment** button lets you clear your environment so that you can use it for another purpose. This option is only available if the environment is stopped.
@@ -106,25 +87,74 @@ To clear your environment, follow these steps:
10687
3. Confirm that you want to clear your environment by typing the indicated text (*clear database* or *clear model and database*, depending on which option you selected).
10788
4. Click **Clear Environment**.
10889

109-
### Naming of Environments – Flexible Environments in Mendix Cloud {#naming}
90+
## The General Tab
91+
92+
In the **General** tab, you can find four sections that provide information about the [application status](#application-status), [deployment package details](#deployment-package-details), [plan details](#plan-details), and [license](#license).
93+
94+
### Application Status
95+
96+
In the **Application Status** section of the **General** tab, you can find the following information about your environment:
97+
98+
* **Status**
99+
* {{% icon name="checkmark-circle-filled" color="green" %}} – The application in this environment is running
100+
* {{% icon name="subtract-circle-filled" color="gray" %}} – No application has been started yet in this environment, or it has been turned off
101+
* {{% icon name="alert-circle-filled" color="yellow" %}} – The application in this environment is experiencing some difficulties; check the alerts page or logs for more information
102+
* {{% icon name="remove-circle-filled" color="red" %}} – The application in this environment is unstable and probably not usable anymore
103+
* **Project ID** – the unique identifier of the app
104+
* **Environment ID** – the unique identifier of the environment
105+
* **Running Since** – the date the app was started, if it is running
106+
* **Name** – the type of environment (Acceptance, Production, Test, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments)); for more information, see the [Naming of Environments](#naming) section below
107+
* **URL** – the URL of the app
108+
* **Custom Domains** – any [custom domains](/developerportal/deploy/custom-domains/) of the app; to add a new domain, click **Add Custom Domain**
109+
* **Studio Pro Target** – a **Yes** or **No** value indicating whether the environment is the designated deployment target from Studio Pro; for more information, see [Studio Pro Deployment Settings](/developerportal/deploy/studio-deployment-settings/)
110+
* **Java Version** – the JDK version selected for the MDA that is deployed to the environment
111+
* **Database Version** – the PostgreSQL version supporting the database
112+
* **Region** – the data center region where the app is hosted (for the full list of Mendix Cloud regions, see [Outgoing IP](/developerportal/deploy/mendix-ip-addresses/#outgoing))
113+
* **Data Backup Secondary Location** – the region where the backup is stored (for more information, see [Data Location](/developerportal/operate/backups/#data-location) in the *Backups* documentation)
114+
115+
#### Naming of Environments – Flexible Environments in Mendix Cloud {#naming}
110116

111117
If you are the app's [Technical Contact](/developerportal/general/app-roles/#technical-contact), you can rename the environments.
112118

113119
To rename an environment, follow these steps:
114120

115-
1. Click **Change** next to the name of the environment
121+
1. Click **Change** next to the name of the environment.
116122
2. Enter the new name, which must meet the following requirements:
117-
* Consists of at least two characters
118-
* Consists of only alphanumeric characters and hyphens (`a-z`, `A-Z`, `0-9`, and `-`)
119-
* Does not begin or end with a hyphen
123+
* Consists of at least two characters.
124+
* Consists of only alphanumeric characters and hyphens (`a-z`, `A-Z`, `0-9`, and `-`).
125+
* Does not begin or end with a hyphen.
120126

121127
{{% alert color="info" %}}
122128
After you rename an environment, it may take up to 15 minutes before you can access an app via its URL. This is because the URL includes the name of the environment, and the old value needs to be removed from the DNS cache. It may take considerably longer for the change to be visible worldwide.
123129
{{% /alert %}}
124130

125-
### Scaling {#scaling}
131+
### Deployment Package Details
132+
133+
In this section, you can find information about the deployment package that is loaded into the environment:
134+
135+
* **Name** of the deployment package
136+
* **Version** of the deployment package
137+
* **Runtime** version of Mendix used to create the app
138+
* **Size (MB)** of the deployment package
139+
* **Upload Date** of the deployment package
140+
141+
### Plan Details
142+
143+
This section shows details of the plan that applies to this environment:
144+
145+
* **Name** – the type of plan associated with your license
146+
* **Instances** – the number and memory allocation of instances in the environment (for more information, see the [Scaling](#scaling))
147+
* **Memory** – the total allocated memory of the plan
148+
* **Database Plan Cores** – the CPU cores allocated to the database
149+
* **Database Plan Space** – the storage capacity of the database
150+
* **Database Plan Memory** – the database's RAM size
151+
* **File Storage** – available size for storing blobs
152+
* **Backup Storage** – total size available for database backup files
153+
* **Multi-AZ Enabled** – a **Yes** or **No** value indicating whether multiple availability zones are enabled
154+
155+
#### Scaling {#scaling}
126156

127-
To see the options for changing scaling, scroll to the **Instances** row in the **Plan Details** section of the **General** tab, and click **Scale**. This will open the **Change Scaling** dialog box, which includes two sliders that you can control:
157+
To see the options for changing scaling, click **Scale** on the **Instances** row. This will open the **Change Scaling** dialog box, which includes two sliders that you can control:
128158

129159
* Use the **Instances** slider to increase or decrease the number of instances
130160
* The instances are meant for improved resiliency and increased processing power
@@ -135,29 +165,11 @@ The **Total Allocated Memory** is represented by a progress circle that shows ho
135165

136166
{{% alert color="info" %}}The maximum value for **Memory per instance** equals the **Total Allocated Memory** of your plan, and it cannot exceed 32 GiB. The maximum number of instances depends on the **Memory per instance** you have chosen; the maximum number of instances equals the total allocated memory divided by the memory per instance.{{% /alert %}}
137167

138-
If you have 1 GiB RAM of total allocated memory, you have one instance available to store your memory. To scale your memory over multiple instances, you need more memory.
168+
If you have 1 GiB RAM of total allocated memory, you have one instance to use your memory. To scale your memory over multiple instances, you need more memory.
139169

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

142-
### Overviews {#overviews}
143-
144-
In addition to the **Application Status** section in the **General** tab, there are three more sections showing the deployment package details, plan details, and license.
145-
146-
#### Deployment Package Details
147-
148-
In this section, you can find information about the deployment package that is loaded into the environment:
149-
150-
* **Name** of the deployment package
151-
* **Version** of the deployment package
152-
* **Runtime** version of Mendix used to create the app
153-
* **Size (MB)** of the deployment package
154-
* **Upload Date** of the deployment package
155-
156-
#### Plan Details
157-
158-
This section shows details of the plan that applies to this environment.
159-
160-
#### License
172+
### License
161173

162174
The license overview contains the following information:
163175

@@ -181,7 +193,7 @@ To fill in a new value, select the constant and click **Edit** to bring up the *
181193

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

184-
You can also set **Mask** to **Yes** to change the display settings for **Current Value** and **New Value**. When masking is enabled, all screens in the Mendix Portal (and in Excel if you export the constants) conceal these values and display asterisks in their place. This keeps your constants secret from users with no edit rights.
196+
You can also set **Mask** to **Yes** to change the display settings for **Current Value** and **New Value**. When masking is enabled, all screens in the Mendix Portal (and in Excel if you export the constants) conceal their values and display asterisks in their place. This keeps your constants secret from users with no edit rights.
185197

186198
{{% alert color="info" %}}
187199
For the changes to take effect, you must restart your application.
@@ -494,7 +506,7 @@ Click **Add** and select **Supported** to choose from the following variables:
494506
* The value of this variable is in the format `Module.Entity.Attribute`, where `Module` is the module of your app that contains the `Entity` that is a specialization of `System.User` and `Attribute` is the attribute that contains the email address of the user.
495507
* If you have multiple specializations of `System.User`, you can specify the values in comma-separated format (that is, `Module1.Entity1.Attribute1,Module2.Entity2.Attribute2,…,ModuleN.EntityN.AttributeN`). In the following example, there are two specializations identified: `Administration.Account.Email,MendixSSO.MendixSSOUser.EmailAddress`.
496508

497-
Unsupported environment variables can only be used to control Mendix beta features. To configure an unsupported variable, click **Add** and select **Unsupported**. If you are participating in using a beta feature, you will be informed what **Name** and **Value** to enter.
509+
Unsupported environment variables can only be used to control Mendix beta features. To configure an unsupported variable, click **Add** and select **Unsupported**. If you are using a beta feature, you will be informed what **Name** and **Value** to enter.
498510

499511
## The Maintenance Tab {#maintenance-tab}
500512

@@ -523,9 +535,9 @@ The status of a maintenance task can be one of:
523535

524536
* **Succeeded** – the maintenance task was successful
525537
* **Failed** – the maintenance task failed and the environment requires intervention
526-
* Our engineering team has already 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)
538+
* 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)
527539
* **Incomplete** – the maintenance task was unsuccessful and no changes were applied
528-
* You can operate the environment as usual. Our engineering team has received an alerted about the incomplete task and will take the appropriate action (which may involve rescheduling the task)
540+
* 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)
529541
* **Ineligible** – the maintenance task was unsuccessful because one or more starting criteria were not met
530542
* 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
531543

@@ -550,9 +562,9 @@ If you want to add, edit, or delete a tag, make the change on the **Tags** tab a
550562

551563
## The Services Tab {#services}
552564

553-
In the **Services** tab, the [Technical Contact](/developerportal/general/app-roles/#technical-contact) decides which custom services to be used in each environment of the app. You can then enable and disable these services for individual environments of your app.
565+
In the **Services** tab, the [Technical Contact](/developerportal/general/app-roles/#technical-contact) decides the custom services for each environment. You can then enable and disable these services for individual environments as needed.
554566

555-
Note that a service must first be enabled for the app by the [Technical Contact](/developerportal/general/app-roles/#technical-contact) before it can be used. For more information, see [Services](/developerportal/deploy/environments/#services).
567+
The [Technical Contact](/developerportal/general/app-roles/#technical-contact) must first enable a service for the app before you can use it. For more information, see [Services](/developerportal/deploy/environments/#services).
556568

557569
{{< figure src="/attachments/deployment/mendix-cloud-deploy/environments-details-beta/services.png" >}}
558570

0 commit comments

Comments
 (0)