DocumentazioneCommerceGuida di Commerce su infrastruttura Cloud

Distribuzione basata su scenari

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Amministratore
  • Sviluppatore

Con ece-tools 2002.1.0 e versioni successive è possibile utilizzare la funzionalità di distribuzione basata su scenari per personalizzare il comportamento di distribuzione predefinito.
Questa funzionalità utilizza scenari e passaggi nella configurazione:

  • Configurazione scenario-Ogni hook di distribuzione è uno scenario, ovvero un file di configurazione XML che descrive la sequenza e i parametri di configurazione per completare le attività di distribuzione. Configurare gli scenari nella sezione hooks del file .magento.app.yaml.

  • Configurazione del passaggio-Ogni scenario utilizza una sequenza di passaggi che descrivono in modo programmatico le operazioni necessarie per completare le attività di distribuzione. È possibile configurare i passaggi in un file di configurazione dello scenario basato su XML.

Adobe Commerce su infrastruttura cloud fornisce un set di scenari predefiniti e passaggi predefiniti nel pacchetto ece-tools. È possibile personalizzare il comportamento di distribuzione creando file di configurazione XML personalizzati per sostituire o personalizzare la configurazione predefinita. Puoi anche utilizzare scenari e passaggi per eseguire il codice dai moduli personalizzati.

Aggiungere scenari utilizzando gli hook di compilazione e distribuzione

Aggiungere gli scenari per la creazione e la distribuzione di Adobe Commerce alla sezione hooks del file .magento.app.yaml. Ogni hook specifica gli scenari da eseguire durante ogni fase. L’esempio seguente mostra la configurazione dello scenario predefinita.

magento.app.yaml hook

hooks:
    build: |
        set -e
        php ./vendor/bin/ece-tools run scenario/build/generate.xml
        php ./vendor/bin/ece-tools run scenario/build/transfer.xml
    deploy: |
        php ./vendor/bin/ece-tools run scenario/deploy.xml
    post_deploy: |
        php ./vendor/bin/ece-tools run scenario/post-deploy.xml
NOTE
Con la versione di ece-tools 2002.1.x, è disponibile un nuovo formato di configurazione hook. Il formato legacy delle versioni ece-tools 2002.0.x è ancora supportato. Tuttavia, è necessario eseguire l’aggiornamento al nuovo formato per utilizzare la funzione di distribuzione basata su scenari.

Passaggi dello scenario di revisione

Nella configurazione hook, ogni scenario è un file XML che contiene i passaggi per eseguire attività di compilazione, distribuzione o post-distribuzione. Ad esempio, il file scenario/transfer include tre passaggi: compress-static-content, clear-init-directory e backup-data

scenario/transfer.xml

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
    <step name="compress-static-content" type="Magento\MagentoCloud\Step\Build\CompressStaticContent" priority="100"/>
    <step name="clear-init-directory" type="Magento\MagentoCloud\Step\Build\ClearInitDirectory" priority="200"/>
    <step name="backup-data" type="Magento\MagentoCloud\Step\Build\BackupData" priority="300">
        <arguments>
            <argument name="logger" xsi:type="object">Psr\Log\LoggerInterface</argument>
            <argument name="steps" xsi:type="array">
                <item name="static-content" xsi:type="object" priority="100">Magento\MagentoCloud\Step\Build\BackupData\StaticContent</item>
                <item name="writable-dirs" xsi:type="object"  priority="200">Magento\MagentoCloud\Step\Build\BackupData\WritableDirectories</item>
            </argument>
        </arguments>
    </step>
</scenario>

Estendere uno scenario predefinito

L'esempio seguente estende lo scenario di distribuzione predefinito aggiungendo ulteriori file di configurazione della distribuzione alla configurazione hook.

hooks:
  deploy: |
    php ./vendor/bin/ece-tools run scenario/deploy.xml vendor/<vendor-name>/<module-name>/deploy.xml vendor/<vendor-name>/<module-name>/deploy2.xml

