A JSON schema for MTA deployment descriptors v3.3 Json Format

Use this form to visualize A JSON schema for MTA deployment descriptors v3.3.

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

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

version - Application version. Shall follow the semantic versioning standard.

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

provider - The provider or vendor of this software.

.parameters

_

.parameters-metadata

_

hooks hooks

#	name	type	parameters.name	parameters.command	parameters.memory	parameters.disk-quota	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.parameters.name}}	{{row.parameters.command}}	{{row.parameters.memory}}	{{row.parameters['disk-quota']}}

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

#	name	type	description	path	parameters.app-name	parameters.buildpack	parameters.command	parameters.create-service-broker	parameters.dependency-type	parameters.disk-quota	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.description}}	{{row.path}}	{{row.parameters['app-name']}}	{{row.parameters.buildpack}}	{{row.parameters.command}}	{{row.parameters['create-service-brokerSelected'].DisplayText}}	{{row.parameters['dependency-type']}}	{{row.parameters['disk-quota']}}

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

#	name	type	active	optional	description	parameters.service	parameters.service-key-name	parameters.service-name	parameters.service-broker	parameters.service-plan	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.activeSelected.DisplayText}}	{{row.optionalSelected.DisplayText}}	{{row.description}}	{{row.parameters.service}}	{{row.parameters['service-key-name']}}	{{row.parameters['service-name']}}	{{row.parameters['service-broker']}}	{{row.parameters['service-plan']}}

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

#	name	extends	Actions
{{$index+1}}.

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

#	name	extends	Actions
{{$index+1}}.

name - An internal name which can be used for documentation purposes and shown by the deployer.

type - Defines the type of action that should be executed by the deployer.

phases A list of strings that define the points at which the hook must be executed.

#	Values	Actions
{{$index+1}}.

.parameters

_hooks

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

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

parameters.memory

parameters.disk-quota

.parameters-metadata

_hooks

requires List of names either matching a resource name or a provided dependency name provided within the same MTA that are required by this hook.

#	name	Actions
{{$index+1}}.

.parameters

_requires

.parameters-metadata

_requires

name - The module name which must be unique and cannot be the same as any provided property set or resource name.

type

description - A free text describing this module.

path - The path to a folder that contains the module artifacts.

deployed-after A list containing the names of the modules that must be deployed prior to this one.

#	Values	Actions
{{$index+1}}.

.properties

_modules

.properties-metadata

_modules

.parameters

_modules

parameters.app-name - The name of the application in the Cloud Foundry environment to be deployed for this module, based on the module name.

parameters.buildpack - The name or the URL of a custom buildpack required by the application.

parameters.command - A custom command required to start the application.

parameters.create-service-broker - Specifies whether [true|false] a service broker should be registered for the application module; default value is: false.

parameters.dependency-type - Defines the memory allocated to the application.

parameters.disk-quota

parameters.buildpacks buildpacks

#	Values	Actions
{{$index+1}}.

.parameters.docker

_modules

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

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

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

parameters.domain - The domain on which the application will be available later.

parameters.enable-ssh - Enables use of SSH within an application. Supported for the Diego container runtime environment only.

parameters.health-check-type - Defines how the module will be monitored for availability.

parameters.health-check-timeout - The timeout is the amount of time (in seconds) allowed to elapse between starting up an app and the first healthy response.

parameters.health-check-invocation-timeout - The timeout in seconds for individual health check requests for http and port health checks.

parameters.health-check-http-endpoint - A http health check defaults to using '/' as its endpoint, but you can specify a custom endpoint.

parameters.host - The hostname or subdomain where an application is available later.

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

parameters.idle-host - The hostname or subdomain where the idle application will be available during blue-green deploy.

parameters.instances - The number of application instances that will be started during the deployment.

parameters.domains domains

#	Values	Actions
{{$index+1}}.

parameters.hosts hosts

#	Values	Actions
{{$index+1}}.

parameters.idle-domains idle-domains

#	Values	Actions
{{$index+1}}.

parameters.idle-hosts idle-hosts

#	Values	Actions
{{$index+1}}.

.parameters.keep-existing

_modules

parameters.keep-existing.env - Keep the existing environment

parameters.keep-existing.service-bindings - Keep the existing Service bindings

parameters.keep-existing.routes - Keep the existing routes

parameters.keep-existing-routes - When specified on module level, it indicates if the existing routes of the module's corresponding application should be kept even if they are not defined within the deployment and/or extension descriptors.When specified on global level, under the parameters section of the descriptor, it indicates if the existing routes of all applications within that MTA should be kept.The module-level variant of the parameter has priority over the global parameter.This parameter is typically used when users want to keep the routes they have mapped manually by using the cf map-route command. We discourage this approach, as manual operations could lead to inconsistent deployment results and difficult troubleshooting. We recommend you to define all routes in the deployment and/or extension descriptors, which allows for their automatic management.

parameters.memory

parameters.no-route - Defines if a route should be assigned to the application.

parameters.no-start - Start/do not start the application during deployment. This parameter setting overrides the command-line option --no-start. If you explicitly set the no-start to false for the module foo in the example provided, then the module foo is started on deployment, even if you also specify the command-line option --no-start with the cf deploy command.

parameters.service-broker-name - The name of the service broker in the Cloud Foundry environment to be created and registered for the specified application module.

