btpsa-v1.9.0 (#560)

SAP-samples · Sep 5, 2023 · 54396c3 · 54396c3
1 parent a5800f2
commit 54396c3
Show file tree

Hide file tree

Showing 2,174 changed files with 6,477 additions and 11,087 deletions.
diff --git a/.github/workflows/build-quality-check.yml b/.github/workflows/build-quality-check.yml
@@ -23,7 +23,7 @@ jobs:
         python-version: ["3.10"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -38,7 +38,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

diff --git a/.github/workflows/docker-dev-build-and-push.yml b/.github/workflows/docker-dev-build-and-push.yml
@@ -15,7 +15,7 @@ jobs:
       contents: read
       packages: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ env.DEV_BRANCH }}
 
@@ -26,7 +26,7 @@ jobs:
         uses: docker/setup-buildx-action@v2
         with:
           driver-opts: |
-            image=moby/buildkit:v0.10.6
+            image=moby/buildkit:v0.11.6
         #with:
         #  buildkitd-flags: --debug
 

diff --git a/.github/workflows/docker-release-build-and-push.yml b/.github/workflows/docker-release-build-and-push.yml
@@ -16,7 +16,7 @@ jobs:
       contents: read
       packages: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.release.commitish }}
 
@@ -27,7 +27,8 @@ jobs:
         uses: docker/setup-buildx-action@v2
         with:
           driver-opts: |
-            image=moby/buildkit:v0.10.6
+            image=moby/buildkit:v0.11.6
+            
         #with:
         #  buildkitd-flags: --debug
 

diff --git a/.github/workflows/links-watcher-cron.yml b/.github/workflows/links-watcher-cron.yml
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout source code"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Link Checker
         id: lychee
         uses: lycheeverse/[email protected]

diff --git a/.github/workflows/reuse-check.yml b/.github/workflows/reuse-check.yml
@@ -8,6 +8,6 @@ jobs:
   compliance-check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: REUSE Compliance Check
       uses: fsfe/reuse-action@v2
diff --git a/.github/workflows/stage-integration-test-full.yml b/.github/workflows/stage-integration-test-full.yml
@@ -29,7 +29,7 @@ jobs:
     outputs:
       image_path: ${{ steps.set-image-path.outputs.image_path }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
         with:

diff --git a/.github/workflows/stage-integration-test-slim.yml b/.github/workflows/stage-integration-test-slim.yml
@@ -29,7 +29,7 @@ jobs:
     outputs:
       image_path: ${{ steps.set-image-path.outputs.image_path }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
         with:

diff --git a/.github/workflows/update-metadata-artifacts.yml b/.github/workflows/update-metadata-artifacts.yml
@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ env.TARGET_BRANCH }}
 

diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/btp-setup-automator)](https://api.reuse.software/info/github.com/SAP-samples/btp-setup-automator) [![Release Docker Image](https://github.com/SAP-samples/btp-setup-automator/actions/workflows/docker-release-build-and-push.yml/badge.svg)](https://github.com/SAP-samples/btp-setup-automator/actions/workflows/docker-release-build-and-push.yml)[![Dev Docker Image](https://github.com/SAP-samples/btp-setup-automator/actions/workflows/docker-dev-build-and-push.yml/badge.svg)](https://github.com/SAP-samples/btp-setup-automator/actions/workflows/docker-dev-build-and-push.yml)
 
+## ⚠ Maintenance Mode ⚠
+
+📢 **Please be aware that with release 1.9.0 this tool is in maintenance mode** - see also the corresponding [announcement](https://github.com/SAP-samples/btp-setup-automator/discussions/558)
+
 ## Description
 
 This repository provides the user with a script to **automate the setup** of an [SAP Business Technology Platform (SAP BTP) account](https://account.hana.ondemand.com/) and to **learn** how this is done with the various command line interfaces and tools that run inside a [Docker](https://www.docker.com/) container. It uses  JSON configuration files to automate this setup of SAP BTP accounts or do other administrative tasks.
@@ -42,8 +46,6 @@ Checkout [the issues section in this repo](https://github.com/SAP-samples/btp-se
 
 🐛 - If you find a bug, feel free to [create a bug report](https://github.com/SAP-samples/btp-setup-automator/issues/new?assignees=&labels=bug&template=bug-report.yml&title=%5BBUG%5D+%3Ctitle%3E).
 
-🚀 - If you have an idea for improvement or a feature request, please open a [feature-request](https://github.com/SAP-samples/btp-setup-automator/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=%5BFEATURE+REQUEST%5D+%3Ctitle%3E).
-
 ## Contributions
 
 Checkout the [CONTRIBUTING.md file](CONTRIBUTING.md) for more details on how to contribute to this open source project.

diff --git a/config/Dockerfile b/config/Dockerfile
@@ -32,7 +32,7 @@ FROM base AS btp_cli
 SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
 WORKDIR /tmp/tools
 
-RUN BTP_CLI_VERSION="2.38.0" \
+RUN BTP_CLI_VERSION="2.49.0" \
   && curl --fail --silent --location --cookie eula_3_1_agreed="$TOOLS_URL/developer-license-3_1.txt" \
     --url "https://$TOOLS_URL/additional/btp-cli-$ARCH-$BTP_CLI_VERSION.tar.gz" \
     | tar -xzf - --strip-components 1 "$ARCH/btp"
@@ -97,7 +97,7 @@ ARG BTPSA_VERSION_GIT_ARG=default
 ##################################################################################################################################################
 # Now putting all pieces together
 ##################################################################################################################################################
-FROM --platform=linux/amd64 python:3.10-alpine3.16 AS final_build
+FROM --platform=linux/amd64 python:3.10-alpine3.18 AS final_build
 ENV USERNAME=user
 ENV HOME_FOLDER /home/$USERNAME
 ENV LIBS_FOLDER $HOME_FOLDER/libs

diff --git a/config/python/requirements.txt b/config/python/requirements.txt
@@ -5,11 +5,11 @@ charset-normalizer==3.2.0
 idna==3.4
 inquirer==3.1.3
 Jinja2==3.1.2
-jsonschema==4.18.4
+jsonschema==4.19.0
 MarkupSafe==2.1.3
 mccabe==0.7.0
 ninja2==0.1
-pycodestyle==2.10.0
+pycodestyle==2.11.0
 pyflakes==3.0.1
 pyrsistent==0.19.3
 python-dateutil==2.8.2

diff --git a/config/templates/libs/BTPSA-PARAMETERS.json b/config/templates/libs/BTPSA-PARAMETERS.json
@@ -17,6 +17,15 @@
             "title": "host region for the BTP CLI calls",
             "default": "eu10"
         },
+        "btplogonidp": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "The tenant ID of a custom identity provider if configured for the global account. To be found in the cockpit under Trust Configuration.",
+            "title": "custom IDP for BTP logon",
+            "default": null
+        },
         "cfcliapihostregion": {
             "type": [
                 "string",

diff --git a/docs/generated/btpsa-parameters-properties-custom-idp-for-btp-logon.md b/docs/generated/btpsa-parameters-properties-custom-idp-for-btp-logon.md
@@ -0,0 +1,3 @@
+## btplogonidp Type
+
+`string` ([custom IDP for BTP logon](btpsa-parameters-properties-custom-idp-for-btp-logon.md))
diff --git a/docs/generated/btpsa-parameters.md b/docs/generated/btpsa-parameters.md
@@ -16,6 +16,7 @@ all of
 | :---------------------------------------------------------------------------------------------- | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [$schema](#schema)                                                                              | `string`  | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-schema.md "undefined#/properties/$schema")                                                                                                                                          |
 | [btpcliapihostregion](#btpcliapihostregion)                                                     | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-host-region-for-the-btp-cli-calls.md "undefined#/properties/btpcliapihostregion")                                                                                                   |
+| [btplogonidp](#btplogonidp)                                                                     | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-custom-idp-for-btp-logon.md "undefined#/properties/btplogonidp")                                                                                                                    |
 | [cfcliapihostregion](#cfcliapihostregion)                                                       | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-host-region-for-the-cloud-foundry-cli-calls.md "undefined#/properties/cfcliapihostregion")                                                                                          |
 | [cfLandscape](#cflandscape)                                                                     | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-landscape-of-the-cf-environment-for-use-case.md "undefined#/properties/cfLandscape")                                                                                                |
 | [cfspacename](#cfspacename)                                                                     | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-name-for-the-cf-space.md "undefined#/properties/cfspacename")                                                                                                                       |
@@ -111,6 +112,24 @@ The default value is:
 "eu10"
 ```
 
+## btplogonidp
+
+The tenant ID of a custom identity provider if configured for the global account. To be found in the cockpit under Trust Configuration.
+
+`btplogonidp`
+
+*   is optional
+
+*   Type: `string` ([custom IDP for BTP logon](btpsa-parameters-properties-custom-idp-for-btp-logon.md))
+
+*   can be null
+
+*   defined in: [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-custom-idp-for-btp-logon.md "undefined#/properties/btplogonidp")
+
+### btplogonidp Type
+
+`string` ([custom IDP for BTP logon](btpsa-parameters-properties-custom-idp-for-btp-logon.md))
+
 ## cfcliapihostregion
 
 host region for the Cloud Foundry CLI (normally the same as 'region'). In case of errors you might have to set this to e.g. 'eu10-004' (check CF API in your SAP BTP cockpit in the sub account and CF environment).

diff --git a/...-usecase-properties-services-items-allof-1-then-allof-100-if-properties-name.md b/...-usecase-properties-services-items-allof-1-then-allof-100-if-properties-name.md
@@ -7,5 +7,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"retention-manager"
+"sap-calm"
 ```
diff --git a/.../generated/btpsa-usecase-properties-services-items-allof-1-then-allof-100-if.md b/.../generated/btpsa-usecase-properties-services-items-allof-1-then-allof-100-if.md
@@ -31,5 +31,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"retention-manager"
+"sap-calm"
 ```
diff --git a/...erties-services-items-allof-1-then-allof-100-then-allof-0-if-properties-plan.md b/...erties-services-items-allof-1-then-allof-100-then-allof-0-if-properties-plan.md
@@ -7,5 +7,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"free"
+"default"
 ```
diff --git a/...psa-usecase-properties-services-items-allof-1-then-allof-100-then-allof-0-if.md b/...psa-usecase-properties-services-items-allof-1-then-allof-100-then-allof-0-if.md
@@ -31,5 +31,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"free"
+"default"
 ```
diff --git a/...a-usecase-properties-services-items-allof-1-then-allof-100-then-allof-0-then.md b/...a-usecase-properties-services-items-allof-1-then-allof-100-then-allof-0-then.md
@@ -10,18 +10,13 @@ unknown
 
 ## plan
 
-service plan >free< for >retention-manager< is available in data centers:
+service plan >default< for >sap-calm< is available in data centers:
 
 *   {'region': 'ap10', 'name': 'Australia (Sydney)'}
-*   {'region': 'ap11', 'name': 'Singapore'}
-*   {'region': 'br10', 'name': 'Brazil (Sao Paulo)'}
 *   {'region': 'eu10', 'name': 'Europe (Frankfurt)'}
-*   {'region': 'eu11', 'name': 'Europe (Frankfurt) EU Access - AWS'}
 *   {'region': 'eu20', 'name': 'Europe (Netherlands)'}
+*   {'region': 'jp10', 'name': 'Japan (Tokyo)'}
 *   {'region': 'us10', 'name': 'US East (VA)'}
-*   {'region': 'us20', 'name': 'US West (WA)'}
-*   {'region': 'us21', 'name': 'US East (VA)'}
-*   {'region': 'us30', 'name': 'US Central (IA)'}
 
 `plan`
 

diff --git a/...a-usecase-properties-services-items-allof-1-then-allof-100-then-allof-1-then.md b/...a-usecase-properties-services-items-allof-1-then-allof-100-then-allof-1-then.md
diff --git a/...secase-properties-services-items-allof-1-then-allof-100-then-properties-plan.md b/...secase-properties-services-items-allof-1-then-allof-100-then-properties-plan.md
@@ -6,7 +6,6 @@ unknown
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value        | Explanation |
-| :----------- | :---------- |
-| `"free"`     |             |
-| `"standard"` |             |
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"default"` |             |
diff --git a/...enerated/btpsa-usecase-properties-services-items-allof-1-then-allof-100-then.md b/...enerated/btpsa-usecase-properties-services-items-allof-1-then-allof-100-then.md
@@ -6,8 +6,6 @@ all of
 
 *   [Untitled undefined type in JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-100-then-allof-0.md "check type definition")
 
-*   [Untitled undefined type in JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-100-then-allof-1.md "check type definition")
-
 # then Properties
 
 | Property      | Type          | Required | Nullable       | Defined by                                                                                                                                                                                                              |
@@ -37,14 +35,13 @@ unknown
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value        | Explanation |
-| :----------- | :---------- |
-| `"free"`     |             |
-| `"standard"` |             |
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"default"` |             |
 
 ## name
 
-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.
+SAP Cloud ALM, memory extension: Add extensions for special use cases that exceed the standard functions of SAP Cloud ALM under Enterprise Support. Excessively store and extend data, e.g. to upload additional data, increase run retention time, add process management assets and tenants. Leverage the development environment of SAP BTP, for example, by your own, dashboards, or enhancements.
 
 `name`
 

diff --git a/...-usecase-properties-services-items-allof-1-then-allof-101-if-properties-name.md b/...-usecase-properties-services-items-allof-1-then-allof-101-if-properties-name.md
@@ -7,5 +7,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"saas-registry"
+"sap-document-information-extraction"
 ```
diff --git a/.../generated/btpsa-usecase-properties-services-items-allof-1-then-allof-101-if.md b/.../generated/btpsa-usecase-properties-services-items-allof-1-then-allof-101-if.md
@@ -31,5 +31,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"saas-registry"
+"sap-document-information-extraction"
 ```
diff --git a/...erties-services-items-allof-1-then-allof-101-then-allof-0-if-properties-plan.md b/...erties-services-items-allof-1-then-allof-101-then-allof-0-if-properties-plan.md
@@ -7,5 +7,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"application"
+"blocks_of_100"
 ```
diff --git a/...psa-usecase-properties-services-items-allof-1-then-allof-101-then-allof-0-if.md b/...psa-usecase-properties-services-items-allof-1-then-allof-101-then-allof-0-if.md
@@ -31,5 +31,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"application"
+"blocks_of_100"
 ```
diff --git a/...a-usecase-properties-services-items-allof-1-then-allof-101-then-allof-0-then.md b/...a-usecase-properties-services-items-allof-1-then-allof-101-then-allof-0-then.md
@@ -10,27 +10,13 @@ unknown
 
 ## plan
 
-service plan >application< for >saas-registry< is available in data centers:
+service plan >blocks\_of\_100< for >sap-document-information-extraction< is available in data centers:
 
 *   {'region': 'ap10', 'name': 'Australia (Sydney)'}
-*   {'region': 'ap11', 'name': 'Singapore'}
-*   {'region': 'ap12', 'name': 'South Korea (Seoul)'}
-*   {'region': 'ap20', 'name': 'Australia (Sydney) Azure'}
-*   {'region': 'ap21', 'name': 'Singapore'}
-*   {'region': 'br10', 'name': 'Brazil (Sao Paulo)'}
-*   {'region': 'ca10', 'name': 'Canada (Montreal)'}
-*   {'region': 'ch20', 'name': 'cf-ch20'}
 *   {'region': 'eu10', 'name': 'Europe (Frankfurt)'}
 *   {'region': 'eu11', 'name': 'Europe (Frankfurt) EU Access - AWS'}
-*   {'region': 'eu20', 'name': 'Europe (Netherlands)'}
-*   {'region': 'eu30', 'name': 'Europe (Frankfurt)'}
-*   {'region': 'in30', 'name': 'India (Mumbai)'}
 *   {'region': 'jp10', 'name': 'Japan (Tokyo)'}
-*   {'region': 'jp20', 'name': 'Japan (Tokyo)'}
 *   {'region': 'us10', 'name': 'US East (VA)'}
-*   {'region': 'us20', 'name': 'US West (WA)'}
-*   {'region': 'us21', 'name': 'US East (VA)'}
-*   {'region': 'us30', 'name': 'US Central (IA)'}
 
 `plan`
 

diff --git a/...of-118-then-allof-0-if-properties-plan.md → ...of-101-then-allof-1-if-properties-plan.md b/...of-118-then-allof-0-if-properties-plan.md → ...of-101-then-allof-1-if-properties-plan.md
diff --git a/...n-allof-100-then-allof-1-if-properties.md → ...n-allof-101-then-allof-1-if-properties.md b/...n-allof-100-then-allof-1-if-properties.md → ...n-allof-101-then-allof-1-if-properties.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## btplogonidp Type

		`string` ([custom IDP for BTP logon](btpsa-parameters-properties-custom-idp-for-btp-logon.md))
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,5 +7,5 @@ unknown @@
     **constant**: the value of this property must be equal to:
     ```json
-    "free"
+    "default"
     ```