latest--mtad

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/mta-yaml/_shared/latest--mtad.json
Parent schema mta-yaml
Type: object

MTA deployment descriptor schema v3.3. Contains Cloud Foundry and XSA specific types and parameters.

Properties

_schema-version string required

Used to indicate to an MTA processing tool (e.g. a deployer), which schema version was taken as the base when authoring a descriptor.

Default: "3.3.0"
pattern=^(\d+\.)?(\d+\.)?(\*|\d+)$
ID string required

A globally unique ID of this MTA. Unlimited string of unicode characters.

pattern=^[A-Za-z0-9_\-\.]+$
version string required

Application version. Shall follow the semantic versioning standard.

pattern=^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$
description string

A non-translatable description of this MTA. This is not a text for application users.

provider string

The provider or vendor of this software.

parameters object

Global parameters related to the MTA application.

8 nested properties
apply-namespace apply-namespace-values[]

Apply namespace to application names, service names and application routes.

apps-stage-timeout number

[CF] Defines how long, in seconds, your application can take during staging before the MTA operation times out.

apps-start-timeout number

[CF] Defines how long, in seconds, your application can take to start before the MTA operation times out.

apps-task-execution-timeout number

[CF] Defines how long, in seconds, your application can take to execute a task before the MTA operation times out

apps-upload-timeout number

[CF] Defines how long, in seconds, you can upload your application binary before the MTA operation times out.

enable-parallel-deployments boolean

[CF/XSA] Defines if parallel deployment of modules is enabled. When enabled, modules without explicitly set deployed-after parameter are deployed in parallel.

keep-existing-routes boolean

[CF/XSA] Indicates if the existing routes of all applications within that MTA should be kept.

bg-dependency-aware-stop-order boolean

[CF] Enables dependency-aware stop ordering during the final phase of blue-green deployments.

parameters-metadata Record<string, object>
hooks object[]
modules object[]

A list of modules to be deployed by the MTA application.

resources object[]

A list of resources to be deployed by the MTA application.

module-types object[]

A list of custom module type definitions that will be used by the MTA application.

resource-types object[]

A list of custom resource type definitions that will be used by the MTA application.

Definitions

generic-memory string
module-type string
module-parameters object
module-parameters-cf object
app-features object
2 nested properties
ssh boolean

Enable SSH access to the application.

file-based-vcap-services boolean

Enable file-based VCAP service bindings for the app.

apply-namespace boolean

[CF] Apply namespace to application name.

buildpacks string[]
create-service-broker boolean

[CF] Specifies whether a service broker should be registered for the application module; default value is: false.

docker object
3 nested properties
image string

An image parameter is a docker image from the Docker Hub or somewhere else. eg. cloudfoundry/test-app

username string

The username is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.

password string

The password is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.

enable-parallel-service-bindings boolean

[CF] Enables or disables the parallel binding or unbinding of services during deployment.

health-check-invocation-timeout integer

[CF] The timeout in seconds for individual health check requests for http and port health checks.

idle-domain string

[CF] The idle domain on which the idle application will be available during blue-green deploy.

idle-domains string[]
idle-host string

[CF] The hostname or subdomain where the idle application will be available during blue-green deploy.

idle-hosts string[]
idle-routes object[]

List of idle-route objects for the module

keep-existing object
3 nested properties
env boolean

Keep the existing environment

service-bindings boolean

Keep the existing Service bindings

routes boolean

Keep the existing routes

readiness-health-check-http-endpoint string

[CF] The endpoint called to determine if the app is ready for HTTP checks.

readiness-health-check-interval number

[CF] Interval in seconds between individual readiness health check requests.

readiness-health-check-invocation-timeout number

[CF] Timeout in seconds for individual readiness health check requests.

readiness-health-check-type string

[CF] The type of health check to be performed on the module: http, port, or process.

Values: "port" "http" "process"
task-execution-timeout number

[CF] Timeout in seconds for executing a task.

min=0
upload-timeout number

[CF] Timeout in seconds for uploading application binary.

min=0
skip-deploy boolean

[CF] Skip the deployment of the application.

stack string

[CF] Defines which prebuilt root file system (rootfs) to use.

