The platform recognizes the APS applications that contain the deployment configuration for the wizard. By a request from the platform, such application returns that configuration in the proper format.
The document explains the general structure of a deployment configuration and the methods to process the related requests.
In this document:
The built-in initialization wizard provides its service to the provider for an APS application, if the APS package meets the following requirements:
The root application APS type, presenting the APS application instance, implements the init-wizard APS type
whose APS ID is http://odin.com/init-wizard/config/1.0
.
This allows the wizard to call the getInitWizardConfig
method on the APS root service endpoint.
The returned data must specify a set of deployment components
and some default configuration parameters.
http://aps-standard.org/types/core/profile/service/1.0
.http://aps-standard.org/types/core/profile/reseller/1.0
.The root application service definition must contain the getInitWizardConfig
method that returns data for the wizard
in the JSON format.
The root application service definition must contain the testConnection
method that tests a connection with
the cloud application and returns the 200 OK code in the case of success.
The getInitWizardConfig
method must return data for the wizard in the following JSON format:
{
"configurableProperties": [<property-1>, ...], // Global app properties
"defaults": {
"apsVersion": <APS API version>,
"appId": <APS application ID>,
"apsName": <arbitrary name>,
<OSS components>,
<BSS components>
}
}
The above wizard data contains the following configuration components.
configurableProperties
is an optional list of global properties to configure. Also, all global properties
declared as public are available for configuration in the APS application instance deployment process.
In the following example, the apphost
global property is allowed for configuration:
"configurableProperties": ["apphost"]
In the defaults
named list, the first three properties are general. Each of the other properties is optional
and used to provide a list of product components by default at a certain wizard step. If the step is missed,
those default components will be presented in the Summary
step for review and for commitment.
apsVersion
is the version of the APS API in accordance with the Versioning.
In the following example, the APS version 2.2 is required:
"apsVersion": "2.2"
appId
is the APS ID of the application root service as specified in the corresponding APS type, for example:
"appId": "http://aps-standard.org/samples/vpsdemo/cloud/1.0"
apsName
is an arbitrary application name, for example:
"apsName": "Cloud VPS Services"
The other configuration components inside the defaults
list are explained in the next sections.