Durante la distribuzione, gli scenari personalizzati si fondono con lo scenario predefinito basato sulle regole seguenti:

  • Gli scenari vengono classificati in base alla loro sequenza nella definizione dell’hook, con l’ultimo scenario elencato che ha la priorità più alta.

    Nell’esempio, gli scenari hanno la seguente priorità:

    1. vendor/vendor-name/module-name/deploy2.xml
    2. vendor/vendor-name/module-name/deploy.xml
    3. scenario/deploy.xml (scenario predefinito o di base)

  • I passaggi dello scenario con priorità più alta sostituiscono i passaggi con lo stesso nome negli altri scenari. Vengono aggiunti nuovi passaggi alla configurazione. Le stesse regole si applicano a più di due scenari con ogni scenario con priorità da destra a sinistra, ad esempio (C → B → A).

Rimuovi passaggi predefiniti

Rimuovere i passaggi dagli scenari predefiniti utilizzando il parametro skip.

Ad esempio, per saltare i passaggi enable-maintenance-mode e set-production-mode nello scenario di distribuzione predefinito, crea un file di configurazione che include la configurazione seguente.

vendor/vendor-name/module-name/deploy-custom-mode-config.xml

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
    <step name="enable-maintenance-mode" skip="true" />
    <step name="set-production-mode"  skip="true" />
</scenario>

Per utilizzare il file di configurazione personalizzato, aggiornare il file .magento.app.yaml predefinito.

.magento.app.yaml con scenario di distribuzione personalizzato

hooks:
    build: |
        set -e
        php ./vendor/bin/ece-tools run scenario/build/generate.xml
        php ./vendor/bin/ece-tools run scenario/build/transfer.xml
    deploy: |
        php ./vendor/bin/ece-tools run scenario/deploy.xml vendor/vendor-name/module-name/deploy-custom-mode-config.xml
    post_deploy: |
        php ./vendor/bin/ece-tools run scenario/post-deploy.xml

Sostituisci passaggi predefiniti

Gli scenari personalizzati possono sostituire i passaggi predefiniti per fornire un’implementazione personalizzata. A tale scopo, utilizzate il nome di default del passo come nome del passo personalizzato.

Ad esempio, nello scenario di distribuzione predefinito il passaggio enable-maintenance-mode esegue lo script PHP predefinito [EnableMaintenanceMode].

<step name="enable-maintenance-mode" type="Magento\MagentoCloud\Step\EnableMaintenanceMode" priority="300"/>

Per ignorare questo passaggio, creare un file di configurazione dello scenario personalizzato per eseguire uno script diverso durante l'esecuzione del passaggio enable-maintenance-mode.

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
<scenario>
    <step name="enable-maintenance-mode" type="VendorName\VendorModule\Step\CustomEnableMaintenanceMode" priority="300"/>
</scenario>

Modificare la priorità del passaggio

Gli scenari personalizzati possono modificare la priorità dei passaggi predefiniti. Il passaggio seguente cambia la priorità del passaggio enable-maintenance-mode da 300 a 10 in modo che venga eseguito prima nello scenario di distribuzione.

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
<scenario>
    <step name="enable-maintenance-mode" type="Magento\MagentoCloud\Step\EnableMaintenanceMode" priority="10"/>
</scenario>

In questo esempio, il passaggio enable-maintenance-mode si sposta all'inizio dello scenario perché ha una priorità inferiore rispetto a tutti gli altri passaggi dello scenario di distribuzione predefinito.

Esempio: estendere lo scenario di distribuzione

L'esempio seguente personalizza lo scenario di distribuzione predefinito con le seguenti modifiche:

  • Sostituisce il passaggio remove-deploy-failed-flag con un passaggio personalizzato
  • Ignora il passaggio clean-redis-cache nella fase di pre-distribuzione
  • Ignora il passaggio unlock-cron-jobs
  • Ignora il passaggio validate-config per disabilitare le convalide critiche
  • Aggiunge un nuovo passaggio di predistribuzione