stage-timeout number

[CF] Defines staging timeout in seconds.

min=0
start-timeout number

[CF] Defines start timeout in seconds.

min=0
module-parameters-cf-xsa object
app-name string

[CF/XSA] The name of the application in the Cloud Foundry environment to be deployed for this module, based on the module name.

buildpack string

[CF/XSA] The name or URL of a custom buildpack required by the application.

command string

[CF/XSA] A custom command required to start the application.

dependency-type string

[CF/XSA] Defines the dependency type.

Values: "hard" "soft"
disk-quota string
pattern=^[1-9][0-9]*(M|MB|G|GB|m|mb|g|gb)$
domain string

[CF/XSA] The domain on which the application will be available later.

domains string[]
enable-ssh boolean

[CF/XSA] Enables use of SSH within an application.

health-check-type string

[CF/XSA] Defines how the module will be monitored for availability.

Values: "port" "process" "http"
health-check-timeout integer

[CF/XSA] The timeout between starting an app and the first healthy response.

host string

[CF/XSA] The hostname or subdomain where an application is available later.

hosts string[]
instances number

[CF/XSA] The number of application instances that will be started during deployment.

min=0
keep-existing-routes boolean

[CF/XSA] Keep existing routes even if not defined within the descriptors.

memory string
pattern=^[1-9][0-9]*(M|MB|G|GB|m|mb|g|gb)$
no-route boolean

[CF/XSA] Defines if a route should be assigned to the application.

no-start boolean

[CF/XSA] Start/do not start the application during deployment.

restart-on-env-change object[]
route-path string

[CF/XSA] The context 'route-path' part of the default URI.

routes object[]
service-broker-password string

[CF/XSA] The password used for authentication by the XS controller at the service broker.

service-broker-space-scoped boolean

[CF/XSA] Makes the service plans of the broker visible only within the targeted space.

service-broker-url string

[CF/XSA] The URL to register service requests.

service-broker-user string

[CF/XSA] The name of the user required for authentication by the XS controller.

tasks object[]
module-parameters-app-features object
ssh boolean

Enable SSH access to the application.

file-based-vcap-services boolean

Enable file-based VCAP service bindings for the app.

module-parameters-buildpacks string[]
module-parameters-domains string[]
module-parameters-hosts string[]
module-parameters-idle-routes object[]

List of idle-route objects for the module

module-parameters-routes object[]
module-parameters-tasks object[]
module-parameters-docker object
image string

An image parameter is a docker image from the Docker Hub or somewhere else. eg. cloudfoundry/test-app

username string

The username is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.

password string

The password is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.

module-parameters-keep-existing object
env boolean

Keep the existing environment

service-bindings boolean

Keep the existing Service bindings

routes boolean

Keep the existing routes

module-parameters-restart-on-env-change object[]
module-requires object[]
module-requires-parameters object
content-target boolean

[CF] Specify that the resource would be used as a target for the module content deployment.

binding-name string

[CF] Provide a binding name for the association between an application and a service instance.

delete-service-key-after-deployment boolean

[CF] If this parameter is set to true, the service keys used during the content deployment are deleted once the deployment is completed. The parameter is valid only for modules with direct content deployment.

env-var-name string

[CF/XSA] Used when consuming an existing service key. Specifies the name of the environment variable that will contain the service key's credentials.

module-provides object[]
module-provides-parameters object
visibility resource-configuration-target[]
use-live-routes boolean

[CF] Valid for blue-green deployment. Specify this parameter if you want to provide the routes specified in the descriptor.

resource-type string
resource-requires object[]
resource-parameters object
resource-parameters-cf object
apply-namespace boolean

[CF] Apply namespace to service name.

syslog-drain-url string

[CF] URL to which logs for bound applications are streamed.

skip-service-updates object
4 nested properties
parameters boolean

The configuration parameters which will be passed to the service broker.

plan boolean

The service plan.

tags boolean

The custom tags for a service instance.

syslog-drain-url boolean

URL to which logs for bound applications are streamed.

fail-on-service-update object
3 nested properties
parameters boolean

Specifies whether the deployment should fail if updating the service instance parameters fails.

plan boolean

