Service Package Structure
The file structure of a service package is determined by the version of the JSON file generator. The generator converts the files from the service package into a JSON file, which the broker needs to integrate an image-based application with the marketplace. The generator version is specified in the version.yaml file.
To create a file structure for the JSON file generator 0.0.1:
-
Create the
<SERVICE_NAME>service directory. -
In the service directory, create a
version.yamlfile. Inside the file, in theversionparameter, specify the generator version0.0.1:version: 0.0.1 -
In the service directory, create the following directories and files:
-
The
full_description.mdfile — contains the full description of the service. -
The
service.yamlfile — describes the service parameters and its tariff plans. -
The
imagesdirectory — contains the file with the image of the service icon in the marketplace.-
A file with the
pngorsvgextension, used as the service icon (for more details, see the section Icon). The file name is used in theiconparameter when filling in theservice.yamlfile.The file size must not exceed 1 MB. The image size must be at least 62×62 pixels.
-
-
The
parametersdirectory — contains files describing the options of all tariff plans of the service:- The
<OPTION_NAME>.yamlfiles — describe the tariff plan options. Each individual file corresponds to one option. These options will be used when forming the file describing a specific tariff plan (theplan.yamlfile in the directory of a specific plan).
- The
-
The
plansdirectory — contains all tariff plans of the service. Inside, there are separate directories for each plan:-
Separate directories for each plan
<PLAN_NAME>— contain files describing a specific tariff plan. One directory corresponds to one plan:-
The
plan.yamlfile — describes the parameters of a specific tariff plan. -
The
display.yamlfile — describes the tariff plan configuration wizard. The tariff plan configuration wizard will be displayed in the marketplace when connecting the service and updating the tariff plan. -
The
deploymentdirectory — contains the Terraform manifest.- The
deploy.tffile — a manifest describing the infrastructure and the deployment process of a specific tariff plan of the service in the cloud platform. - The
settings.yamlfile (optional) — settings for executing the manifest.
- The
-
-
-
image_based_service/plans/free/deployment│├── common.tf├── compute.tf├── network.tf├── output.tf├── secgroup.tf└── variables.tf