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

btpsa-v1.9.0 #560

Merged
merged 43 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
7d64db7
[btpsa bot] Generate parameter documentation
Jul 26, 2023
2dae2a9
[btpsa bot] Generate parameter documentation
Jul 27, 2023
ec84271
[btpsa bot] Generate parameter documentation
Jul 28, 2023
b5ee30a
[btpsa bot] Generate parameter documentation
Aug 1, 2023
ad52be7
Bump pycodestyle from 2.10.0 to 2.11.0 in /config/python (#536)
dependabot[bot] Aug 1, 2023
24c1a2b
[btpsa bot] Generate parameter documentation
Aug 3, 2023
07cfc59
[btpsa bot] Generate parameter documentation
Aug 5, 2023
21d899c
[btpsa bot] Generate parameter documentation
Aug 8, 2023
bfbfeaa
[btpsa bot] Generate parameter documentation
Aug 9, 2023
17dd042
[btpsa bot] Generate parameter documentation
Aug 11, 2023
108ee3a
[btpsa bot] Generate parameter documentation
Aug 14, 2023
2124543
[btpsa bot] Generate parameter documentation
Aug 16, 2023
2d408a5
[btpsa bot] Generate parameter documentation
Aug 19, 2023
d11fb83
Bump jsonschema from 4.18.4 to 4.19.0 in /config/python (#540)
dependabot[bot] Aug 19, 2023
54af172
Bump pycodestyle from 2.10.0 to 2.11.0 in /config/python (#539)
dependabot[bot] Aug 19, 2023
605fa7c
[btpsa bot] Generate parameter documentation
Aug 20, 2023
da86b0f
chore: update BTP CLI version (#546)
lechnerc77 Aug 20, 2023
1acf5ac
fix: broken links (#547)
lechnerc77 Aug 20, 2023
697c7f3
chore: update alpine base image to 3.18 (#548)
lechnerc77 Aug 20, 2023
244f318
feat: support custom IDP in logon
lechnerc77 Aug 20, 2023
3d90826
[btpsa bot] Generate parameter documentation
Aug 21, 2023
19ad891
Bump pycodestyle from 2.10.0 to 2.11.0 in /config/python (#551)
dependabot[bot] Aug 22, 2023
db4e336
Bump jsonschema from 4.18.4 to 4.19.0 in /config/python (#550)
dependabot[bot] Aug 22, 2023
7507f18
[btpsa bot] Generate parameter documentation
Aug 23, 2023
ca58c84
[btpsa bot] Generate parameter documentation
Aug 24, 2023
b5435c4
[btpsa bot] Generate parameter documentation
Aug 25, 2023
e8092c3
[btpsa bot] Generate parameter documentation
Aug 28, 2023
ebd5b64
Bump jsonschema from 4.18.4 to 4.19.0 in /config/python (#553)
dependabot[bot] Aug 29, 2023
10c4eb6
Bump pycodestyle from 2.10.0 to 2.11.0 in /config/python (#552)
dependabot[bot] Aug 29, 2023
d93343d
[btpsa bot] Generate parameter documentation
Aug 29, 2023
04ccc2c
[btpsa bot] Generate parameter documentation
Aug 30, 2023
38255f6
chore: change to latest builx image (#554)
lechnerc77 Aug 30, 2023
a57f5b1
[btpsa bot] Generate parameter documentation
Aug 31, 2023
c72ceb4
[btpsa bot] Generate parameter documentation
Sep 1, 2023
93218b9
[btpsa bot] Generate parameter documentation
Sep 2, 2023
e686c1b
[btpsa bot] Generate parameter documentation
Sep 4, 2023
9143a17
Merge pull request #549 from SAP-samples/issue-545
rui1610 Sep 4, 2023
744dcbd
Bump actions/checkout from 3 to 4 (#557)
dependabot[bot] Sep 4, 2023
d9e1f59
[btpsa bot] Generate parameter documentation
Sep 5, 2023
0c1723b
docs: maintenance mode (#559)
lechnerc77 Sep 5, 2023
15a3000
docker build
lechnerc77 Sep 5, 2023
44b5f13
revert docker build
lechnerc77 Sep 5, 2023
129db83
switch version of moby buildkit
lechnerc77 Sep 5, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/build-quality-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docker-dev-build-and-push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
contents: read
packages: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
ref: ${{ env.DEV_BRANCH }}

Expand All @@ -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

Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/docker-release-build-and-push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
contents: read
packages: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
ref: ${{ github.event.release.commitish }}

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/links-watcher-cron.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/reuse-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion .github/workflows/stage-integration-test-full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stage-integration-test-slim.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-metadata-artifacts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions config/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions config/python/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions config/templates/libs/BTPSA-PARAMETERS.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
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))
19 changes: 19 additions & 0 deletions docs/generated/btpsa-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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") |
Expand Down Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ unknown
**constant**: the value of this property must be equal to:

```json
"retention-manager"
"sap-calm"
```
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ unknown
**constant**: the value of this property must be equal to:

```json
"retention-manager"
"sap-calm"
```
Original file line number Diff 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"
```
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ unknown
**constant**: the value of this property must be equal to:

```json
"free"
"default"
```
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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"` | |
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ unknown
**constant**: the value of this property must be equal to:

```json
"saas-registry"
"sap-document-information-extraction"
```
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ unknown
**constant**: the value of this property must be equal to:

```json
"saas-registry"
"sap-document-information-extraction"
```
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ unknown
**constant**: the value of this property must be equal to:

```json
"application"
"blocks_of_100"
```
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ unknown
**constant**: the value of this property must be equal to:

```json
"application"
"blocks_of_100"
```
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
Loading