onedevatlasBeta
Browse the atlas
AllBTPCAPUI5ABAP
CLICLItypeA command you run, rather than a dependency you import.See every one →What this type is →by SAPby SAPoriginPublished by SAP itself. A visible facet, never an input to a reading — a dormant official plugin reads exactly like a dormant independent one.See every one →

btp-setup-automator

A containerised script that sets up an SAP BTP account from JSON configuration files: entitlements, subscriptions, service instances, administrators and role collections, instead of clicking through the cockpit.

Sets up a BTP account from JSON configuration files run inside a Docker container that carries the command line tools it drives, which the overview gives as the reason it exists: configuring BTP without installing and understanding several of them first. It entitles services, subscribes to applications and creates service instances with service keys, adds administrator users to the global account and its subaccounts, sets up roles and role collections and assigns them to users, deploys whole applications, and unrolls a setup it created. A setup is written as a use case, and the repository ships a folder of them, of which only the ones in the released directory are described as tested. SAP has archived the repository and states that the tool is no longer maintained, recommending the Terraform Provider for SAP BTP instead.

GitHub96 ★
Docs
Issues

Facts

Last pushLicenceApache-2.0

Where it sits

Lives in
BTP/BAIP
Provides
Account provisioningBTPAccount provisioningcapabilitySetting up cloud accounts, their organisational structure, resource entitlements, subscriptions and access assignments so the setup can be repeated from code. [Deployment](capability:deployment) puts an application onto a runtime that this account structure makes available.
Requires
DockerDockeroutside the atlasThe engine that runs the container the script and the command line tools it drives live in; the basic setup lists installing it among the prerequisites, and the images are either pulled pre-built or built on the reader's machine.

Who is behind it

SAP ArchiveSAP ArchiveOrganisationMaintains this
In the atlas: maintains 2@SAP-archiveSAPSAPOrganisationMaintains this
In the atlas: maintains 137, wrote 14@SAPmaintainersAlexander RiederPersonContributes to this
In the atlas: contributes to 1@AlexRiederAlper DedeogluPersonContributes to this
In the atlas: contributes to 3, wrote 2@alperdedeogluArmin KramerPersonContributes to this
In the atlas: contributes to 1@AMNKramerAndrePersonContributes to this
In the atlas: contributes to 2@andre68723Brian BernardPersonContributes to this
In the atlas: contributes to 64@btbernardBritta VarwigPersonContributes to this
In the atlas: contributes to 8@bvarwigDJ AdamsPersonContributes to this
Developer Advocate
In the atlas: contributes to 20, wrote 22@qmacroFabian LehmannPersonContributes to this
In the atlas: contributes to 4@fabianlehilyabelozerovsapPersonContributes to this
In the atlas: contributes to 1@ilyabelozerovsapSangeetha JayakumarPersonContributes to this
In the atlas: contributes to 2@jsangeetha18 contributors

Before choosing this

Signals

RepositoryArchivedThe declared repository is archived

GitHub reports the repository as archived. The package may remain installable, but its source is no longer open for normal maintenance.

What it declares

Every artifact

Type
CLI
Origin
By SAP

As a CLI

Distributed through
Container image

Connections2

Download
btp-setup-automator connectionsbtp-setup-automatorPROVIDES→ provides1provides stated Configures a BTP account from JSON use case files run in a container: service entitlements, application subscriptions, service instances with service keys, administrator users on the global account and its subaccounts, and roles and role collections with their assignments, together with a step that unrolls the setup it created. SAP-archive/btp-setup-automator — repository description: https://github.com/SAP-archive/btp-setup-automator SAP-archive/btp-setup-automator — README, introduction: https://github.com/SAP-archive/btp-setup-automator/blob/main/README.md SAP-archive/btp-setup-automator — README, what can be automated: https://github.com/SAP-archive/btp-setup-automator/blob/main/README.md SAP-archive/btp-setup-automator — README, role collections and unrolling: https://github.com/SAP-archive/btp-setup-automator/blob/main/README.md SAP-archive/btp-setup-automator — Overview: https://github.com/SAP-archive/btp-setup-automator/blob/main/docs/OVERVIEW.md SAP-archive/btp-setup-automator — Use Cases: https://github.com/SAP-archive/btp-setup-automator/blob/main/docs/USECASES.md SAP-archive/btp-setup-automator — README, status notice: https://github.com/SAP-archive/btp-setup-automator/blob/main/README.md SAP-archive/btp-setup-automator — README, alternative: https://github.com/SAP-archive/btp-setup-automator/blob/main/README.mdAccount provisioningNEEDS→ needs1needs stated The engine that runs the container the script and the command line tools it drives live in; the basic setup lists installing it among the prerequisites, and the images are either pulled pre-built or built on the reader's machine. SAP-archive/btp-setup-automator — Basic Setup, prerequisites: https://github.com/SAP-archive/btp-setup-automator/blob/main/docs/BASIC_SETUP.md SAP-archive/btp-setup-automator — Basic Setup, images: https://github.com/SAP-archive/btp-setup-automator/blob/main/docs/BASIC_SETUP.mdDocker