vendor/vendor-name/module-name/deploy-extended.xml

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
    <!-- Replace "remove-deploy-failed-flag" step with custom step -->
    <step name="remove-deploy-failed-flag" type="Vendor\ModuleName\Step\Deploy\RemoveDeployFailedFlag" priority="100"/>

    <!-- Skip "clean-redis-cache" sub-step in pre-deploy step -->
    <step name="pre-deploy" type="Magento\MagentoCloud\Step\Deploy\PreDeploy" priority="200">
        <arguments>
            <argument name="logger" xsi:type="object">Psr\Log\LoggerInterface</argument>
            <argument name="steps" xsi:type="array">
                <item name="clean-redis-cache" xsi:type="object" skip="true"/>
            </argument>
        </arguments>
    </step>

    <!-- Skip step "unlock-cron-jobs" -->
    <step name="unlock-cron-jobs" skip="true"/>

    <!-- Skip critical validators -->
    <step name="validate-config" type="Magento\MagentoCloud\Step\ValidateConfiguration" priority="300">
        <arguments>
            <argument name="logger" xsi:type="object">Psr\Log\LoggerInterface</argument>
            <argument name="validators" xsi:type="array">
                <item name="critical" xsi:type="array">
                    <item name="database-configuration" xsi:type="object" skip="true"/>
                    <item name="search-configuration" xsi:type="object" skip="true"/>
                </item>
            </argument>
        </arguments>
    </step>

    <!-- Add new step into the beginning of the deploy scenario -->
    <step name="new-pre-deploy-step" type="Vendor\ModuleName\Step\Deploy\PreDeploy" priority="10"/>
</scenario>

Per utilizzare questo script nel progetto, aggiungi la seguente configurazione al file .magento.app.yaml per il progetto di infrastruttura cloud di Adobe Commerce:

hooks:
    build: |
        set -e
        php ./vendor/bin/ece-tools run scenario/build/generate.xml
        php ./vendor/bin/ece-tools run scenario/build/transfer.xml
    deploy: |
        php ./vendor/bin/ece-tools run scenario/deploy.xml vendor/vendor-name/module-name/deploy-extended.xml
    post_deploy: |
        php ./vendor/bin/ece-tools run scenario/post-deploy.xml
TIP
È possibile esaminare gli scenari predefiniti e la configurazione dei passaggi predefiniti nell'archivio GitHub ece-tools per determinare gli scenari e i passaggi da personalizzare per le attività di generazione, distribuzione e post-distribuzione del progetto.

Aggiungi un modulo personalizzato per estendere ece-tools

Il pacchetto ece-tools fornisce interfacce API predefinite che seguono gli standard della versione semantica. Tutte le interfacce API sono contrassegnate con annotazione @api. Puoi sostituire l’implementazione API predefinita con la tua creando un modulo personalizzato e modificando il codice predefinito in base alle esigenze.

Per utilizzare il modulo personalizzato con Adobe Commerce sull'infrastruttura cloud, è necessario registrare il modulo nell'elenco delle estensioni per il pacchetto ece-tools. Il processo di registrazione è simile a quello utilizzato per registrare i moduli in Adobe Commerce.

Per registrare un modulo con il pacchetto ece-tools:

  1. Crea o estendi il file registration.php nella radice del modulo.

    code language-php?start_inline=1 
    \Magento\MagentoCloud\ExtensionRegistrar::register('module-name', __DIR__);

  2. Aggiornare la sezione autoload del file di configurazione del modulo per includere il file registration.php nei file del modulo di caricamento automatico in composer.json.

    code language-json 
    {
  "name": "vendor/ece-tools-extend",
  "description": "Extension for ece-tools",
  "type": "magento2-component",
  "version": "1.0.0",
  "license": "OSL-3.0",
  "autoload": {
    "files": [ "registration.php" ],
    "psr-4": {
      "Vendor\\EceToolExtend\\": "src/"
    }
  }
}

  3. Aggiungi il file config/services.xml al modulo. Questa configurazione è unita in config/services.xml dal pacchetto ece-tools.

    code language-xml 
    <?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
    <services>
        <defaults autowire="true" autoconfigure="true" public="true"/>

        <prototype namespace="Vendor\EceToolExtend\" resource="../src/*" exclude="../src/{Test}"/>

        <!-- Use your own implementation of EnvironmentDataInterface -->
        <service id="Magento\MagentoCloud\Config\EnvironmentDataInterface" alias="Vendor\EceToolExtend\Config\CustomEnvironmentData" />
    </services>
</container>

Per ulteriori informazioni sull'iniezione di dipendenza, vedere Iniezione di dipendenza Symfony.

recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26