parameters.service-broker-password - The password used for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true.

parameters.service-broker-space-scoped - Makes the service plans of the broker visible only within the targeted space.

parameters.service-broker-url - Specifies the value of the service broker universal resource locator (URL) to register; service requests are sent to this URL. The parameter is mandatory if create-service-broker: true.

parameters.service-broker-user - The name of the user required for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true.

parameters.stack - Use this parameter to define which prebuilt root file system (rootfs) you want to use.

parameters.upload-timeout - The application upload timeout in seconds.

parameters.restart-on-env-change restart-on-env-change

#	Actions
{{$index+1}}.

parameters.routes routes

#	route	Actions
{{$index+1}}.

parameters.tasks tasks

#	name	command	memory	disk-quota	Actions
{{$index+1}}.

.parameters-metadata

_modules

hooks hooks

#	name	type	parameters.name	parameters.command	parameters.memory	parameters.disk-quota	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.parameters.name}}	{{row.parameters.command}}	{{row.parameters.memory}}	{{row.parameters['disk-quota']}}

requires requires

#	name	Actions
{{$index+1}}.

provides provides

#	name	public	Actions
{{$index+1}}.	{{row.name}}	{{row.publicSelected.DisplayText}}

name - An MTA internal name which can used by a requiring module.

public - Indicates, that the provided properties shall be made publicly available by the deployer. Default value is false.

.properties

_provides

.properties-metadata

_provides

.parameters

_provides

parameters.visibility visibility

#	org	space	Actions
{{$index+1}}.

.parameters-metadata

_provides

name - The resource name which must be unique and cannot be the same as any provided property set or resource name.

type

active - If a resource is declared to be active, it is allocated and bound according to declared requirements. Default value is true.

optional - A resource can be declared to be optional, if the MTA can compensate for its non-existence. Default value is false.

description - A free text describing this resource.

.properties

_resources

.properties-metadata

_resources

.parameters

_resources

parameters.service - Name of the service to create.

parameters.service-key-name - Used when consuming an existing service key. Specifies the name of the service key. See Consumption of existing service keys for more information.

parameters.service-name - Service instance name. Default value is the resource name.

parameters.service-broker - The name of the service broker to be used.

parameters.service-plan - Name of the service plan to be used.

parameters.siteId - A globally unique ID (GUID) for your Fiori LaunchPad site.

parameters.service-tags Some services employ a list of custom tags, which provide an easier way for applications to parse <VCAP_SERVICES> for credentials. You can provide custom tags when creating a service instance. For more information, see Service Tags.

#	Values	Actions
{{$index+1}}.

.parameters.config

_resources

.parameters.skip-service-updates

_resources

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

parameters.skip-service-updates.plan - The service plan.

parameters.skip-service-updates.tags - The custom tags for a service instance.

parameters.provider-nid - When used for cross-MTA dependency resolution the provider-nid is always 'mta'.

parameters.provider-id - The resource from the provider MTA <mta-id>:<mta-provides-dependency-name>.

parameters.version - The version of the provider MTA.

.parameters.target

_resources

parameters.target.org - The org in which the configuration will be looked for

parameters.target.space - The space in which the configuration will be looked for

.parameters-metadata

_resources

hooks hooks

#	name	type	parameters.name	parameters.command	parameters.memory	parameters.disk-quota	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.parameters.name}}	{{row.parameters.command}}	{{row.parameters.memory}}	{{row.parameters['disk-quota']}}

requires requires

#	name	Actions
{{$index+1}}.

.properties

_module-types

.properties-metadata

_module-types

.parameters

_module-types

.parameters-metadata

_module-types

.properties

_resource-types

.properties-metadata

_resource-types

.parameters

_resource-types

.parameters-metadata

ToolMatter

Your Apps in Action

Use this form to visualize A JSON schema for MTA deployment descriptors v3.3.

{{repoTitle.MainEntity}}

_

_

hooks hooks

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

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

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

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

{{repoTitle.MainEntity}}

phases A list of strings that define the points at which the hook must be executed.

_hooks

_hooks

requires List of names either matching a resource name or a provided dependency name provided within the same MTA that are required by this hook.

{{repoTitle.MainEntity}}

_requires

_requires

{{repoTitle.MainEntity}}

deployed-after A list containing the names of the modules that must be deployed prior to this one.

_modules

_modules

_modules

parameters.buildpacks buildpacks

_modules

parameters.domains domains

parameters.hosts hosts

parameters.idle-domains idle-domains

parameters.idle-hosts idle-hosts

_modules

parameters.restart-on-env-change restart-on-env-change

parameters.routes routes

parameters.tasks tasks

_modules

hooks hooks

requires requires

provides provides

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

_provides

_provides

_provides

parameters.visibility visibility

_provides

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

_resources

_resources

_resources

parameters.service-tags Some services employ a list of custom tags, which provide an easier way for applications to parse <VCAP_SERVICES> for credentials. You can provide custom tags when creating a service instance. For more information, see Service Tags.

_resources

_resources

_resources

_resources

hooks hooks

requires requires

{{repoTitle.MainEntity}}

_module-types

_module-types

_module-types

_module-types

{{repoTitle.MainEntity}}

_resource-types

_resource-types

_resource-types

_resource-types