diff --git a/content/en/docs/deployment/sap-btp/_index.md b/content/en/docs/deployment/sap-btp/_index.md index b68c0f75dd5..73797165941 100644 --- a/content/en/docs/deployment/sap-btp/_index.md +++ b/content/en/docs/deployment/sap-btp/_index.md @@ -18,7 +18,7 @@ This document describes two ways of managing the SAP BTP: * Create a new environment for an existing app: see the section [Create a New Environment](#NewEnvironment) {{% alert color="info" %}} -Mendix applications can be deployed to Cloud Foundry regions on SAP Business Technology Platform, not to Neo regions. +You can deploy Mendix applications to Cloud Foundry regions on SAP Business Technology Platform, not to Neo regions. {{% /alert %}} ## Setting Up SAP BTP for the First Time {#FirstTime} @@ -71,7 +71,7 @@ Currently supported regions are: * US Central (IA) Beta * US East (VA) -Please contact Mendix Support if you have a requirement for an additional region. +Contact Mendix Support if you have a requirement for an additional region. {{% /alert %}} Make sure that you have enough quota in this region for your organization to run a Mendix app. You will need enough quota to create the following: @@ -80,30 +80,28 @@ Make sure that you have enough quota in this region for your organization to run * Route * Binding to XSUAA -{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/01-sap-select-region.png" class="no-border" >}} - If you have already logged on to SAP and your SAP session has not expired, you will only have to choose the region. If you do not have a current SAP session you will be asked for your SAP credentials as well. Providing your credentials will grant the Deployment Portal access to manage your SAP BTP account. You may be asked to provide your credentials in one of two ways: * You will be taken to the SAP authentication page to enter your credentials – in this case, your SAP user name (email address) must be the same as your Mendix user name -* The Mendix Portal will ask for your credentials, which it will then use to obtain an access token from SAP – the Mendix Portal will then use the access token, but it will not store your credentials (⚠ please note this method is being deprecated) +* The Mendix Portal asks for your credentials, which it will then use to obtain an access token from SAP – the Mendix Portal will then use the access token, but it will not store your credentials (⚠ Note that this method is being deprecated) {{% alert color="info" %}} -If you have issues using SAP authentication, please refer to the reference [SAP Single Sign-On](/developerportal/deploy/sap-cloud-platform/sap-single-sign-on/). +If you have issues using SAP authentication, refer to [SAP Single Sign-On](/developerportal/deploy/sap-cloud-platform/sap-single-sign-on/). {{% /alert %}} -You will now be asked to provide the final details for the SAP BTP development environment. +Provide the final details for the SAP BTP development environment. {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/create-development.png" class="no-border" >}} -You will be able to choose a Domain, Organization, and Space which is configured for you in this region. +Choose a **Domain**, **Organization**, and **Space** which is configured for you in this region. -If you do not choose a Custom database, you will still be able to choose from a range of different databases, PostgreSQL, Hyperscaler Option and SAP HANA for example. Please ensure that the database you choose is supported by your quota plan for this region and organization. See [Databases in SAP BTP](#databases), below, for important information on selecting the correct database for your app. +If you do not choose a **Custom database**, you can still choose it from a range of different databases, PostgreSQL, Hyperscaler Option, and SAP HANA, for example. Ensure that the database you choose is supported by your quota plan for this region and organization. See [Databases in SAP BTP](#databases) below for important information on selecting the correct database for your app. -If you select **Yes** for **Custom database?**, you will be asked for the **Name** and the **Plan**. +If you select **Yes** for **Custom database**, provide the details for the **Name** and the **Plan**. -After the environment has been created successfully, you will see a confirmation message. Your development environment is now configured and you ca develop your app. +After the environment has been created successfully, you will see a confirmation message. Your development environment is now configured and you can develop your app. ## Creating a New Environment {#NewEnvironment} @@ -111,75 +109,65 @@ You can create several environments for your app. For example, you may have crea You can do this in the **Environments** page after opening your app in [Apps](https://sprintr.home.mendix.com/). -{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/environments-page.png" class="no-border" >}} +{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/finish-environment.png">}} -Your Environments page will show you the following: +The **Environments** page shows you the following tabs: -* a list of **deployment packages** for this app -* a list of **environments** for this app -* all the deployment **activities** which have been performed on this app +* an **Oerview** of environments for this app +* a list of **Deployment Packages** for this app +* an overview of deployment **Activity** which have been performed on this app To create a new environment, perform the following steps: 1. Click **Add Environment** to start the wizard. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/add-environment.png" class="no-border" >}} - -2. Select the region where you want your app to be deployed. - - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/sap-env-0.png" class="no-border" >}} +2. Select the region where you want your app to be deployed. If no session is active for that region, or the current session does not have access to that region, you may need to enter your SAP credentials for that region. - If no session is active for that region, or the current session does not have access to that region, you will be asked for your SAP credentials for that region. - -3. Select the **Domain**, **Organization**, and **Space** of your app. The URL of the domain will form part of the application's URL. The URL of the application will be this: +3. Select the **CF Domain**, **Organization**, and **Space** of your app. The URL of the domain forms part of the application's URL. The URL of the application will be: ```text {appname}-{environment name}.{domain} ``` - This is an example URL: + An example URL is: ```http - https://myapp-development.cfapps.eu10.ondemand.com + https://myapp-development.cfapps.eu20.ondemand.com ``` - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/07-sap-env-1.png" class="no-border" >}} + {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/add-environment.png">}} 4. Click **Next**. -5. Enter the name of the environment. This can be anything you choose: for example Test, Acceptance, or Production. +5. Enter the name of the environment. This can be anything you choose, for example, Test, Acceptance, or Production. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/08-sap-env-2.png" >}} + {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/new-environment.png" >}} 6. Set the size of the memory that the app needs in order to run. This can also be changed later. -7. Set **Development Mode** to Yes if you want the application to run with the Mendix security level of Prototype/demo, or Off (no security). This is not recommended for acceptance or production environments. - -8. Select the database you would like to use. Be aware that even if a specific database is part of the Marketplace it could still be unavailable because of limitations imposed by the quota of your Organization. See [Databases in SAP BTP](#databases), below, for important information on selecting the correct database for your app. +7. Set **Development Mode** to *Yes* if you want the application to run with the Mendix security level of Prototype/demo, or *No* (no security). This is not recommended for acceptance or production environments. - If you choose **Custom database** you will need to enter a name for the database and the plan. +8. Select the database you would like to use. Be aware that even if a specific database is part of the Marketplace, it could still be unavailable because of limitations imposed by the quota of your organization. See [Databases in SAP BTP](#databases) below for information on selecting the correct database for your app. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/custom-database.png" class="no-border" >}} + If you choose **Custom Database**, enter a **Name** for the database and the **Plan**. -9. Select **File Store Enabled** if your application makes use of FileDocument or Image objects. Other sorts of object do not need File Store to be enabled. +9. Enable **ObjectStore** if your application makes use of file document or image objects. Other sorts of objects do not need File Store to be enabled. -10. To configure logging, select the **Logging** service you would like to use from the dropdown. +10. To configure logging, select the **Logging** service from the dropdown. - {{% alert color="info" %}} **Application Logs** has been the default logging service but will be deprecated soon. See [SAP Application Logging Service](https://help.sap.com/docs/application-logging-service/sap-application-logging-service/what-is-sap-application-logging-service) for more details on the deprecation of **Application Logs**. For older environments still using the **Application Logs** service, see the [Migrating from SAP Application Logging to SAP Cloud Logging](#migrating-cloud-logging) section below to ensure continued logging support.{{% /alert %}} + {{% alert color="info" %}} **application-logs** has been the default logging service but will be deprecated soon. See [SAP Application Logging Service](https://help.sap.com/docs/application-logging-service/sap-application-logging-service/what-is-sap-application-logging-service) for more details on the deprecation of **Application Logs**. For older environments still using the **Application Logs** service, see the [Migrating from SAP Application Logging to SAP Cloud Logging](#migrating-cloud-logging) section below to ensure continued logging support.{{% /alert %}} -11. Set a **Subscription Secret** (required). This secret is associated with your Mendix production license. By entering the subscription secret, your application will run in this environment as production. If the subscription secret is invalid, your app will still run, but will restart every 2-4 hours and have a limitation of six concurrent users. +11. Set a **Subscription Secret** (required). This secret is associated with your Mendix production license. By entering the subscription secret, your application runs in this environment as production. If the subscription secret is invalid, your app will still run, but will restart every 2-4 hours and have a limitation of six concurrent users. - {{% alert color="info" %}}If you do not have a subscription secret, refer to our documentation on [Obtaining a Mendix License](/developerportal/deploy/licensing-apps-outside-mxcloud/#get-license) in *Licensing Apps* for details on submitting a request to Mendix Support.{{% /alert %}} + {{% alert color="info" %}}If you do not have a subscription secret, refer to [Obtaining a Mendix License](/developerportal/deploy/licensing-apps-outside-mxcloud/#get-license) of *Licensing Apps* for details on submitting a request to Mendix Support.{{% /alert %}} -12. If you want the user to be redirected to a custom URL after they have logged in using XSUAA then, optionally, add **Redirect URLs**. +12. Optionally, you can add **Redirect URLs**, if you want the user to be redirected to a custom URL after they have logged in using XSUAA. 13. Click **Next** to create the environment and finish the setup. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/09-sap-env-3.png" class="no-border" >}} +An environment is created. With more than one environment created, you transport your application between environments. See [Transport App Between Environments](#TransportApp) below. -An environment is created; with more than one environment it is possible to transport your application between environments (see [Transport App Between Environments](#TransportApp), below). - -{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/10-sap-env-tap.png" class="no-border" >}} +{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/finish-environment.png">}} ## Preparing Packages for Deployment @@ -193,7 +181,7 @@ There are two ways of getting a package ready to deploy to SAP. At any time, you can create a new deployment package from a committed version of the project. If you are working with Mendix Studio Pro, you will first have to commit the project. {{% alert color="info" %}} -You can also deploy your app (the steps in sections 4 and 5.1 of this How-To) automatically from Studio Pro. However, you will then have less control over the deployment. +You can also deploy your app automatically from Studio Pro. However, you have less control over the deployment. If you click **Run** or **Publish** in Studio Pro, this will automatically do the following: @@ -206,44 +194,29 @@ If you click **Run** or **Publish** in Studio Pro, this will automatically do th You will still have to deploy your app in [Apps](https://sprintr.home.mendix.com/) the very first time to ensure that all the services are bound correctly. {{% /alert %}} -1. Open the app in [Apps](https://sprintr.home.mendix.com/). -2. Go to the **Environments** page. - - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/environments-page.png" class="no-border" >}} - -3. Click **Create package from Team Server** to start the wizard. - -4. Select the branch on the Team server which you want to use. +1. Open the app in [Apps](https://sprintr.home.mendix.com/). In the **Environments** page, select **Deployment Packages** tab. It shows the list of built packages. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/03-sap-select-branch.png" class="no-border" >}} + {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/deployment-packages.png">}} -5. Select the revision of the branch you want to build. +2. Click **Create a Package** and select the **Branch** on the Team server which you want to use. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/04-sap-select-revision.png" class="no-border" >}} +3. Select the **Revision** of the branch you want to build and go **Next**. -6. Add a version number and Tag description as required. The revision number will be added to the version number automatically. +4. Add a **New version** number and **Tag description** as required. The revision number will be added to the version number automatically. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/05-sap-define-tag.png" class="no-border" >}} - -7. Click **Build this revision** to build the package. - - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/06-sap-build-revision.png" class="no-border" >}} - -When the package is ready to be deployed, a green tick will be shown next to the deployment package. To deploy your package, follow the instructions in the [Deploy Package](#DeployPackage) section, below. +5. Click **Build this revision** to build the package. ### Uploading an MDA -Alternatively, you can upload an MDA which has already been created from the app model, for example using [Create Deployment Package](/refguide/create-deployment-package-dialog/) from the App menu in Studio Pro. +Alternatively, you can upload an MDA which has already been created from the app model, for example, using [Create Deployment Package](/refguide/create-deployment-package-dialog/) from the App menu in Studio Pro. -1. Click **Upload** in the **Deployment Package Repository**. +1. Click **Upload a Package** in the **Deployment Packages** tab. 2. Select the package accessible to your local machine. 3. Click **Upload** to upload the MDA. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/upload-mda.png" alt="Upload button and dialog for uploading MDAs" class="no-border" >}} - -The package will be added to the list of packages in the **Deployment Package Repository**. To deploy your package, follow the instructions in the [Deploy Package](#DeployPackage) section, below. +The package will be added to the list of packages in the **Deployment Packages**. To deploy your package, follow the instructions in the [Deploy Package](#DeployPackage) section below. {{% alert color="info" %}} There is a limit of 200 MB on the size of the MDA file you can upload to the Mendix Portal for SAP BTP deployment. @@ -257,19 +230,15 @@ SAP BTP [has a limit of 1.5 GB](https://help.sap.com/viewer/65de2977205c403bbc10 ### Deploying to an Environment -1. A green tick indicates that the build has finished. Click **Deploy** to deploy the package to SAP BTP. - - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/sap-revision-built.png" class="no-border" >}} +1. A green tick indicates that the build has finished. Click deploy icon to deploy the package to SAP BTP. 2. Change the deployment environment if required. - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/sap-transport.png" class="no-border" >}} - -3. The **Timeout** value indicates how long (in seconds) Cloud Foundry will wait between starting an app and the first healthy response from the app before deciding that the application has failed to start. For some apps, the default (60 seconds) is too short. If your app is failing to start you can try increasing this value using the **Change timeout** option. + {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/transport.png">}} - {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/sap-change-timeout.png" width="60%" class="no-border" >}} +3. The **Timeout (seconds)** value indicates how long Cloud Foundry will wait between starting an app and the first healthy response from the app before deciding that the application has failed to start. For some apps, the default (60 seconds) is too short. If your app is failing to start you can try increasing this value. -4. Click **Transport** to deploy the package to the SAP environment. This will replace any current app deployed to this environment. If the app is already running, you will be asked to stop it so that your new app can be deployed. +4. Click **Transport** to deploy the package to the SAP environment. This will replace any current app deployed to this environment. If the app is already running, you need to stop it so that your new app can be deployed. ### Configuring the Application {#ConfigureTheApplication} @@ -281,7 +250,7 @@ SAP BTP [has a limit of 1.5 GB](https://help.sap.com/viewer/65de2977205c403bbc10 {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/transport-constants.png" class="no-border" >}} -3. Toggle any scheduled events in the Scheduled Events tab: select the scheduled event you want to enable or disable and click **Toggle**. +3. Toggle any scheduled events in the Scheduled Events tab. select the scheduled event you want to enable or disable and click **Toggle**. {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/transport-events.png" class="no-border" >}} @@ -307,7 +276,7 @@ SAP BTP [has a limit of 1.5 GB](https://help.sap.com/viewer/65de2977205c403bbc10 If you want to remove a service instance from your environment, you can do it is follows: -1. Click the three-dot menu for the service and select **Unbind Service** or **Delete Service**. +1. Click the three-dot ({{% icon name="three-dots-menu-horizontal" %}}) menu for the service and select **Unbind Service** or **Delete Service**. {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/unbind-service.png" class="no-border" >}} @@ -322,11 +291,11 @@ If you want to remove a service instance from your environment, you can do it is {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/transport-environments.png" class="no-border" >}} -2. Change the deployment environment if required by clicking **Change environment**. +2. Change the deployment **Environment** if required. {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/transport-from-to.png" class="no-border" >}} -3. The **Timeout** value indicates how long (in seconds) Cloud Foundry will wait between starting an app and the first healthy response from the app before deciding that the application has failed to start. For some apps, the default (60 seconds) is too short. If your app is failing to start you can try increasing this value using the **Change timeout** option. +3. The **Timeout (seconds)** value indicates how long Cloud Foundry will wait between starting an app and the first healthy response from the app before deciding that the application has failed to start. For some apps, the default (60 seconds) is too short. If your app is failing to start you can try increasing this value. {{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/sap-change-timeout.png" width="60%" class="no-border" >}} @@ -363,7 +332,7 @@ Most of this page shows information about the app, but there are several options If the application is running, click **Stop Application** and confirm when asked to stop the application. -The button will change to **Start Application** which you can click to (re)start the application. +The button will change to **Start Application** which you can click to start or restart the application. {{% alert color="info" %}} You may need to use this option to stop and start your app after changing one of the settings on this page. diff --git a/static/attachments/deployment/sap-btp/sap-cloud-platform/add-environment.png b/static/attachments/deployment/sap-btp/sap-cloud-platform/add-environment.png index 26aff7989b8..8482c019c56 100644 Binary files a/static/attachments/deployment/sap-btp/sap-cloud-platform/add-environment.png and b/static/attachments/deployment/sap-btp/sap-cloud-platform/add-environment.png differ diff --git a/static/attachments/deployment/sap-btp/sap-cloud-platform/deployment-packages.png b/static/attachments/deployment/sap-btp/sap-cloud-platform/deployment-packages.png new file mode 100644 index 00000000000..b399f63f594 Binary files /dev/null and b/static/attachments/deployment/sap-btp/sap-cloud-platform/deployment-packages.png differ diff --git a/static/attachments/deployment/sap-btp/sap-cloud-platform/environments-page.png b/static/attachments/deployment/sap-btp/sap-cloud-platform/environments-page.png deleted file mode 100644 index c429abc7e5d..00000000000 Binary files a/static/attachments/deployment/sap-btp/sap-cloud-platform/environments-page.png and /dev/null differ diff --git a/static/attachments/deployment/sap-btp/sap-cloud-platform/finish-environment.png b/static/attachments/deployment/sap-btp/sap-cloud-platform/finish-environment.png new file mode 100644 index 00000000000..cb7e5e79b40 Binary files /dev/null and b/static/attachments/deployment/sap-btp/sap-cloud-platform/finish-environment.png differ diff --git a/static/attachments/deployment/sap-btp/sap-cloud-platform/new-environment.png b/static/attachments/deployment/sap-btp/sap-cloud-platform/new-environment.png new file mode 100644 index 00000000000..701a2e2980a Binary files /dev/null and b/static/attachments/deployment/sap-btp/sap-cloud-platform/new-environment.png differ diff --git a/static/attachments/deployment/sap-btp/sap-cloud-platform/transport.png b/static/attachments/deployment/sap-btp/sap-cloud-platform/transport.png new file mode 100644 index 00000000000..c5cc72d6299 Binary files /dev/null and b/static/attachments/deployment/sap-btp/sap-cloud-platform/transport.png differ