Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

3586-s4hana kyma initial commit #372

Merged
merged 1 commit into from
Jan 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions usecases/released/discoverycenter/3586-s4hana-kyma/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Instructions for running SAP Discovery Center Mission in btp-setup-automator

The setup of this [mission](https://discovery-center.cloud.sap/protected/index.html#/missiondetail/3586/) can be executed by the [btp-setup-automator](https://github.com/SAP-samples/btp-setup-automator).

The [btp-setup-automator](https://github.com/SAP-samples/btp-setup-automator) is an open source project to help developers setting-up their SAP BTP accounts quickly via various command line interfaces.
The current script was designed to setup the account and create subscriptions used by the mission, [SAP S/4HANA Extend Business Process Scenario in SAP BTP, Kyma Runtime](https://discovery-center.cloud.sap/missiondetail/3586/).

The script will create a subaccount with the necessary entitlements and also creates the necessary subscriptions used by the SAP S/4HANA Extend Business Process Scenario in SAP BTP, Kyma Runtime. The following service entitlements and subscriptions are created:

* Subaccount s4hanakyma
* Kyma Runtime
* SAP HANA Cloud Tools Subscriptions
* SAP Launchpad Service Subscription
* SAP HANA Schemas and DI Containers
* SAP HAAN Cloud
* Event Mesh
* Connectivity Service

## Pre-Requisites

To use the tooling you first need to finish the following tasks:

* Get a [productive SAP BTP account](https://account.hana.ondemand.com/#/home/welcome) where you can make use of the free tier service plans.
* [Install a Docker engine](https://docs.docker.com/desktop/)

> ⚠ NOTE: Be aware of the terms of Docker for usage in enterprises. For details see this [link](https://www.docker.com/blog/updating-product-subscriptions/).

## Changes the configuration

Currently the use case requires a productive SAP BTP account. Also the name and the name of the subaccount is preconfigured to "s4hanakyma" and US10 as region. In case you need to adapt some of the parameters you can parse them via commandline parameters when you call the script, for example to change the region it would look like this:

```bash
./btpsa -parameterfile 'usecases/released/discoverycenter/3586-s4hana-kyma/parameters.json' -globalaccount '<your global account subdomain as shown in the SAP BTP cockpit>' -myemail '<your email address>' -region 'region for your subaccount'
```

If you want to make changes to the actual [usecase.json](usecase.json) you can either attach Visual Studio Code directly to your running container. Then you can perform the changes (it works as well with the parameters.json) and run the script as described above. You should be aware that the changes are not persisted if you terminate the docker container. In case you need to perform permanent changes to either the usecase.json or the parameter json you need to create your own docker image containing the changes as described [in the documentation](../../../../README.md#option-2-start-docker-container-with-self-built-image) for more details.

**Region Change**

Be aware in case you change the region for the use case you need to have a look at the [Available Regions here](https://help.sap.com/products/BTP/65de2977205c403bbc107264b8eccf4b/557ec3adc3174ed4914ec9d6d13487cf.html?locale=en-US&version=Cloud). In order to make sure the the use case is executable you need to check if the [SAP BTP Kyma Runtime availability](https://discovery-center.cloud.sap/serviceCatalog/kyma-runtime?region=all&tab=service_plan) and the [SAP HANA Cloud availability](https://discovery-center.cloud.sap/serviceCatalog/sap-hana-cloud?region=all&tab=service_plan) is given.

## Instructions

Open a command line terminal on your machine.

> 📝 Tip - In case you don't know how to do it, here are the instructions for [MS Windows](https://www.wikihow.com/Open-Terminal-in-Windows), [Mac OS](https://www.wikihow.com/Open-a-Terminal-Window-in-Mac) and [Ubuntu Linux](https://www.wikihow.com/Open-a-Terminal-Window-in-Ubuntu).

Enter the following command into the terminal and press the `ENTER` key:

```bash
docker container run --rm -it --name "btp-setup-automator" "ghcr.io/sap-samples/btp-setup-automator:latest"
```

You'll notice that the prompt in your terminal has changed, because you are now working inside the docker container, that you just started.
Now run the main script `btpsa` with the following command:

```bash
./btpsa -parameterfile 'usecases/released/discoverycenter/3586-s4hana-kyma/parameters.json' -globalaccount '<your global account subdomain as shown in the SAP BTP cockpit>' -myemail '<your email address>'
```

The btp-setup-automator script will now prepare your SAP BTP account to cover the discovery center mission. You can have a look at the [usecase.json](usecase.json) and [parameters.json](parameters.json) for more details about the used services and configuration parameters (e.g. DB Password for SAP HANA Cloud)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://raw.githubusercontent.com/SAP-samples/btp-setup-automator/main/libs/btpsa-parameters.json",
"usecasefile": "usecases/released/discoverycenter/3586-s4hana-kyma/usecase.json",
"region": "us10",
"subaccountname": "s4hanakyma",
"loginmethod": "sso"
}
108 changes: 108 additions & 0 deletions usecases/released/discoverycenter/3586-s4hana-kyma/usecase.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"$schema": "https://raw.githubusercontent.com/SAP-samples/btp-setup-automator/main/libs/btpsa-usecase.json",
"aboutThisUseCase": {
"name": "SAP S/4HANA Extend Business Process Scenario in SAP BTP, Kyma Runtime",
"description": "Create a custom extension application on SAP BTP Kyma Runtime which consumes data from SAP S/4HANA",
"author": "[email protected]",
"testStatus": "tested successfully",
"usageStatus": "RELEASED",
"relatedLinks": [
"https://discovery-center.cloud.sap/missiondetail/3586"
]
},
"services": [
{
"category": "ENVIRONMENT",
"name": "kymaruntime",
"plan": "aws",
"amount": 1,
"parameters": {
"name": "btp-auto-setup",
"region": "us-east-1"
}
},
{
"name": "SAPLaunchpad",
"plan": "free",
"category": "APPLICATION",
"requiredrolecollections": [
"Launchpad_Admin"
],
"targetenvironment": "sapbtp"
},
{
"name": "hana-cloud-tools",
"plan": "tools",
"category": "APPLICATION",
"targetenvironment": "sapbtp"
},
{
"name": "hana-cloud",
"plan": "hana",
"category": "SERVICE",
"entitleonly": true,
"targetenvironment": "sapbtp"
},
{
"name": "enterprise-messaging",
"plan": "default",
"category": "SERVICE",
"entitleonly": true,
"targetenvironment": "sapbtp"
},
{
"name": "connectivity",
"plan": "connectivity_proxy",
"category": "SERVICE",
"entitleonly": true,
"targetenvironment": "sapbtp"
},
{
"name": "hana",
"plan": "hdi-shared",
"category": "SERVICE",
"entitleonly": true,
"targetenvironment": "sapbtp"
}
],
"executeAfterAccountSetup": [
{
"description": "We have now created a subaccount in SAP BTP. Continue manual steps according to Github documentation or from mission",
"command": "echo 'Continue next steps as shown in the Github: https://github.com/SAP-samples/btp-s4hana-kyma-business-process-extension/blob/main/documentation/README.md'"
}
],
"assignrolecollections": [
{
"name": "Global Account Administrator",
"type": "account",
"level": "global account",
"assignedUserGroupsFromParameterFile": [
"admins"
]
},
{
"name": "Subaccount Administrator",
"type": "account",
"level": "sub account",
"assignedUserGroupsFromParameterFile": [
"admins"
]
},
{
"name": "Subaccount Service Administrator",
"type": "account",
"level": "sub account",
"assignedUserGroupsFromParameterFile": [
"admins"
]
},
{
"name": "SAP HANA Cloud Administrator",
"type": "account",
"level": "sub account",
"assignedUserGroupsFromParameterFile": [
"admins"
]
}
]
}