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

Latest commit

 

History

History
1230 lines (680 loc) · 59.1 KB

btpsa-parameters.md

File metadata and controls

1230 lines (680 loc) · 59.1 KB
Raw

JSON Schema for service parameters used in BTPSA Type

object (JSON Schema for service parameters used in BTPSA)

all of

JSON Schema for service parameters used in BTPSA Properties

Property Type Required Nullable Defined by
$schema string Optional cannot be null JSON Schema for service parameters used in BTPSA
btpcliapihostregion string Optional can be null JSON Schema for service parameters used in BTPSA
btplogonidp string Optional can be null JSON Schema for service parameters used in BTPSA
cfcliapihostregion string Optional can be null JSON Schema for service parameters used in BTPSA
cfLandscape string Optional can be null JSON Schema for service parameters used in BTPSA
cfspacename string Optional can be null JSON Schema for service parameters used in BTPSA
cfspacequota object Optional cannot be null JSON Schema for service parameters used in BTPSA
clusterregion string Optional cannot be null JSON Schema for service parameters used in BTPSA
customAppProviderSubaccountId string Optional cannot be null JSON Schema for service parameters used in BTPSA
defaultIdp string Optional can be null JSON Schema for service parameters used in BTPSA
directoryid string Optional can be null JSON Schema for service parameters used in BTPSA
directoryname string Optional can be null JSON Schema for service parameters used in BTPSA
directorylabels object Optional cannot be null JSON Schema for service parameters used in BTPSA
envvariables object Optional cannot be null JSON Schema for service parameters used in BTPSA
externalConfigAuthMethod string Optional can be null JSON Schema for service parameters used in BTPSA
externalConfigUserName string Optional can be null JSON Schema for service parameters used in BTPSA
externalConfigPassword string Optional can be null JSON Schema for service parameters used in BTPSA
externalConfigToken string Optional can be null JSON Schema for service parameters used in BTPSA
fallbackserviceplan string Optional can be null JSON Schema for service parameters used in BTPSA
globalaccount string Optional can be null JSON Schema for service parameters used in BTPSA
iashost string Optional can be null JSON Schema for service parameters used in BTPSA
k8snamespace string Optional cannot be null JSON Schema for service parameters used in BTPSA
kubeconfigpath string Optional cannot be null JSON Schema for service parameters used in BTPSA
logcommands boolean Optional cannot be null JSON Schema for service parameters used in BTPSA
logfile string Optional cannot be null JSON Schema for service parameters used in BTPSA
loginmethod string Required cannot be null JSON Schema for service parameters used in BTPSA
metadatafile string Optional cannot be null JSON Schema for service parameters used in BTPSA
myemail string Optional can be null JSON Schema for service parameters used in BTPSA
mypassword string Optional cannot be null JSON Schema for service parameters used in BTPSA
myusergroups array Optional cannot be null JSON Schema for service parameters used in BTPSA
org string Optional can be null JSON Schema for service parameters used in BTPSA
orgid string Optional can be null JSON Schema for service parameters used in BTPSA
parameterfile string Optional cannot be null JSON Schema for service parameters used in BTPSA
pollingIntervalForKymaCreationInMinutes integer Optional cannot be null JSON Schema for service parameters used in BTPSA
pollingIntervalForKymaDeprovisioningInMinutes integer Optional cannot be null JSON Schema for service parameters used in BTPSA
prunesubaccount boolean Optional cannot be null JSON Schema for service parameters used in BTPSA
pruneusecase boolean Optional cannot be null JSON Schema for service parameters used in BTPSA
region string Optional cannot be null JSON Schema for service parameters used in BTPSA
repeatstatusrequest integer Optional cannot be null JSON Schema for service parameters used in BTPSA
repeatstatustimeout integer Optional cannot be null JSON Schema for service parameters used in BTPSA
rundefaulttests boolean Optional cannot be null JSON Schema for service parameters used in BTPSA
skipcfspacecreation boolean Optional cannot be null JSON Schema for service parameters used in BTPSA
subaccountenablebeta boolean Optional cannot be null JSON Schema for service parameters used in BTPSA
subaccountid string Optional cannot be null JSON Schema for service parameters used in BTPSA
subaccountlabels object Optional cannot be null JSON Schema for service parameters used in BTPSA
subaccountname string Optional can be null JSON Schema for service parameters used in BTPSA
subdomain string Optional can be null JSON Schema for service parameters used in BTPSA
suffixinstancename string Optional can be null JSON Schema for service parameters used in BTPSA
timeoutLimitForKymaCreationInMinutes integer Optional cannot be null JSON Schema for service parameters used in BTPSA
timeoutLimitForKymaDeprovisioningInMinutes integer Optional cannot be null JSON Schema for service parameters used in BTPSA
usecasefile string Required cannot be null JSON Schema for service parameters used in BTPSA
usedirectory boolean Optional cannot be null JSON Schema for service parameters used in BTPSA
waitForKymaEnvironmentCreation boolean Optional cannot be null JSON Schema for service parameters used in BTPSA