Architecture

Download
Where btp-setup-automator runsBy its type: a CLI is run from a terminalcallsdocumentedrequiresYour terminal, actorYour terminalDocker, SoftwareDockerSoftwarebtp-setup-automator, modulebtp-setup-automator
SAPnot SAP's, or the project's ownstated in the documentdocumented only

README

quoted from SAP-archive/btp-setup-automator under Apache-2.0, read
SAP-archive/btp-setup-automator/README.mdOn GitHub

Setup Automator for SAP Business Technology Platform

REUSE status Release Docker ImageDev Docker Image

⚠ ARCHIVED - NO MAINTENANCE ⚠

📢 Please be aware that with tool is no longer maintained and the repository is archived

As an alternative for the btp-setup-automator we recommend to use the Terraform Provider for SAP BTP as tool for the setup of infrastructure on the SAP BTP available in the Hashicorp Terraform registry.

Description

This repository provides the user with a script to automate the setup of an SAP Business Technology Platform (SAP BTP) account and to learn how this is done with the various command line interfaces and tools that run inside a Docker container. It uses JSON configuration files to automate this setup of SAP BTP accounts or do other administrative tasks.

This includes:

  • Setup of your SAP BTP account
  • Entitlement of services
  • Subscriptions to applications and creation of service instances with service keys
  • Addition of administrator users to global account and sub accounts
  • Setup of roles and role collections, assignment of roles collections to users
  • Deployment of complete applications
  • Unrolling created setup
Quick Overview

Get a quick overview & demo of the btp-setup-automator through this video: Ask-the-expert video recording

Documentation

Started as a small helper for basic SAP BTP setups the tool has grown since its start. This documentation should support you in getting started quickly and then dive into the depths of the btp-setup-automator. The documentation has the following outline:

Code of conduct

Checkout the CODE_OF_CONDUCT.md file for more details on the code of conduct for this open source project.

License

Copyright (c) 2023 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.

Apache-2.0, read

History

Latest

v1.12.5

Notes