Specifies whether the deployment should fail if updating the service plan fails.

tags boolean

Specifies whether the deployment should fail if updating the service tags fails.

resource-parameters-cf-xsa object
service string

[CF/XSA] Name of the service to create.

Any of: enum enum, string string
service-key-name string

[CF/XSA] Used when consuming an existing service key. Specifies the name of the service key.

service-name string

[CF/XSA] Service instance name. Default value is the resource name.

service-broker string

[CF/XSA] The name of the service broker to be used.

service-plan string

[CF/XSA] Name of the service plan to be used.

service-tags string[]

[CF/XSA] Some services employ a list of custom tags to parse <VCAP_SERVICES> for credentials.

siteId string

[CF/XSA] A globally unique ID (GUID) for your Fiori LaunchPad site.

config object

[CF/XSA] Map value containing the service creation configuration, e.g., url and user credentials (user and password).

provider-nid string

[CF/XSA] When used for cross-MTA dependency resolution, the provider-nid is always 'mta'.

Values: "mta"
provider-id string

[CF/XSA] The resource from the provider MTA :.

version string

[CF/XSA] The version of the provider MTA.

pattern=^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$
target object
2 nested properties
org string

[CF/XSA] The org in which the configuration will be looked for

space string

[CF/XSA] The space in which the configuration will be looked for

resource-skip-service-updates object
parameters boolean

The configuration parameters which will be passed to the service broker.

plan boolean

The service plan.

tags boolean

The custom tags for a service instance.

syslog-drain-url boolean

URL to which logs for bound applications are streamed.

resource-fail-on-service-update object
parameters boolean

Specifies whether the deployment should fail if updating the service instance parameters fails.

plan boolean

Specifies whether the deployment should fail if updating the service plan fails.

tags boolean

Specifies whether the deployment should fail if updating the service tags fails.

resource-configuration-target object
org string

[CF/XSA] The org in which the configuration will be looked for

space string

[CF/XSA] The space in which the configuration will be looked for

properties-metadata Record<string, object>
hooks object[]
hooks-parameters object
command string required

Defines the actual command that is executed as a Cloud Foundry task.

name string

Defines the name of the Cloud Foundry task that should be executed.

memory string
pattern=^[1-9][0-9]*(M|MB|G|GB|m|mb|g|gb)$
disk-quota string
pattern=^[1-9][0-9]*(M|MB|G|GB|m|mb|g|gb)$
apply-namespace-values object
app-names boolean

Apply namespace to application names.

service-names boolean

Apply namespace to service names.

app-routes boolean

Apply namespace to application routes.

as-suffix boolean

Apply namespace as suffix.

module-parameters-xsa object
check-deploy-id boolean

[XSA] Check the deployment (process) id when checking the application execution status

execute-app boolean

[XSA] After start and upon completion, application sets [success | failure]-marker in a log message

failure-marker string

[XSA] The failure marker in the log files for application execution.

port number

[XSA] Overwrite the default port of application.

ports integer[]

[XSA] Overwrite the default ports of application.

minItems=1uniqueItems=true
stop-app boolean

[XSA] Stop the application after execution.

success-marker string

[XSA] The success marker in logfiles for application execution.

tcp boolean

[XSA] Use TCP type routes for all application routes if there is domains parameters with multiple values.

tcps boolean

[XSA] Create a TCPS route (and use TLS with SSL termination at the platform router) for all app routes where there are 'hosts' and domains parameters with multiple values.

zdm-mode boolean

[XSA] Run blue-green deployment in zero-downtime-maintenance mode

resource-parameters-xsa object
config-path string

[XSA] The relative path from the MTA root directory to a file in the same application project, which contains information used to create or update parameters of an XS advanced service represented by the MTA resource.

database_id string

[XSA] The unique ID of a database instance (other than the default) that hosts the run-time to which you want to deploy an application.

service-alternatives string[]

[XSA] List of alternatives for a default service offering defined in the deploy service configuration. If a default service offering does not exist for the current org/space or creating a service fails (with a specific error), service alternatives are used. The order of service alternatives is considered.

minItems=1uniqueItems=true
siteId string

[XSA] A globally unique ID (GUID) for your Fiori LaunchPad site