$schema

$schema

$schema Type

string

btpcliapihostregion

host region for the BTP CLI calls

btpcliapihostregion

btpcliapihostregion Type

string (host region for the BTP CLI calls)

btpcliapihostregion Default Value

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

btplogonidp Type

string (custom IDP for BTP logon)

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

cfcliapihostregion

cfcliapihostregion Type

string (host region for the Cloud Foundry CLI calls)

cfLandscape

landscape of the Cloud Foundry environment to be used for your use case (e.g. cf-eu10-004)

cfLandscape

cfLandscape Type

string (landscape of the CF environment for use case)

cfspacename

name for the Cloudfoundry space to be used for your use case

cfspacename

cfspacename Type

string (name for the CF space)

cfspacename Default Value

The default value is:

"development"

cfspacequota

space quota definition for the cf space

cfspacequota

cfspacequota Type

object (CF space quota)

clusterregion

region for the SAP BTP Kyma runtime cluster. This parameter is used as default for Kyma cluster creation. Override via usecase.json possible

clusterregion

clusterregion Type

string (region for SAP BTP Kyma runtime cluster)

customAppProviderSubaccountId

id of provider sub account of custom app

customAppProviderSubaccountId

customAppProviderSubaccountId Type

string (provider subaccount id of custom app on SAP BTP)

defaultIdp

default identity provider for role collections

defaultIdp

defaultIdp Type

string (default IdP)

directoryid

id of the directory that should be used

directoryid

directoryid Type

string (directory id in SAP BTP global account)

directoryname

name of your directory in case you want to define a specific name for it

directoryname

directoryname Type

string (directory name for use case)

directorylabels

labels for the directory

directorylabels

directorylabels Type

object (directory labels)

envvariables

list of environment variables on OS level to be used within commands defined in the executeBeforeAccountSetup and executeAfterAccountSetup.

envvariables

envvariables Type

object (list of environment variables on OS level to be used within commands defined in the `executeBeforeAccountSetup` and `executeAfterAccountSetup`.)

externalConfigAuthMethod

authentication method for external configuration file retrieval

externalConfigAuthMethod

externalConfigAuthMethod Type

string (authentication method for external configuration)

externalConfigAuthMethod Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"basicAuthentication"
"token"

externalConfigUserName

user name for external configuration file retrieval (basic authentication)

externalConfigUserName

externalConfigUserName Type

string (user name for external configuration file retrieval )

externalConfigPassword

password for external configuration file retrieval (basic authentication)

externalConfigPassword

externalConfigPassword Type

string (password for external configuration file retrieval)

externalConfigToken

token for external configuration file retrieval (token-based authentication)

externalConfigToken

externalConfigToken Type

string (token for external configuration file retrieval)

fallbackserviceplan

if defined, the tool will use the defined name as fallback service plan, if the plan defined in the use case is not supported

fallbackserviceplan

fallbackserviceplan Type

string (fallback service plan, if the plan defined in the use case is not supported)

globalaccount

