A JSON schema for MTA projects v3.3 Json Format

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

_schema-version - The schema version that is being used for authoring a descriptor. The schema version should comply with the semantic versioning standard.

ID - An application ID, that may contain any number of unicode characters and should be unique in the target runtime environment.

description - A free text describing this application.

version - The application version that should comply with the semantic versioning standard.

provider - The provider or vendor of this application.

modules A list of modules.

#	name	type	description	path	properties-metadata.overwritable	properties-metadata.optional	properties-metadata.datatype	parameters-metadata.overwritable	parameters-metadata.optional	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.description}}	{{row.path}}	{{row['properties-metadata'].overwritableSelected.DisplayText}}	{{row['properties-metadata'].optionalSelected.DisplayText}}	{{row['properties-metadata'].datatype}}	{{row['parameters-metadata'].overwritableSelected.DisplayText}}	{{row['parameters-metadata'].optionalSelected.DisplayText}}

resources A list of resources that are required by the modules of this MTA project.

#	name	type	description	properties-metadata.overwritable	properties-metadata.optional	properties-metadata.datatype	parameters-metadata.overwritable	parameters-metadata.optional	optional	active	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.description}}	{{row['properties-metadata'].overwritableSelected.DisplayText}}	{{row['properties-metadata'].optionalSelected.DisplayText}}	{{row['properties-metadata'].datatype}}	{{row['parameters-metadata'].overwritableSelected.DisplayText}}	{{row['parameters-metadata'].optionalSelected.DisplayText}}	{{row.optionalSelected.DisplayText}}	{{row.activeSelected.DisplayText}}

.parameters

_

.parameters-metadata

_

parameters-metadata.overwritable

parameters-metadata.optional

includes It is possible to define parameters in external files. The "includes" section is used to point to those files.

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

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

type - The module type that defines the design-time tools for the module.

description - A free text describing this module.

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

deployed-after A list of modules that must be deployed before deploying the current module.

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

.properties

_modules

.properties-metadata

_modules

properties-metadata.overwritable

properties-metadata.optional

properties-metadata.datatype

.parameters

_modules

.parameters-metadata

_modules

parameters-metadata.overwritable

parameters-metadata.optional

hooks hooks

#	name	type	parameters.name	parameters.command	parameters.memory	parameters.disk-quota	parameters-metadata.overwritable	parameters-metadata.optional	parameters-metadata.datatype	Actions
{{$index+1}}.	{{row.name}}	{{row.type}}	{{row.parameters.name}}	{{row.parameters.command}}	{{row.parameters.memory}}	{{row.parameters['disk-quota']}}	{{row['parameters-metadata'].overwritableSelected.DisplayText}}	{{row['parameters-metadata'].optionalSelected.DisplayText}}	{{row['parameters-metadata'].datatype}}

.build-parameters

_modules

includes It is possible to define parameters in external files. The "includes" section is used to point to those files.

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

provides Used to define the named property sets that other modules and resources can require.

#	name	public	properties-metadata.overwritable	properties-metadata.optional	properties-metadata.datatype	Actions
{{$index+1}}.

requires A list of property sets provided by other modules and/or resources (providers) that this module requires.

#	name	parameters-metadata.overwritable	parameters-metadata.optional	parameters-metadata.datatype	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

parameters-metadata.overwritable

parameters-metadata.optional

parameters-metadata.datatype

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	parameters-metadata.overwritable	parameters-metadata.optional	parameters-metadata.datatype	Actions
{{$index+1}}.

.parameters

_requires

.parameters-metadata

_requires

.properties

_provides

.properties-metadata

_provides

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

type - A type of resource supported by deployment tools in the target environment.

description - A free text describing this resource.

.properties

_resources

.properties-metadata

_resources

properties-metadata.overwritable

properties-metadata.optional

properties-metadata.datatype

.parameters

_resources

.parameters-metadata

_resources

parameters-metadata.overwritable

parameters-metadata.optional

optional - If the resource is set to optional and the deployment tools are unable to allocate it, then the tools will issue a warning and continue the deployment process.

active - If a resource is declared to be inactive, the resource will not be allocated during the deployment process.

includes It is possible to define parameters in external files. The "includes" section is used to point to those files.

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

requires A list of property sets provided by other modules and/or resources (providers) that this resource requires.

#	name	parameters-metadata.overwritable	parameters-metadata.optional	parameters-metadata.datatype	Actions
{{$index+1}}.

ToolMatter

Your Apps in Action

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

{{repoTitle.MainEntity}}

modules A list of modules.

resources A list of resources that are required by the modules of this MTA project.

_

_

includes It is possible to define parameters in external files. The "includes" section is used to point to those files.

{{repoTitle.MainEntity}}

deployed-after A list of modules that must be deployed before deploying the current module.

_modules

_modules

_modules

_modules

hooks hooks

_modules

includes It is possible to define parameters in external files. The "includes" section is used to point to those files.

provides Used to define the named property sets that other modules and resources can require.

requires A list of property sets provided by other modules and/or resources (providers) that this module requires.

{{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}}

{{repoTitle.MainEntity}}

_provides

_provides

{{repoTitle.MainEntity}}

_resources

_resources

_resources

_resources

includes It is possible to define parameters in external files. The "includes" section is used to point to those files.

requires A list of property sets provided by other modules and/or resources (providers) that this resource requires.