Release btpsa-v1.5.0 (#434)

.devcontainer/dev/devcontainer.json

@@ -0,0 +1,36 @@
+// For format details, see https://aka.ms/devcontainer.json.
+{
+    "name": "BTP Setup Automator (Dev)",
+    "image": "ghcr.io/sap-samples/btp-setup-automator:latest",
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python3",
+                "python.linting.enabled": true,
+                "python.formatting.provider": "black",
+                "python.linting.flake8Enabled": true,
+                "python.linting.flake8Args": [
+                    "--ignore=E501,F405,W504"
+                ],
+                "python.linting.pylintEnabled": false
+            },
+            "extensions": [
+                "ms-python.python",
+                "ms-python.vscode-pylance"
+            ]
+        },
+        "codespaces": {
+            "openFiles": [
+                "parameters.json"
+            ]
+        }
+    },
+    "remoteUser": "user",
+    "postCreateCommand": "cd /home/user && echo 'export PATH=\"$HOME/.local/bin:$PATH\"' >> ~/.profile && pip install flake8 black && source ~/.profile",
+    "workspaceFolder": "/home/user",
+    "hostRequirements": {
+        "cpus": 2,
+        "memory": "4gb",
+        "storage": "32gb"
+    }
+}

.devcontainer/stable/devcontainer.json

@@ -0,0 +1,36 @@
+// For format details, see https://aka.ms/devcontainer.json.
+{
+    "name": "BTP Setup Automator (Stable)",
+    "image": "ghcr.io/sap-samples/btp-setup-automator:latest",
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python3",
+                "python.linting.enabled": true,
+                "python.formatting.provider": "black",
+                "python.linting.flake8Enabled": true,
+                "python.linting.flake8Args": [
+                    "--ignore=E501,F405,W504"
+                ],
+                "python.linting.pylintEnabled": false
+            },
+            "extensions": [
+                "ms-python.python",
+                "ms-python.vscode-pylance"
+            ]
+        },
+        "codespaces": {
+            "openFiles": [
+                "parameters.json"
+            ]
+        }
+    },
+    "remoteUser": "user",
+    "postCreateCommand": "cd /home/user && echo 'export PATH=\"$HOME/.local/bin:$PATH\"' >> ~/.profile && pip install flake8 black && source ~/.profile",
+    "workspaceFolder": "/home/user",
+    "hostRequirements": {
+        "cpus": 2,
+        "memory": "4gb",
+        "storage": "32gb"
+    }
+}

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-    "python.pythonPath": "/usr/local/bin/python3",
+    "python.defaultInterpreterPath": "/usr/local/bin/python3",
     "python.linting.enabled": true,
     "python.formatting.provider": "black",
     "python.linting.flake8Enabled": true,

docs/BASIC_SETUP.md

@@ -18,14 +18,44 @@ In case you are new to the containers topic, we **strongly recommend** that you
 
 Once the pre-requisites above are all met, you can either use one of the pre-built Docker images for the `btp-setup-automator`, or build it yourself.
 
-### Option 1: Start Docker Container via Pre-Built Image (recommended)
+### Option 1: Start the btpsa via Dev Container (recommended)
 
-This is the fastest way to use the `btp-setup-automator`. We offer two images for the `btp-setup-automator`:
+We provide two configurations for Dev Containers to start the `btp-setup-automator` based on the two pre-built images we serve on GitHub:
 