the 'subdomain id' of your SAP BTP global account (please check it in the SAP BTP cockpit)

globalaccount

globalaccount Type

string (your SAP BTP global account)

iashost

IAS host for your SAP BTP sub account in case you want to make use of it in your use case (create a service instance for service 'xsuaa' and plan 'apiaccess')

iashost

iashost Type

string (IAS host for your SAP BTP sub account)

k8snamespace

name for the Kubernetes namespace to be used for your use case

k8snamespace

k8snamespace Type

string (name for the Kubernetes namespace)

k8snamespace Default Value

The default value is:

"default"

kubeconfigpath

path to kubeconfig file to be used for your use case

kubeconfigpath

kubeconfigpath Type

string (path to kubeconfig file)

kubeconfigpath Default Value

The default value is:

".kube/configsa"

logcommands

if set to True, the script will log all commands sent to the SAP BTP account. If set to False it won't

logcommands

logcommands Type

boolean (log all commands sent to your SAP BTP account)

logcommands Default Value

The default value is:

true

logfile

file including all logged information

logfile

logfile Type

string (log file)

logfile Default Value

The default value is:

"log/script.log"

loginmethod

if set to sso, you'll need to open a link provided in a browser to login. Set to basicAuthentication (default) the script will ask if you want to provide username and password. If set to envVariables you need to provide the email address and password by setting the environment variable BTPSA_PARAM_MYEMAIL and BTPSA_PARAM_MYPASSWORD. In addition you can as well provide the global account through the environment variable BTPSA_PARAM_GLOBALACCOUNT. Like this: export BTPSA_PARAM_MYEMAIL=[email protected]

loginmethod

loginmethod Type

string (login method to SAP BTP)

loginmethod Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"basicAuthentication"
"sso"
"envVariables"

loginmethod Default Value

The default value is:

"basicAuthentication"

metadatafile

file for log information

metadatafile

metadatafile Type

string (file for log information)

metadatafile Default Value

The default value is:

"log/metadata_log.json"

myemail

Email address you use to access your SAP BTP account

myemail

myemail Type

string (Your email address)

myemail Constraints

email: the string must be an email address, according to RFC 5322, section 3.4.1

mypassword

password for the user of your SAP BTP account (USE WITH CARE!)

mypassword

mypassword Type

string (password for the user of your SAP BTP account (USE WITH CARE!))

myusergroups

list of user groups to be used in btpsa

myusergroups

myusergroups Type

object[] (Details)

org

org name of the Cloud Foundry environment to be used for your use case

org

org Type

string (org name of the CF environment for use case)

orgid

org id of the Cloudfoundry environment to be used for your use case

orgid

orgid Type

string (org id of the CF environment for use case)

parameterfile

file to deliver all parameters within a single json file

parameterfile

parameterfile Type

string (parameters file for btp-setup-automator)

parameterfile Default Value

The default value is:

"parameters.json"

pollingIntervalForKymaCreationInMinutes

Polling interval in minutes when tool is waiting for the Kyma instance to be created

pollingIntervalForKymaCreationInMinutes

pollingIntervalForKymaCreationInMinutes Type

integer (Polling interval in minutes when tool is waiting for the Kyma instance to be created)

pollingIntervalForKymaCreationInMinutes Default Value

The default value is:

5

pollingIntervalForKymaDeprovisioningInMinutes

Polling interval in minutes when tool is waiting for the Kyma instance to be deprovisioned/deleted

pollingIntervalForKymaDeprovisioningInMinutes

pollingIntervalForKymaDeprovisioningInMinutes Type

integer (Polling interval in minutes when tool is waiting for the Kyma instance to be deprovisioned/deleted)

pollingIntervalForKymaDeprovisioningInMinutes Default Value

The default value is:

5

prunesubaccount

if set to True: same like -pruneusecase, but on-top deletes the subaccount. USE WITH CARE!!!

prunesubaccount

prunesubaccount Type

boolean (same like parameter 'pruneusecase', but on-top deletes the subaccount)

