Package lifecycle
This page describes Manufacturing Data Engine (MDE)'s package lifecycle.
Upload a new configuration package
You can upload a new MDE's configuration package using
the a REST endpoint or from the
MDE web interface by providing a single *.zip file.
REST
Execute the REST API request with the following information:
- Method: POST.
- Endpoint:
/configuration/v1/configuration-packages. - Request body:
multiform data with key=”packageArchive”, value=configuration-package-zip file. - Response code: 200 OK.
Response body (JSON):
{ "id": "4adaecc2-54b9-482b-90d6-380f5d4b2be6", "name": "basic-configuration", "provider": "google", "latestStatus": "ACTIVATED", "status": [ { "code": "NOT_LOADED", "updatedTime": "1742566718210", "messages": [] }, { "code": "VALIDATED", "updatedTime": "1742566718210", "messages": [ { "severity": "INFO", "message": "Successfully validated all message classes in the package" }, { "severity": "INFO", "message": "Successfully validated all parsers in the package" }, { "severity": "INFO", "message": "Successfully validated all types in the package" } ] }, { "code": "LOADED", "updatedTime": "1742566718696", "messages": [ { "severity": "INFO", "message": "Successfully applied all message classes in the package" }, { "severity": "INFO", "message": "Successfully applied all types in the package" }, { "severity": "INFO", "message": "Successfully applied all parsers in the package" } ] }, { "code": "ACTIVATED", "updatedTime": "1742566718792", "messages": [ { "severity": "INFO", "message": "Successfully activated all ingestion-specification, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all message classes, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all buckets, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all metadata instance, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all types, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all parsers, if there is any, in the package" } ] } ] }
Console
- Click Cloud Configuration.
- Click ADD NEW CONFIGURATION PACKAGE.
- Select the file to upload to the console.
- Click UPLOAD.
After the package is uploaded, MDE will process it by running the following stages:
Validation: In this stage, MDE validates the contents of the package, it ensures that all the files are syntactically correct and that they are in the right place. If this phase is successfully completed, then MDE proceeds to the next stage.
Loading: In this stage, MDE tries to load and merge the configurations specified in the package with the current environment configurations. It checks any dependencies and makes sure that there are no naming collisions with existing configurations. This stage is atomic, which means that the package will either successfully be loaded, or it will be rolled-back completely. If the loading is successful, then MDE will proceed with the next stage.
Activation: In this stage MDE activates the configuration and makes it visible to the rest of the environment users. It also triggers the creation of any infrastructure elements required as part of the package configuration (for example, activating a type).
MDE v1.5.0 doesn't support updates for already deployed or activated packages. You can upload the same package again as long as it isn't active if this is required to fix any errors in either the validation or the loading stages. Once the package is set to active, you can't upload the same package again or upload a package that contains configuration entities with conflicting names.
List existing configuration packages
You can list existing MDE's configuration package using the a REST endpoint or from the MDE web interface.
REST
Execute the REST API request with the following information:
- Method: GET.
- Endpoint:
/configuration/v1/configuration-packages. - Response code: 200 OK.
Response body (JSON):
{ "configurationPackages": [ { "id": "0505ed17-ad20-458d-9128-d44783704acb", "name": "default-configuration-package", "provider": "google", "latestStatus": "ACTIVATED", "status": [ { "code": "NOT_LOADED", "updatedTime": "1742501535249", "messages": [] }, { "code": "VALIDATED", "updatedTime": "1742501535249", "messages": [ { "severity": "INFO", "message": "Successfully validated all buckets in the package" }, { "severity": "INFO", "message": "Successfully validated all message classes in the package" }, { "severity": "INFO", "message": "Successfully validated all metadata-instances in the package" }, { "severity": "INFO", "message": "Successfully validated all parsers in the package" }, { "severity": "INFO", "message": "Successfully validated all types in the package" } ] }, { "code": "LOADED", "updatedTime": "1742501536740", "messages": [ { "severity": "INFO", "message": "Successfully applied all message classes in the package" }, { "severity": "INFO", "message": "Successfully applied all buckets in the package" }, { "severity": "INFO", "message": "Successfully validated all metadata-instances in the package" }, { "severity": "INFO", "message": "Successfully applied all types in the package" }, { "severity": "INFO", "message": "Successfully applied all parsers in the package" } ] }, { "code": "ACTIVATED", "updatedTime": "1742501537289", "messages": [ { "severity": "INFO", "message": "Successfully activated all ingestion-specification, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all message classes, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all buckets, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all metadata instance, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all types, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all parsers, if there is any, in the package" } ] } ] }, { "id": "4adaecc2-54b9-482b-90d6-380f5d4b2be6", "name": "basic-configuration", "provider": "google", "latestStatus": "ACTIVATED", "status": [ { "code": "NOT_LOADED", "updatedTime": "1742566718210", "messages": [] }, { "code": "VALIDATED", "updatedTime": "1742566718210", "messages": [ { "severity": "INFO", "message": "Successfully validated all message classes in the package" }, { "severity": "INFO", "message": "Successfully validated all parsers in the package" }, { "severity": "INFO", "message": "Successfully validated all types in the package" } ] }, { "code": "LOADED", "updatedTime": "1742566718696", "messages": [ { "severity": "INFO", "message": "Successfully applied all message classes in the package" }, { "severity": "INFO", "message": "Successfully applied all types in the package" }, { "severity": "INFO", "message": "Successfully applied all parsers in the package" } ] }, { "code": "ACTIVATED", "updatedTime": "1742566718792", "messages": [ { "severity": "INFO", "message": "Successfully activated all ingestion-specification, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all message classes, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all buckets, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all metadata instance, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all types, if there is any, in the package" }, { "severity": "INFO", "message": "Successfully activated all parsers, if there is any, in the package" } ] } ] } ], "nextPageToken": "" }
Console
You can see the list of existing configuration packages on the Cloud Configuration section, in the Configurations page.
Delete an existing configuration package
Starting in v1.5.0, MDE supports an environment flag that can change the environment to development mode, which lets you delete configuration entities and delete configuration packages. After this mode is set, you can then delete an already activated package using the REST endpoint or the MDE web interface delete button.
REST
Execute the REST API request with the following information:
- Method: DELETE
- Endpoint:
/configuration/v1/configuration-packages/$PACKAGE-ID - Response code: 200 OK
- Response body (JSON):
{
"id": "87e160db-8ff9-403a-a873-e6674f6ac3cb",
"name": "postman-test-configuration-package",
"provider": "google",
"latestStatus": "DELETED",
"status": [
{
"code": "NOT_LOADED",
"updatedTime": "1742550114832",
"messages": []
},
{
"code": "VALIDATED",
"updatedTime": "1742550114832",
"messages": [
{
"severity": "INFO",
"message": "Successfully validated all buckets in the package"
},
{
"severity": "INFO",
"message": "Successfully validated all ingestion-specifications in the package"
},
{
"severity": "INFO",
"message": "Successfully validated all message classes in the package"
},
{
"severity": "INFO",
"message": "Successfully validated all metadata-instances in the package"
},
{
"severity": "INFO",
"message": "Successfully validated all parsers in the package"
},
{
"severity": "INFO",
"message": "Successfully validated all types in the package"
}
]
},
{
"code": "LOADED",
"updatedTime": "1742550115241",
"messages": [
{
"severity": "INFO",
"message": "Successfully applied all ingestion-specification in the package"
},
{
"severity": "INFO",
"message": "Successfully applied all message classes in the package"
},
{
"severity": "INFO",
"message": "Successfully applied all buckets in the package"
},
{
"severity": "INFO",
"message": "Successfully validated all metadata-instances in the package"
},
{
"severity": "INFO",
"message": "Successfully applied all types in the package"
},
{
"severity": "INFO",
"message": "Successfully applied all parsers in the package"
}
]
},
{
"code": "ACTIVATED",
"updatedTime": "1742550115327",
"messages": [
{
"severity": "INFO",
"message": "Successfully activated all ingestion-specification, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully activated all message classes, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully activated all buckets, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully activated all metadata instance, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully activated all types, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully activated all parsers, if there is any, in the package"
}
]
},
{
"code": "DELETED",
"updatedTime": "1742567553260",
"messages": [
{
"severity": "INFO",
"message": "Successfully deleted all parsers, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully deleted all message classes, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully deleted all types, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully activated all metadata instance, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully deleted all buckets, if there is any, in the package"
},
{
"severity": "INFO",
"message": "Successfully deleted all ingestion-specification, if there is any, in the package"
}
]
}
]
}
Console
- Click Cloud Configuration.
- Select the configuration package to delete.
- Click Actions.
Click Delete.
Confirm you are sure of deleting the selected configuration package by clicking Remove.