Other Changes

  • Several updates of dependencies via Dependabot (see list)

  1. v1.12.4

    Notes

    Other Changes

    • Several updates of dependencies via Dependabot (see list)

  2. v1.12.3

    Notes

    Other Changes

    • Several updates of dependencies via Dependabot (see list)

  3. v1.12.2

    Notes

    Bug Fixes 🐞

    • [#619] - Fix for breaking Docker Built - pinning MTA plugin to version 3.0.3

    Other Changes

    • [#601] - Fixed typo in usecase description of 4000-kyma-identity-management
    • Several updates of dependencies via Dependabot (see list)
    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata

  4. v1.12.1

    Notes

    Other Changes

    • Several updates of dependencies via Dependabot (see list)
    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata

  5. v1.12.0

    Notes

    Other Changes

    • Fix of security vulnerability CVE-2023-45803
    • [#585] Fix of cf multiapp plugin download location
    • Several updates of dependencies via Dependabot (see list)
    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata

  6. v1.11.0

    Notes

    Other Changes

    • Removal of tool fx (fetched from https://github.com/antonmedv/fx/) from Docker image btp-setup-automator as no longer available
    • Update of CF CLI version from 8.6.1 to 8.7.3
    • Fix of security vulnerability CVE-2023-43804
    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)

  7. v1.10.0

    Notes

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)

  8. v1.9.0

    Notes

    New Features and Enhancements 🚀

    • [#549] - Support custom IDP in logon

    Bug Fixes 🐞

    • [#547] - Broken links in use case readme for multitenant apps

    Breaking Changes 🛠

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)
    • [#546] - update BTP CLI version to 2.49.0
    • [#548] - update alpine base image to 3.18

  9. v1.8.5

    Notes

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)
    • Security fix for CVE-2023-26115

  10. v1.8.4

    Notes

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)
    • [#520] New use case "SaaS Onboarding"

    Community Contributions

    @martinfrick

  11. v1.8.3

    Notes

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)

  12. v1.8.2

    Notes

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)
    • Fix for vulnerability CVE-2023-32681

  13. v1.8.1

    Notes

    Bug Fixes 🐞

    • [#501] - fix: consistency of usecase files

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot (see list)

  14. v1.8.0

    Notes

    Bug Fixes 🐞

    • [#487] - Allow special characters for cf user password
    • [#495] - Pin platform for Mac M1/M2 support

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Several updates of dependencies via Dependabot
    • [#489] - Update CF CLI to version 8.6.1
    • [#490] - Update of MTA build tool to version 1.2.23 and FX Terminal tool to version 24.1.0

    Community Contributions

    @biehlera , @ublock

  15. v1.7.1

    Notes

    New Features and Enhancements 🚀

    • [#477] - Improvement of 3586-s4hana-kyma-mission
    • [#478] - Enhanced documentation
    • [#480] - Improved usecases documentation and enhancements

    Bug Fixes 🐞

    • [#479] - Type in overview.

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • [#484] - Update link checker to update existing issues

    Community Contributions

    @shankarigr , @bvarwig , @AlexRieder

  16. v1.7.0

    Notes

    New Features and Enhancements 🚀

    • [#467] - Update UseCase file for btp-resilient-apps repo - event mesh changes + entitleonly param usage
    • [#468] - Enhancement of role collection assignment with custom IdP.

    Bug Fixes 🐞

    • [#470] - Fix NoneType Error during app subscription.
    • [#472] - Read subaccount domain from existing subaccount
    • [#473] - Fix issue inappropriate ioctl for device with multiple CF spaces in a subaccount.

    Other Changes

    • [#466] - Update version of BTP CLI to 2.38.0.
    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata including the latest naming changes introduced by SAP Build
    • Dependabot updates of dependencies

    Community Contributions

    @AlexRieder , @maxstreifeneder

  17. v1.6.1

    Notes

    New Features and Enhancements 🚀

    • [#456] - Enable of service parameterfiles for sapbtp and kymaruntimeresources.
    • [#457] - Enable native HANA consumption in discovery center use cases.
    • [#459] - New use cases for Setup of SAP Build Apps and DSAG Technology Days 2023 session.

    Bug Fixes 🐞

    • [#458] - Increases timeouts to detect plans in environments after entitlement.
    • [#463] - Fix for differing app name and commercial app name.

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata including the latest naming changes introduced by SAP Build
    • Dependabot updates of dependencies

    Community Contributions

    @bondfelix , @AlexRieder

  18. v1.6.0

    Notes

    Bug Fixes 🐞

    • [#450] - Mitigate "plan not found" issues in usecase execution via a waiting strategy. This includes an improvement of the logging of the process.
    • [#452] - Improvement of waiting strategy introduced with [#450].
    • [#453] - Usage of correct app name in case of difference between commercial and technical app name.

    Breaking Changes 🛠

    • [#451] - The automatic creation of the subdomain ID is no longer linked to the GUID of the global account, but is postfixed with a GUID of length 10 to avoid length issues in downstream service instance creation. See also issue 260.

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata including the latest naming changes introduced by SAP Build
    Community Contributions

    @AlexRieder

  19. v1.5.2

    Notes

    Bug Fixes 🐞

    • [#441] - Fix devcontainer of dev branch to point to the right image.
    • [#441] - Fix wrong flow when creating entitlements.
    • [#441] - Fix None Type error when service instance is not created.

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata including the latest naming changes introduced by SAP Build
    • Dependabot updates of dependencies

  20. v1.5.1

    Notes

    Bug Fixes 🐞

    • [#438] Fix for issue with GitHub Codespace badges.

  21. v1.5.0

    Notes

    New Features and Enhancements 🚀

    • [#429] Introduction of devcontainer and GitHub Codespaces for easier execution of btpsa

    Bug Fixes 🐞

    • [#431] Fix runtime error for services and service key creation with "targetenvironment": "sapbtp").
    • [#433] Fix for services not requiring the creation of a service instance ("provisioningMethod": "NONE_REQUIRED").

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata including the latest naming changes introduced by SAP Build
    • Dependabot updates of dependencies

  22. v1.4.1

    Notes

    Other Changes

    • [#424] Refactoring of use case "Build resilient apps" due to refactoring of the btp-build-resilient-apps repository
    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata including the latest naming changes introduced by SAP Build
    • Dependabot updates of dependencies

  23. v1.4.0

    Notes

    Breaking Changes 🛠

    • [#419] - Removal of the build for linux/arm64 platform due to incompatibilities of dependencies.

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata including the latest naming changes introduced by SAP Build
    • Dependabot updates of dependencies

  24. v1.3.0

    Notes

    New Features and Enhancements 🚀

    • [#399] - Establishing Trust for XSUAA in plan apiaccess is now configurable

    Other Changes

    • [#385] - Version updates in Dockerfile of several CLIs and images
    • [#389] - Consistent linting of Python files with Black
    • [#393] - Update of documentation for option to configure JSON schema source in VS Code
    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Dependabot updates of dependencies
    • Infrastructure update for handling broken links: an automated issue is created whenever the scheduled check fails (see [#391])

  25. v1.2.4

    Notes

    Bug Fixes 🐞

  26. v1.2.3

    Notes

    New Features and Enhancements 🚀

    Bug Fixes 🐞

    • [#381] - Fix of issue with cf login and skipping of space creation.
    • [#382] - Correction of documentation for executing btpsa in interactive mode.

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Dependabot updates of dependencies

  27. v1.2.2

    Notes

    Bug Fixes 🐞

    • [#364] - Fix for CVE-2022-23491

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata

  28. v1.2.1

    Notes

    Bug Fixes 🐞

    • [#357] - Propagation of errors for Cloud Foundry org role assignment
    • [#359] - Skip CF space creation

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Restructuring of documentation [#361]

  29. v1.2.0

    Notes

    New Features and Enhancements 🚀

    • [#319] and - [#342] - Support of custom IdPs in role assignment (incl. CF roles)
    • [#329] - Support of labels for resources
    • [#338] - Cf api endpoint hardening
    • [#340] - Make accountMetadata available as env variables
    • [#343] - Subaccount enable beta features
    • [#330] and [#345] - Support of parameters when subscribing to applications
    • [#347] - Enhance fetching of remote parameters and usecase files

    Bug Fixes 🐞

    • [#327] - remove deletion of apps that are only entitled
    • [#346] and [#351] - Fix the wrong role collection assignment

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata
    • Bump of dependency updates (see overview)
    • Cleanup of code base [#353]
    Community Contributions

    @pirnz

  30. v1.1.0

    Notes

    New Features and Enhancements 🚀

    • [#319] - Support of IdPs in role assignment
    • [#320] - Enhancement of Dependabot configuration for package ecosystem npm

    Bug Fixes 🐞

    • [aab7f53] - Bug fix for parameter handling in service creation

    Other Changes

    • Regular update of btpsa-usecase.json and automated documentation due to updates in the service metadata

  31. v1.0.1

    Notes

    New Features and Enhancements 🚀

    • Update of btpsa-usecase.json and automated documentation due to renaming of services at SAP TechEd 2022. See also SAP TechEd News Guide 2022

    Other Changes

    • [#308] Bump lycheeverse/lychee-action from 1.5.2 to 1.5.4
    • [#309] Bump inquirer from 2.10.0 to 2.10.1 in /config/python

  32. v1.0.0

    Notes

    🎉 Welcome to release 1.0.0 of the btp-setup-automator! 🎉

    New Features and Enhancements 🚀

    We decided to adjust the development procedure for the btp-setup-automator by switching to releases. This change should make your life easier as you can now clearly see which changes namely bug fixes and enhancements are part of a release.

    Releases will consequently not be created daily, but whenever it is reasonable to create one – we do not want to flood you with a version every other day.

    In case you want to stay on the latest and greatest version of the btp-setup-automator we also create a dev image will be created more often and an image will be available in the registry called btp-setup-automator-dev

    Breaking Changes 🛠

    Due to the switch, we also changed the tagging of the container images. You will now find:

    • the release image as ghcr.io/sap-samples/btp-setup-automator:latest - as you can see the main tag is no longer available
    • the dev images available via ghcr.io/sap-samples/btp-setup-automator-dev:dev

    These changes are also reflected in the run scripts shipped with the btp-setup-automator. Instead of one parameter you now have two parameters to instruct the scripts which image to pull. You find more information in the README.

On GitHub

Others providing6

Compare all 7 on the Account provisioning page →
Account provisioning
  1. SAP Cloud Management Service for SAP BTPREST APIs for administering a BTP accountfrom BTP/BAIP
  2. SAP Service ManagerRegistry for service brokers, instances and environments on SAP BTPfrom BTP/BAIP
  3. BTP MCP ServerBTP Core Services as MCP tools with in-chat dashboardsfrom BTP/BAIP
  4. auth-transportUI5 app and CAP service copying role collections between subaccountsfrom BTP/BAIP
  5. MCP Server for SAP BTP AdministrationSAP-hosted MCP endpoint for BTP account administrationfrom BTP/BAIP
  6. Terraform Provider for SAP BTPTerraform and OpenTofu provider for SAP BTP global accountsfrom BTP/BAIP

Details

Sources3
Added by handdiscovered herechecked
github.com/SAP-archive/btp-setup-automatortree, pushes, contributors, CIchecked
README.mdquoted, and what the entry declareschecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
discovered viaAdded by hand
first seen in the atlas
ecosystem and domainbtp, operations-and-runtime
Contributors18
Alexander RiederAlper DedeogluArmin KramerAndreBrian BernardBritta VarwigDJ AdamsFabian LehmannilyabelozerovsapSangeetha JayakumarChristian LechnerMarcMartin FrickNidhi MurkuteThanh Phong LamRui Nogueirarui8472Yevgen Trukhin

From the repository’s contributor list, .

History in the atlas1
  1. First seen.
For your agent
Ref
artifact:sap-btp-setup-automator
JSON
/artifacts/sap-btp-setup-automator.json
MCP
Connecting an agent