Setup Automator for SAP Business Technology Platform

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.

This includes:

• Setup of your SAP BTP account
• Entitlement of services
• Subscription of applications and creation of service instances with api keys
• Addition of administrator users to global account and subaccounts
• Setup of roles and role collections, assignment of roles collections to users
• Deployment of complete applications
• Unrolling created setup

In essence it’s all about making it easier to get developers quickly onboard on SAP BTP and use services on SAP BTP without having to know too much of the terminology and how to use the SAP BTP Cockpit.

All in containers

The tooling provided in this repository is supposed to run inside a docker container.

Why docker? We want to ensure that you can focus on getting your work done on the SAP BTP account without having to worry whether you have the right tools in the right release for the right operating system in place.

The Use Cases

As a user the only thing you need to focus on is your use case that defines which services or subscriptions you need. The use case is defined within a JSON structure. You can find use cases in the use cases folder of this repository, and - of course - you can create your own use case files, if you want to run the script.

With the built-in json schemas it's fairly simple to create your own use case file as you can see in this video:

You find more information on the different use cases in the usecases document.

Requirements

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

• Get an SAP BTP trial account or a productive SAP BTP account (recommended) where you can make use of the free tier service plans
• Install a Docker engine

⚠ NOTE: Be aware of the terms of Docker for usage in enterprises. For details see this link.

In case you are new to the containers topic, it is highly recommended to install and setup MS Visual Studio Code, too:

• Install VS Code - this will be your development environment.
• Install the VS Code plugin for Remote containers.

Download and Installation

If the pre-requisites above are all met, you can start your work by creating first your container. You can either use the pre-built docker image for the btp-setup-automator, or build the docker image yourself.

For starting quickly it is recommended to use the pre-built Docker image.

Option 1: Start Docker Container via Pre-Built Image (recommended)

The fastest way to use the btp-setup-automator it, to open a terminal windows on your machine and to enter the following command to pull the docker image from the GitHub repository and run it in a container:

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

You'll notice that the prompt in your terminal has changed, because you are now working inside the docker container, that you just started.

You can now run the main script btpsa with the following command and you'll be deploying a CAP application on your SAP BTP Trial account (the default usecase):

./btpsa

The tool starts to execute and the only thing you need to type-in is your password for your SAP BTP account.

📝 Tip - If you are already using VS Code, you should execute this command instead, so that the container runs "detached" (-d) from your command line session:

docker container run --rm -it -d --name "btp-setup-automator" "ghcr.io/sap-samples/btp-setup-automator:main"

You can also use the provided run files to pull the image from the registry and start the container via one command. To do so execute the following command:

• bash (macOS/Linux)

  ./run RunFromRegistry
  

• Command Prompt (Windows):

  .\run.bat RunFromRegistry
  

• PowerShell Core (Cross Platform):

  .\run.ps1 -RunFromRegistry $True 
  

Option 2: Start Docker Container With Self-Built Image

To create the Docker image yourself you need to execute these steps:

• Clone this GitHub repository to a local folder on your machine.

• Open the local folder in a command terminal on your machine (or in VS Code).

• Build the container with the following command:

  • bash (macOS/Linux)

    ./run
    

  • Command Prompt (Windows):

    .\run.bat
    

  • PowerShell Core (Cross Platform):

    .\run.ps1
    

The script will build a docker image and create a docker container on your machine.

Using the Docker Container

Independently whether you've created the docker image yourself, or used the pre-built image, you should now see the Docker container up-and-running. In case you are using VS Code, open the command palette (Windows: Ctrl+Shift+P ; Mac: Cmd+Shift+P) and select the Remote Containers: Attach to running Container ... command:

📝 Tip - Don't forget to install the "Remote-Containers" extension in VS Code)

The select the btp-setup-automator container:

Using BTP-SETUP-AUTOMATOR

You can run the container directly via the terminal or within VS Code, modify use case file and parameter file or supply externally available use case and parameter file.

Read the detailed instructions on how to setup your SAP BTP account for a use case with the btp-setup-automator.

If you want a more detailed walk-through guiding you through the first steps with the btp-setup-automator, then this video on YouTube is worth a look:

Sample Use-Cases

You find several sample Use cases in the folder ./usecases/released. They are described in the USECASES.md file.

Known Issues

Checkout the issues section in this repo for known and current issues.

How to obtain Support?

❓ - If you have question you may peruse the Frequently Asked Questions document. If you did not find your questions answered there you can ask a question in SAP Community.

🐛 - If you find a bug, feel free to create an bug report.

🚀 - If you have an idea for improvement or a feature request, please open feature-request.

Contributions

Checkout the CONTRIBUTING.md file for more details on how to contribute to this open source project.

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) 2022 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.