Cycle de vie des packages

Cette page décrit le cycle de vie des packages de Manufacturing Data Engine (MDE).

Importer un nouveau package de configuration

Vous pouvez importer un nouveau package de configuration MDE à l'aide d'un point de terminaison REST ou de l'interface Web MDE en fournissant un seul fichier *.zip.

REST

Exécutez la requête de l'API REST avec les informations suivantes :

  • Méthode : POST.
  • Point de terminaison : /configuration/v1/configuration-packages.
  • Corps de la requête : multiform data with key=”packageArchive”, value=configuration-package-zip file.
  • Code de réponse : 200 OK.
  • Corps de la réponse (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

  1. Cliquez sur Configuration du cloud.
  2. Cliquez sur AJOUTER UN PACK DE CONFIGURATION.
  3. Sélectionnez le fichier à importer dans la console.
  4. Cliquez sur IMPORTER.

Nouveau package de configuration

Une fois le package importé, MDE le traite en exécutant les étapes suivantes :

  1. Validation : à cette étape, MDE valide le contenu du package. Il s'assure que tous les fichiers sont syntaxiquement corrects et qu'ils se trouvent au bon endroit. Si cette phase est terminée, MDE passe à l'étape suivante.

  2. Chargement : à cette étape, MDE tente de charger et de fusionner les configurations spécifiées dans le package avec les configurations de l'environnement actuel. Il vérifie les dépendances et s'assure qu'il n'y a pas de conflits de noms avec les configurations existantes. Cette étape est atomique, ce qui signifie que le package sera chargé avec succès ou qu'il sera complètement annulé. Si le chargement réussit, MDE passe à l'étape suivante.

  3. Activation : à cette étape, MDE active la configuration et la rend visible pour les autres utilisateurs de l'environnement. Il déclenche également la création de tous les éléments d'infrastructure requis dans la configuration du package (par exemple, l'activation d'un type).

MDE v1.5.0 n'est pas compatible avec les mises à jour des packages déjà déployés ou activés. Vous pouvez réimporter le même package tant qu'il n'est pas actif, si cela est nécessaire pour corriger les erreurs lors de la validation ou du chargement. Une fois le package défini sur "actif", vous ne pouvez plus importer le même package ni un package contenant des entités de configuration avec des noms en conflit.

Lister les packages de configuration existants

Vous pouvez répertorier le package de configuration MDE existant à l'aide d'un point de terminaison REST ou de l'interface Web MDE.

REST

Exécutez la requête de l'API REST avec les informations suivantes :

  • Méthode : GET.
  • Point de terminaison : /configuration/v1/configuration-packages.
  • Code de réponse : 200 OK.
  • Corps de la réponse (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

Vous pouvez consulter la liste des packages de configuration existants dans la section Configuration du cloud de la page Configurations.

Package de configuration des listes

Supprimer un package de configuration existant

À partir de la version 1.5.0, MDE est compatible avec un indicateur d'environnement qui peut modifier l'environnement en mode développement, ce qui vous permet de supprimer des entités de configuration et des packages de configuration. Une fois ce mode défini, vous pouvez supprimer un package déjà activé à l'aide du point de terminaison REST ou du bouton de suppression de l'interface Web MDE.

REST

Exécutez la requête de l'API REST avec les informations suivantes :

  • Méthode : DELETE
  • Point de terminaison : /configuration/v1/configuration-packages/$PACKAGE-ID
  • Code de réponse : 200 OK
  • Corps de la réponse (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

  1. Cliquez sur Configuration du cloud.
  2. Sélectionnez le package de configuration à supprimer.
  3. Cliquez sur Actions.
  4. Cliquez sur Supprimer.

    Supprimer un package de configuration

  5. Confirmez que vous souhaitez supprimer le package de configuration sélectionné en cliquant sur Supprimer.

Confirmation de la suppression du package de configuration