Environments and Deployment
Introduction
You can use the Environments page to access information about your environments, deployment packages, manage certificates and access restrictions, and more.
To access your app’s Environments page, go to Apps and click Environments on your app. You can also directly visit the Environments page using this link: https://cloud.home.mendix.com/link/deploy/
APP_ID
, with APP_ID
replaced by your project ID.
Available Tabs
The Environments page has the following tabs:
- Overview
- Deployment Packages
- Permissions
- Activity
- Request Overview
Overview Tab
On the Overview tab, you can view the environment information and perform actions on your environments.
The most recent deployment package is shown in a banner at the top of the page, along with a button to deploy it.
Environment Information
You can see the following details for each environment shown in the Overview tab:
- The environment’s name
- The Studio Pro Target ( ) – This is displayed if the environment is the designated Studio Pro target. For more information, see Studio Pro Deployment Settings.
- Licensed badge – This is displayed if the environment is licensed.
- The environment’s status:
- – The application in this environment is running.
- – No application has been started yet in this environment, or the application has been turned off.
- – The application in this environment is experiencing some difficulties. Check the alerts page or logs for more information.
- – The application in this environment is unstable and probably not usable anymore.
- The date and time the app was started, if it is running. This is set in the user’s time zone.
- The version of the deployment package
- The name of the deployment package
Environment Actions
You can perform the following actions on your environments:
- Deploy ( ) – Launch the Deploy wizard, where you can configure and start a new deployment for the selected environment.
- View Details ( ) – Access the Environment Details page.
- View App – Launch the app in a new browser tab.
- More Options (
):
- Restart – Stop the running app and restart. Restarting your app is required for applying new constant values or scheduled events to the environment.
- Start – Start a stopped app.
- Live Log – Display a live log for your app. This option performs the same action as the View Live Log button on the Logs page.
- Debugger Info – Display 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.
- Running Now – Monitor all actions that are currently running in your environment. For more information, see Running Now.
- Logged In Users – Display all users who are logged in to your app.
- Stop – Stop the app.
To view more information about each environment such as its environment resources and the deployed package, use the Expand ( ) toggle on the environment.
Environment Resources
In the environment resources section, you can view the following information:
- The environment ID
- The deployment region
- The cloud resource pack
Additionally, you can perform the following actions:
- Scale the environment by clicking Scale.
- Change the resource pack by clicking Change Plan. For more information on how to change plans on your Mendix Cloud, refer to Changing Plans.
Deployed Package
These are the details you can view about the package currently deployed to the environment:
- The package name
- The package version
- The package runtime
You can promote the package to another environment by clicking Promote.
Environment Settings
If you are the Technical Contact, you can use Environment Settings (
) to choose the default target for the deployment package. If you do not select a target, the .mda
packages is built and uploaded without being deployed.
Deployment Packages Tab
On the Deployment Packages tab, you can view information about your deployment packages.
You can also perform the following actions on this tab:
- Use the Search field to search the deployment packages by name or version
- Click Upload a Package to upload a deployment package from your local device
- Click Create a Package to create a deployment package based on a specific branch
Deployment Package Details
For each deployment package, the table contains the following details:
- Deployment status
- Deployment package name
- Deployment label, for packages that are deployed
- Version of the deployment package
- Date that the deployment package was uploaded
- Uploader account
- Expiry date of the deployment package. If an expiry date is set:
- Currently deployed packages do not expire
- Among any non-deployed packages, the five most recently deployed packages do not expire
- Packages that do not meet either of the non-expiry criteria outlined above are assigned an expiry date and will be deleted within 15 days, unless deployed before that date
On a package:
- Launch the Deploy wizard by clicking the Deploy ( ) icon
- Click More Options (
) to:
- View details, including the package size, description, build output, and an overview of the environments that are running the package
- Download the package
- Delete the package
Creating a Package
The Create a Package wizard walks you through creating deployment packages. To use the wizard, follow these steps:
- On the Deployment Packages tab, click Create a Package. This launches the Create Package wizard.
- On the Select Branch tab, select the branch on which to base the build.
- On the Select Revision tab, select the branch revision on which to base the package.
- On the Choose a Tag tab, specify the version tag. This includes the major, minor, and patch version numbers.
- Click Build this revision.
Uploading a Package
Click Upload a Package on the Deployment Packages tab to select an existing package from your computer.
Deploying a Package
Follow these steps to deploy packages to selected environments using the Deploy or Promote wizard:
- Launch the wizard by choosing one of the following options:
- Select an environment to which you want to deploy a package by clicking the Deploy ( ) icon on the Overview tab.
- Select a package that you want to deploy by clicking the Deploy ( ) icon on the Deployment Packages tab, or by clicking Promote by a package name on the Overview tab.
- Perform one of the following actions, depending on whether you selected the package or the environment first:
- If you launched the wizard by selecting an environment, the first screen of the wizard is the Select Package tab. Use it to select a package from the repository.
- If you launched the wizard by selecting a package, the first screen of the wizard is the Select Environment tab. Use it to select the target environment for your package.
- On the Configure Environment tab, review the new constant values, and adjust them as required.
- In the Other Options tab, choose whether to stage the package without deploying, and when to create the backup: either before or after deploying the new package. The app is unavailable while the backup runs.
- On the Deploy tab, review the deployment settings:
- To see an overview of the configuration for this deployment, click View Summary. This summary displays the selected package, selected backup option, and any changed constants or scheduled events.
- Review this summary, then click Deploy Now.
Permissions Tab
On the Permissions tab, the Technical Contact and other team members who have Manage Permissions enabled can manage various environment permissions for each team member. Team members who have a role with Cloud Access can view the permissions.
For details on managing node permissions, refer to Node Permissions.
Activity Tab
On the Activity tab, you can view a log of deployment, backup, and permission activities performed on your environments.
If you are the Technical Contact, you can download a copy of the activity log by following these steps:
- Click Download to CSV. This button is only visible if you are the Technical Contact.
- Select the period for which you want to download log entries.
- Click Download.
Request Overview Tab
On the Request Overview tab, the Technical Contact can view details of all past and current Change Plan requests and perform certain actions based on the current request status.
For each submitted plan change request you can see the following information:
- Request Type – Type of change requested
- Environment – The environment the plan change was requested for (such as, acceptance or production)
- Current Plan – The environment’s existing plan
- Requested Plan – The plan requested for change
- Submitted on – Request submission date
- Status – Current request state. This can be:
- Pending approval – Awaiting Mendix Admin review
- Pending schedule – Approved by Mendix Admin, but plan change application not yet scheduled by the Technical Contact
- Scheduled – Plan change scheduled for the next maintenance window
- In progress – Plan change is being applied
- Completed – Mendix Admin has approved the change, Technical Contact has scheduled and applied the changes, and the new plan has been successfully applied to the environment
- Rejected – Request was denied
- Failed – Plan change did not complete successfully
- Action – Shows more details of each plan request and provides options based on the request status. For more information, see Request Overview Action
Request Overview Action
Click Details on any request to view the name of the requester and the reviewer and other request details, including:
- Status of the request
- Current plan
- Requested plan
- Reasons for resizing
- Date of request creation
- Date the request was scheduled
- Request ID
- Request type
- App name
- Environment
For more information, refer to the Available Actions by Status section in Changing Your Plan in Mendix Cloud.
Cloud Settings
If you click Cloud Settings ( ) from any tab, you can adjust the custom domains, access restriction profiles, and services.
Custom Domains
On the Custom Domains tab, you can manage your custom domain certificates at the application level. You can also see an overview of linked custom domains.
When you need your Mendix app to be accessible via your own URL (for example, https://myapp.mycompany.com/
), you must provide a custom SSL/TLS certificate for your domain. This ensures a secure connection to your Mendix app. For more information, refer to Custom Domains.
Access Restriction Profiles
On the Access Restriction Profiles tab, you can manage custom access restriction profiles. These profiles can combine IP range filters and client certificate verification, so that any match on either the IP range or the client certificate will grant access. You can apply access restriction profiles to path-based access restrictions in specific environments of the application.
For details on setting up access restriction profiles, refer to Restrict Access for Incoming Requests.
Services
On the Services tab, the Technical Contact can determine which custom services can be used in the app’s environments.
Available Services
One custom service is available: Mendix Event Broker. This service is required to use Mendix Business Events on production apps.
Enabling Custom Services
The Technical Contact can only see services that have been licensed for their company. If the Technical Contact cannot enable the service, this means that the service has previously been licensed, but the license has expired.
Team members who have a role with Cloud Access can see which services are enabled or disabled.
Once a service has been enabled for an app, Technical Contacts can selectively enable it for each environment. For more information, refer to the Services section of the Environment Details page.