Skip to content

Commit

Permalink
Merge pull request #623 from SAP/moremigration
Browse files Browse the repository at this point in the history 
fixes in migration section
  • Loading branch information
@ShimiT
ShimiT authored Dec 4, 2019
2 parents acff030 + 67d8104 commit d9a82d6
Showing 1 changed file with 51 additions and 19 deletions.
70 changes: 51 additions & 19 deletions docs/docs/migration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ If you have previously used the [Multitarget Application Archive Builder](https:


#### Features that are handled differently in the Cloud MTA Build Tool

* The Cloud MTA build Tool uses `GNU Make` technology for building an MTA project. Therefore, you should have `GNU Make` installed in your build environmnet.
<ul>
<li> The Cloud MTA build Tool uses `GNU Make` technology for building an MTA project. Therefore, you should have `GNU Make` installed in your build environmnet.

For more information, see sections [`GNU Make` installation](makefile.md) and [commands for building a project](usage.md#how-to-build-an-mta-archive-from-the-project-sources).
&nbsp;
* Packaging of HTML5 modules in `deploy_mode=html5-repo`

<li> Packaging of HTML5 modules in `deploy_mode=html5-repo`
You need to update your `mta.yaml` file to exclude `html5` modules from the resulting MTA archive and configure the build result folder. In order to do that, add the following to the `build-parameters` section for each module of this type:

```yaml
Expand All @@ -18,15 +19,17 @@ You need to update your `mta.yaml` file to exclude `html5` modules from the resu
build-result: dist
```
For more information about the `supported-platforms` build parameter, see [Configuring and Packaging Modules According to Target Platforms](configuration.md#configuring-and-packaging-modules-according-to-target-platforms).
<br>


* The following `build-parameters` are not supported by the Cloud MTA Build Tool: <ul><li>`npm-opts`<li>`grunt-opt`<li>`maven-opts`</ul>
<li> The following `build-parameters` are not supported by the Cloud MTA Build Tool: <ul><li>`npm-opts`<li>`grunt-opt`<li>`maven-opts`</ul>

If you need to change the default build behavior defined for the corresponding builder, see [configure `custom` builder](configuration.md#configuring-the-custom-builder). For a complete list of available builders and their default behaviors, see [Builders execution commands](https://github.com/SAP/cloud-mta-build-tool/blob/master/configs/builder_type_cfg.yaml).

&nbsp;

* The Cloud MTA Build tool strictly validates the rule that names of modules, resources, and provided property sets, are unique within the `mta.yaml` file. This ensures that when the name is referenced in the `requires` section, it is unambiguously resolved. The [Multitarget Application Archive Builder](https://help.sap.com/viewer/58746c584026430a890170ac4d87d03b/Cloud/en-US/ba7dd5a47b7a4858a652d15f9673c28d.html) allowed the use of the same name for a module and for one of its property sets. For example:
<br>

<li>The Cloud MTA Build tool strictly validates the rule that names of modules, resources, and provided property sets, are unique within the `mta.yaml` file. This ensures that when the name is referenced in the `requires` section, it is unambiguously resolved.

The [Multitarget Application Archive Builder](https://help.sap.com/viewer/58746c584026430a890170ac4d87d03b/Cloud/en-US/ba7dd5a47b7a4858a652d15f9673c28d.html) allowed the use of the same name for a module and for one of its property sets. For example:

```yaml
Expand All @@ -39,7 +42,7 @@ If you need to change the default build behavior defined for the corresponding b
url: ${default-url}
```

When migrating to the new build tool, you need to rename either the module or the provided property set. For example:
When migrating to the new build tool, you need to rename either the module or the provided property set. For example:

```yaml
Expand All @@ -52,18 +55,34 @@ If you need to change the default build behavior defined for the corresponding b
url: ${default-url}
```
After renaming, make sure that the places where the name is used refer to the correct artifact.
</li>

<br>
<li>


The `hdb` builder is not supported by the Cloud MTA Build tool. You no longer require builder settings for the `hdb` module because the required `npm install --production` command is run by default for this module type.

If you used this builder for other module types, you can repace it with the `npm` builder or use the `custom` builder that runs the `"npm install --production"`command.




</li>

---
**NOTE**
If you try to build the project without these changes, the build tool will identify this and will fail the build with the corresponding errors.
**NOTE:**
<b>If you try to build the project without the changes above, the build tool will identify this and will fail the build with the corresponding errors.</b>

---

* `JSON` files with [service creation parameters](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/a36df26b36484129b482ae20c3eb8004.html) or [service binding parameters](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/a36df26b36484129b482ae20c3eb8004.html) referenced by `path` property of the correponding entity in the `mta.yaml` are packaged differently into the result MTA archive.
<li>

`JSON` files with [service creation parameters](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/a36df26b36484129b482ae20c3eb8004.html) or [service binding parameters](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/c7b09b79d3bb4d348a720ba27fe9a2d5.html) referenced by the `path` property of the correponding entity in the `mta.yaml`, are packaged differently by the tools into the result MTA archive. &nbsp; &nbsp; &nbsp;

Therefore, if your `JSON` file contains [parameters or placeholders](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/490c8f71e2b74bc0a59302cada66117c.html) that should be resolved when you deploy the MTA archive, the correponding properties should be moved to the `mta.yaml` file. Otherwise, values assigned to these properties during deploymnet will be incorrect, since the [parameters or placeholders](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/490c8f71e2b74bc0a59302cada66117c.html) are resolved only if they are specified within an MTA descriptor, i.e. the `mta.yaml` or `mtad.yaml` files. &nbsp;
Therefore, if your `JSON` file contains [parameters or placeholders](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/490c8f71e2b74bc0a59302cada66117c.html) that should be resolved when you deploy the MTA archive, the correponding properties should be moved to the `mta.yaml` file. Otherwise, values assigned to these properties during deployment will be incorrect, because the [parameters or placeholders](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/490c8f71e2b74bc0a59302cada66117c.html) are resolved only if they are specified within an MTA descriptor, i.e. the `mta.yaml` or `mtad.yaml` files. &nbsp;

For example, if you provide parameters for creation of a UAA service in a `xs-security.json` file:
For example, if you provide parameters for creating a UAA service in an `xs-security.json` file:

```yaml
Expand All @@ -72,20 +91,18 @@ resources:
type: com.sap.xs.uaa
parameters:
path: ./xs-security.json
```

And your `xs-security.json` file contains a property which value should be resolved during the MTA archive deployment:
and your `xs-security.json` file contains a property whose value should be resolved during the MTA archive deployment:

```json
{
"xsappname": "${default-xsappname}"
}
```

Then, you need to modify your `mta.yaml` file as follows:
then, you need to modify your `mta.yaml` file as follows:


```yaml
Expand All @@ -97,7 +114,22 @@ resources:
path: ./xs-security.json
config:
xsappname: "${default-xsappname}"
```

In the `xs-security.json` file, you can assign the property a temporary value that does not use the parameter. During deployment, the value specified directly in the MTA descriptor overrides the value specified in the `JSON` file.

```json
{
"xsappname": "tmp_appname"
}
```

There is no need to remove the property from the `xs-security.json` file since the value specified directly in the MTA descriptor override the value specified in the `JSON` file.
Alternatively, you can remove the property from your `xs-security.json` file.

---
**NOTE:**
<b>If you try to deploy the project without the changes above, the deploy service will identify this and will fail the deployment with the corresponding errors.</b>

---
</ul>

0 comments on commit d9a82d6

Please sign in to comment.