JSON Schema for service parameters used in BTPSA Properties

September 5, 2023 · View on GitHub

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

is optional
Type: string
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

btpcliapihostregion

host region for the BTP CLI calls

btpcliapihostregion

is optional
Type: string (host region for the BTP CLI calls)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (custom IDP for BTP logon)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (host region for the Cloud Foundry CLI calls)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (landscape of the CF environment for use case)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (name for the CF space)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: object (CF space quota)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (region for SAP BTP Kyma runtime cluster)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

clusterregion Type

string (region for SAP BTP Kyma runtime cluster)

customAppProviderSubaccountId

id of provider sub account of custom app

customAppProviderSubaccountId

is optional
Type: string (provider subaccount id of custom app on SAP BTP)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

customAppProviderSubaccountId Type

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

defaultIdp

default identity provider for role collections

defaultIdp

is optional
Type: string (default IdP)
can be null
defined in: JSON Schema for service parameters used in BTPSA

defaultIdp Type

string (default IdP)

directoryid

id of the directory that should be used

directoryid

is optional
Type: string (directory id in SAP BTP global account)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (directory name for use case)
can be null
defined in: JSON Schema for service parameters used in BTPSA

directoryname Type

string (directory name for use case)

directorylabels

labels for the directory

directorylabels

is optional
Type: object (directory labels)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: object (list of environment variables on OS level to be used within commands defined in the `executeBeforeAccountSetup` and `executeAfterAccountSetup`.)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (authentication method for external configuration)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (user name for external configuration file retrieval )
can be null
defined in: JSON Schema for service parameters used in BTPSA

externalConfigUserName Type

string (user name for external configuration file retrieval )

externalConfigPassword

password for external configuration file retrieval (basic authentication)

externalConfigPassword

is optional
Type: string (password for external configuration file retrieval)
can be null
defined in: JSON Schema for service parameters used in BTPSA

externalConfigPassword Type

string (password for external configuration file retrieval)

externalConfigToken

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

externalConfigToken

is optional
Type: string (token for external configuration file retrieval)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (fallback service plan, if the plan defined in the use case is not supported)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (your SAP BTP global account)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (IAS host for your SAP BTP sub account)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (name for the Kubernetes namespace)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (path to kubeconfig file)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: boolean (log all commands sent to your SAP BTP account)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (log file)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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=youremail@x.com

loginmethod

is required
Type: string (login method to SAP BTP)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (file for log information)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (Your email address)
can be null
defined in: JSON Schema for service parameters used in BTPSA

is optional
Type: string (password for the user of your SAP BTP account (USE WITH CARE!))
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

myusergroups Type

object[] (Details)

org

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

org

is optional
Type: string (org name of the CF environment for use case)
can be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (org id of the CF environment for use case)
can be null
defined in: JSON Schema for service parameters used in BTPSA

orgid Type

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

parameterfile

file to deliver all parameters within a single json file

parameterfile

is optional
Type: string (parameters file for btp-setup-automator)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: integer (Polling interval in minutes when tool is waiting for the Kyma instance to be created)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

is optional
Type: integer (Polling interval in minutes when tool is waiting for the Kyma instance to be deprovisioned/deleted)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

is optional
Type: boolean (same like parameter 'pruneusecase', but on-top deletes the subaccount)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: boolean (delete all assets of a usecase based on the collected info in the metadatafile)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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

is optional
Type: string (region for SAP BTP subaccount)
cannot be null
defined in: JSON Schema for service parameters used in BTPSA

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"`