-- The **release** image: This is a stable version of the `btp-setup-automator` and corresponds to the latest release visible on the [release section](https://github.com/SAP-samples/btp-setup-automator/releases) of the repository. The corresponding code is taken from the [`main branch`](https://github.com/SAP-samples/btp-setup-automator/tree/main) of the repository.
+- The **release**/**stable** image: This is a *stable* version of the `btp-setup-automator` and corresponds to the latest release visible on the [release section](https://github.com/SAP-samples/btp-setup-automator/releases) of the repository. The corresponding code is taken from the [`main branch`](https://github.com/SAP-samples/btp-setup-automator/tree/main) of the repository.
 - The **dev** image: This is an up-to-date version of the `btp-setup-automator`. It usually contains newer features and fixes but was not yet officially released. The corresponding code is taken from the [`dev branch`](https://github.com/SAP-samples/btp-setup-automator/tree/dev) of the repository.
 
-Open a terminal window on your machine and run the following command to pull the Docker image from the GitHub repository and start a container based upon it.
+To start a Dev Container in VS Code the easiest way is to click on the "Open a remote Window" button in the footer of VS Code:
+
+![open in remote window](pics/open-in-remote-window.png)
+
+This opens the command palette. Select `Reopen in Container` in the Dev Container section:
+
+![reopen in container](pics/command-palette-devcontainer.png)
+
+Select the configuration you want to use (*stable* or *dev*):
+
+![devcontainer config options](pics/devcontainer-config-options.png)
+
+VS Code will reopen in the Dev Container and you can start using the  `btp-setup-automator`.
+
+> 📝 Tip - You can also use the VS Code command palette (in the menu "View" select "Command Palette" or press the key combination `Ctrl+Shift+P` for Windows or `Cmd+Shift+P` for Mac) and use the "Dev Container: Reopen in Container" option from there.
+
+#### Alternative GitHub Codespaces
+
+Defining Dev Container configurations opens up the option to use [GitHub Codespaces](https://docs.github.com/en/codespaces) as you execution environment for the `btp-setup-automator`.
+
+To open the btpsa in GitHub Codespaces use the badges provided on the [main page](https://github.com/SAP-samples/btp-setup-automator) of the repository.
+
+> ⚠ NOTE: Cost might occur on your personal or organizational account when using GitHub Codespaces. You find more information on that topic [here](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces).
+
+In case you are using SSO as login option when execution use cases, be aware that there might be issues when it comes to [forwarded ports](https://docs.github.com/en/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports) depending on your organizational settings.
+
+### Option 2: Start Docker Container with Pre-Built Images via scripts
+
+As an alternative to Dev Containers you can also directly spin up the `btpsa` container via Docker CLI or via `run` scripts that we provide. This sections guides you through this setup.
+
+To leverage the Docker CLI, open a terminal window on your machine and run the following command to pull the Docker image from the GitHub repository and start a container based upon it.
 
 - For the **release** image:
 
@@ -111,7 +141,7 @@ You can also use the provided `run` files to pull the image from the registry an
       .\run.ps1 -RunDevFromRegistry $True
       ```
 
-### Option 2: Start Docker Container With Self-Built Image
+### Option 3: Start Docker Container With Self-Built Image
 
 To create the Docker image yourself you need to execute these steps:
 

docs/README.md

@@ -1,30 +1,35 @@
-# Detailed walk-though
-
-In case you are using VS Code (recommended), you need to open the Command Palette (in the menu "View" select "Command Palette") or press the key combination `Ctrl+Shift+P` (Windows) or `Cmd+Shift+P` (Mac). Then enter the command:
-
-```text
-Remote-Containers: Attach to Running Container
-```
-
-![command in VS Code to attach it to a running container](pics/quick-guide-step00.png)
-
-Now you should see the running container. Click on it, and a new window will pop-up with the content of the Docker container.
-
-![select running container in VS Code](pics/quick-guide-step01.png)
-
-You might have to select folder with the content in navigation panel of VS Code via `Open Folder`:
-
-![open folder](pics/quick-guide-step02.png)
-
-Select the `/home/user` folder:
-
-![select folder](pics/quick-guide-step03.png)
-
-You can also open a new terminal in the container via the menu `Terminal` - `New Terminal`. This will open an `ash` shell.
-
+# Detailed walk-through
+
+To edit the `parameters.json` as well as the `usecase.json` files and to execute them you must connect to the `btp-setup-automator` container.
+
+In case you are using VS Code (recommended), you have the following options:
+
+* Use the [Dev Container](./BASIC_SETUP.md#option-1-start-the-btpsa-via-dev-container-recommended) that opens VS Code inside of the container.
+* Attach to a running container (e.g. when [started via Docker CLI](./BASIC_SETUP.md#option-2-start-docker-container-with-pre-built-images-via-scripts))need to open the Command Palette (in the menu "View" select "Command Palette") or press the key combination `Ctrl+Shift+P` (Windows) or `Cmd+Shift+P` (Mac). Then enter the command:
+
+   ```text
+   Remote-Containers: Attach to Running Container
+   ```
+
+   ![command in VS Code to attach it to a running container](pics/quick-guide-step00.png)
+
+   Now you should see the running container. Click on it, and a new window will pop-up with the content of the Docker container.
+
+   ![select running container in VS Code](pics/quick-guide-step01.png)
+
+   You might have to select folder with the content in navigation panel of VS Code via `Open Folder`:
+
+   ![open folder](pics/quick-guide-step02.png)
+
+   Select the `/home/user` folder:
+
+   ![select folder](pics/quick-guide-step03.png)
+
+After connecting to the container, open a new terminal in the container via the menu `Terminal` - `New Terminal`. This will open an `ash` shell.
+
 ![open new terminal](pics/quick-guide-step04.png)
 
-The last step is to run the main script `btpsa` with the following command:
+The last step is to run the main script `btpsa` via the command:
 
 ```bash
 ./btpsa

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-0-then.md

@@ -53,7 +53,7 @@ unknown
 
 ## name
 
-SAP BTP, ABAP environment: Develop ABAP cloud apps and extensions, leveraging innovations of SAP HANA
+SAP BTP, ABAP environment: Access an instance to build custom ABAP cloud apps, leveraging newest innovations powered by SAP HANA.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-10-then.md

@@ -53,7 +53,7 @@ unknown
 
 ## name
 
-SAP ASE service: SAP ASE
+SAP ASE service: The SAP ASE service on SAP Business Technology Platform lets you consume SAP ASE databases from your applications running on SAP Business Technology Platform or on-premise via Java APIs. It offers variousself-services, for example, that let you create or update databases, whileSAPis providing infrastructure and database platform operations.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-101-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-SAP Responsibility Management service: Determine responsible agents for a business process
+SAP Responsibility Management service: As we move toward an intelligent enterprise, intelligent systems need to determine agents who are responsible for business processes and objects, and automatically notify them. It is essential to define and manage these responsibilities for various contexts and retrieve responsible agents who can respond to tasks and activities.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-102-then.md

@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-SAP Data Retention Manager: Manage retention and residence rules to block or delete personal data.
+SAP Data Retention Manager: The SAP Business Technology Platform Data Retention Manager lets you block or delete personal data based on the residence and retention rules maintained.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-103-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-SAP Software-as-a-Service Provisioning service: Manage the registration and provisioning of multitenant application and service subscriptions.
+SAP Software-as-a-Service Provisioning service: Service for application providers to register multitenant applications and services.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-104-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-SAP Analytics Cloud, embedded edition: Analyze data via live connection to your business application's SAP HANA database.
+SAP Analytics Cloud, embedded edition: With SAP Analytics Cloud, embedded edition, you can build and embed reports, dashboards, and visuals into your business application to make confident decisions. Explore your business data via live connection between your SAP Analytics Cloud tenant and the remote SAP HANA database on SAP Business Technology Platform.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-107-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-SAP Build Apps runtime service: SAP Build Apps runtime internal reuse service
+SAP Build Apps runtime: The runtime service for SAP Build Apps. Allows connectivity to visual cloud functions applications developed and deployed on the SAP Build Apps runtime. A subscription to SAP Build Apps is required to use this service.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-109-then.md

@@ -47,7 +47,7 @@ unknown
 
 ## name
 
-Document Information Extraction: Document Information Extraction helps to reduce the time spent on business document processing by extracting information from documents automatically.
+Document Information Extraction: Document Information Extraction helps you to process various documents that have content in headers and tables. You can use the extracted information, for example, to automatically process payables, invoices, or payment notes while making sure that invoices and payables match.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-11-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-DEPRECATED Audit Log Retrieval: DEPRECATED Retrieve the audit logs.
+Audit Log Service API: SAP Audit Log service API
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-110-then.md

@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-Graph: SAP Graph is the unified API for accessing SAP-managed data, the API of the Intelligent Enterprise.
+SAP Graph: SAP Graph is a new unified API for SAP, using modern open standards like OData v4. With SAP Graph, developers access SAP-managed business data as a single semantically connected data graph, spanning the suite of SAP products. Targeting SAP's ecosystem of developers and customers, SAP Graph's one API and Business Data Graph reduce the cost and complexity of creating and deploying reusable extension applications. The unified API exposes a unified graph-like model of business objects (entities) and relationships. As a BTP service, SAP Graph is compatible with SAP Cloud Application Programming (CAP) extension solutions, events managed via SAP Event Mesh, and No-Code/Low-Code applications like SAP AppGyver. SAP Graph uses open standards, such as OData v.4 and OAuth, thus allowing you to easily build applications and extensions for the SAP Intelligent Enterprise.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-111-then.md

@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-Document Management, integration option: Provide API and UI based document management capabilities to your business applications.
+Document Management Service, Integration Option: Leverage the APIs of SAP Document Management service and build your own document management layer to enable document management capabilities for your business applications. You can also embed the easy-to-use, UI5-based, reusable UI component of Document Management into your application for document management scenarios.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-112-then.md

@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-SAP Document Management service: Use a CMIS complaint repository provided internally with all Document Management capabilities.
+SAP Document Management service: Use a CMIS complaint repository provided internally with all SAP Document Management service capabilities.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-113-then.md

@@ -50,7 +50,7 @@ unknown
 
 ## name
 
-SAP Service Manager: The central registry for service brokers and platforms in SAP Business Technology Platform
+SAP Service Manager: SAP Service Manager service allows you to consume platform services in any connected runtime environment, track service instances creation, and share services and service instances between different environments.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-114-then.md

@@ -47,7 +47,7 @@ unknown
 
 ## name
 
-Service Ticket Intelligence: Build a self-driven customer service powered by machine learning with Service Ticket Intelligence
+Service Ticket Intelligence: With Service Ticket Intelligence, incoming customers service tickets are automatically classified into their categories, and routed to the right agent. The agent is then provided with recommended solutions to improve operational efficiency. Service Ticket Intelligence leverages deep learning neural networks trained on large amounts of historical data. The model understands the semantics of unstructured ticket messages, classifies the ticket into their most likely categories and recommends solutions or knowledge base articles from similar previously answered tickets for the agent. With more processed service tickets and users feedback, the model improves over time.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-115-then.md

@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-SAP HANA spatial services: SAP HANA spatial services provides a set of APIs for location-based services.
+SAP HANA spatial services: SAP HANA spatial services provides a unified access layer for location-based services, including maps for visualization, geocoding and routing capabilities. It integrates location-based content and services from external providers into SAP products and customer applications.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-116-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-UI theme designer: Create custom themes for your Cloud Platform Portal based applications.
+UI theme designer: The UI theme designer lets you apply your corporate branding to applications built with SAP UI technologies. You can make changes to theme templates supplied by SAP to create custom themes that use your own color scheme, background images, and company logo. You can apply a custom theme to various SAP UI clients and technologies. Additionally, you can include your own custom CSS files without having to modify any of your applications.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-118-then.md

@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-SAP Usage Data Management service for SAP BTP: Collect and analyze usage information for analysis, reporting, cost, and auditing
+SAP Usage Data Management service for SAP BTP: The Usage Data Management service broker allows you to use the new REST APIs to collect information about the monthly usage of services and applications in your SAP Business Technology Platform accounts. You can build scripts and apps that react to the usage reports generated by this API. This information includes all the entity levels, namely global account, directories, subaccounts, orgs, spaces and instances for the relevant services.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-12-then.md

@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-SAP Audit Log Management service: Retrieve the audit logs for your account.
+SAP Audit Log Management service: SAP Audit Log Management service helps to retrieve logs and change retention.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-121-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-SAP Workflow Management: Automate business processes using workflow technology.
+SAP Workflow Management: SAP Workflow service allows you to build, run, and manage workflows, from simple approvals to end-to-end processes that span across different organizations and applications. With an inbox application and custom-built user interfaces, you involve end users into business processes for decision making and data entry. The workflow service comes with web-based tools for workflow modeling, APIs for consumption in custom applications, monitoring tools, and a set of Fiori-based applications for end-user access. You can use JavaScript to embed custom business logic.
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-122-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-SAP Workflow Management: Digitize workflows, manage decisions and gain end-to-end process visibility.
+SAP Workflow Management: Digitize workflows, manage decisions and gain end-to-end process visibility
 
 `name`
 

docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-123-then.md

@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-SAP Cloud for Real Estate Workspace Utilization Management API (BETA): SAP Cloud for Real Estate Workspace Utilization Management API (BETA)
+Workspace Utilization: The Workspace Utilization Management service lets you write sensor measurements to the Workspace Utilization Management API. Sensor platform providers use this API to integrate with the Workspace Utilization Management solution of SAP Cloud for Real Estate.
 
 `name`