diff --git a/docs/10-concepts/cloud-foundry-environment-9c7092c.md b/docs/10-concepts/cloud-foundry-environment-9c7092c.md index f77eab89..21c23a57 100644 --- a/docs/10-concepts/cloud-foundry-environment-9c7092c.md +++ b/docs/10-concepts/cloud-foundry-environment-9c7092c.md @@ -108,11 +108,13 @@ The following technical configurations are specific to SAP BTP and differ from t - In the SAP BTP, Cloud Foundry environment, for both HTTP Request Headers and HTTP Response Headers the total amount of Headers is limited to 101. +- In the SAP BTP, Cloud Foundry environment, the limit of concurrent HTTP connections between client and application is 3000 per application container. + - In the SAP BTP, Cloud Foundry environment, the HTTP `keep-alive` timeout towards the client is set to 60s to protect against misuse. 60s is the maximum time span allowed to wait for a new HTTP request to appear if `keep-alive` is enabled. - In the SAP BTP, Cloud Foundry environment, an internal HTTP `keep-alive` is set to 90s. A higher value must be set on application-side to avoid intermittent disruptions. For more information, see step 4 of [3406978](https://me.sap.com/notes/3406978). -- In the Cloud Foundry environment, there’s a logging rate limit to guard against malicious applications. The limit is in the range of up to a few thousand logs per second per application instance. If this limit is exceeded, additional logs from the application instance are dropped and a warning message is injected into the application instance’s log stream every second. This message also contains the exact log rate limit. +- In the Cloud Foundry environment, there’s a logging rate limit to guard against malicious applications. If this limit is exceeded, additional logs from the application instance are dropped and a warning message is injected into the application instance’s log stream every second. This message also contains the exact log rate limit. - Applications requiring sent envelopes to be delivered to external Log Management Services should use the Cloud Foundry syslog drain capability. See [https://docs.cloudfoundry.org/devguide/services/log-management.html](https://docs.cloudfoundry.org/devguide/services/log-management.html). @@ -195,7 +197,7 @@ The SAP BTP Cloud Foundry environment follows these recommendations to support h For more information on high availability configuration, see [High Availability in Cloud Foundry](https://docs.cloudfoundry.org/concepts/high-availability.html#overview). - For more information on application stability and resilience, see [Develop Resilient Applications](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/b1b929a5aea64571b2f74e810b622568.html "Our best practices about resilient application design help you to make your applications running on SAP BTP stable and highly available.") :arrow_upper_right:. + For more information on application stability and resilience, see . @@ -418,3 +420,493 @@ Blog about Cloud Foundry + + + + +## Commercial Information for Cloud Foundry Runtime + +This page explains the relationship between the service plans in the SAP Discovery Center and those in the SAP BTP cockpit, and provides information to help you understand how the service is billed. + + + + + + + +## Service + + + +### Overview + +The diagram below shows how the service plans listed in the [SAP Discovery Center](https://discovery-center.cloud.sap/serviceCatalog/cloud-foundry-runtime?region=all&tab=service_plan) correspond to the plans you choose in the [SAP BTP cockpit](https://cockpit.btp.cloud.sap), depending on the commercial model of your enterprise global account. For more information about the commercial models offered by SAP, see [Commercial Models](commercial-models-263d400.md). + +![A diagram depicting the relationship between service plans in the SAP Discovery Center, service plans in the SAP BTP cockpit, environment plans in the SAP BTP cockpit, and the metric GB Memory. Consumption-based commercial model, line 1 of 2: Service Plan (SAP Discovery Center) - Standard; Service Plan (SAP BTP Cockpit) - not applicable; Environment Plan (SAP BTP Cockpit) - standard; Metrics - GB Memory; SKU - 8008837. Consumption-based commercial model, line 2 of 2: Service Plan (SAP Discovery Center) - Free; Service Plan (SAP BTP Cockpit) - free (Environment); Environment Plan (SAP BTP Cockpit) - free; Metrics - GB Memory; SKU - 8011138. Subscription-based commercial model, line 1 of 1: Service Plan (SAP Discovery Center) - Standard; Service Plan (SAP BTP Cockpit) - MEMORY, the plan is associated with a standalone service Cloud Foundry Runtime (technical name: APPLICATION_RUNTIME); Environment Plan (SAP BTP Cockpit) - standard; Metrics - GB Memory; SKU - 8008837.](images/SAP_BTP_Cloud_Foundry_Runtime_Commercial_Information_Plans_-_2024_V2_67db7c4.png) + + + +### Diagram captions: Service plans and environment plans in SAP BTP cockpit \[Show/Hide\] + + +
+
+ +Service Plan \(SAP BTP Cockpit\) + +
+
+ +The plan that the global account administrator can assign to a subaccount or a directory on the *Entitlements* page by choosing *Edit* \> *Add Service Plans*. + +**Screenshot: Assigning a service plan to a subaccount in SAP BTP cockpit \[Show/Hide\]** + +> ### Tip: +> Open image in new tab for the full-screen version. + +![A screenshot of the Entitlements screen in the SAP BTP cockpit, showing the assignment of a service plan to a subaccount.](images/English_-_Entitlements_-_SAP_BTP_Cloud_Foundry_Runtime_94337c9.png "Screenshot: Assigning a service plan to a subaccount in SAP BTP + cockpit [Show/Hide]") + +For more information about the procedure, see [Configure Entitlements and Quotas for Subaccounts](../50-administration-and-ops/configure-entitlements-and-quotas-for-subaccounts-5ba357b.md) or [Configure Entitlements and Quotas for Directories](../50-administration-and-ops/configure-entitlements-and-quotas-for-directories-37f8871.md). + + + +
+ +Environment Plan \(SAP BTP Cockpit\) + +
+
+ +The plan that the subaccount administrator can select on the *Overview* page of a subaccount when choosing *Enable Cloud Foundry*. + +**Screenshot: Selecting an environment plan for the subaccount in SAP BTP cockpit \[Show/Hide\]** + +> ### Tip: +> Open image in new tab for the full-screen version. + +![A screenshot of the Overview screen of a subaccount in the SAP BTP cockpit, showing the enablement of an environment plan.](images/English_-_Enable_Cloud_Foundry_-_SAP_BTP_Cloud_Foundry_Runtime_0377151.png "Screenshot: Selecting an environment plan for the subaccount in SAP BTP + cockpit [Show/Hide]") + +For more information about the procedure, see [Create Orgs](../50-administration-and-ops/create-orgs-a9b1f54.md). + +> ### Note: +> An environment plan is a service plan associated with an environment. For more information about services and service plans, see [Entitlements and Quotas](entitlements-and-quotas-00aa2c2.md). + + + +
+
+ + + +### Service Plans + +The tables below provide details about the plans for SAP BTP, Cloud Foundry runtime. They can give you more context for understanding the diagram in the **Overview** section. + +**Table 1: Plans for Consumption-Based Commercial Model \[Show/Hide\]** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Service Plan \(SAP Discovery Center\) + + + +Service \(SAP BTP Cockpit: *Entitlements*\) + + + +Service Plan \(SAP BTP Cockpit: *Entitlements*\) + + + +Environment Plan \(SAP BTP Cockpit: *Enable Cloud Foundry*\) + + + +Explanation + +
+ +Standard + + + +\- + + + +\- + + + +standard + + + +This is a **paid** plan for productive use. In the consumption-based commercial model, you are charged based on how much runtime memory has been consumed by your applications running in the Cloud Foundry environment. For details, see [Service Specifics](cloud-foundry-environment-9c7092c.md#loio8d41fa40e47b45bf90d38e393a989c4c__service_specifics). + +> ### Caution: +> With this plan, you get a technical quota of 200 GB of runtime memory per Cloud Foundry org. This doesn't mean that you can use the runtime memory for free. The technical quota represents a **limit** on how much runtime memory all the spaces in the org can use at any given time. To increase this limit, create a case on the [SAP Support Portal](https://support.sap.com) using the component `BC-NEO-CIS`. + +The plan is available for all subaccounts by default and can be enabled by a subaccount administrator. + +
+ +Free + + + +Cloud Foundry Environment \(`cloudfoundry`\) + + + +free \(Environment\) + + + +free + + + +This is a **free tier** plan that allows you to try out and evaluate the service. For more information, see [Using Free Service Plans](using-free-service-plans-524e108.md). + +With this plan, you get a free quota of runtime memory for your Cloud Foundry org. The amount of such free quotas per global enterprise account is limited. + +The plan must be assigned to the subaccount by a global account administrator \(or a directory administrator\), before it can be enabled by a subaccount administrator. + +> ### Note: +> Only community support is available for free tier service plans and these are not subject to SLAs. Use of free tier service plans is subject to additional terms and conditions as provided in the [Business Technology Platform Supplemental Terms and Conditions](https://www.sap.com/about/trust-center/agreements/cloud/cloud-services.html?sort=latest_desc&search=Supplement%20Business%20Technology%20Platform&tag=language%3Aenglish&pdf-asset=c8e624f5-bc7e-0010-bca6-c68f7e60039b&page=1). + + + +
+ +See [SAP Build Code](https://discovery-center.cloud.sap/serviceCatalog/sap-build-code?region=all&tab=service_plan) + + + +Cloud Foundry Environment \(`cloudfoundry`\) + + + +build-code + + + +build-code + + + +This plan is only for using the SAP BTP, Cloud Foundry runtime as part of SAP Build Code. For more information, see [What Is SAP Build Code](https://help.sap.com/docs/build_code/d0d8f5bfc3d640478854e6f4e7c7584a/504854f457cc4fbf9f79136dbc773618.html). + +> ### Note: +> The plan is not depicted on the diagram in the **Overview** section. + + + +
+ +**Table 2: Plans for Subscription-Based Commercial Model \[Show/Hide\]** + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Service Plan \(SAP Discovery Center\) + + + +Service \(SAP BTP Cockpit: *Entitlements*\) + + + +Service Plan \(SAP BTP Cockpit: *Entitlements*\) + + + +Environment Plan \(SAP BTP Cockpit: *Enable Cloud Foundry*\) + + + +Explanation + +
+ +Standard + + + +Cloud Foundry Runtime \(`APPLICATION_RUNTIME`\) + + + +MEMORY + + + +standard + + + +This is a **paid** plan for productive use. In the subscription-based commercial model, you pay for runtime memory quota in advance. + +The runtime memory quota purchased with your subscription must be entitled to subaccounts through the service plan MEMORY. This service plan is associated with the service Cloud Foundry Runtime \(`APPLICATION_RUNTIME`\), which is specific to the subscription-based commercial model. + +The plan **standard** is available for all subaccounts by default and can be enabled by a subaccount administrator. The runtime memory quota can be entitled to the subaccount only by a global account administrator \(or a directory administrator\). These steps are independent, but both of them are required to run applications in the Cloud Foundry environment. + +
+ +See [SAP Build Code](https://discovery-center.cloud.sap/serviceCatalog/sap-build-code?region=all&tab=service_plan) + + + +Cloud Foundry Environment \(`cloudfoundry`\) + + + +build-code + + + +build-code + + + +This plan is only for using the SAP BTP, Cloud Foundry runtime as part of SAP Build Code. For more information, see [What Is SAP Build Code](https://help.sap.com/docs/build_code/d0d8f5bfc3d640478854e6f4e7c7584a/504854f457cc4fbf9f79136dbc773618.html). + +> ### Note: +> The plan is not depicted on the diagram in the **Overview** section. + + + +
+ + + +
+ +## Metrics + +The table below provides details about the metrics for SAP BTP, Cloud Foundry runtime. It includes the names of services, with which the metrics are associated on the pages *Usage* accessed from the global account level\) and *Usage Analytics* \(accessed from the subaccount level\) in the SAP BTP cockpit. + + + + + + + + + + + + + + + + + + + + +
+ +Service + + + +Metric + + + +Definition + + + +Additional Information + +
+ +Cloud Foundry Runtime + + + +GB Memory + + + +Temporary memory bank where computers store data that needs to be retrieved and processed quickly. + +The memory represents the size of the data that can be processed and CPU represents the speed at which the data can be retrieved. + + + +For billing purposes, the metric GB Memory is calculated as the total hourly usage of Cloud Foundry runtime memory across all spaces in the global account over a calendar month, divided by 730 hours and rounded up to the next full GB. For an example of such calculation, see [Consumption Monitoring](https://help.sap.com/docs/cf-runtime/cloud-foundry-runtime/monitoring-and-troubleshooting?version=Cloud#consumption-monitoring). + +> ### Note: +> In the Cloud Foundry environment, applications get a guaranteed CPU share of ¼ core per GB of runtime memory quota reserved for an application instance. For more information, see [SAP BTP-Specific Configurations](cloud-foundry-environment-9c7092c.md#loio9809fa4f02cb4696baea5c23d6eaac94). + + + +
+ +SAP Build Code + + + +CF Runtime + + + +The metric CF Runtime is intended only for monitoring the usage of SAP BTP, Cloud Foundry runtime when it's used as part of SAP Build Code. For more information, see [What Is SAP Build Code](https://help.sap.com/docs/build_code/d0d8f5bfc3d640478854e6f4e7c7584a/504854f457cc4fbf9f79136dbc773618.html). + +> ### Note: +> The metric is not depicted on the diagram in [Service](cloud-foundry-environment-9c7092c.md#loio8d41fa40e47b45bf90d38e393a989c4c__service). + + + +
+ + + +
+ +## Service Specifics + +In the context of SAP BTP, Cloud Foundry runtime, the terms **consumption** \(or **consume**\) and **usage** \(or **use**\) refer to the runtime memory quota **reserved** by the platform for each application instance. This quota serves as the basis for calculating the billable consumption, as explained in [Consumption Monitoring](https://help.sap.com/docs/cf-runtime/cloud-foundry-runtime/monitoring-and-troubleshooting?version=Cloud#consumption-monitoring). + +> ### Caution: +> From a billing standpoint, it doesn't matter how much of the reserved runtime memory quota is utilized when the application is running. Billable consumption is calculated based on the full amount of runtime memory reserved, regardless of how much runtime memory actually gets utilized. + +> ### Note: +> If an application is stopped, it doesn't reserve any runtime memory and, therefore, doesn't contribute to runtime memory consumption. + +There are two application settings that define how much runtime memory an application uses at any given time: + +- Runtime memory quota reserved for each application instance \(default: 1024 MB\) + +- Number of running application instances \(default: 1\) + + +You can specify custom values for these settings when deploying an application in the Cloud Foundry environment. You can also change them for an application that has already been deployed without having to redeploy it. + + + +### How to set runtime memory quota and number of instances when deploying applications + +- **Option 1:** Create a manifest YAML file and specify the following application attributes: + + - memory: runtime memory quota per application instance + - instances: number of application instances + + For more information about the manifest formatting, see [https://docs.cloudfoundry.org/devguide/deploy-apps/manifest-attributes.html](https://docs.cloudfoundry.org/devguide/deploy-apps/manifest-attributes.html). + + You can then deploy your application with the manifest in one of two ways: + + - Using the SAP BTP cockpit: [Deploy an Application](../50-administration-and-ops/deploy-an-application-09fdb9b.md) + - Using the Cloud Foundry CLI: [https://docs.cloudfoundry.org/devguide/deploy-apps/manifest.html](https://docs.cloudfoundry.org/devguide/deploy-apps/manifest.html) + +- **Option 2:** In the SAP BTP cockpit, choose *Deploy Application*, deselect *Use Manifest* and specify the following: + + - *Instance Memory \(MB\)*: runtime memory quota per application instance + - *Number of Instances*: number of application instances + + For more information about the procedure, see [Deploy an Application](../50-administration-and-ops/deploy-an-application-09fdb9b.md). + +- **Option 3:** In the Cloud Foundry CLI, use the command `cf push` with the following flags: + + - `-m`: runtime memory quota per application instance + - `-i`: number of application instances + + For more information about the procedure, see [https://docs.cloudfoundry.org/devguide/deploy-apps/deploy-app.html\#custom-push](https://docs.cloudfoundry.org/devguide/deploy-apps/deploy-app.html#custom-push). + + + + +### How to change runtime memory quota and number of instances for already deployed applications + +- **Option 1:** In the SAP BTP cockpit, on the *Overview* page of the application you can: + + - Change the runtime memory quota per application instance under *Change Instance Details* \> *Instance Memory \(MB\)* + - Change the number of application instances as described in [Add or Remove Application Instances](../50-administration-and-ops/add-or-remove-application-instances-75836f1.md) + +- **Option 2:** In the Cloud Foundry CLI, you can use the command `cf scale` with the following flags: + + - `-m`: change the runtime memory quota per application instance + - `-i`: change the number of application instances + + For more information about the procedure, see [https://docs.cloudfoundry.org/devguide/deploy-apps/cf-scale.html](https://docs.cloudfoundry.org/devguide/deploy-apps/cf-scale.html). + + +You can use the **Application Autoscaler** to automatically increase or decrease the number of application instances based on the policies you have defined. For more information, see [What Is Application Autoscaler](https://help.sap.com/viewer/7472b7d13d5d4862b2b06a730a2df086/Cloud/en-US/45341f37cf6e4738a4b7cd20f18350de.html "Automatically scale your applications to meet their dynamic resource needs.") :arrow_upper_right:. + +> ### Tip: +> For tips on how to optimize the consumption of runtime memory, see the blog post [Optimise your SAP BTP, Cloud Foundry runtime costs](https://blogs.sap.com/2022/02/11/optimise-your-sap-btp-cloud-foundry-runtime-costs/). Note that while the general principles outlined in the blog post still apply, some of the UI texts and parameter names may have changed. + + + + + +## Supplemental Terms and Conditions + +For more information, see the section **SAP BTP, Cloud Foundry Runtime** in the [SAP Business Technology Platform Service Description Guide](https://www.sap.com/about/trust-center/agreements/cloud/cloud-services.html?%3Bpage=1&%3Bpdf-asset=82ce6fed-917e-0010-bca6-c68f7e60039b&%3Btag=language%3Aenglish&search=SAP%20Business%20Technology%20Platform%20Service%20Description%20Guide&sort=latest_desc&pdf-asset=9a48fd54-c97e-0010-bca6-c68f7e60039b&page=7). + + + + + +## Glossary + +[Commercial Information Glossary](https://help.sap.com/docs/help/5d771150f8f547c6bc604c7d674cf30d/7014f9db099148f1897c1bda5db21f39.html) + diff --git a/docs/10-concepts/images/1_to_1_e1fe224.jpg b/docs/10-concepts/images/1_to_1_e1fe224.jpg new file mode 100644 index 00000000..45f38611 Binary files /dev/null and b/docs/10-concepts/images/1_to_1_e1fe224.jpg differ diff --git a/docs/10-concepts/images/1_to_2_14d05d5.jpg b/docs/10-concepts/images/1_to_2_14d05d5.jpg new file mode 100644 index 00000000..bd7472f8 Binary files /dev/null and b/docs/10-concepts/images/1_to_2_14d05d5.jpg differ diff --git a/docs/10-concepts/images/English_-_Enable_Cloud_Foundry_-_SAP_BTP_Cloud_Foundry_Runtime_0377151.png b/docs/10-concepts/images/English_-_Enable_Cloud_Foundry_-_SAP_BTP_Cloud_Foundry_Runtime_0377151.png new file mode 100644 index 00000000..edea83b8 Binary files /dev/null and b/docs/10-concepts/images/English_-_Enable_Cloud_Foundry_-_SAP_BTP_Cloud_Foundry_Runtime_0377151.png differ diff --git a/docs/10-concepts/images/English_-_Entitlements_-_SAP_BTP_Cloud_Foundry_Runtime_94337c9.png b/docs/10-concepts/images/English_-_Entitlements_-_SAP_BTP_Cloud_Foundry_Runtime_94337c9.png new file mode 100644 index 00000000..63aae0a2 Binary files /dev/null and b/docs/10-concepts/images/English_-_Entitlements_-_SAP_BTP_Cloud_Foundry_Runtime_94337c9.png differ diff --git a/docs/10-concepts/images/Graphic_Template_687ed92.jpg b/docs/10-concepts/images/Graphic_Template_687ed92.jpg new file mode 100644 index 00000000..f74328a7 Binary files /dev/null and b/docs/10-concepts/images/Graphic_Template_687ed92.jpg differ diff --git a/docs/10-concepts/images/SAP_BTP_Cloud_Foundry_Runtime_Commercial_Information_Plans_-_2024_V2_67db7c4.png b/docs/10-concepts/images/SAP_BTP_Cloud_Foundry_Runtime_Commercial_Information_Plans_-_2024_V2_67db7c4.png new file mode 100644 index 00000000..952a1132 Binary files /dev/null and b/docs/10-concepts/images/SAP_BTP_Cloud_Foundry_Runtime_Commercial_Information_Plans_-_2024_V2_67db7c4.png differ diff --git a/docs/10-concepts/images/user-accounts_27c8463.png b/docs/10-concepts/images/user-accounts_27c8463.png index be68366a..f7af40ad 100644 Binary files a/docs/10-concepts/images/user-accounts_27c8463.png and b/docs/10-concepts/images/user-accounts_27c8463.png differ diff --git a/docs/10-concepts/regions-and-api-endpoints-available-for-the-cloud-foundry-environment-f344a57.md b/docs/10-concepts/regions-and-api-endpoints-available-for-the-cloud-foundry-environment-f344a57.md index ce9007dc..f2e1497f 100644 --- a/docs/10-concepts/regions-and-api-endpoints-available-for-the-cloud-foundry-environment-f344a57.md +++ b/docs/10-concepts/regions-and-api-endpoints-available-for-the-cloud-foundry-environment-f344a57.md @@ -1270,6 +1270,58 @@ cn40.platform.sapcloud.cn [Open Cockpit](https://cockpit.cn40.platform.sapcloud.cn/cockpit) + + + + + +Google Cloud + + + + +sa30 + + + + +KSA \(Dammam\) + + + + +cf-sa30 + + + + +me-central2 + + + + +34.166.4.164, 34.166.4.182, 34.166.8.22, 34.166.10.68, 34.166.19.145, 34.166.20.65, 34.166.37.166, 34.166.38.149, 34.166.39.3, 34.166.40.145, 34.166.41.104, 34.166.44.55, 34.166.46.73, 34.166.46.216, 34.166.47.18, 34.166.50.229, 34.166.52.69, 34.166.53.147, 34.166.55.78, 34.166.57.177, 34.166.60.109, 34.166.61.61, 34.166.61.119, 34.166.61.169, 34.166.61.173, 34.166.62.51, 34.166.62.206, 34.166.63.160, 34.166.64.6, 34.166.65.231 + + + + +34.166.32.46 + + + + +api.cf.sa30.hana.ondemand.com + + + + +sa30.hana.ondemand.com + + + + +[Open Cockpit](https://cockpit.btp.cloud.sap/) + diff --git a/docs/10-concepts/regions-for-the-kyma-environment-557ec3a.md b/docs/10-concepts/regions-for-the-kyma-environment-557ec3a.md index 43d82d1a..5456c7ee 100644 --- a/docs/10-concepts/regions-for-the-kyma-environment-557ec3a.md +++ b/docs/10-concepts/regions-for-the-kyma-environment-557ec3a.md @@ -276,6 +276,42 @@ Australia \(Sydney\) Enterprise account +Partner Test, Demo, and Development account + + + + +br20 + + + + +Microsoft Azure + + + + +cf-br20 + + + + +Brazil \(São Paulo\) + + + + +`azure` + +`azure_lite` + + + + + + +Enterprise account + @@ -789,6 +825,70 @@ Israel \(Tel Aviv\) `gcp` + + + + + +Enterprise account + + + + +br30 + + + + +Google Cloud + + + + +cf-br30 + + + + +Brazil \(São Paulo\) + + + + +`gcp` + + + + + + +Enterprise account + + + + +ap30 + + + + +Google Cloud + + + + +cf-ap30 + + + + +Australia \(Sydney\) + + + + +`gcp` + @@ -828,12 +928,12 @@ Region Name - + Microsoft Azure - + `azure` @@ -962,6 +1062,18 @@ Switzerland \(Zurich\) +`brazilsouth` + + + + +Brazil \(São Paulo\) + + + + + + `trial` @@ -1148,12 +1260,12 @@ US East \(VA\) - + Google Cloud - + `gcp` @@ -1227,6 +1339,30 @@ KSA \(Dammam\) Israel \(Tel Aviv\) + + + + + +`australia-southeast1` + + + + +Australia \(Sydney\) + + + + + + +`southamerica-east1` + + + + +Brazil \(São Paulo\) + diff --git a/docs/10-concepts/resilience-high-availability-and-disaster-recovery-e3ac4f7.md b/docs/10-concepts/resilience-high-availability-and-disaster-recovery-e3ac4f7.md index ecca68c2..a4f29ba2 100644 --- a/docs/10-concepts/resilience-high-availability-and-disaster-recovery-e3ac4f7.md +++ b/docs/10-concepts/resilience-high-availability-and-disaster-recovery-e3ac4f7.md @@ -117,7 +117,7 @@ In addition to the services offered by SAP BTP, you can follow our best practice - **Working with Availability Zones** - To benefit from the high availability mechanisms in Cloud Foundry, set up your applications with multiple instances. For more information, see [Developing Resilient Applications in the Cloud Foundry Environment](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/b1b929a5aea64571b2f74e810b622568.html "Our best practices about resilient application design help you to make your applications running on SAP BTP stable and highly available.") :arrow_upper_right:. + To benefit from the high availability mechanisms in Cloud Foundry, set up your applications with multiple instances. For more information, see . diff --git a/docs/10-concepts/role-collections-and-roles-in-global-accounts-directories-and-subaccounts-0039cf0.md b/docs/10-concepts/role-collections-and-roles-in-global-accounts-directories-and-subaccounts-0039cf0.md index 32039301..ff67561f 100644 --- a/docs/10-concepts/role-collections-and-roles-in-global-accounts-directories-and-subaccounts-0039cf0.md +++ b/docs/10-concepts/role-collections-and-roles-in-global-accounts-directories-and-subaccounts-0039cf0.md @@ -525,7 +525,7 @@ Read-only access for authorizations, trusted identity providers, and users. ## Directory Role Collections -The role collections *Directory Administrator* and *Directory Viewer* can be assigned during the creation of a directory. If you select the checkbox *Manage Authorizations* in the creation wizard, you can assign users the role collections during the step *Manage Authorizations*. You can't create custom role collections for directories. +The role collections *Directory Administrator* and *Directory Viewer* can be assigned after the creation of a directory. If you select the *Enable user management* checkbox, you receive the *Directory Administrator* role collection by default. You can't create custom role collections for directories. The *Directory Administrator* role collection grants a user administration permission for directories. diff --git a/docs/10-concepts/trial-accounts-and-free-tier-046f127.md b/docs/10-concepts/trial-accounts-and-free-tier-046f127.md index e06a9e49..9a96620c 100644 --- a/docs/10-concepts/trial-accounts-and-free-tier-046f127.md +++ b/docs/10-concepts/trial-accounts-and-free-tier-046f127.md @@ -75,6 +75,8 @@ In the [SAP Discovery Center service catalog overview](https://discovery-center. - A trial account enables you to explore the basic functionality of SAP BTP. +- SAP BTP trial accounts use cloud management tools feature set B. For more information, see [Cloud Management Tools — Feature Set Overview](cloud-management-tools-feature-set-overview-caf4e4e.md). + - SAP BTP trial accounts are available in several regions. For more information, see [Regions](regions-350356d.md). - You can create directories in your trial account. For more information, see [Managing Directories Using the Cockpit](../50-administration-and-ops/managing-directories-using-the-cockpit-f495ac1.md) diff --git a/docs/10-concepts/user-and-member-management-cc1c676.md b/docs/10-concepts/user-and-member-management-cc1c676.md index 8ba78035..4a31ace8 100644 --- a/docs/10-concepts/user-and-member-management-cc1c676.md +++ b/docs/10-concepts/user-and-member-management-cc1c676.md @@ -35,7 +35,7 @@ For more information, see [Platform Users](platform-users-4401316.md) and [Busin **Related Information** -[Working with Users](../50-administration-and-ops/working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role is belongs to.") +[Working with Users](../50-administration-and-ops/working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role belongs to.") [Roles and Role Collections](../50-administration-and-ops/roles-and-role-collections-14a877c.md "Usually a role collection consists of one or multiple roles. You can use the SAP BTP cockpit to add or remove roles.") diff --git a/docs/20-getting-started/getting-started-144e173.md b/docs/20-getting-started/getting-started-144e173.md index 3e5d3725..852d609a 100644 --- a/docs/20-getting-started/getting-started-144e173.md +++ b/docs/20-getting-started/getting-started-144e173.md @@ -49,7 +49,7 @@ The SAP Developer Center provides further resources to get you started: **Related Information** -[Best Practices for SAP BTP](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "This document helps you plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP). It's part of the SAP BTP Guidance Framework and contains recommendations for planning development projects – from setting up the correct organizational structure to creating an account and security model, to developing and operating applications.") :arrow_upper_right: +[SAP BTP Administrator's Guide](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "Learn about the SAP BTP Administrator's Guide and how you can use it to plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP).") :arrow_upper_right: [Access the Cockpit](../50-administration-and-ops/access-the-cockpit-4e75066.md "Learn how to access the SAP BTP cockpit.") diff --git a/docs/30-development/applications-0540211.md b/docs/30-development/applications-0540211.md index 869959e6..ed0fdcbc 100644 --- a/docs/30-development/applications-0540211.md +++ b/docs/30-development/applications-0540211.md @@ -40,6 +40,107 @@ The MTA deployment is an incremental process. This means that the state of the a - The MTA version is changed, which requires a change of special application environment variables, managed by the deploy service. + + + + +## **Application-Specific Timeouts** + +When creating Cloud Foundry applications as part of the MTA deployment, you have the option to set specific timeouts for different phases of the application's creation or execution. When any of these timeouts occur, the MTA operation fails with a relevant error message to avoid MTA deployment run indefinitely. When any of these timeouts occurs, the MTA operation fails and a relevant error message is displayed. This is to prevent the MTA deployment from running indefinitely. + +Currently the following timeouts are supported: + +- **Upload timeout** – the time it takes to upload the application binary to the Cloud Controller. Once the upload is complete, the application is ready to use. + + +- **Stage timeout** – the time it takes to stage the application. + + +- **Start timeout** – the time it takes to start all application instances. + + +- **Task execution timeout** – the time between when you run a Cloud Foundry task and when it reaches its final state. + + + + +### Priority of Timeout Parameters + +You can configure application timeouts at different levels according to your needs. When the same timeout \(for example, start timeout\) is configured in several places for one MTA deployment, a certain order of priority is applied. + +The order provides flexibility when you want to define common timeouts for all applications which are part of an MTA but at the same time, you need to define application-specific timeouts. + +The timeout parameters follow the following descending order of priority: + +1. **Operation parameters / Command-Line Options \(Highest Priority\):** + + The highest priority is given to operation parameters passed during the MTA deployment. If you provide a timeout value as a command-line option, it overrides any other parameters defined into the MTA descriptor. These operation parameters apply to all applications. + + > ### Example: + > ``` + > cf deploy … --apps-upload-timeout 40 –apps-upload-timeout 50 --apps-start-timeout 30 –apps-task-execution-timeout 100 + > ``` + +2. **Module-Level Parameters:** + + If you do not provide any command-line arguments, the module-level parameters are used instead. + + > ### Example: + > ``` + > + > modules: + > - name: java + > .......... + > parameters: + > upload-timeout: 100 + > stage-timeout: 50 + > start-timeout: 60 + > task-execution-timeout:120 + > ``` + +3. **Global-Level Parameters:** + + If neither a command-line option nor a module-level parameter are provided, the global parameters are used. Global parameters are applicable to all applications. + + > ### Example: + > ``` + > + > parameters: + > apps-upload-timeout: 50 + > apps-stage-timeout: 60 + > apps-start-timeout: 70 + > apps-task-execution-timeout:110 + > ``` + +4. **Default Values:** + + If you do not provide any of the above parameters, the application uses the predefined default timeout values. This ensures that there is always a time limit in place to prevent MTA operations from running indefinitely. + + Default values: + + - Start timeout: 1h + + - Upload timeout: 1h + + - Stage timeout: 1h + + - Task execution timeout: 12h + + + + + +### Maximum Allowed Values + +- Upload timeout: 3h + +- Stage timeout: 3h + +- Start timeout: 3h + +- Task execution timeout: 24h + + **Related Information** diff --git a/docs/30-development/best-practices-0859096.md b/docs/30-development/best-practices-0859096.md index f2a5273a..88f2bb73 100644 --- a/docs/30-development/best-practices-0859096.md +++ b/docs/30-development/best-practices-0859096.md @@ -4,7 +4,7 @@ Choose the development environment, tools, APIs, and programming model that best suit your needs with recommendations from SAP. -Navigating the large portfolio of solutions, services, tools, and frameworks can be difficult. That's why we want to provide you with recommendations based on our years of experience in helping customers achieve their goals. The best practices listed here are targeted at developers. If you're looking for recommendations on general development planning and setting up SAP BTP, see [Best Practices for SAP BTP](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "This document helps you plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP). It's part of the SAP BTP Guidance Framework and contains recommendations for planning development projects – from setting up the correct organizational structure to creating an account and security model, to developing and operating applications.") :arrow_upper_right:. If you're interested in extending existing applications, see [Extensions](../40-extensions/extensions-08b1eff.md). +Navigating the large portfolio of solutions, services, tools, and frameworks can be difficult. That's why we want to provide you with recommendations based on our years of experience in helping customers achieve their goals. The best practices listed here are targeted at developers. If you're looking for recommendations on general development planning and setting up SAP BTP, see [SAP BTP Administrator's Guide](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "Learn about the SAP BTP Administrator's Guide and how you can use it to plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP).") :arrow_upper_right:. If you're interested in extending existing applications, see [Extensions](../40-extensions/extensions-08b1eff.md). The following graphic offers an overview of the most important considerations to take when starting development on SAP BTP for the Cloud Foundry environment. The steps are recommendations, you're free to complete them in a different order if you feel it suits your needs better. diff --git a/docs/30-development/calling-an-http-service-via-communication-targets-e03a11d.md b/docs/30-development/calling-an-http-service-via-communication-targets-e03a11d.md index 48a7cbcf..e3fb82bd 100644 --- a/docs/30-development/calling-an-http-service-via-communication-targets-e03a11d.md +++ b/docs/30-development/calling-an-http-service-via-communication-targets-e03a11d.md @@ -56,16 +56,16 @@ To call an HTTP service via communication targets, proceed as follows. > FIELD-SYMBOLS: LIKE LINE OF lt_out_srv_a. > DATA(lt_properties) = io_com_arrangement->get_properties( ). > -> DATA lv_scenarioid TYPE i VALUE 1. +> DATA lv_usecase TYPE i VALUE 1. > LOOP AT lt_properties INTO DATA(ls_property). > IF ls_property-name EQ 'USECASE'. -> lv_scenarioid = ls_property-values[ 1 ]. +> lv_usecase = ls_property-values[ 1 ]. > ENDIF. > ENDLOOP. > > " save the application destination to an application-specific persistence > LOOP AT lt_out_srv_a ASSIGNING . -> ls_custom-scenario = lv_scenarioid. +> ls_custom-usecase = lv_usecase. > ls_custom-appldest = -destination_name. > > MODIFY zcota_custom FROM @ls_custom. @@ -100,21 +100,21 @@ To call an HTTP service via communication targets, proceed as follows. > DATA lt_output TYPE STANDARD TABLE OF string. > DATA lv_appl_dest TYPE sappdestname. > -> DATA(lv_scen) = request->get_form_field( i_name = 'scen' ). +> DATA(lv_usecase) = request->get_form_field( i_name = 'usecase' ). > -> IF lv_scen IS INITIAL. -> response->set_text( 'Scenario Parameter not provided.' ). +> IF lv_usecase IS INITIAL. +> response->set_text( 'Use case parameter not provided.' ). > RETURN. > ENDIF. > > " select the relevant application destination from the customizing table > SELECT SINGLE dest > FROM zcota_custom -> WHERE scenario = @lv_scen +> WHERE usecase = @lv_scen > INTO @lv_appl_dest. > > IF sy-subrc <> 0. -> response->set_text( 'Unknown scenario.' ). +> response->set_text( 'Unknown use case.' ). > RETURN. > ENDIF. > @@ -131,7 +131,7 @@ To call an HTTP service via communication targets, proceed as follows. > CATCH cx_communication_target_error INTO DATA(lx_communication_target_error). > APPEND lx_communication_target_error->get_text( ) TO lt_output. > CATCH cx_web_http_client_error INTO DATA(lx_web_http_client_error). -> APPEND cx_web_http_client_error->get_text( ) TO lt_output. +> APPEND lx_web_http_client_error->get_text( ) TO lt_output. > ENDTRY. > > DATA(lv_output) = REDUCE string( INIT r = `` diff --git a/docs/30-development/classes-and-interfaces-of-the-application-log-api-59023fc.md b/docs/30-development/classes-and-interfaces-of-the-application-log-api-59023fc.md index 51f793c3..37547426 100644 --- a/docs/30-development/classes-and-interfaces-of-the-application-log-api-59023fc.md +++ b/docs/30-development/classes-and-interfaces-of-the-application-log-api-59023fc.md @@ -504,5 +504,5 @@ Internal error during processing > ### Note: -> Find more information about classes and interfaces of the *Application Log API* in the ABAB Development Tools \(ADT\). +> Find more information about classes and interfaces of the *Application Log API* in the ABAP development tools for Eclipse \(ADT\). diff --git a/docs/30-development/configure-a-java-application-for-logs-and-traces-5551c5e.md b/docs/30-development/configure-a-java-application-for-logs-and-traces-5551c5e.md index 8dfc3f70..cea23f13 100644 --- a/docs/30-development/configure-a-java-application-for-logs-and-traces-5551c5e.md +++ b/docs/30-development/configure-a-java-application-for-logs-and-traces-5551c5e.md @@ -2,7 +2,7 @@ # Configure a Java Application for Logs and Traces -Configure the collection of log and trace messages generated by a Java application in the Cloud Foundry Environment. +Configure the collection of log and trace messages generated by a Java application in SAP BTP, Cloud Foundry. @@ -14,9 +14,9 @@ Configure the collection of log and trace messages generated by a Java applicati - You have installed and configured Maven. -- For SAP Java Buildpack 1: You use SAP JVM 8 or SapMachine 11 or 17, and your environment variable points to this location. +- For **SAP Java Buildpack 1**: You use SAP JVM 8 or SapMachine 11 or 17, and your environment variable points to this location. -- For SAP Java Buildpack 2: You use SapMachine 17 or 21 and your environment variable points to this location. +- For **SAP Java Buildpack 2**: You use SapMachine 17 or 21, and your environment variable points to this location. - You do **not** have any SLF4J and logback JAR files in the application. @@ -31,7 +31,7 @@ Configure the collection of log and trace messages generated by a Java applicati The recommended framework for logging is Simple Logging Facade for Java \(SLF4J\). To use this framework, you can create an instance of the *org.slf4j.Logger* and *org.slf4j.LoggerFactory* classes. You can use SLF4J to configure your Java application to generate logs and traces, and if appropriate – set the logging and tracing levels. > ### Note: -> It is the application's responsibility to ensure that *logback* is configured in a secure way in the case when the application overrides the default logback configuration included in the SAP Java buildpack. See step 2 below. +> It is the application's responsibility to ensure that *logback* is configured in a secure way in the case when the application overrides the default logback configuration included in SAP Java Buildpack. See step 2 below. @@ -39,7 +39,7 @@ The recommended framework for logging is Simple Logging Facade for Java \(SLF4J\ 1. Instruct Maven that the application should not package the SLF4J dependency, since it's already provided by the runtime. - To do that, go to the `pom.xml` file and set scope **provided** for the following dependency: + To do that, go to the **`pom.xml`** file and set scope **provided** for the following dependency: - For SAP Java Buildpack 1: @@ -64,9 +64,9 @@ The recommended framework for logging is Simple Logging Facade for Java \(SLF4J\ ``` -2. \(Optional\) Configure the logback in case the application overrides the default logback configuration. To do that, you need to do the following two steps: +2. \(Optional\) Configure the logback in case the application overrides the default logback configuration. To do that, you need to do the following steps: - 1. Create a custom `logback.xml` file. For example: + 1. Under path `META-INF/sap_java_buildpack/resources/tomcat/conf`, create a custom **`logback.xml`** file. For example: > ### Example: > ``` @@ -87,7 +87,20 @@ The recommended framework for logging is Simple Logging Facade for Java \(SLF4J\ > > ``` - 2. Add the following property in your `manifest.yml` file. For example \(using Tomcat\): + 2. Create a **`resource_configuration.yml`** file or add the following entries to your existing **`resource_configuration.yml`** file \(if using Tomcat\): + + > ### Example: + > ``` + > + > --- + > tomcat/conf/logback.xml: + > pattern: '' + > encoder: '' + > ``` + + **NOTE:** You can also add some default values for *pattern* and *encoder*. + + 3. Add the following property in your **`manifest.yml`** file. For example \(if using Tomcat\): > ### Example: > ``` @@ -98,7 +111,7 @@ The recommended framework for logging is Simple Logging Facade for Java \(SLF4J\ > > ... > env: - > JBP_CONFIG_RESOURCE_CONFIGURATION: "['tomcat/webapps/ROOT/META-INF/.sap_java_buildpack/tomcat/conf/logback.xml': {'encoder': 'com.sap.hcp.cf.logback.encoder.JsonEncoder', 'pattern': ''}]" + > JBP_CONFIG_RESOURCE_CONFIGURATION: "['tomcat/conf/logback.xml': {'encoder': 'com.sap.hcp.cf.logback.encoder.JsonEncoder', 'pattern': ''}]" > ``` diff --git a/docs/30-development/creating-an-odbc-data-source-on-linux-business-user-access-326f056.md b/docs/30-development/creating-an-odbc-data-source-on-linux-business-user-access-326f056.md index ef7487e0..71fc8959 100644 --- a/docs/30-development/creating-an-odbc-data-source-on-linux-business-user-access-326f056.md +++ b/docs/30-development/creating-an-odbc-data-source-on-linux-business-user-access-326f056.md @@ -58,7 +58,7 @@ In the example used in this documentation, you need the ODBC data source for a b > TrustAll=true > CryptoLibrary=/home//ODBC_driver_for_ABAP/libsapcrypto.so > AuthenticationType=Browser - > AuthenticationURL=https:///sap/bc/sec/reentrance + > AuthenticationURL=https:///sap/bc/sec/reentrance > UID=dummy > PWD=dummy > @@ -66,6 +66,8 @@ In the example used in this documentation, you need the ODBC data source for a b In this example, the driver definition was included in the `.odbc.ini` file using the driver keyword. In the example, for the sake of simplicity, no PSE file was created and the `TrustAll=True` property was used instead. The entries UID=dummy and PWD=dummy were added so that you are not forced to enter a user and password in the browser that are required by the unixODBC tool `iusql` for testing, but are not needed by the ODBC driver. + `` is the standard host name also used in the SAP Fiori Launchpad. + 4. Use the unixODBC tools `isql` or `iusql` to test the ODBC connection. If everything is configured correctly, you can see the following in the `iusql` tool, for example: diff --git a/docs/30-development/creating-an-odbc-data-source-on-windows-business-user-access-7a3bd28.md b/docs/30-development/creating-an-odbc-data-source-on-windows-business-user-access-7a3bd28.md index 2d7eefce..9f4873e5 100644 --- a/docs/30-development/creating-an-odbc-data-source-on-windows-business-user-access-7a3bd28.md +++ b/docs/30-development/creating-an-odbc-data-source-on-windows-business-user-access-7a3bd28.md @@ -33,6 +33,8 @@ In the example used in this documentation, you need the ODBC data source for a b > > `AuthenticationType=Browser` > - > `AuthenticationURL=https:///sap/bc/sec/reentrance` + > `AuthenticationURL=https:///sap/bc/sec/reentrance` + > + > `` is the standard host name also used in the SAP Fiori Launchpad. diff --git a/docs/30-development/creating-service-keys-4514a14.md b/docs/30-development/creating-service-keys-4514a14.md index 8980a71a..0fa44cc0 100644 --- a/docs/30-development/creating-service-keys-4514a14.md +++ b/docs/30-development/creating-service-keys-4514a14.md @@ -6,7 +6,7 @@ You can use service keys to generate credentials to communicate directly with a You can usethe SAP BTP cockpit or the Cloud Foundry Command Line Interface to create service keys: -- [Create Service Keys Using the Cockpit](create-service-keys-using-the-cockpit-cdf4f20.md) +- [Creating Service Keys Using the Cockpit](https://help.sap.com/docs/service-manager/sap-service-manager/creating-service-keys-in-cloud-foundry) - [Create Service Keys Using the Cloud Foundry Command Line Interface](create-service-keys-using-the-cloud-foundry-command-line-interface-7de6b31.md) diff --git a/docs/30-development/defining-mta-extension-descriptors-50df803.md b/docs/30-development/defining-mta-extension-descriptors-50df803.md index e52d8062..6889e689 100644 --- a/docs/30-development/defining-mta-extension-descriptors-50df803.md +++ b/docs/30-development/defining-mta-extension-descriptors-50df803.md @@ -2,81 +2,168 @@ # Defining MTA Extension Descriptors -The Multitarget Application \(МТА\) extension descriptor is a YAML file that contains data complementary to the deployment descriptor. The data can be environment or deployment specific, for example, credentials depending on the user who performs the deployment. The MTA extension descriptor is a YAML file that has a similar structure to the deployment decriptor. It follows the Multitarger Application Model structure with several limitations and differences. Normally, the extension descriptor extends the deployment descriptor but it is possible to build upon another extension descriptor, making an extension descriptors chain. It can add or overwrite existing data if necessary. +The Multitarget Application \(МТА\) extension descriptor is a YAML file that contains data complementary to the deployment descriptor \(from MTA archive\). It has a structure similar to the one of the deployment descriptor, and you will normally find it placed outside of the MTA archive. -Several extension descriptors can be additionally used after the initial deployment. +The data can be environment or deployment specific, for example, application scaling setup or credentials depending on the user who performs the deployment. This allows you to use the one and the same unmodifiable MTA archive and deploy it with different extension descriptors, resulting in different setups. + +When you are deploying an MTA, you can provide several extension descriptors. The descriptors in the chain are considered in order, with each descriptor having a higher priority than the one it extends. > ### Note: > The format and available options within the extension descriptor may change with newer versions of the MTA specification. You must always specify the schema version option when defining an extension descriptor to inform the SAP BTP which MTA specification version should be used. Furthermore, the schema version used within the extension descriptor and the deployment descriptor should always be the same. -In the examples below, we have a deployment descriptor, which has already been defined, and several extension descriptors. - > ### Note: > Each extension descriptor is defined in a separate file with an extension `.mtaext`. -Deployment descriptor: +In the examples below, we have a deployment descriptor, which has already been defined, and several extension descriptors. + +MTA deployment descriptor: > ### Example: > ``` +> ----MTA Deployment descriptor----- > _schema-version: '3.1' -> parameters: -> hcp-deployer-version: '1.0' -> ID: com.example.extension +> ID: sample.app > version: 0.1.0 -> -> resources: -> - name: data-storage -> properties: -> existing-data: value +> +> modules: +> - name: my-app +> type: application +> parameters: +> memory: 2GB > ``` -The example above instructs SAP BTP to: +When an MTA with the above deployment descriptor is being deployed, the following steps are performed: -- Validate the extension descriptor against the MTA specification version `3.1` -- Extend the `com.example.extension` deployment descriptor +- Validates the deployment descriptor against the MTA specification version `3.1`. If it is not compliant, the deployment will fail at the beginning +- Defines an MTA module with type `application` that will end up into a Cloud Foundry application +- Defines a parameter `memory` that equals to 2GB +- …... +- Creates a Cloud Foundry application that runs with 2GB memory -The following is a basic example of an extension descriptor that adds data and overwrites data to another extension descriptor: +The following is a basic example of an extension descriptor that adds and overwrites data: > ### Example: > ``` +> ----prod.mtaext----- > _schema-version: '3.1' -> ID: com.example.extension.first -> extends: com.example.extension -> -> resources: -> - name: data-storage -> properties: -> existing-data: new-value -> non-existing-data: value +> ID: sample.app.prod +> extends: sample.app +> +> modules: +> - name: my-app +> parameter: +> memory: 4GB +> instances: 2 > ``` -The above instructs SAP BTP to: +When the same MTA is deployed in combination with the above MTA extension descriptor, using the command `cf deploy -e prod.mtaext`, the following steps are performed: -- Extend the deployment descriptor by its ID `com.example.extension` -- Validate the extension descriptor against the MTA specification version 3.1 -- Overwrite the data for the `existing-data` property -- Add a new data called `non-existing-data` to the `data-storage` properties +- Validates the deployment descriptor and the extension descriptor against the MTA specification version **3.1** +- Extends the deployment descriptor with an extension descriptor with ID `sample.app.prod` and merges the result: + - Overwrites the value of the parameter `memory`. It becomes equals to 4GB + - Adds a new parameter `instances` that equals to 2 -The following is an example of another extension descriptor that builds upon the extension descriptor from the previous example: +- …... +- Creates a Cloud Foundry application which runs on 2 instances with 4GB memory each + +In this scenario, the descriptor chain will consist of two descriptors. They will be arranged in this order: `sample.app` followed by `sample.app.prod`. + +The following is an example of a second extension descriptor that builds upon the extension descriptor from the previous example: > ### Example: > ``` +> ----largemtaext----- > _schema-version: '3.1' -> ID: com.example.extension.second -> extends: com.example.extension.first -> -> resources: -> - name: data-storage -> properties: -> second-non-existing-data: value +> ID: sample.app.large +> extends: sample.app.prod +> +> modules: +> - name: my-app +> parameter: +> instances: 5 +> disk-quota: 10GB > ``` -The example above instructs the SAP BTP to: - -- Extend the first extension descriptor by its ID -- Add a new data called `second-non-existing-data` to the `data-storage` properties - -- The examples above are incomplete. To deploy a solution, you have to create a deployment descriptor and an MTA archive. +When you deploy the same MTA in combination with the two MTA extension descriptors, using the command `cf deploy -e prod.mtaext,large.mtaext`, the following steps are performed: + +- Validates the deployment descriptor and the extension descriptors against the MTA specification version **3.1** +- Extends the deployment descriptor with an extension descriptor with ID `sample.app.prod` and merges the result: + - Overwrites the value of the parameter `memory`. It becomes equals to 4GB + - Adds a new parameter `instances` that equals to 2 + +- Extends the merged descriptor with an extension descriptor with ID `sample.app.large` and merges the result: + - Overwrites the value of the parameter `instances`. It becomes equals to 5 + - Adds a new parameter `disk-quota` that equals to 10GB + + +- … +- Creates a Cloud Foundry application, which runs on 5 instances, each with 4GB of memory and 10GB of disk space + +In this scenario, the descriptor chain will consist of three descriptors: `sample.app`, followed by `sample.app.prod`, and then `sample.app.large`. + +Extension descriptors can be used to add or override all data types of parameters and properties, following the specified rules. + +- Simple data types, such as Boolean, integer and String, are overwritten directly + +- Maps \(objects\) are overwritten and merged in depth + +``` +----MTA Deployment descriptor----- +ID: sample.postgre + +resources: + - name: my-postgre + type: org.cloudfoundry.managed-service + parameters: + service-plan: standard + service: postgresql-db + config: + memory: 4 + storage: 200 +``` + +``` +----prod-postgre.mtaext----- +ID: sample.postgre.dev +extends: sample.postgre + +resources: + - name: my-postgre + parameters: + config: + storage: 10 +``` + +When using a combination of the MTA deployment descriptor and MTA extension descriptor, the MTA deployment will result in the creation of a service instance with the service offering `postgresql-db`, plan **standard**, running on 4GB memory, and 10GB storage. This example demonstrates how the parameter `config`, a YAML map \(JSON Object\), is processed. The value from the extension descriptor is merged with the value from the deployment descriptor while retaining the element `memory`. Without using the extension descriptor, the result of the MTA deployment would be a Postgre service instance with 4GB memory and 200GB storage. + +Note that lists \(arrays\) are overwritten by replacing all elements. This means that if you want to preserve any of the elements from the MTA deployment descriptor you need to define them again in the extension descriptor. + +``` +----MTA Deployment descriptor----- +ID: sample.app + +modules: + - name: my-app + type: application + properties: + my-list: [1,2] +``` + +``` +----app-list.mtaext----- +ID: sample.app.ext +extends: sample.app + +modules: + - name: my-app + type: application + properties: + my-list: [2,3] +``` + +When you use a combination of the MTA deployment descriptor and an MTA extension descriptor, the resulting MTA deployment will create an application with the environment variable `my-list` set to \[2,3\]. This example demonstrates how the parameter `my-list`, which is a YAML list \(JSON Array\), is processed. The value from the extension descriptor completely overwrites the value from the deployment descriptor without retaining element “1”. If the extension descriptor is not used, the environment variable `my-list` would be \[1,2\]. + +In some cases, there are operation-level parameters \(command-line arguments\) that take the highest priority over all descriptors. See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc). diff --git a/docs/30-development/development-c2fec62.md b/docs/30-development/development-c2fec62.md index ad1fc589..46490344 100644 --- a/docs/30-development/development-c2fec62.md +++ b/docs/30-development/development-c2fec62.md @@ -206,7 +206,7 @@ We provide detailed information about developing, configuring, and deploying you **Related Information** -[Best Practices for SAP BTP](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "This document helps you plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP). It's part of the SAP BTP Guidance Framework and contains recommendations for planning development projects – from setting up the correct organizational structure to creating an account and security model, to developing and operating applications.") :arrow_upper_right: +[SAP BTP Administrator's Guide](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "Learn about the SAP BTP Administrator's Guide and how you can use it to plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP).") :arrow_upper_right: [Developing with the SAP Cloud Application Programming Model](developing-with-the-sap-cloud-application-programming-model-00823f9.md "The SAP Cloud Application Programming Model (CAP) is a framework of languages, libraries, and tools for building enterprise-grade services and applications. It guides developers along a ‘golden path’ of proven best practices and a great wealth of out-of-the-box solutions to recurring tasks.") diff --git a/docs/30-development/development-in-the-cloud-foundry-environment-40a8f8f.md b/docs/30-development/development-in-the-cloud-foundry-environment-40a8f8f.md index ef3cc0a9..44a53b63 100644 --- a/docs/30-development/development-in-the-cloud-foundry-environment-40a8f8f.md +++ b/docs/30-development/development-in-the-cloud-foundry-environment-40a8f8f.md @@ -93,7 +93,7 @@ The following graphic is designed to help you find the information you need for ## Development Options Overview -![](images/Development_Options_Overview_1_1_1f5671e.png) +![](images/Development_Options_Overview_1_2_1f5671e.png) diff --git a/docs/30-development/frequently-asked-questions-6062ecc.md b/docs/30-development/frequently-asked-questions-6062ecc.md index 7fb602a1..9c4b7635 100644 --- a/docs/30-development/frequently-asked-questions-6062ecc.md +++ b/docs/30-development/frequently-asked-questions-6062ecc.md @@ -60,7 +60,7 @@ Use the command `cf mta-ops` and find the id of the operation related to the des ### How can I list the MTAs that I have deployed in my space? -Use the `cf mtas` command and locate the ID of the desired MTA. After locating the correct MTA ID, execute the command `cf mta ` to get detailed information about the the MTA with the provided ID. +Use the `cf mtas` command and locate the ID of the desired MTA. After locating the correct MTA ID, execute the command `cf mta ` to get detailed information about the MTA with the provided ID. @@ -83,7 +83,7 @@ Use the `cf mtas` command and locate the ID of the desired MTA. After locating t ### How can I redeploy my MTA when a deployment is already running? -You can abort the currently running deployment, using the command `cf -i -a abort` \(Example: `cf deploy -i 12353 -a abort`\) or you can execute the command for staring the deployment by providing the option -f as described in the [deploy](../50-administration-and-ops/multitarget-application-commands-for-the-cloud-foundry-environment-65ddb1b.md#loio65ddb1b51a0642148c6b468a759a8a2e__section_irt_3dc_zs) section. +You can abort the currently running deployment, using the command `cf -i -a abort` \(Example: `cf deploy -i 12353 -a abort`\) or you can execute the command for starting the deployment by providing the option -f as described in the [deploy](../50-administration-and-ops/multitarget-application-commands-for-the-cloud-foundry-environment-65ddb1b.md#loio65ddb1b51a0642148c6b468a759a8a2e__section_irt_3dc_zs) section. > ### Example: > `cf deploy .mtar -f` diff --git a/docs/30-development/generate-provider-proxies-from-wsdl-files-9843375.md b/docs/30-development/generate-provider-proxies-from-wsdl-files-9843375.md index a9614c16..592bc45f 100644 --- a/docs/30-development/generate-provider-proxies-from-wsdl-files-9843375.md +++ b/docs/30-development/generate-provider-proxies-from-wsdl-files-9843375.md @@ -16,11 +16,14 @@ You have created a communication scenario as described in [Defining a Communicat ## Context -With the SOAP Provider Model \(SPRV\), you can generate the proxy objects that are required for providing SOAP services, based on a WSDL file that describe your service. The SPRV is mainly used to provide a corresponding inbound service for an exposed outbound service. +With the SOAP Provider Model \(SPRV\), you can generate the proxy objects that are required for providing SOAP services, based on a WSDL file that describe your service. The SPRV is used to provide a corresponding inbound service for an exposed outbound service. > ### Example: > An external system triggers a confirmation in your system to inform the external system about the creation of an appointment activity. To receive this information, a provider proxy for this service must be implemented in your system. This provider proxy is generated by the SPRV. +> ### Restriction: +> In ABAP development tools for Eclipse, it is not possible to model SOAP web services. Therefore, the SPRV is not intended to provide a SOAP service. + During and after activation, the following objects are generated: - Proxy objects diff --git a/docs/30-development/getting-numbers-from-an-interval-c9b48a1.md b/docs/30-development/getting-numbers-from-an-interval-c9b48a1.md index e2e6f032..815ad718 100644 --- a/docs/30-development/getting-numbers-from-an-interval-c9b48a1.md +++ b/docs/30-development/getting-numbers-from-an-interval-c9b48a1.md @@ -148,7 +148,7 @@ NUMBER\_ALPHA -Obsolete. Please use the parameter `NUMBER` +Alphanumeric and optional length check diff --git a/docs/30-development/http-communication-via-url-d30fe6a.md b/docs/30-development/http-communication-via-url-d30fe6a.md index d292d272..f6a3d911 100644 --- a/docs/30-development/http-communication-via-url-d30fe6a.md +++ b/docs/30-development/http-communication-via-url-d30fe6a.md @@ -12,7 +12,7 @@ You can configure the URL static in the code: > ``` > ### Note: -> Using `create_by_url` is only suitable for public services or test purposes, because credentials should be stored in the destination service, or using communication arrangements \(`create_by_comm_arrangement`, `create_by_cloud_destination`\). +> Using `create_by_url` is only suitable for public services or test purposes, because credentials should be stored in the communication management in SAP Fiori launchpad. **Related Information** diff --git a/docs/30-development/images/Best_Practices_Overview_1_2_1936742.png b/docs/30-development/images/Best_Practices_Overview_1_2_1936742.png index 4e443978..7201d1f3 100644 Binary files a/docs/30-development/images/Best_Practices_Overview_1_2_1936742.png and b/docs/30-development/images/Best_Practices_Overview_1_2_1936742.png differ diff --git a/docs/30-development/images/Development_Options_Overview_1_1_1f5671e.png b/docs/30-development/images/Development_Options_Overview_1_1_1f5671e.png deleted file mode 100644 index ab368170..00000000 Binary files a/docs/30-development/images/Development_Options_Overview_1_1_1f5671e.png and /dev/null differ diff --git a/docs/30-development/images/Development_Options_Overview_1_2_1f5671e.png b/docs/30-development/images/Development_Options_Overview_1_2_1f5671e.png new file mode 100644 index 00000000..a915474e Binary files /dev/null and b/docs/30-development/images/Development_Options_Overview_1_2_1f5671e.png differ diff --git a/docs/30-development/images/FioriAppsinCF_0086ea3.png b/docs/30-development/images/FioriAppsinCF_0086ea3.png deleted file mode 100644 index 83179939..00000000 Binary files a/docs/30-development/images/FioriAppsinCF_0086ea3.png and /dev/null differ diff --git a/docs/30-development/images/Keda_module_architecture_0cb8230.svg b/docs/30-development/images/Keda_module_architecture_0cb8230.svg new file mode 100644 index 00000000..1e688d82 --- /dev/null +++ b/docs/30-development/images/Keda_module_architecture_0cb8230.svg @@ -0,0 +1,4 @@ + + + +
Kyma Cluster
Kyma Cluster
Kyma User
Kyma User
Keda CR
Keda CR
KEDA
KEDA
keda-controller
keda-controller
spec:
// Keda config
spec:...
2
2
3
3
1
1
applies
applies
watches
watches
reconciles
reconciles
Keda Manager
Keda Manager
keda-metric-server
keda-metric-server
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/30-development/images/UIDevCF_dfa94a6.png b/docs/30-development/images/UIDevCF_dfa94a6.png new file mode 100644 index 00000000..d7f11eb2 Binary files /dev/null and b/docs/30-development/images/UIDevCF_dfa94a6.png differ diff --git a/docs/30-development/integration-with-approuter-87a38c2.md b/docs/30-development/integration-with-approuter-87a38c2.md new file mode 100644 index 00000000..3870d13d --- /dev/null +++ b/docs/30-development/integration-with-approuter-87a38c2.md @@ -0,0 +1,11 @@ + + +# Integration with Approuter + +You can integrate the OData service of your ABAP environment into the application by specifying a corresponding route in the `xs-app.json` file of the HTML5 module. The routing can be done either by providing a destination that points to the ABAP environment instance or by specifying the service endpoint of the ABAP environment and binding the service instance. + +> ### Note: +> If the application and the instance of the ABAP environment are deployed to different subaccounts, use routing via destination. + +For more information about the two types of routing, navigate to or . + diff --git a/docs/30-development/keda-custom-resource-conditions-12a88ed.md b/docs/30-development/keda-custom-resource-conditions-12a88ed.md new file mode 100644 index 00000000..9eb8e56d --- /dev/null +++ b/docs/30-development/keda-custom-resource-conditions-12a88ed.md @@ -0,0 +1,364 @@ + + +# Keda Custom Resource Conditions + +This document describes the possible states of the Keda CR. Two condition types, `Installed` and `Deleted`, are used. + +**** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +No + + + +CR State + + + +Condition Type + + + +Condition Status + + + +Condition Reason + + + +Remarks + +
+ +1 + + + +Ready + + + +Installed + + + +true + + + +Verified + + + +Server ready + +
+ +2 + + + +Processing + + + +Installed + + + +unknown + + + +Initialized + + + +Initialized + +
+ +3 + + + +Processing + + + +Installed + + + +unknown + + + +Verification + + + +Verification in progress + +
+ +4 + + + +Error + + + +Installed + + + +false + + + +ApplyObjError + + + +Apply object error + +
+ +5 + + + +Error + + + +Installed + + + +false + + + +DeploymentUpdateErr + + + +Deployment update error + +
+ +6 + + + +Error + + + +Installed + + + +false + + + +VerificationErr + + + +Verification error + +
+ +7 + + + +Error + + + +Installed + + + +false + + + +KedaDuplicated + + + +One instance of Keda is allowed + +
+ +8 + + + +Deleted + + + +unknown + + + +Deletion + + + +Deletion in progress + + + +Deletion in progress + +
+ +9 + + + +Deleting + + + +Deleted + + + +true + + + +Deleted + + + +Keda module deleted + +
+ +10 + + + +Error + + + +Deleted + + + +false + + + +DeletionErr + + + +Deletion failed + +
+ diff --git a/docs/30-development/keda-module-2f69be2.md b/docs/30-development/keda-module-2f69be2.md new file mode 100644 index 00000000..8f697430 --- /dev/null +++ b/docs/30-development/keda-module-2f69be2.md @@ -0,0 +1,75 @@ + + +# Keda Module + +Learn more about the Keda module. Use it to install and manage the [KEDA](https://keda.sh/) autoscaler in your Kubernetes cluster. + + + +
+ +## What Is KEDA? + +Kubernetes-based Event Driven Autoscaler \(KEDA\) is an autoscaler that allows you to easily scale your Kubernetes-based resources. You can scale your applications on the basis of the data of your choice. + +KEDA supports a great number of scalers that help you manage your deployments. For the complete list, check the[KEDA Scalers documentation](https://keda.sh/docs/latest/scalers/). + +For more information about KEDA features, see the[KEDA documentation](https://keda.sh/docs/latest). + + + + + +## Features + +With the Keda module, you can have a custom event-driven autoscaling for Kubernetes workloads. + + + + + +## Architecture + +![](images/Keda_module_architecture_0cb8230.svg) + +1. User applies the Keda custom resource \(CR\). + +2. Keda Manager watches the Keda CR. +3. Keda Manager reconciles the KEDA workloads. + +To learn more about the KEDA architecture, see the [KEDA architecture diagram](https://keda.sh/docs/latest/concepts/#architecture). + + + +### Keda Manager + +Keda Manager helps you to install and manage KEDA in your cluster. It manages the lifecycle of KEDA based on the dedicated Keda CR. + + + + + +## API/Custom Resource Definitions + +For the Keda CR conditions, check [Keda Custom Resource Conditions](keda-custom-resource-conditions-12a88ed.md). + +To learn more about the KEDA CR, see [KEDA Custom Resources](https://keda.sh/docs/latest/concepts/#custom-resources-crd). + + + + + +## Resource Consumption + +To learn more about the resources used by the Keda module, see [Keda](../50-administration-and-ops/kyma-modules-sizing-3a92490.md#loio3a924906857b4f01969cb684ccd25309__section_keda). + + + + + + + +## Keda Module Demo Applications + +To learn how to scale the Kubernetes workloads using the KEDA API based on a simple CPU consumption case and how the Keda module can complement other Kyma components, see [Demo Applications](https://github.com/kyma-project/keda-manager/blob/main/docs/user/04-20-demo-applications.md). + diff --git a/docs/30-development/keda-module-configuration-3cc1f25.md b/docs/30-development/keda-module-configuration-3cc1f25.md new file mode 100644 index 00000000..52daea73 --- /dev/null +++ b/docs/30-development/keda-module-configuration-3cc1f25.md @@ -0,0 +1,68 @@ + + +# Keda Module Configuration + +Learn how to configure the Keda module using the Keda CustomResourceDefinition \(CRD\). See how to configure the `logging.level` attribute or the resource consumption. + + + + + +## Procedure + +- You can change the logging level of the KEDA workloads. To change `logging.level`, choose one of the accepted values: + + - `debug` - is the most detailed option. Useful for a developer during debugging. + + - `info` - provides standard log level indicating operations within the Keda module. For example, it can show whether the workload scaling operation was successful or not. + + - `error` - shows error logs only. This means only log messages corresponding to errors and misconfigurations are visible in logs. + + + ``` + spec: + logging: + operator: + level: "debug" + ``` + +- To enable the Istio sidecar injection for `operator` and `metricServer`, set the value of `enabledSidecarInjection` to `true`. For example: + + ``` + spec: + istio: + metricServer: + enabledSidecarInjection: true + operator: + enabledSidecarInjection: true + ``` + +- To change the resource consumption, enter your preferred values for `operator` and `metricServer`. For example: + + ``` + resources: + operator: + limits: + cpu: "1" + memory: "200Mi" + requests: + cpu: "0.5" + memory: "150Mi" + metricServer: + limits: + cpu: "1" + memory: "1000Mi" + requests: + cpu: "300m" + memory: "500Mi" + ``` + + + + + + +## Next Steps + +For more information about the Keda resources, see [KEDA concepts](https://keda.sh/docs/latest/concepts/). + diff --git a/docs/30-development/logging-and-tracing-7eb922a.md b/docs/30-development/logging-and-tracing-7eb922a.md index c5db83a3..faa2576f 100644 --- a/docs/30-development/logging-and-tracing-7eb922a.md +++ b/docs/30-development/logging-and-tracing-7eb922a.md @@ -52,7 +52,7 @@ SAP Java Buildpack integrates the [Cloud Foundry Java Logging Support](https://g **Related Information** -[Configure a Java Application for Logs and Traces](configure-a-java-application-for-logs-and-traces-5551c5e.md "Configure the collection of log and trace messages generated by a Java application in the Cloud Foundry Environment.") +[Configure a Java Application for Logs and Traces](configure-a-java-application-for-logs-and-traces-5551c5e.md "Configure the collection of log and trace messages generated by a Java application in SAP BTP, Cloud Foundry.") [SAP Application Logging Service for Cloud Foundry](https://help.sap.com/docs/APPLICATION_LOGGING/ee8e8a203e024bbb8c8c2d03fce527dc/68454d44ad41458788959485a24305e2.html?version=Cloud) diff --git a/docs/30-development/modules-177d34d.md b/docs/30-development/modules-177d34d.md index ea42f563..47a4a8aa 100644 --- a/docs/30-development/modules-177d34d.md +++ b/docs/30-development/modules-177d34d.md @@ -71,7 +71,7 @@ Result No default parameter. > ### Note: -> We strongly recommend that you specify the appropriate buildpack for your application. To do so, use the `buildpack` module parameter. +> We strongly recommend that you specify the appropriate buildpack for your application.modules: parameters: buildpack: binary\_buildpack To do so, use the `buildpack` - name: my-binary-app module parameter. @@ -389,6 +389,9 @@ Direct content deployment to backing services > ### Note: > This module type is **deprecated**. Please use `com.sap.html5.application.content` instead. +> ### Note: +> Keep the dependency to `@sap/html5-app-deployer` updated to the latest version. If you are using an older version, you might encounter some issues. + - `no-route` \(`true`\). Defines if a route should be assigned to the application. - `memory` \(`256M`\). Defines the memory allocated to the application. - `execute-app` - \(`true`\). Defines whether the application is executed. If yes, the application performs certain amount of work and upon completion sets a `success-marker` or `failure-marker` by means of a log message. @@ -423,7 +426,7 @@ Deploys a content deployment application, and creates a task that performs the c > ### Note: -> Before using this module type, update the content deployer applications to their latest version. +> Keep the dependency to `@sap/html5-app-deployer` updated to the latest version. If you are using an older version, you might encounter some issues. - `no-route` \(`true`\). Defines if a route should be assigned to the application. - `no-start` - \(`true`\). Only the one-off tasks will be executed, that is, without triggering the start of the application. @@ -624,11 +627,7 @@ To choose a `binary_buildpack`, define it by using the following: > ### Sample Code: > ``` -> modules: -> - name: my-binary-app -> type: custom -> parameters: -> buildpack: binary_buildpack +> > ``` @@ -693,7 +692,7 @@ The name of the application in the Cloud Foundry environment to be deployed for -`${default-app-name`\} +`${default-app-name}` @@ -2248,6 +2247,117 @@ n/a + + + + + +`stage-timeout` + + + + +Write + + + + +Defines how long, in seconds, your application can take during staging before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc). + + + + +1h + + + + +``` +modules: + - name: java + …………….. + parameters: + stage-timeout: 100 +``` + + + + + + + + +`start-timeout` + + + + +Write + + + + +Defines how long, in seconds, your application can take to start before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc). + + + + +1h + + + + +``` +modules: + - name: java + …………….. + parameters: + start-timeout: 100 +``` + + + + + + + + +`task-execution-timeout` + + + + +Write + + + + +Defines how long, in seconds, your application can take to execute a task before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc). + + + + +12h + + + + +``` +modules: + - name: java + …………….. + parameters: + task-execution-timeout: 100 +``` + + + @@ -2338,6 +2448,43 @@ Specifies whether the application should have `TCPS` type routes. `tcps:true` + + + + + +`upload-timeout` + + + + +Write + + + + +Defines how long, in seconds, you can upload your application binary before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + + + + +1h + + + + +``` +modules: + - name: java + .......... + parameters: + upload-timeout: 100 +``` + + + diff --git a/docs/30-development/order-and-provide-975bd3e.md b/docs/30-development/order-and-provide-975bd3e.md index a657d13b..9f5f3dab 100644 --- a/docs/30-development/order-and-provide-975bd3e.md +++ b/docs/30-development/order-and-provide-975bd3e.md @@ -1265,7 +1265,7 @@ As a provider, you can deploy your SaaS solution in a subaccount that is located A consumer can then subscribe to and access your SaaS solution from a subaccount. The consumer subaccount needs to be located in the same region as the subaccount which you deployed the SaaS solution in. -Keep in mind that regions are chosen on the subaccount level: For each subaccount, you select exactly one region. This is done when creating the subaccount. The **Landscape Portal** can only be accessed from subaccounts located in region cf-eu10. You thus need to make sure that the subaccount from which you want to access the **Landscape Portal** has the region attribute cf-eu10. For more information on regions, see [Regions.](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/350356d1dc314d3199dca15bd2ab9b0e.html) and [Accessing the Landscape Portal](https://help.sap.com/docs/help/d91c4152c3d74c12bc9bd4ed92681902/d9e865ad47204b80816b6f62af57b823.html). +Keep in mind that regions are chosen on the subaccount level: For each subaccount, you select exactly one region. This is done when creating the subaccount. The **Landscape Portal** can be accessed from subaccounts located in regions that are available for the ABAP environment. You thus need to make sure that the subaccount from which you want to access the **Landscape Portal** has the correct region attribute \(that is, the technical key, such as cf-eu10\). For more information on regions, see [Regions](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/350356d1dc314d3199dca15bd2ab9b0e.html) and [Accessing the Landscape Portal](https://help.sap.com/docs/help/d91c4152c3d74c12bc9bd4ed92681902/d9e865ad47204b80816b6f62af57b823.html). diff --git a/docs/30-development/parameters-and-properties-490c8f7.md b/docs/30-development/parameters-and-properties-490c8f7.md index 1400d93a..a60ce914 100644 --- a/docs/30-development/parameters-and-properties-490c8f7.md +++ b/docs/30-development/parameters-and-properties-490c8f7.md @@ -101,6 +101,181 @@ Example +`apps-stage-timeout` + + + + +Global + + + + +Write + + + + +Defines how long, in seconds, your application can take during staging before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + +> ### Note: +> This applies to all applications. + + + + + + +1h + + + + +``` + +parameters: + apps-stage-timeout: 100 +``` + + + + + + + + +`apps-start-timeout` + + + + +Global + + + + +Write + + + + +Defines how long, in seconds, your application can take to start before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + +> ### Note: +> This applies to all applications. + + + + + + +1h + + + + +``` + +parameters: + apps-start-timeout: 100 +``` + + + + + + + + +`apps-task-execution-timeout` + + + + +Global + + + + +Write + + + + +Defines how long, in seconds, your application can take to execute a task before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + +> ### Note: +> This applies to all applications. + + + + + + +12h + + + + +``` + +parameters: + apps-task-execution-timeout: 100 +``` + + + + + + + + +`apps-upload-timeout` + + + + +Global + + + + +Write + + + + +Defines how long, in seconds, you can upload your application binary before the MTA operation times out. + +See [Application-Specific Timeouts](applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + + + + +1h + + + + +``` + +parameters: + apps-upload-timeout: 100 +``` + + + + + + + + `authorization-url` diff --git a/docs/30-development/protection-against-csrf-attacks-c878936.md b/docs/30-development/protection-against-csrf-attacks-c878936.md index 8b021cd4..16fba4f1 100644 --- a/docs/30-development/protection-against-csrf-attacks-c878936.md +++ b/docs/30-development/protection-against-csrf-attacks-c878936.md @@ -27,16 +27,16 @@ The code below shows an example for implementing the method `HANDLE_REQUEST` of > ### Sample Code: > ``` -> method IF_HTTP_SERVICE_EXTENSION~HANDLE_REQUEST. -> data(lv_valid) = cl_http_service_utility=>handle_csrf( -> EXPORTING -> request = request -> response = response -> ). -> check lv_valid = abap_true. -> //Start der Implementierung des HTTP Services -> //Beginn der Anwendungslogik -> endmethod. +> METHOD if_http_service_extension~handle_request. +> DATA(lv_valid) = cl_http_service_utility=>handle_csrf( +> EXPORTING +> request = request +> response = response +> ). +> CHECK lv_valid = abap_true. +> //Start the implementation of the HTTP service +> //Start the application logic +> ENDMETHOD. > > ``` diff --git a/docs/30-development/resources-9e34487.md b/docs/30-development/resources-9e34487.md index 837059f8..083b78cf 100644 --- a/docs/30-development/resources-9e34487.md +++ b/docs/30-development/resources-9e34487.md @@ -25,7 +25,7 @@ Optional resource attributes include: > ### Tip: > By default recourses process in parallel, but if you want to enable an order of resources, see [Sequential Resource Processing](sequential-resource-processing-b93db81.md). -- `optional` +- `optional`- its value can be `true` or `false` and the default value is `false`. If set to `true`, the resource processing is fail-safe. @@ -209,28 +209,6 @@ Created Service -`com.sap.xs.hana-sbss` - - - - -`hana` - - - - -`sbss` - - - - -Service-broker security - - - - - - `com.sap.xs.hana-schema` > ### Example: diff --git a/docs/30-development/routing-configuration-file-c103fb4.md b/docs/30-development/routing-configuration-file-c103fb4.md index d391e5d0..ac104493 100644 --- a/docs/30-development/routing-configuration-file-c103fb4.md +++ b/docs/30-development/routing-configuration-file-c103fb4.md @@ -152,6 +152,9 @@ Define the amount of time \(in minutes\) for which a session can remain inactive > > If the environment variable [SESSION\_TIMEOUT](environment-variables-ba52705.md#loioba527058dc4d423a9e0a69ecc67f4593__section_blz_hgn_mv) is set this property will be overwritten. +> ### Note: +> You can configure `sessionTimeout` only in the central routing configuration file \(xs-app.json\) that belongs to the application router, not in an xs-app.json file that is part of an HTML5 application. + diff --git a/docs/30-development/sessiontimeout-9d24198.md b/docs/30-development/sessiontimeout-9d24198.md index 8a2a6ce5..73bb8bea 100644 --- a/docs/30-development/sessiontimeout-9d24198.md +++ b/docs/30-development/sessiontimeout-9d24198.md @@ -25,3 +25,6 @@ A session timeout triggers a central log out with the following consequences: - Deletes the user session - Requests the log out paths for all your back-end services \(if you provided these paths in the `destinations` and `service` properties\). +> ### Note: +> `sessionTimeout` can only be configured in the central routing configuration file \(xs-app.json\) that belongs to the application router, not in an xs-app.json file that is part of an HTML5 application. + diff --git a/docs/30-development/setting-up-the-authorizations-bb559a5.md b/docs/30-development/setting-up-the-authorizations-bb559a5.md index 06be7ea7..64ace495 100644 --- a/docs/30-development/setting-up-the-authorizations-bb559a5.md +++ b/docs/30-development/setting-up-the-authorizations-bb559a5.md @@ -8,13 +8,13 @@ Some further activities in ADT and in the administrator’s launchpad are necess 1. Create an Identity and Access Management \(IAM\) Business Catalog. - When you create a job catalog entry and a job template as explained in [Creating a Job Catalog Entry and a Job Template in ADT](creating-a-job-catalog-entry-and-a-job-template-in-adt-949ba00.md), an object of the type **IAM App** is created automatically. It has the name **\_SAJC**. + When you create a job catalog entry and a job template as explained in [Creating a Job Catalog Entry and a Job Template in ADT](creating-a-job-catalog-entry-and-a-job-template-in-adt-949ba00.md), an object of the type **IAM App** is created automatically. It has the name **\_SAJC**. This IAM app contains the start authorization for all job templates that refer to this job catalog entry. Create an IAM business catalog via ADT: 1. Right-click the package where the objects are located that have already been created. 2. Select *New \> Other ABAP Repository Object*. - 3. Collapse *Cloud Identity and Access Management*. + 3. Expand *Cloud Identity and Access Management*. 4. Double-click *Business Catalog*. 5. Enter a name \(e.g. `ZTEST_MY_SIMPLE_JOBS`\) and a description. 6. Select *Save* and choose the appropriate transport request. @@ -24,7 +24,30 @@ Some further activities in ADT and in the administrator’s launchpad are necess 10. Select *Save*. 11. Press *Publish Locally* on the top right corner of the screen. -2. Create a business role. +2. If the business logic performs own authorization checks, remember to add the required authorizations to a separate IAM app of type `EXT`. The following steps explain how to do this: + + 1. Right-click the package that contains the objects that have already been created. + + 2. Select *New* and then choose *Other ABAP Repository Object*. + + 3. Expand *Cloud Identity and Access Management*. + + 4. Choose *IAM App*. + + 5. Enter a name and a description. Choose *EXT - External App* as application type. + + 6. Select an appropriate transport request and click *Save*. + + 7. Select the *Authorizations* tab. + + 8. Select *Insert*. Now, you can specify an authorization object and assign values to the authorization fields. + + 9. Repeat step `h` for each authorization that is necessary to run the business logic. + + 10. Add the IAM app to the business catalog that you've created as described in step 1. + + +3. Create a business role. Open the Fiori App *Maintain Business Roles* in the Fiori Launchpad of the administrator and perform the following steps: @@ -32,18 +55,16 @@ Some further activities in ADT and in the administrator’s launchpad are necess 2. Choose a name \(e.g. `ZTEST_MY_SIMPLE_JOBS`\) and a description. 3. Click on *Assigned Business Catalogs*. 4. Select *Add*. - 5. Select the business role created in the previous step \(e.g. `ZTEST_MY_SIMPLE_JOBS`\). + 5. Select the business catalog created in the previous step \(e.g. `ZTEST_MY_SIMPLE_JOBS`\). > ### Note: - > A business user who shall be able to schedule application jobs needs to have access to the *Application Jobs* tile. This tile was provided by the business catalog `SAP_CORE_BC_APJ`, which is contained in the business role `SAP_BR_ADMINISTRATOR`. - > - > With the 2105 cloud release, the business catalog `SAP_CORE_BC_APJ` has been set to **deprecated**. Use the new business catalog `SAP_CORE_BC_APJ_JCE` instead. It doesn't only provide the *Application Jobs* app, but also contains restriction types to configure the authorization on other users’ jobs \(for more information, see the section *Assigning Further Authorizations* below\). + > A business user who shall be able to schedule application jobs needs to have access to the *Application Jobs* tile. This tile is provided by the business catalog `SAP_CORE_BC_APJ_JCE`, which is contained in the business role `SAP_BR_ADMINISTRATOR`. It doesn't only provide the *Application Jobs* app, but also contains restriction types to configure the authorization on other users’ jobs and to schedule jobs for other users \(for more information, see the section *Assigning Further Authorizations* below\). > > Add the business catalog `SAP_CORE_BC_APJ_JCE` to the business role created following the steps above, or assign it to a separate business role. 6. Select *Save*. -3. Assign the business role to a user. +4. Assign the business role to a user. For more information, see [How to Maintain Business Users](../50-administration-and-ops/how-to-maintain-business-users-db1d0b4.md). @@ -54,22 +75,22 @@ Some further activities in ADT and in the administrator’s launchpad are necess ## Assigning Further Authorizations -With the 2105 cloud release, you can access only your own jobs in the *Application Jobs* app. In order to grant access to other users' objects used in the *Application Jobs* app, create a new business role assigning the business catalog `SAP_CORE_BC_APJ_JCE` to it. You can modify the provided restriction types according to your needs. +You can access only your own jobs in the *Application Jobs* app. In order to grant access to other users' objects used in the *Application Jobs* app, create a new business role assigning the business catalog `SAP_CORE_BC_APJ_JCE` to it. You can modify the provided restriction types according to your needs. -1. Create a new business role assigning the business catalog `SAP_CORE_BC_APJ_JCE` to it. The restriction type `Job Catalog Entry/Application Job Part` contains the two fields `Application Job Catalog Entry` and `Application Job Part`. For more information, see [Maintain Business Roles](../50-administration-and-ops/maintain-business-roles-8980ad0.md). +1. Create a new business role assigning the business catalog `SAP_CORE_BC_APJ_JCE` to it. The restriction type `Job Catalog Entry/Application Job Part` contains the two fields `Application Job Catalog Entry` and `Application Job Part`. > ### Note: > With this restriction type you'll be able to provide the necessary authorizations for certain actions on other users' application jobs, which are based on a specified job catalog entry. With this, you can display the logs of other users' jobs, which are based on this specified job catalog entry. > > Alternatively, you can also create a display only-role using this restriction type. -2. Next, define your business role with the above-mentioned restriction fields `Application Job Catalog Entry` and `Application Job Part`. To do so, select *Maintain Restrictions*. In the `Application Job Catalog Entry` field, you can choose the job catalog entries, and in the `Application Job Part` field, you can choose for which part of a job access should be granted. You can choose the values `JOB` \(Job Details\), `SPOOL` \(Result List\), and `APPLOG` \(Log\) by clicking the *Edit* icon next to the fields. - -3. Go back and select *Save*. Now, you've maintained your business role, and you can assign the role to a business user. +2. The business catalog `SAP_CORE_BC_APJ_JCE` has another restriction type: `Create Application Jobs for Other Users`. It has the restriction field `Application Job Catalog Entry`. + > ### Note: + > With this restriction type you'll be able to grant a business user the authorization to schedule an application job for any other business user, based on the job catalog entry selected. This feature is supported by the parameter `iv_username` of the method `cl_apj_rt_api=>schedule_job`. For more information, see [Maintaining Application Jobs Using an API](maintaining-application-jobs-using-an-api-1491e6c.md). -**Related Information** +3. Next, define your business role with the above-mentioned restriction fields `Application Job Catalog Entry` and `Application Job Part`. To do so, select *Maintain Restrictions*. In the `Application Job Catalog Entry` field, you can choose the job catalog entries, and in the `Application Job Part` field, you can choose for which part of a job access should be granted. You can choose the values `JOB` \(Job Details\), `SPOOL` \(Result List\), and `APPLOG` \(Log\) by clicking the *Edit* icon next to the fields. +4. Go back and select *Save*. Now, you've maintained your business role, and you can assign the role to a business user. - diff --git a/docs/30-development/soap-communication-via-communication-arrangements-2133e15.md b/docs/30-development/soap-communication-via-communication-arrangements-2133e15.md index 0ec7e196..4f974855 100644 --- a/docs/30-development/soap-communication-via-communication-arrangements-2133e15.md +++ b/docs/30-development/soap-communication-via-communication-arrangements-2133e15.md @@ -12,6 +12,10 @@ - You have a service meta data file \(WSDL file\) for the service you want to consume. - You have created and activated a service consumption model \(SRVC\) of type `Web Service`. See [Generating Proxies for Remote Web Service](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/generating-proxies-for-remote-web-service?version=sap_btp) for more information. + > ### Restriction: + > When calling a SOAP service via communication arrangements, only SOAP 1.1 is supported. + + ## Procedure diff --git a/docs/30-development/soap-communication-via-url-7e22ed9.md b/docs/30-development/soap-communication-via-url-7e22ed9.md index 01680eca..47e47ce8 100644 --- a/docs/30-development/soap-communication-via-url-7e22ed9.md +++ b/docs/30-development/soap-communication-via-url-7e22ed9.md @@ -16,7 +16,7 @@ Instead of setting the *Additional Properties* as in the destination service app > An existing service consumption model \(SRVC\) is required. > ### Note: -> Use the URL approach mainly for testing purposes. +> Using `create_by_url` is only suitable for public services or test purposes, because credentials should be stored in the communication management in SAP Fiori launchpad. Call the SOAP service as described in the example. As described in [SOAP Communication via Communication Arrangements](soap-communication-via-communication-arrangements-2133e15.md), copy the code snippet from the *Overview* tab in your SRVC. Replace the `CREATE_BY_COMM_ARRANGEMENT` method with the `CREATE_BY_URL` method and pass the required URL to the method. diff --git a/docs/30-development/ui-development-b74a89d.md b/docs/30-development/ui-development-b74a89d.md index 61bfe0c9..321ecd8e 100644 --- a/docs/30-development/ui-development-b74a89d.md +++ b/docs/30-development/ui-development-b74a89d.md @@ -76,7 +76,7 @@ If you want to deploy an SAP Fiori application to the Cloud Foundry environment, - An administrator in the ABAP environment provides access to the OData service via a business role. A launchpad administrator enables access to the tile via a role collection. - A business user that is assigned to the business role and role collection can access the tile from SAP Fiori launchpad and launch the application. -![](images/FioriAppsinCF_0086ea3.png) +![](images/UIDevCF_dfa94a6.png) **Related Information** diff --git a/docs/30-development/user-api-service-b80abb0.md b/docs/30-development/user-api-service-b80abb0.md index 344bc9de..c989281f 100644 --- a/docs/30-development/user-api-service-b80abb0.md +++ b/docs/30-development/user-api-service-b80abb0.md @@ -40,8 +40,8 @@ The `/attributes` endpoint response has the following format: > "lastname": "Doe", > "email": "john.doe@sap.com", > "name": "john.doe@sap.com" (The user ID in the identity provider), -> "scopes": ["openid","user_attributes","uaa.user"] (Only if the the authentication type is “xsuaa"), -> < user attributes including custom attributes > (Only if the the authentication type is “xsuaa") +> "scopes": ["openid","user_attributes","uaa.user"] (Only if the authentication type is “xsuaa"), +> < user attributes including custom attributes > (Only if the authentication type is “xsuaa") > } > ``` > diff --git a/docs/40-extensions/enabling-system-landscape-for-sap-integration-suite-a14c276.md b/docs/40-extensions/enabling-system-landscape-for-sap-integration-suite-a14c276.md index d468ef50..4efab9dd 100644 --- a/docs/40-extensions/enabling-system-landscape-for-sap-integration-suite-a14c276.md +++ b/docs/40-extensions/enabling-system-landscape-for-sap-integration-suite-a14c276.md @@ -32,6 +32,9 @@ When creating *Integration with SAP Integration Suite* formations, keep in mind - You have a subscription to SAP Integration Suite. See[Subscribing and Configuring Initial Access to SAP Integration Suite](https://help.sap.com/docs/integration-suite/sap-integration-suite/subscribing-to-integration-suite?version=CLOUD). + > ### Note: + > Every time you create a subscription to a new SAP Integration Suite tenant, the system type for the tenant is automatically defined as “SAP Integration Suite”. + diff --git a/docs/40-extensions/my-sap-successfactors-odata-destination-does-not-work-cf26911.md b/docs/40-extensions/my-sap-successfactors-odata-destination-does-not-work-cf26911.md index 12175e8f..2f9c69f5 100644 --- a/docs/40-extensions/my-sap-successfactors-odata-destination-does-not-work-cf26911.md +++ b/docs/40-extensions/my-sap-successfactors-odata-destination-does-not-work-cf26911.md @@ -10,7 +10,7 @@ SAP SuccessFactors OData destination does not work. ## Issue/Symptom -You are extending SAP SuccessFactors on SAP BTP, Cloud Foundry environment using the SAP SuccessFactors Extensibility service. You are trying to configure the the integration between SAP SuccessFactors and SAP Business Technology Platform \(SAP BTP\) and your SAP SuccessFactors OData destination does not work. +You are extending SAP SuccessFactors on SAP BTP, Cloud Foundry environment using the SAP SuccessFactors Extensibility service. You are trying to configure the integration between SAP SuccessFactors and SAP Business Technology Platform \(SAP BTP\) and your SAP SuccessFactors OData destination does not work. diff --git a/docs/50-administration-and-ops/about-routes-in-the-cockpit-4af288c.md b/docs/50-administration-and-ops/about-routes-in-the-cockpit-4af288c.md index fe2a24dd..d6750480 100644 --- a/docs/50-administration-and-ops/about-routes-in-the-cockpit-4af288c.md +++ b/docs/50-administration-and-ops/about-routes-in-the-cockpit-4af288c.md @@ -8,13 +8,11 @@ To enable your end users to reach your application, create a route and map it to ## What Is a Route? -A route is the Uniform Resource Locator \(URL\) that enables your end users to reach your application. - -Routes belong to a space, and therefore are managed at space level. +A route is the URL that enables your end users to reach your application. Routes belong to a space, and therefore are managed at space level. The Router component in Cloud Foundry is responsible for routing routes. It maintains a list of mapped applications and compares each request with the list to find the best match. Based on this comparison, it then routes requests to the appropriate application instance. -Currently, you can create, map, and delete HTTP routes. An HTTP route includes a domain, an optional host name \(or subdomain\), and an optional path. +Currently, you can create, map, and delete HTTP routes. An HTTP route includes a domain, a host name \(or subdomain\), and an optional path. diff --git a/docs/50-administration-and-ops/about-user-management-in-the-cloud-foundry-environment-8e6ce96.md b/docs/50-administration-and-ops/about-user-management-in-the-cloud-foundry-environment-8e6ce96.md index ea17825c..39357019 100644 --- a/docs/50-administration-and-ops/about-user-management-in-the-cloud-foundry-environment-8e6ce96.md +++ b/docs/50-administration-and-ops/about-user-management-in-the-cloud-foundry-environment-8e6ce96.md @@ -19,7 +19,7 @@ If you’re the `Org Manager`, you already have the authorizations to add users ## Cloud Foundry and Shadow Users -Whenever you add a user at the org or space level with the SAP BTP cockpit, SAP BTP also creates the user at the subaccount level, also known as a shadow user. When you use the SAP BTP cockpit to add a user, SAP BTPassigns at least one Cloud Foundry role to the user, namely *Org User* if you don't add any other role. SAP BTPchecks for Cloud Foundry users with a role and creates corresponding shadow users at the subaccount level if no such user exists. Creating users with the Cloud Foundry CLI or Cloud Foundry APIs doesn't add any Cloud Foundry roles by default. Once you add a role to the user, the system ensures that there's a corresponding user at the subaccount level. +Whenever you add a user at the org or space level with the SAP BTP cockpit, SAP BTP also creates the user at the subaccount level, also known as a shadow user. When you use the SAP BTP cockpit to add a user, SAP BTP assigns at least one Cloud Foundry role to the user, namely *Org User* if you don't add any other role. SAP BTPchecks for Cloud Foundry users with a role and creates corresponding shadow users at the subaccount level if no such user exists. Creating users with the Cloud Foundry CLI or Cloud Foundry APIs doesn't add any Cloud Foundry roles by default. Once you add a role to the user, the system ensures that there's a corresponding user at the subaccount level. > ### Remember: > When you delete a user at the Cloud Foundry level, SAP BTP doesn’t delete the corresponding shadow user at the subaccount level. diff --git a/docs/50-administration-and-ops/access-joule-beta-9107b1c.md b/docs/50-administration-and-ops/access-joule-beta-9107b1c.md index d71b0373..b4726d91 100644 --- a/docs/50-administration-and-ops/access-joule-beta-9107b1c.md +++ b/docs/50-administration-and-ops/access-joule-beta-9107b1c.md @@ -9,7 +9,7 @@ Launch Joule directly from SAP BTP cockpit. > ### Note: > This offering is a beta feature. Beta features aren't part of the officially delivered scope that SAP guarantees for future releases. For more information, see [Important Disclaimers and Legal Information](https://help.sap.com/viewer/disclaimer). -Joule is accessed directly from the cockpit when you click the diamond icon in the cockpit tool header. When the chat window opens, you can ask Joule to perform one of the supported administrative tasks or you can ask Joule a question about SAP BTP. +Joule is accessed directly from the cockpit when you click the diamond icon in the cockpit tool header. When the chat window opens, you can ask Joule to perform one of the supported capabilities or you can ask Joule a question about SAP BTP. diff --git a/docs/50-administration-and-ops/account-administration-using-joule-beta-3d7626b.md b/docs/50-administration-and-ops/account-administration-using-joule-beta-3d7626b.md index 6f6882ce..3d7b756b 100644 --- a/docs/50-administration-and-ops/account-administration-using-joule-beta-3d7626b.md +++ b/docs/50-administration-and-ops/account-administration-using-joule-beta-3d7626b.md @@ -9,7 +9,7 @@ Learn about the administrative tasks that SAP's generative AI copilot, Joule, ca Joule makes it easier than ever to create subaccounts and manage account users in the cockpit. With Joule integrated into the cockpit, you can accomplish your goals faster. -- Ask Joule to perform an administrative action for you from a set of pre-defined administrative workflows. +- Ask Joule to perform an administrative action for you from a set of pre-defined capabilities. - Ask Joule a question about SAP BTP services or the cockpit. Joule references SAP BTP cockpit documentation and provides a summary of what it finds, as well as links to relevant help content. **Related Information** diff --git a/docs/50-administration-and-ops/assign-space-quotas-to-spaces-13028c4.md b/docs/50-administration-and-ops/assign-space-quotas-to-spaces-13028c4.md index 605585d1..4dcaeef2 100644 --- a/docs/50-administration-and-ops/assign-space-quotas-to-spaces-13028c4.md +++ b/docs/50-administration-and-ops/assign-space-quotas-to-spaces-13028c4.md @@ -1,5 +1,7 @@ + + # Assign Space Quotas to Spaces You can use the SAP BTP cockpit to assign space quotas to spaces. @@ -27,7 +29,7 @@ You can use the SAP BTP cockpit to assign space quotas to spaces. 3. Open the *Quota Assignments* tab. -4. Select one of the existing quota assignments and choose *![](images/Edit_Icon_abfe424.png) \(Edit\)* to make changes. +4. Select one of the existing quota assignments and choose :pencil2: to make changes. 5. Select either a specific *Space Quota* from the drop-down or the *Org Quota*. diff --git a/docs/50-administration-and-ops/available-plans-in-the-kyma-environment-befe01d.md b/docs/50-administration-and-ops/available-plans-in-the-kyma-environment-befe01d.md index bdc9de3b..27d384fe 100644 --- a/docs/50-administration-and-ops/available-plans-in-the-kyma-environment-befe01d.md +++ b/docs/50-administration-and-ops/available-plans-in-the-kyma-environment-befe01d.md @@ -157,7 +157,10 @@ The technical name of the plan is `free`. Using the free service plans for Kyma - Before you enable the Kyma environment, you must first assign it as an entitlement to your subaccount. -- You have only one 30-day free service plan quota available per global account. +- You can use the free plan only once in a global account for up to 30 days. + + > ### Remember: + > Once you have started the free plan in a subaccount, you cannot use it in another subaccount within the same global account even though the 30-day period has not ended. - The services you plan to use must be available in the same region as the subaccount for the Kyma runtime. If necessary, change the default subaccount region. @@ -620,7 +623,7 @@ Updating ## Kyma Test Demo and Development \(Azure Lite\) -The technical name of the plan is `azure_lite`. The Kyma Test Demo and Development plan is offered to Partners, who can use it for testing, development, and demo purposes. +The technical name of the plan is `azure_lite`. The Kyma Test Demo and Development plan is offered to Partners, whithin the [*Pay-As-You-Go for SAP BTP for cloud test, demo, and development*](https://partneredge.sap.com/en/profile/create-profile.html) commercial model. You can use this plan for testing, development, and demo purposes. In the SAP BTP cockpit, the plan is called "Kyma Runtime Partner TDD". > ### Remember: > The parameters marked with an asterisk "\*" are mandatory. diff --git a/docs/50-administration-and-ops/conversations-with-joule-beta-20b5e3e.md b/docs/50-administration-and-ops/conversations-with-joule-beta-20b5e3e.md index 1f355ac9..7ccf0d80 100644 --- a/docs/50-administration-and-ops/conversations-with-joule-beta-20b5e3e.md +++ b/docs/50-administration-and-ops/conversations-with-joule-beta-20b5e3e.md @@ -9,7 +9,7 @@ Let Joule help you find answers to questions about managing your accounts in SAP Take your SAP BTP cockpit administration questions to Joule. Just type a question in the Joule chat using natural language and let Joule scan the product documentation on the SAP Help Portal for answers. -Joule summarizes the relevant SAP Help Portal information. This summary is then displayed along with the top three search results. If you select a link result, you're taken directly to the topic on the SAP Help Portal. +Joule summarizes the relevant SAP Help Portal information. This summary is then displayed along with the top help results. If you select a link result, you're taken directly to the topic on the SAP Help Portal. > ### Note: > Joule is an addition to in-app help content, guided tours, embedded learning content, and customer-specific enablement content in SAP Companion. diff --git a/docs/50-administration-and-ops/create-users-a3bc7e8.md b/docs/50-administration-and-ops/create-users-a3bc7e8.md index e1c7b1f2..d27dc303 100644 --- a/docs/50-administration-and-ops/create-users-a3bc7e8.md +++ b/docs/50-administration-and-ops/create-users-a3bc7e8.md @@ -20,7 +20,7 @@ All users in the subaccounts of SAP BTP are stored in identity providers, either A new hire starts to work in your company next month. As an administrator, you want to provide a user, enable logon to the SAP BTP subaccount, and provide the necessary authorizations for this new hire. You create the actual user in the identity provider. However, you can't assign subaccount authorizations to an individual user in an identity provider. You need a shadow user in the SAP BTP subaccount to assign authorizations. After having created a shadow user, you can assign role collections. Thus, you make sure that the new hire can log on to the subaccount and that the necessary authorizations are in place when the new hire starts. -If you switched off the creation of shadow users in the trust configuration of your custom identity providers, new users created in the identity provider don't have a user copy \(shadow user\) in the respective SAP BTP subaccount. You, as a subaccount administrator, have full control of who can log on to this subaccount. The new user can log on to the subaccount if you've created a shadow user with the same e-mail address in the SAP BTP subaccount. Now, you can grant authorizations by assigning role collections. +If you switched off the creation of shadow users in the trust configuration of your custom identity providers, new users created in the identity provider don't have a user copy \(shadow user\) in the respective SAP BTP subaccount. You, as a subaccount administrator, have full control of who can log on to this subaccount. The new user can log on to the subaccount if you've created a shadow user with the same email address in the SAP BTP subaccount. Now, you can grant authorizations by assigning role collections. You can alternatively grant authorizations in the subaccount by mapping role collections to the user group if the user belongs to a user group in the identity provider. @@ -40,7 +40,10 @@ As an administrator, you can create shadow users in your subaccount and you must The SAP BTP cockpit displays a new row where you can enter the user data. -5. Enter the user ID and e-mail address. +5. Enter the user ID and email address. + + > ### Note: + > The email address of the user is the user identifier for all account levels \(global account, directory, multi-environment subaccount\) and for the Cloud Foundry environment. > ### Note: > To specify the last name and first name of the user, maintain the names in the identity provider that stores the user. This information is automatically added to the shadow users when the user logs on with their identity provider using a URL such as: diff --git a/docs/50-administration-and-ops/default-identity-provider-d6a8db7.md b/docs/50-administration-and-ops/default-identity-provider-d6a8db7.md index c1d92361..7dfb0d4b 100644 --- a/docs/50-administration-and-ops/default-identity-provider-d6a8db7.md +++ b/docs/50-administration-and-ops/default-identity-provider-d6a8db7.md @@ -130,5 +130,5 @@ For more information, see [Trust and Federation with Identity Providers](trust-a [Platform Identity Provider for Tools](https://help.sap.com/viewer/ea72206b834e4ace9cd834feed6c0e09/Cloud/en-US/80edbe70b8f3478d8a59c21a91a47aa6.html "Configure the platform identity provider to be used for authentication in service and platform tools (for example, Neo console client, Cloud Connector, SAP Git Service, and so on). The default user base is provided by SAP ID Service. You can switch to an Identity Authentication tenant if you want to use a custom user base.") :arrow_upper_right: -[Working with Users](working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role is belongs to.") +[Working with Users](working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role belongs to.") diff --git a/docs/50-administration-and-ops/delete-users-51000c2.md b/docs/50-administration-and-ops/delete-users-51000c2.md index 3f0b52d2..7bac8c7e 100644 --- a/docs/50-administration-and-ops/delete-users-51000c2.md +++ b/docs/50-administration-and-ops/delete-users-51000c2.md @@ -109,7 +109,7 @@ Keep in mind that you also delete the user's role collection assignments. **Related Information** -[Working with Users](working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role is belongs to.") +[Working with Users](working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role belongs to.") [Deletion](../60-security/deletion-25e3cc6.md "The processing of personal data is subject to applicable laws related to the deletion of this data when the specified, explicit, and legitimate purpose for processing this personal data has expired. If there is no longer a legitimate purpose that requires the retention and use of personal data, it must be deleted.") diff --git a/docs/50-administration-and-ops/download-and-start-using-the-btp-cli-client-8a8f17f.md b/docs/50-administration-and-ops/download-and-start-using-the-btp-cli-client-8a8f17f.md index 0d0aeaa4..743c2c1d 100644 --- a/docs/50-administration-and-ops/download-and-start-using-the-btp-cli-client-8a8f17f.md +++ b/docs/50-administration-and-ops/download-and-start-using-the-btp-cli-client-8a8f17f.md @@ -25,7 +25,7 @@ In the [What's New for SAP Business Technology Platform](https://help.sap.com/wh ## Procedure -1. Download the appropriate client for your operating system from [SAP Development Tools](https://tools.hana.ondemand.com/#cloud-btpcli) with the links in the table below. If you prefer using the the command line or a script, you can use the curl command from the table below, which downloads and saves the latest client version to your computer and accepts the SAP Developer Agreement \(EULA\). +1. Download the appropriate client for your operating system from [SAP Development Tools](https://tools.hana.ondemand.com/#cloud-btpcli) with the links in the table below. If you prefer using the command line or a script, you can use the curl command from the table below, which downloads and saves the latest client version to your computer and accepts the SAP Developer Agreement \(EULA\). @@ -139,7 +139,7 @@ In the [What's New for SAP Business Technology Platform](https://help.sap.com/wh 4. \(Optional\) If you have a proxy server configured in your environment, you need to specify its address and port as environment variable `HTTPS_PROXY` or `https_proxy` to access SAP BTP. For example, `HTTPS_PROXY=https://my-https-proxy:1234`. - The specified proxy server is then used for HTTPS requests, unless overriden by the `NO_PROXY` or `no_proxy`, environment variables, which define a comma-separated list of hosts to be excluded from proxying. + The specified proxy server is then used for HTTPS requests, unless overridden by the `NO_PROXY` or `no_proxy`, environment variables, which define a comma-separated list of hosts to be excluded from proxying. 5. Run `btp` in your terminal. Note that you need read and write permissions in the target folder to run this executable. diff --git a/docs/50-administration-and-ops/edit-space-quotas-2a58364.md b/docs/50-administration-and-ops/edit-space-quotas-2a58364.md index bd175a82..94c3b3d7 100644 --- a/docs/50-administration-and-ops/edit-space-quotas-2a58364.md +++ b/docs/50-administration-and-ops/edit-space-quotas-2a58364.md @@ -1,5 +1,7 @@ + + # Edit Space Quotas Edit space quotas in the Cloud Foundry environment using the SAP BTP cockpit. @@ -20,7 +22,7 @@ You have the Org Manager role for the org in which you want to edit space quotas 2. In the navigation menu, choose *Cloud Foundry* \> *Space Quotas*. -3. Choose *![](images/Edit_Icon_abfe424.png) \(Edit\)* for an existing space quota. +3. Choose :pencil2: for an existing space quota. 4. Adjust the values in the text fields as needed. diff --git a/docs/50-administration-and-ops/establish-trust-and-federation-of-custom-identity-providers-for-platform-users-c368984.md b/docs/50-administration-and-ops/establish-trust-and-federation-of-custom-identity-providers-for-platform-users-c368984.md index dee0f97b..6233497c 100644 --- a/docs/50-administration-and-ops/establish-trust-and-federation-of-custom-identity-providers-for-platform-users-c368984.md +++ b/docs/50-administration-and-ops/establish-trust-and-federation-of-custom-identity-providers-for-platform-users-c368984.md @@ -20,6 +20,9 @@ You want to use a custom identity provider for the platform users of SAP BTP in - Make sure that the email addresses of all users in your identity provider are unique and correct. + > ### Note: + > The email address of the user is the user identifier for all account levels \(global account, directory, multi-environment subaccount\) and for the Cloud Foundry environment. + diff --git a/docs/50-administration-and-ops/manage-users-in-directories-ff4d4a4.md b/docs/50-administration-and-ops/manage-users-in-directories-ff4d4a4.md index 25e1b4d5..89c55e9c 100644 --- a/docs/50-administration-and-ops/manage-users-in-directories-ff4d4a4.md +++ b/docs/50-administration-and-ops/manage-users-in-directories-ff4d4a4.md @@ -73,7 +73,7 @@ The next time this user logs on to the SAP BTP cockpit, the user can access this **Related Information** -[Working with Users](working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role is belongs to.") +[Working with Users](working-with-users-2c91f88.md "In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role belongs to.") [Role Collections and Roles in Global Accounts, Directories, and Subaccounts](../10-concepts/role-collections-and-roles-in-global-accounts-directories-and-subaccounts-0039cf0.md "SAP BTP provides a set of role collections to set up administrator access to your global account and subaccounts.") diff --git a/docs/50-administration-and-ops/managing-space-quotas-4e5f0ee.md b/docs/50-administration-and-ops/managing-space-quotas-4e5f0ee.md index 3da0f7b8..6dad886e 100644 --- a/docs/50-administration-and-ops/managing-space-quotas-4e5f0ee.md +++ b/docs/50-administration-and-ops/managing-space-quotas-4e5f0ee.md @@ -1,5 +1,7 @@ + + # Managing Space Quotas Learn what a space quota is, what type of information you will find on the *Space Quotas* page in the SAP BTP cockpit, and what you can do with a space quota in the Cloud Foundry environment. @@ -99,7 +101,7 @@ You can switch between the following views on this page: - A list of all the available spaces in the subaccount you have access to and whether they have a space quota assigned to them or if they are using the org quota instead. - - The option to *![](images/Edit_Icon_abfe424.png) \(Edit\)* a quota assignment. + - The option to :pencil2: a quota assignment. For more information, see [Assign Space Quotas to Spaces](assign-space-quotas-to-spaces-13028c4.md). diff --git a/docs/50-administration-and-ops/managing-spaces-5209d55.md b/docs/50-administration-and-ops/managing-spaces-5209d55.md index 9256d91e..d1c06fd7 100644 --- a/docs/50-administration-and-ops/managing-spaces-5209d55.md +++ b/docs/50-administration-and-ops/managing-spaces-5209d55.md @@ -1,5 +1,7 @@ + + # Managing Spaces Learn what a Cloud Foundry space is, what type of information you will find on the *Spaces* page in the SAP BTP cockpit, and what you can do with or within a space. @@ -73,7 +75,7 @@ Here are some of the space-related actions you can do: - Edit Spaces - To edit a space, choose ![](images/Edit_Icon_abfe424.png) \(Edit\) on the space tile. This option lets you change the name of the space. + To edit a space, choose :pencil2: Org Managers and Space Managers are allowed to rename spaces. diff --git a/docs/50-administration-and-ops/monitoring-usage-and-consumption-costs-in-your-global-account-de6f0db.md b/docs/50-administration-and-ops/monitoring-usage-and-consumption-costs-in-your-global-account-de6f0db.md index 5cac9443..5ac63921 100644 --- a/docs/50-administration-and-ops/monitoring-usage-and-consumption-costs-in-your-global-account-de6f0db.md +++ b/docs/50-administration-and-ops/monitoring-usage-and-consumption-costs-in-your-global-account-de6f0db.md @@ -110,7 +110,7 @@ Note the following:
-Pay attention that if your global account uses a combination of the consumption-based commercial model and the subscription-based commercial model, the card on the right shows billing and usage data that is charged solely according to the consumption-based commercial model. In other words, for services that are part of your subscription-based commercial agreement, the billing and usage data in this card apples only to consumption that exceeds your prepaid \(subscription\) quota. For this excess service usage, you are charged according to your contract for the consumption-based commercial model. +Pay attention that if your global account uses a combination of the consumption-based commercial model and the subscription-based commercial model, the card on the right shows billing and usage data that is charged solely according to the consumption-based commercial model. In other words, for services that are part of your subscription-based commercial agreement, the billing and usage data in this card applies only to consumption that exceeds your prepaid \(subscription\) quota. For this excess service usage, you are charged according to your contract for the consumption-based commercial model. For example, if your subscription contract is entitled to consume a given service at a fixed cost for up to 100 unique site visits, and 151 unique site visits are registered, this card shows data relating only to the 51 visits that have exceeded the prepaid 100 visits. diff --git a/docs/50-administration-and-ops/multitarget-application-commands-for-the-cloud-foundry-environment-65ddb1b.md b/docs/50-administration-and-ops/multitarget-application-commands-for-the-cloud-foundry-environment-65ddb1b.md index 7e7c9938..3a5a22c3 100644 --- a/docs/50-administration-and-ops/multitarget-application-commands-for-the-cloud-foundry-environment-65ddb1b.md +++ b/docs/50-administration-and-ops/multitarget-application-commands-for-the-cloud-foundry-environment-65ddb1b.md @@ -199,10 +199,11 @@ Deploy a new MTA or synchronize changes to an existing one. You have the followi ``` cf deploy | [-e [,]] [-u ] [-t ] [-v ] - [--no-start] [--namespace] + [--no-start] [--namespace] [--apps-upload-timeout ] [--apps-stage-timeout ] [--apps-start-timeout ] [--apps-task-execution-timeout ] [--delete-services] [--delete-service-keys] [--delete-service-brokers] - [][--keep-files] [--no-restart-subscribed-apps] [--do-not-fail-on-missing-permissions] [--skip-idle-start] + [--keep-files] [--no-restart-subscribed-apps] [--do-not-fail-on-missing-permissions] [--skip-idle-start] cf deploy ...[--retries ] + ``` - **Deployment using an URL to the MTA archive** @@ -215,10 +216,11 @@ Deploy a new MTA or synchronize changes to an existing one. You have the followi ``` | cf deploy [-e [,]] [-u ] [-t ] [-v ] - [--no-start] [--namespace] + [--no-start] [--namespace] [--apps-upload-timeout ] [--apps-stage-timeout ] [--apps-start-timeout ] [--apps-task-execution-timeout ] [--delete-services] [--delete-service-keys] [--delete-service-brokers] - [][--keep-files] [--no-restart-subscribed-apps] [--do-not-fail-on-missing-permissions] [--skip-idle-start] + [--keep-files] [--no-restart-subscribed-apps] [--do-not-fail-on-missing-permissions] [--skip-idle-start] cf deploy ...[--retries ] + ``` > ### Caution: @@ -422,6 +424,82 @@ Force deployment without requiring any confirmation about aborting any conflicti Do not start application after deployment + + + + + +--apps-upload-timeout <TIMEOUT> + + + + +Defines how long, in seconds, you can upload your application binary before the MTA operation times out. + +See [Application-Specific Timeouts](../30-development/applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + +> ### Note: +> This applies to all applications. + + + + + + + + +--apps-stage-timeout <TIMEOUT> + + + + +Defines how long, in seconds, your application can take during staging before the MTA operation times out. + +See [Application-Specific Timeouts](../30-development/applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + +> ### Note: +> This applies to all applications. + + + + + + + + +--apps-start-timeout <TIMEOUT> + + + + +Defines how long, in seconds, your application can take to start before the MTA operation times out. + +See [Application-Specific Timeouts](../30-development/applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + +> ### Note: +> This applies to all applications. + + + + + + + + +--apps-task-execution-timeout <TIMEOUT> + + + + +Defines how long, in seconds, your application can take to execute a task before the MTA operation times out. + +See [Application-Specific Timeouts](../30-development/applications-0540211.md#loio05402110821742479725338cc8d7fe8c__section_qlj_kky_ncc) . + +> ### Note: +> This applies to all applications. + + + diff --git a/docs/50-administration-and-ops/org-management-using-the-sap-btp-command-line-interface-btp-cli-aee40e1.md b/docs/50-administration-and-ops/org-management-using-the-sap-btp-command-line-interface-btp-cli-aee40e1.md index fbfa9ff3..95cd8a31 100644 --- a/docs/50-administration-and-ops/org-management-using-the-sap-btp-command-line-interface-btp-cli-aee40e1.md +++ b/docs/50-administration-and-ops/org-management-using-the-sap-btp-command-line-interface-btp-cli-aee40e1.md @@ -340,7 +340,7 @@ For a custom identity provider: Add one or more org managers to a Cloud Foundry org in a subaccount. -`usersToAdd` adds the OrgManager role to the user, and, if it doesnt exist yet, it creates the user in the org. +`usersToAdd` adds the OrgManager role to the user, and, if it doesn't exist yet, it creates the user in the org. @@ -379,7 +379,7 @@ For a custom identity provider: Remove one or more org managers from a Cloud Foundry org in a subaccount. -`usersToRemove` removes the OrgManager role from the the user, but it doesn't remove the user from the org. +`usersToRemove` removes the OrgManager role from the user, but it doesn't remove the user from the org. diff --git a/docs/50-administration-and-ops/provisioning-and-updating-parameters-in-the-kyma-environment-e2e13bf.md b/docs/50-administration-and-ops/provisioning-and-updating-parameters-in-the-kyma-environment-e2e13bf.md index 70f71e2f..bce90001 100644 --- a/docs/50-administration-and-ops/provisioning-and-updating-parameters-in-the-kyma-environment-e2e13bf.md +++ b/docs/50-administration-and-ops/provisioning-and-updating-parameters-in-the-kyma-environment-e2e13bf.md @@ -1685,14 +1685,14 @@ Australia \(Sydney\) - + Standard: Google Cloud technical name: `gcp` - + Provisioning @@ -1769,7 +1769,31 @@ Israel \(Tel Aviv\) - + + +`australia-southeast1` + + + + +Australia \(Sydney\) + + + + + + +`southamerica-east1` + + + + +Brazil \(São Paulo\) + + + + + Standard: Microsoft Azure @@ -1780,7 +1804,7 @@ Kyma Test Demo and Development \(Azure Lite\) technical name: `azure_lite` - + Provisioning @@ -1902,6 +1926,18 @@ Australia \(Sydney\) Switzerland \(Zurich\) + + + + + +`brazilsouth` + + + + +Brazil \(São Paulo\) + diff --git a/docs/50-administration-and-ops/supported-administrative-tasks-beta-88b02d5.md b/docs/50-administration-and-ops/supported-administrative-tasks-beta-88b02d5.md index 97ab528a..ed47c3b5 100644 --- a/docs/50-administration-and-ops/supported-administrative-tasks-beta-88b02d5.md +++ b/docs/50-administration-and-ops/supported-administrative-tasks-beta-88b02d5.md @@ -9,7 +9,7 @@ Learn about the administrative tasks that Joule can perform for you in the SAP B > > Joule doesn't support administrative actions in Neo environments. -You can ask Joule to perform certain administrative tasks for you in the cockpit. If Joule recognizes the task as a supported workflow, then it walks you through the steps to complete the task. +You can ask Joule to perform certain administrative tasks for you in the cockpit. If Joule recognizes the task as a supported capability, then it walks you through the steps to complete the task. You can ask Joule to do these things in the cockpit: @@ -27,6 +27,7 @@ There are times when it's helpful to see a summary of your global account and su - View global account users. You can view all users or filter by role. - View subaccount users. You can view all users or filter by role. +- View subaccount details. Joule displays information about the account. For example, region, Cloud Foundry status, subdomain, and more. ![Joule screen with administrative task prompts](images/Joule_BTP_Tasks_b9ba888.png) diff --git a/docs/50-administration-and-ops/supported-tools-and-services-when-using-custom-identity-providers-for-platform-users-94ef515.md b/docs/50-administration-and-ops/supported-tools-and-services-when-using-custom-identity-providers-for-platform-users-94ef515.md index e6867ebf..f2e7963c 100644 --- a/docs/50-administration-and-ops/supported-tools-and-services-when-using-custom-identity-providers-for-platform-users-94ef515.md +++ b/docs/50-administration-and-ops/supported-tools-and-services-when-using-custom-identity-providers-for-platform-users-94ef515.md @@ -38,7 +38,7 @@ For more information, see [Use a Custom IDP for Subaccount Configuration](https: > Currently, Cloud Connector can be connected to an SAP BTP subaccount only with users from the default identity provider. > ### Note: -> In addition to the the initial connection from Cloud Connector to SAP BTP, the regular rotation of the client certificate that is used for the ongoing connection, is also affected. +> In addition to the initial connection from Cloud Connector to SAP BTP, the regular rotation of the client certificate that is used for the ongoing connection, is also affected. diff --git a/docs/50-administration-and-ops/working-with-users-2c91f88.md b/docs/50-administration-and-ops/working-with-users-2c91f88.md index c15927b8..2b1d36ad 100644 --- a/docs/50-administration-and-ops/working-with-users-2c91f88.md +++ b/docs/50-administration-and-ops/working-with-users-2c91f88.md @@ -2,7 +2,7 @@ # Working with Users -In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role is belongs to. +In the SAP BTP cockpit, you can see the users of your global account or subaccount, user-related identity provider information, and their authorizations. In a user's overview, you can create and delete users, and assign role collections. You can also display an overview of the role collections, where you can drill down all the way to the role, and see the application that the role belongs to. @@ -22,7 +22,7 @@ SAP BTP creates a copy of the user in the global account or in the subaccount wh > ### Note: > User data of shadow users is regularly updated after authentication at the identity provider. > -> When a user authenticates against SAP BTP, an authentication request is forwarded to the trusted identity provider \(for example, SAP Cloud Identity Services\). After succcessful authentication, the identity provider creates a user token based on its configuration and sends it back to SAP BTP. In SAP BTP, the user data is updated according to the token. +> When a user authenticates against SAP BTP, an authentication request is forwarded to the trusted identity provider \(for example, SAP Cloud Identity Services\). After successful authentication, the identity provider creates a user token based on its configuration and sends it back to SAP BTP. In SAP BTP, the user data is updated according to the token. @@ -182,7 +182,7 @@ Delete shadows user to comply with data protection and privacy regulations. -For data protection and privacy reasons, administrators might be legallly obliged to delete shadow users who belonged to employees who left the company. You can find and delete the shadow users in the SAP BTP cockpit. +For data protection and privacy reasons, administrators might be legally obliged to delete shadow users who belonged to employees who left the company. You can find and delete the shadow users in the SAP BTP cockpit. See [Delete Users](delete-users-51000c2.md). diff --git a/docs/60-security/security-recommendations-for-sap-authorization-and-trust-management-service-0578b80.md b/docs/60-security/security-recommendations-for-sap-authorization-and-trust-management-service-0578b80.md index 295eca16..7b665d8d 100644 --- a/docs/60-security/security-recommendations-for-sap-authorization-and-trust-management-service-0578b80.md +++ b/docs/60-security/security-recommendations-for-sap-authorization-and-trust-management-service-0578b80.md @@ -71,18 +71,6 @@ Synchronize the user data with a provisioning service. -Keep a few global account administrators from the default identity provider. - - - - -[BTP-UAA-0009](https://help.sap.com/docs/BTP/c8a9bb59fe624f0981efa0eff2497d7d/531f33def8074ccdb6f1f784a34dafcb.html?seclist-index=BTP-UAA-0009) - - - - - - Check which users have critical roles. diff --git a/docs/60-security/third-party-cookies-and-sap-authorization-and-trust-management-service-5ab1e0b.md b/docs/60-security/third-party-cookies-and-sap-authorization-and-trust-management-service-5ab1e0b.md index 27aff087..b0f90442 100644 --- a/docs/60-security/third-party-cookies-and-sap-authorization-and-trust-management-service-5ab1e0b.md +++ b/docs/60-security/third-party-cookies-and-sap-authorization-and-trust-management-service-5ab1e0b.md @@ -2,12 +2,12 @@ # Third-Party Cookies and SAP Authorization and Trust Management Service -Browser manufacturers are ending support for third-party cookies. This change can prevent embedded BTP applications and their logon screens from functioning. +Browser manufacturers are phasing out support for third-party cookies. This change can prevent embedded BTP applications and their logon screens from functioning. To prevent your logon scenarios from failing, make sure that all multi-environment subaccounts, which contain these embedded applications, are configured to use a tenant of SAP Cloud Identity Services as the trusted identity provider. > ### Caution: -> Migrate your trust before the browser vendors deprecate support. +> Migrate your trust before the browser vendors phase out support. > > Trusting your SAP Cloud Identity Services tenant enables your applications to integrate with the overall solution provided by SAP. > @@ -18,16 +18,16 @@ To migrate an existing trust configuration, see [Migration from SAML Trust to Op If your framing and framed applications run under different domains, you must still maintain trust between the domains as before. For more information, see [Configure Trusted Domains for SAP Authorization and Trust Management Service \[Feature Set B\]](https://help.sap.com/docs/btp/sap-business-technology-platform/configure-trusted-domains-for-sap-authorization-and-trust-management-service). > ### Recommendation: -> Test your solutions before third-party cookies have been deprecated. To test how your solutions function once third-party cookies have been deprecated, enable the `partitionedCookies` property of the Security Settings API of the SAP Authorization and Trust Management service and run your tests. If your business scenarios fail, set `partitionedCookies` to false to help troubleshoot the source of the problem. +> Test your solutions before third-party cookies have been phased out. To test how your solutions function once third-party cookies have been phased out, enable the `partitionedCookies` property of the Security Settings API of the SAP Authorization and Trust Management service and run your tests. If your business scenarios fail, set `partitionedCookies` to false to help troubleshoot the source of the problem. > > For more information, see the following: > -> - How to test: [Preparing and Testing Your Solution for Third-Party Cookie Deprecation](https://help.sap.com/viewer/25b384c4cc9c472f9e056ebca95fa6ff/Cloud/en-US/70d545de1931484c9efbc2cda6519fa7.html "The focus of this guide is to identify issues related to the phase out of third-party cookies. You will learn how to test your application your extensions and assess whether they are affected. Mitigation strategies are covered in Implementing a Permanent Solution for the Third-Party Cookie Phase-Out guide.") :arrow_upper_right: +> - How to test: [Preparing and Testing Your Solution for Third-Party Cookie Phase-Out](https://help.sap.com/viewer/25b384c4cc9c472f9e056ebca95fa6ff/Cloud/en-US/70d545de1931484c9efbc2cda6519fa7.html "The focus of this guide is to identify issues related to the phase out of third-party cookies. You will learn how to test your application your extensions and assess whether they are affected. Mitigation strategies are covered in Implementing a Permanent Solution for the Third-Party Cookie Phase-Out guide.") :arrow_upper_right: > > - How to use the API: [Accessing Administration Using APIs of the SAP Authorization and Trust Management Service](https://help.sap.com/docs/btp/sap-business-technology-platform/accessing-administration-using-apis-of-sap-authorization-and-trust-management-service) > > -> In subaccounts created before May 30, 2024, the `partitionedCookies` property has a default value of ***false***. In subaccounts created afterward, the property has a default value of ***true***. When Google begins large-scale deprecation of third-party cookies, we plan to set this property to ***true*** and read-only in all subaccounts. +> In subaccounts created before May 30, 2024, the `partitionedCookies` property has a default value of ***false***. In subaccounts created afterward, the property has a default value of ***true***. When Google begins large-scale phase-out of third-party cookies, we plan to set this property to ***true*** and read-only in all subaccounts. **Related Information** diff --git a/docs/70-getting-support/support-components-08d1103.md b/docs/70-getting-support/support-components-08d1103.md index 34b492a2..415b225c 100644 --- a/docs/70-getting-support/support-components-08d1103.md +++ b/docs/70-getting-support/support-components-08d1103.md @@ -2324,7 +2324,7 @@ Detect and highlight entities from unstructured text using machine learning. -Connects extension applications running in a subaccount in SAP BTP to an SAP S/4HANA Cloud system. +Automates the connectivity configuration of extension applications running on SAP BTP to SAP S/4HANA Cloud systems. @@ -2350,13 +2350,15 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP S/4 -- Europe \(Frankfurt\) -- US East \(VA\) -- Brazil \(São Paulo\) -- Japan \(Tokyo\) - Australia \(Sydney\) - Singapore +- South Korea \(Seoul\) +- Brazil \(São Paulo\) - Canada \(Montreal\) +- Europe \(Frankfurt\) +- Europe \(Frankfurt\) EU Access +- Japan \(Tokyo\) +- US East \(VA\) @@ -2384,7 +2386,7 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP S/4 -Connects extension applications running in a subaccount in SAP BTP to an SAP S/4HANA Cloud system. +Automates the connectivity configuration of extension applications running on SAP BTP to SAP S/4HANA Cloud systems. @@ -2410,9 +2412,13 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP S/4 +- Australia \(Sydney\) +- Singapore +- Switzerland \(Zurich\) EU Access - Europe \(Netherlands\) -- US West \(WA\) - Japan \(Tokyo\) +- US West \(WA\) +- US East \(VA\) @@ -2440,7 +2446,7 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP S/4 -Connects extension applications running in a subaccount in SAP BTP to an SAP S/4HANA Cloud system. +Automates the connectivity configuration of extension applications running on SAP BTP to SAP S/4HANA Cloud systems. @@ -2466,8 +2472,9 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP S/4 -- US Central \(IA\) - Europe \(Frankfurt\) +- India \(Mumbai\) GCP +- US Central \(IA\) @@ -3405,6 +3412,7 @@ Develop, debug, test, and deploy SAP business applications. - Israel \(Tel Aviv\) GCP - India \(Mumbai\) GCP - KSA \(Dammam\) GCP public sector +- Europe \(Frankfurt\) @@ -4726,7 +4734,7 @@ Allows you to create, manage, configure extensions on SAP Cloud Platform. -Connects extension applications running in a subaccount in SAP BTP to an SAP SuccessFactors system. +Automates the connectivity configuration of extension applications running on SAP BTP to SAP SuccessFactors systems. @@ -4752,13 +4760,15 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP Suc -- Brazil \(São Paulo\) - Australia \(Sydney\) -- Europe \(Frankfurt\) -- US East \(VA\) -- Canada \(Montreal\) - Singapore +- South Korea \(Seoul\) +- Brazil \(São Paulo\) +- Canada \(Montreal\) +- Europe \(Frankfurt\) +- Europe \(Frankfurt\) EU Access - Japan \(Tokyo\) +- US East \(VA\) @@ -4786,7 +4796,7 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP Suc -Connects extension applications running in a subaccount in SAP BTP to an SAP SuccessFactors system. +Automates the connectivity configuration of extension applications running on SAP BTP to SAP SuccessFactors systems. @@ -4812,9 +4822,13 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP Suc +- Australia \(Sydney\) +- Singapore +- Switzerland \(Zurich\) EU Access - Europe \(Netherlands\) -- US West \(WA\) - Japan \(Tokyo\) +- US West \(WA\) +- US East \(VA\) @@ -4842,7 +4856,7 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP Suc -Connects extension applications running in a subaccount in SAP BTP to an SAP SuccessFactors system. +Automates the connectivity configuration of extension applications running on SAP BTP to SAP SuccessFactors systems. @@ -4868,8 +4882,9 @@ Connects extension applications running in a subaccount in SAP BTP to an SAP Suc -- US Central \(IA\) - Europe \(Frankfurt\) +- India \(Mumbai\) GCP +- US Central \(IA\) @@ -11735,6 +11750,7 @@ Configure and run predefined pipelines for continuous integration and delivery. - Israel \(Tel Aviv\) GCP +- US Central \(IA\) diff --git a/docs/index.md b/docs/index.md index 62b804a3..f0b1973b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,6 +15,7 @@ - [SAP BTP-Specific Configurations](10-concepts/cloud-foundry-environment-9c7092c.md#loio9809fa4f02cb4696baea5c23d6eaac94) - [Availability Zones in the Cloud Foundry Environment](10-concepts/cloud-foundry-environment-9c7092c.md#loiob6a7e11c3a58416a9ab1175bba17193a) - [Additional Information About Cloud Foundry](10-concepts/cloud-foundry-environment-9c7092c.md#loio1c6cba872ce24f2ba24f53feb6dbce6d) + - [Commercial Information for Cloud Foundry Runtime](10-concepts/cloud-foundry-environment-9c7092c.md#loio8d41fa40e47b45bf90d38e393a989c4c) - [ABAP Environment](10-concepts/abap-environment-11d6265.md) - [ABAP Development Tools for Eclipse](10-concepts/abap-development-tools-for-eclipse-54dd712.md) - [Commercial Information for SAP BTP, ABAP environment](10-concepts/commercial-information-for-sap-btp-abap-environment-b7f5a93.md) @@ -1116,6 +1117,7 @@ - [SAP Fiori Applications in the Cloud Foundry Environment](30-development/sap-fiori-applications-in-the-cloud-foundry-environment-c954634.md) - [Develop an SAP Fiori Application and Deploy it to Cloud Foundry Using SAP Business Application Studio](30-development/develop-an-sap-fiori-application-and-deploy-it-to-cloud-foundry-using-sap-business-applic-2498cbf.md) - [Develop an SAP Fiori Application and Deploy it to Cloud Foundry Using Visual Studio Code](30-development/develop-an-sap-fiori-application-and-deploy-it-to-cloud-foundry-using-visual-studio-code-a064640.md) + - [Integration with Approuter](30-development/integration-with-approuter-87a38c2.md) - [Development in the Kyma Environment](30-development/development-in-the-kyma-environment-606ec61.md) - [Kyma Modules](30-development/kyma-modules-db6b63f.md) - [Kyma Telemetry Module](30-development/kyma-telemetry-module-87ec550.md) @@ -1125,6 +1127,9 @@ - [Traces](30-development/traces-f98cda5.md) - [Metrics](30-development/metrics-44ac6c5.md) - [Integrate with SAP Cloud Logging](30-development/integrate-with-sap-cloud-logging-eac5771.md) + - [Keda Module](30-development/keda-module-2f69be2.md) + - [Keda Module Configuration](30-development/keda-module-configuration-3cc1f25.md) + - [Keda Custom Resource Conditions](30-development/keda-custom-resource-conditions-12a88ed.md) - [Access a Kyma Instance Using kubectl](30-development/access-a-kyma-instance-using-kubectl-3e25944.md) - [Using SAP BTP Services in the Kyma Environment](30-development/using-sap-btp-services-in-the-kyma-environment-ea4dd81.md#loioea4dd81e49254dd482d32e3c20f4477a) - [Creating and Managing Services Using Kyma dashboard](30-development/using-sap-btp-services-in-the-kyma-environment-ea4dd81.md#loio975983821be040f0b7886791abcf3b7e) diff --git a/docs/sap-business-technology-platform-6a2c1ab.md b/docs/sap-business-technology-platform-6a2c1ab.md index d895a9fe..3dbdc218 100644 --- a/docs/sap-business-technology-platform-6a2c1ab.md +++ b/docs/sap-business-technology-platform-6a2c1ab.md @@ -88,7 +88,7 @@ More resources that you might find interesting: ## Best Practices -Get onboarded to SAP BTP. Learn about basic concepts and see our best practices for your development projects, from setting up the correct organizational structure to creating an account and security model, to developing and operating applications: [Best Practices for SAP BTP](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "This document helps you plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP). It's part of the SAP BTP Guidance Framework and contains recommendations for planning development projects – from setting up the correct organizational structure to creating an account and security model, to developing and operating applications.") :arrow_upper_right:. +Get onboarded to SAP BTP. Learn about basic concepts and see our best practices for your development projects, from setting up the correct organizational structure to creating an account and security model, to developing and operating applications: [SAP BTP Administrator's Guide](https://help.sap.com/viewer/df50977d8bfa4c9a8a063ddb37113c43/Cloud/en-US/9f2bb927464e4d1ba3d13b2d79ca9bd1.html "Learn about the SAP BTP Administrator's Guide and how you can use it to plan and set up your landscape and your lifecycle management for running applications on SAP Business Technology Platform (SAP BTP).") :arrow_upper_right:.