pruneusecase

if set to True: deletes all assets of a usecase based on the collected info in the metadatafile. No confirmation message. USE WITH CARE!!!

pruneusecase

pruneusecase Type

boolean (delete all assets of a usecase based on the collected info in the metadatafile)

region

region for the SAP BTP sub account that should be used for the use case

region

region Type

string (region for SAP BTP subaccount)

region Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"ae1"
"ap1"
"ap10"
"ap11"
"ap12"
"ap20"
"ap21"
"br1"
"br10"
"ca1"
"ca10"
"ch20"
"cn1"
"eu1"
"eu10"
"eu11"
"eu2"
"eu20"
"eu3"
"eu30"
"in30"
"jp1"
"jp10"
"jp20"
"sa1"
"us1"
"us10"
"us2"
"us20"
"us21"
"us3"
"us30"
"us4"

region Default Value

The default value is:

"us10"

repeatstatusrequest

time in seconds to wait after requesting status info (pulling)

repeatstatusrequest

repeatstatusrequest Type

integer (time in seconds to wait after requesting status info (pulling))

repeatstatusrequest Default Value

The default value is:

4

repeatstatustimeout

timeout in seconds after which requests should be stopped

repeatstatustimeout

repeatstatustimeout Type

integer (timeout in seconds after which requests should be stopped)

repeatstatustimeout Default Value

The default value is:

4200

rundefaulttests

switch to run default tests at the beginning of the script (INTERNAL USAGE)

rundefaulttests

rundefaulttests Type

boolean (switch to run default tests at the beginning of the script)

rundefaulttests Default Value

The default value is:

true

skipcfspacecreation

if set to True: skips the creation of a CF space

skipcfspacecreation

skipcfspacecreation Type

boolean (skip the creation of a CF space)

subaccountenablebeta

if set to true, a newly create subaccount will have beta features enabled

subaccountenablebeta

subaccountenablebeta Type

boolean (enable beta features in new subaccount)

subaccountid

id of your sub account that should be used

subaccountid

subaccountid Type

string (subaccount id of SAP BTP sub account)

subaccountlabels

labels for your sub account

subaccountlabels

subaccountlabels Type

object (sub account labels)

subaccountname

name of your sub account in case you want to define a specific name for your sub account

subaccountname

subaccountname Type

string (sub account name for use case)

subdomain

name of the subdomain of your sub account

subdomain

subdomain Type

string (subdomain of sub account)

suffixinstancename

suffix attached to each service instance that is created (e.g. hana_yoursuffixinstancename)

suffixinstancename

suffixinstancename Type

string (suffix attached to each service instance created)

timeoutLimitForKymaCreationInMinutes

Limit in minutes until the tool should wait for the Kyma instance to be created

timeoutLimitForKymaCreationInMinutes

timeoutLimitForKymaCreationInMinutes Type

integer (Limit in minutes until the tool should wait for the Kyma instance to be created)

timeoutLimitForKymaCreationInMinutes Default Value

The default value is:

40

timeoutLimitForKymaDeprovisioningInMinutes

Limit in minutes until the tool should wait for the Kyma instance to be deprovisioned/deleted

timeoutLimitForKymaDeprovisioningInMinutes

timeoutLimitForKymaDeprovisioningInMinutes Type

integer (Limit in minutes until the tool should wait for the Kyma instance to be deprovisioned/deleted)

timeoutLimitForKymaDeprovisioningInMinutes Default Value

The default value is:

40

usecasefile

file with usecase config

usecasefile

usecasefile Type

string (file with usecase config)

usedirectory

Should the tool create/use a directory for the subaccount?

usedirectory

usedirectory Type

boolean (Trigger creation/usage of a directory for the subaccount?)

waitForKymaEnvironmentCreation

Should the tool wait for the creation of the Kyma environment

waitForKymaEnvironmentCreation

waitForKymaEnvironmentCreation Type

boolean (Should the tool wait for the creation of the Kyma environment)

waitForKymaEnvironmentCreation Default Value

The default value is:

true