| title | url | weight | description | tags | |||
|---|---|---|---|---|---|---|---|
Environments |
/developerportal/deploy/environments/ |
5 |
Lists the environments in which your app is deployed. Also the starting point for managing existing environments and further deployments. |
|
You can use the Environments page to access information about your environments, deploy packages, manage certificates and access restrictions, and more. To access your app's Environments page, open your app in the Developer Portal and click Environments in the navigation pane.
The Environments page has the following tabs:
- Deploy
- Custom Domains
- Access Restriction Profiles
- Permissions
- Services
In the Deploy tab, you can view information about your environments. You can also create, upload, delete, and deploy packages.
The Deployment Package Repository section has an overview of your deployment packages.
{{< figure src="/attachments/developerportal/deploy/mendix-cloud-deploy/environments/deployment-package.png" alt="The Deployment Package Repository section" >}}
You can perform the following actions in this section:
- Use the Search field to search the deployment packages by name, version, or creator
- Click Upload to upload a deployment package from your local device
- Click Create Deployment Package to create a deployment package based on a specific branch
You can also see information and perform actions on the existing deployment packages. For each deployment package, the table contains the following details:
- Deployment package name
- Version of the deployment package
- Date that the deployment package was created
- Creator account
- Expiry date of the deployment package, if one is set
- Currently deployed packages do not expire. Among any non-deployed packages, the five most recently deployed packages do not expire.
- Expiry dates apply only to packages that do not meet either of two non-expiry criteria outlined above. These packages are set to expire and be deleted within 15 days, unless they are deployed before that date.
To deploy a package, transporting it from the Team Server to an environment where you can run your app, click Deploy ({{% icon name="deploy" %}}).
{{< figure src="/attachments/developerportal/deploy/mendix-cloud-deploy/environments/deploy-icon.png" alt="" >}}
If you click More Options ({{% icon name="three-dots-menu-horizontal" %}}) on a package, you can do the following:
- View details, including the package size, description, build output, and an overview of the environments that are running the package
- Delete the package
{{< figure src="/attachments/developerportal/deploy/mendix-cloud-deploy/environments/deployment-package-options.png" alt="More Options" >}}
The Environments section has an overview of all the available environments. The contents of the Environments section differ based on whether or not your node supports flexible environments.
For standard plans, your node has production and acceptance environments. It can also include an optional test environment.
For standard plans, the Environments section shows the following information:
- Environment name (Acceptance, Production, or Test)
- Environment status, indicated by the icon next to the environment name:
- {{% icon name="checkmark-circle-filled" color="green" %}} – the application in this environment is running
- {{% icon name="subtract-circle-filled" color="gray" %}} – no application has been started yet in this environment, or it has been turned off
- {{% icon name="remove-circle-filled" color="red" %}} – the application in this environment is unstable and probably not usable anymore {{% alert color="info" %}}The environment status is cached; there can be a delay of up to five minutes before the status icon displays a change of status. For information on the details of any alerts, see Alerts.{{% /alert %}}
- Name of the deployment package
- Version of the deployment package
- Runtime, the Studio Pro version with which the app was built
- URL of the app
You can perform the following actions in this section:
-
View an environment's details – Click Details ({{% icon name="notes-paper-edit" %}}) to go to the Environment Details page.
-
Transport an environment – If you have Transport rights enabled, you will see a More Options button ({{% icon name="three-dots-menu-horizontal" %}}) that you can click to stage an environment to acceptance or production.
{{< figure src="/attachments/developerportal/deploy/mendix-cloud-deploy/environments/transport-to.png" alt="" class="no-border" >}}
-
Set up deployment – If you are the Technical Contact, you will see a Setup Studio Pro Deployment button. You can use this to set the target environment to which apps are deployed from Studio Pro; for more information, see Studio Pro Deployment Settings.
If your Mendix license supports flexible environments, you can define the number and type of environments on your node. You must define at least two environments, one of which must be a production environment. The other environment (or environments) may be designated according to your requirements. For example, you can have a production environment and multiple staging environments if your deployment process requires it.
To convert a node with standard environments into one with flexible environments, or to add new environments to your flexible node, submit a request to Mendix Support. To rename existing environments, see Naming of Environments on the Environment Details page.
For flexible environments, the Environments section shows the following information:
- Environment status, indicated by the icon next to the environment name:
- {{% icon name="checkmark-circle-filled" color="green" %}} – the application in this environment is running
- {{% icon name="subtract-circle-filled" color="gray" %}} – no application has been started yet in this environment, or it has been turned off
- {{% icon name="remove-circle-filled" color="red" %}} – the application in this environment is unstable and probably not usable anymore {{% alert color="info" %}}The environment status is cached; there can be a delay of up to five minutes before the status icon displays a change of status. For information on the details of any alerts, see Alerts.{{% /alert %}}
- Name of the environment
- Version of the deployment package
- Runtime, the Studio Pro version with which the app was built
- Plan for the environment
- URL of the app
You can perform the following actions in this section:
-
Search for an environment – Find a specific environment using the Search field.
-
View an environment's details – Go to the environment's Details page by clicking Details ({{% icon name="notes-paper-edit" %}}).
-
Set up deployment – If you are the Technical Contact, you will see a Setup Studio Pro Deployment button. You can use this to set the target environment to which apps are deployed from Studio Pro; for more information, see Studio Pro Deployment Settings.
-
Reorder environments – If you are the Technical Contact, you can reorder the environments by clicking More Options ({{% icon name="three-dots-menu-horizontal" %}}) and selecting Move Up or Move Down.
{{< figure src="/attachments/developerportal/deploy/mendix-cloud-deploy/environments/reorder-environments.png" alt="Move Up and Move Down options" >}}
{{% alert color="info" %}}The button to transport an environment is not available when flexible environments are enabled. This is because you must choose your deployment target each time you deploy when you have flexible environments. To deploy, click Deploy ({{% icon name="deploy" %}}) in the Deployment Package Repository section, as described above.{{% /alert %}}
In the Activity section, you can view a log of deployment activities performed on your environments.
{{< figure src="/attachments/developerportal/deploy/mendix-cloud-deploy/environments/activity.png" alt="Sample activity log" >}}
{{% alert color="info" %}} Operations performed on a customer's behalf through an authorized Mendix support ticket are not logged in the activity log. {{% /alert %}}
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.
In 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 enables your Mendix app to be accessible via a secure connection. For more information, see Custom Domains.
In 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, see Restrict Access for Incoming Requests.
In the Permissions tab, the Technical Contact and other team members who have Manage Permissions enabled can manage various permissions to the environments for each team member. Team members who have a role with Cloud Access can view the permissions.
For details on managing node permissions, see Node Permissions.
In the Services tab, the Technical Contact can determine which custom services can be used in the app's environments.
One custom service is available: Mendix Event Broker. This service is required to use Mendix Business Events on production apps.
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, see the Services section of the Environment Details page.