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

Latest commit

 

History

History
65 lines (39 loc) · 2.64 KB

OVERVIEW.md

File metadata and controls

65 lines (39 loc) · 2.64 KB
Raw

Overview

Architecture

The btp-setup-automator enables you to configure the setup of the SAP BTP without the hassel to install and understand several CLIs in order to achieve this. The architectural diagram gives you an overview of what the tool contains:

architectural overview

Let us get an overview how to use the btp-setup-automator in the following sections.

Configuration

As a developer you configure your use case inside a usecase.json file with all services and subscriptions that you need (find some sample use cases here including their detailed descriptions). The JSON schema btpsa-usecase.json makes it fairly simple to create your own use case file as you can see in this video:

json schema for creating use case files

You find more information on the sample use cases in the use cases document.

Using the 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.

With VS Code

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

Watch the intro video on the btp-setup-automator

From a terminal

You can also attach to the running container and execute a shell in there:

docker exec -it btp-setup-automator bash

You'll be placed in a new Bash shell inside the container, with access to all the tools:

; docker exec -it btp-setup-automator bash
bash-5.1$ ls
LICENSE  LICENSES  README.md  btpsa  config  docs  generator  libs  parameters.json  tests  usecases
bash-5.1$ btp
Welcome to the SAP BTP command line interface (client v2.24.0)

Usage: btp [OPTIONS] ACTION GROUP/OBJECT PARAMS

CLI server URL:                    not set
User:                              not set
Configuration:                     /home/user/.config/btp/config.json

You are currently not logged in.

Tips:
    To log in to a global account of SAP BTP, use 'btp login'. For help on login, use 'btp help login'.
    To display general help, use 'btp help'.

bash-5.1$

What's next?

Now you have a basic overview over the moving parts of the btp-setup-automator. Now it is time to get your hands dirty. Learn here how to do that.