Variablen bereitstellen

Die folgenden deploy-Variablen steuern Aktionen in der Bereitstellungsphase und können Werte von den (globalen )und überschreiben. Fügen Sie diese Variablen in den deploy Schritt der .magento.env.yaml ein:

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

Weitere Informationen zum Anpassen des Build- und Bereitstellungsprozesses finden Sie unter:

CACHE_CONFIGURATION

Konfigurieren Sie die Redis-Seite und das Standard-Caching. Beim Festlegen des cm_cache_backend_redis müssen Sie die Optionen server, port und database angeben.

stage:
  deploy:
    CACHE_CONFIGURATION:
      frontend:
        default:
          backend: file
        page_cache:
          backend: file

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php-Datei. Sie können jedoch festlegen, dass ein oder mehrere Werte für eine Service-Konfiguration zusammengeführt werden, ohne dass alle Werte überschrieben werden.

Legen Sie die Option _merge auf einen der folgenden Werte fest:

Im folgenden Beispiel werden neue Werte mit einer vorhandenen Konfiguration zusammengeführt:

stage:
  deploy:
    CACHE_CONFIGURATION:
      _merge: true
      frontend:
        default:
          backend_options:
            database: 10
        page_cache:
          backend_options:
            database: 11

Im folgenden Beispiel wird die Redis-Vorabladefunktion verwendet, wie im Konfigurationshandbuch definiert:

stage:
  deploy:
    CACHE_CONFIGURATION:
      _merge: true
      frontend:
        default:
          id_prefix: '061_'
          backend_options:
            preload_keys:
              - '061_EAV_ENTITY_TYPES:hash'
              - '061_GLOBAL_PLUGIN_LIST:hash'
              - '061_DB_IS_UP_TO_DATE:hash'
              - '061_SYSTEM_DEFAULT:hash'

Um ein benutzerdefiniertes REDIS_BACKEND-Modell (nicht nur aus der Zulassungsliste) zu verwenden, setzen Sie die _custom_redis_backend-Option auf true, um die richtige Validierung zu aktivieren, wie im folgenden Beispiel gezeigt:

stage:
  deploy:
    CACHE_CONFIGURATION:
      frontend:
        default:
          _custom_redis_backend: true
          backend: '\CustomRedisModel'

CLEAN_STATIC_FILES

Aktiviert oder deaktiviert Bereinigung von (statischen), die während der Build- oder Bereitstellungsphase generiert wurde. Verwenden Sie den Standardwert true in der Entwicklungsumgebung als Best Practice.

Wenn Sie statische Inhalte über einen separaten Prozess ändern, setzen Sie den Wert auf false.

stage:
  deploy:
    CLEAN_STATIC_FILES: false

Wenn statische Ansichtsdateien vor der Bereitstellung nicht bereinigt werden, können Probleme auftreten, wenn Sie Aktualisierungen für vorhandene Dateien bereitstellen, ohne die vorherigen Versionen zu entfernen. Aufgrund von statischen Datei-Fallback-Regeln können Fallback-Vorgänge die falsche Datei anzeigen, wenn das Verzeichnis mehrere Versionen derselben Datei enthält.

CRON_CONSUMERS_RUNNER

Verwenden Sie diese Umgebungsvariable, um zu bestätigen, dass Nachrichtenwarteschlangen nach einer Bereitstellung ausgeführt werden.

Beispiel-Array, das bestimmte consumers ausführt und die für jeden Verbraucher zu erstellenden multiple_processes enthält:

stage:
  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      max_messages: 1000
      consumers:
        - example_consumer_1
        - example_consumer_2
-     multiple_processes:
        example_consumer_1: 4
        example_consumer_2: 3

Beispiel eines leeren Arrays, das alle consumers ausführt:

stage:
  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      max_messages: 1000
      consumers: []

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php. Siehe Verwalten von Nachrichtenwarteschlangen im Commerce-Konfigurationshandbuch für lokale Adobe Commerce.

CONSUMERS_WAIT_FOR_MAX_MESSAGES

Konfigurieren Sie consumers Verarbeitung von Nachrichten aus der Nachrichtenwarteschlange, indem Sie eine der folgenden Optionen auswählen:

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

Wenn Sie die Datenbank ohne Installationsvorgang von einer Umgebung in eine andere verschieben, benötigen Sie die entsprechenden kryptografischen Informationen. Adobe Commerce verwendet den im Cloud Console festgelegten Verschlüsselungsschlüsselwert als crypt/key Wert in der env.php.

DATABASE_CONFIGURATION

Wenn Sie eine Datenbank in der Relations-Eigenschaft der .magento.app.yaml-Datei definiert haben, können Sie Ihre Datenbankverbindungen für die Bereitstellung anpassen.

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_value'

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php-Datei. Sie können jedoch festlegen, dass ein oder mehrere Werte für eine Service-Konfiguration zusammengeführt werden, ohne dass alle Werte überschrieben werden.

Legen Sie die Option _merge auf einen der folgenden Werte fest:

Im folgenden Beispiel werden neue Werte mit einer vorhandenen Konfiguration zusammengeführt:

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_new_value'
      _merge: true

Außerdem können Sie ein Tabellenpräfix konfigurieren.

Im folgenden Beispiel wird das ece_-Tabellenpräfix mit standardmäßigen Verbindungseinstellungen anstelle der Option _merge verwendet:

stage:
  deploy:
    DATABASE_CONFIGURATION:
      connection:
        default:
          username: user
          host: host
          dbname: magento
          password: password
      table_prefix: 'ece_'

Beispielausgabe:

MariaDB [main]> SHOW TABLES;
+-------------------------------------+
| Tables_in_main                      |
+-------------------------------------+
| ece_admin_passwords                 |
| ece_admin_system_messages           |
| ece_admin_user                      |
| ece_admin_user_session              |
| ece_adminnotification_inbox         |
| ece_amazon_customer                 |
| ece_authorization_rule              |
| ece_cache                           |
| ece_cache_tag                       |
| ece_captcha_log                     |
...

ELASTICSUITE_CONFIGURATION

Behält benutzerdefinierte Elastic Suite zwischen Bereitstellungen bei und verwendet sie im Abschnitt „system/default/smile_elasticsuite_core_base_settings“ der Elastic Suite. Wenn das Elastic Suite Composer-Paket installiert ist, wird es automatisch konfiguriert.

stage:
  deploy:
    ELASTICSUITE_CONFIGURATION:
      es_client:
        servers: 'remote-host:9200'
      indices_settings:
        number_of_shards: 1
        number_of_replicas: 0

           indices_settings:
               number_of_shards: 3
               number_of_replicas: 2

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php-Datei. Sie können jedoch festlegen, dass ein oder mehrere Werte für eine Service-Konfiguration zusammengeführt werden, ohne dass alle Werte überschrieben werden.

Legen Sie die Option _merge auf einen der folgenden Werte fest:

Im folgenden Beispiel wird ein neuer Wert mit der vorhandenen Konfiguration zusammengeführt:

stage:
  deploy:
    ELASTICSUITE_CONFIGURATION:
      indices_settings:
        number_of_shards: 3
        number_of_replicas: 2
      _merge: true

Bekannte:

ENABLE_GOOGLE_ANALYTICS

Aktiviert und deaktiviert Google Analytics beim Bereitstellen in Staging- und Integrationsumgebungen. Standardmäßig ist "Google Analytics" nur für die Produktionsumgebung aktiviert. Legen Sie diesen Wert auf true fest, um Google Analytics in den Staging- und Integrationsumgebungen zu aktivieren.

Fügen Sie die Umgebungsvariable ENABLE_GOOGLE_ANALYTICS zum deploy in der .magento.env.yaml hinzu:

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Bei der Bereitstellung in Pro- oder Starter-Staging- und Produktionsumgebungen ersetzt diese Variable die Adobe Commerce-Basis-URLs in der Datenbank durch die Projekt-URLs, die durch die MAGENTO_CLOUD_ROUTES Variable angegeben werden. Verwenden Sie diese Einstellung, um das Standardverhalten der Bereitstellungsvariablen UPDATE_URLS zu überschreiben, das bei der Bereitstellung in Staging- oder Produktionsumgebungen ignoriert wird.

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

Der Sperranbieter verhindert den Start doppelter Cron-Aufträge und Cron-Gruppen. Verwenden Sie den file-Anbieter in der Produktionsumgebung. Starterumgebungen und die Pro-Integrationsumgebung verwenden nicht die Variable MAGENTO_CLOUD_LOCKS_DIR. ece-tools wendet daher automatisch den db an.

stage:
  deploy:
    LOCK_PROVIDER: "db"

Siehe Konfigurieren der Sperre im Installationshandbuch.

MYSQL_USE_SLAVE_CONNECTION

Adobe Commerce kann mehrere Datenbanken asynchron lesen. Wenn auf true gesetzt, wird automatisch eine schreibgeschützte) zur Datenbank verwendet, um schreibgeschützten Traffic auf einem Nicht-Master-Knoten zu empfangen. Diese Verbindung verbessert die Leistung durch Lastenausgleich, da nur ein Knoten Lese-/Schreib-Traffic verarbeitet. Mit der Einstellung auf false entfernen Sie ein vorhandenes schreibgeschütztes Verbindungs-Array aus der env.php.

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

Wenn die Variable MYSQL_USE_SLAVE_CONNECTION auf true festgelegt ist, wird der Parameter synchronous_replication in der env.php in der Pro-Staging- und Produktionsumgebung standardmäßig auf true festgelegt. Wenn der MYSQL_USE_SLAVE_CONNECTION auf false gesetzt ist, ist der synchronous_replication nicht konfiguriert.

QUEUE_CONFIGURATION

Verwenden Sie diese Umgebungsvariable, um benutzerdefinierte AMQP-Diensteinstellungen zwischen Bereitstellungen beizubehalten. Wenn Sie beispielsweise lieber einen vorhandenen Message Queue-Service verwenden, anstatt ihn für Sie über die Cloud-Infrastruktur zu erstellen, verwenden Sie die Umgebungsvariable QUEUE_CONFIGURATION , um ihn mit Ihrer Site zu verbinden:

stage:
  deploy:
    QUEUE_CONFIGURATION:
      amqp:
        host: test.host
        port: 1234
      amqp2:
        host: test.host2
        port: 12345
      mq:
        host: mq.host
        port: 1234

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php-Datei. Sie können jedoch festlegen, dass ein oder mehrere Werte für eine Service-Konfiguration zusammengeführt werden, ohne dass alle Werte überschrieben werden.

Legen Sie die Option _merge auf einen der folgenden Werte fest:

Im folgenden Beispiel werden neue Werte mit einer vorhandenen Konfiguration zusammengeführt:

stage:
  deploy:
    QUEUE_CONFIGURATION:
      _merge: true
      amqp:
        host: changed1.host
        port: 5672
      amqp2:
        host: changed2.host2
        port: 12345
      mq:
        host: changedmq.host
        port: 1234

REDIS_BACKEND

Gibt die Backend-Modellkonfiguration für den Redis-Cache an.

Adobe Commerce Version 2.3.0 und höher enthält die folgenden Backend-Modelle:

Das Beispiel zum Festlegen von REDIS_BACKEND

stage:
  deploy:
    REDIS_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'

REDIS_USE_SLAVE_CONNECTION

Adobe Commerce kann mehrere Redis-Instanzen asynchron lesen. Wenn auf true gesetzt, wird automatisch eine schreibgeschützte Verbindung zu einer Redis-Instanz verwendet, um schreibgeschützten Traffic auf einem Nicht-Master-Knoten zu empfangen. Diese Verbindung verbessert die Leistung durch Lastenausgleich, da nur ein Knoten Lese-/Schreib-Traffic verarbeitet. Mit der Einstellung auf false entfernen Sie ein vorhandenes schreibgeschütztes Verbindungs-Array aus der env.php.

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

In der .magento.app.yaml-Datei und in der services.yaml-Datei muss ein Redis-Dienst konfiguriert sein.

ECE-Tools Version 2002.0.18 und höher verwendet fehlertolerantere Einstellungen. Wenn Adobe Commerce keine Daten aus der Redis-Instanz Slave lesen kann, liest es Daten aus der Redis-Instanz Master.

Die schreibgeschützte Verbindung ist nicht für die Verwendung in der Integrationsumgebung verfügbar oder wenn Sie die Variable CACHE_CONFIGURATION verwenden.

RESOURCE_CONFIGURATION

Ordnet einer Datenbankverbindung einen Ressourcennamen zu. Diese Konfiguration entspricht dem resource Abschnitt der env.php.

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php-Datei. Sie können jedoch festlegen, dass ein oder mehrere Werte für eine Service-Konfiguration zusammengeführt werden, ohne dass alle Werte überschrieben werden.

Legen Sie die Option _merge auf einen der folgenden Werte fest:

Im folgenden Beispiel werden neue Werte mit einer vorhandenen Konfiguration zusammengeführt:

stage:
  deploy:
    RESOURCE_CONFIGURATION:
      _merge: true
      default_setup:
        connection: default

SCD_COMPRESSION_LEVEL

Gibt an welche GZIP-Komprimierungsstufe (0 zu 9) beim Komprimieren statischer Inhalte verwendet werden soll; 0 deaktiviert die Komprimierung.

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

Wenn die Zeit, die zum Komprimieren der statischen Assets benötigt wird, das Komprimierungs-Timeout überschreitet, wird der Bereitstellungsprozess unterbrochen. Legen Sie die maximale Ausführungszeit in Sekunden für den Befehl zur Komprimierung statischer Inhalte fest.

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

Sie können mehrere Gebietsschemata pro Design konfigurieren. Diese Anpassung beschleunigt den Bereitstellungsprozess, indem die Anzahl der unnötigen Design-Dateien reduziert wird. Sie können beispielsweise das Design magento/backend auf Englisch und ein benutzerdefiniertes Design in anderen Sprachen bereitstellen.

Im folgenden Beispiel wird das Magento/backend-Design mit drei Gebietsschemata bereitgestellt:

stage:
  deploy:
    SCD_MATRIX:
      "magento/backend":
        language:
          - en_US
          - fr_FR
          - af_ZA

Sie können auch wählen, ein Design bereitzustellen nicht):

stage:
  deploy:
    SCD_MATRIX:
      "magento/backend": [ ]

SCD_MAX_EXECUTION_TIME

Ermöglicht die Verlängerung der maximal erwarteten Ausführungszeit für die Bereitstellung statischer Inhalte.

Standardmäßig legt Adobe Commerce die maximal erwartete Ausführung auf 900 Sekunden fest. In einigen Szenarien benötigen Sie jedoch möglicherweise mehr Zeit, um die statische Inhaltsbereitstellung für ein Cloud-Projekt abzuschließen.

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

Stellen Sie in der Bereitstellungsphase SCD_NO_PARENT: true so ein, dass während der Bereitstellungsphase keine statischen Inhalte für die übergeordneten Designs generiert werden. Diese Einstellung minimiert die Bereitstellungszeit und verhindert Website-Ausfallzeiten, die auftreten können, wenn der statische Inhaltserstellungsvorgang während der Bereitstellung fehlschlägt. Siehe Statische Inhaltsbereitstellung.

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

Ermöglicht die Anpassung der -Bereitstellungsstrategiestatische Inhalte. Siehe Bereitstellen von statischen Ansichtsdateien.

Verwenden Sie diese Optionen nur wenn Sie mehr als ein Gebietsschema haben:

stage:
  deploy:
    SCD_STRATEGY: "compact"

SCD_THREADS

Legt die Anzahl der Threads für die Bereitstellung statischer Inhalte fest. Der Standardwert wird anhand der erkannten CPU-Thread-Anzahl festgelegt und überschreitet den Wert 4 nicht. Eine Erhöhung der Thread-Anzahl beschleunigt die Bereitstellung statischer Inhalte; eine Verringerung der Thread-Anzahl verlangsamt die Bereitstellung. Sie können den Thread-Wert festlegen, z. B.:

stage:
  deploy:
    SCD_THREADS: 2

Um die Bereitstellungszeit weiter zu verkürzen, verwenden Konfigurationsverwaltung mit dem Befehl scd-dump , um die statische Bereitstellung in die Build-Phase zu verschieben.

SEARCH_CONFIGURATION

Verwenden Sie diese Umgebungsvariable, um benutzerdefinierte Suchdiensteinstellungen zwischen Bereitstellungen beizubehalten. Beispiel:

Elasticsearch-Konfiguration:

stage:
  deploy:
    SEARCH_CONFIGURATION:
      engine: elasticsearch
      elasticsearch_server_hostname: http://elasticsearch.internal
      elasticsearch_server_port: '9200'
      elasticsearch_index_prefix: magento2
      elasticsearch_server_timeout: '15'

OpenSearch-Konfiguration (für Commerce 2.4.6 und höher):

stage:
  deploy:
    SEARCH_CONFIGURATION:
      engine: opensearch
      opensearch_server_hostname: 'http://opensearch.internal'
      opensearch_server_port: '9200'
      opensearch_index_prefix: 'magento2'
      opensearch_server_timeout: '15'

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php-Datei. Sie können jedoch festlegen, dass ein oder mehrere Werte für eine Service-Konfiguration zusammengeführt werden, ohne dass alle Werte überschrieben werden.

Legen Sie die Option _merge auf einen der folgenden Werte fest:

Im folgenden Beispiel wird ein neuer Wert mit der vorhandenen Konfiguration zusammengeführt:

stage:
  deploy:
    SEARCH_CONFIGURATION:
      engine: elasticsearch
      elasticsearch_server_port: '9200'
      _merge: true

SESSION_CONFIGURATION

Konfigurieren Sie den Redis-Sitzungsspeicher. Erfordert die Optionen save, redis, host, port und database für die Sitzungsspeichervariable. Beispiel:

stage:
  deploy:
    SESSION_CONFIGURATION:
      redis:
        bot_first_lifetime: 100
        bot_lifetime: 10001
        database: 0
        disable_locking: 1
        host: redis.internal
        max_concurrency: 10
        max_lifetime: 10001
        min_lifetime: 100
        port: 6379
      save: redis

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der env.php-Datei. Sie können jedoch festlegen, dass ein oder mehrere Werte für eine Service-Konfiguration zusammengeführt werden, ohne dass alle Werte überschrieben werden.

Legen Sie die Option _merge auf einen der folgenden Werte fest:

Im folgenden Beispiel wird ein neuer Wert mit der vorhandenen Konfiguration zusammengeführt:

stage:
  deploy:
    SESSION_CONFIGURATION:
      _merge: true
      redis:
        max_concurrency: 10

SKIP_SCD

Wenn auf true gesetzt, wird die Bereitstellung statischer Inhalte während der Bereitstellungsphase übersprungen.

Stellen Sie in der Bereitstellungsphase SKIP_SCD: true so ein, dass der statische Inhaltserstellungsvorgang während der Bereitstellungsphase nicht ausgeführt wird. Diese Einstellung minimiert die Bereitstellungszeit und verhindert Website-Ausfallzeiten, die auftreten können, wenn der statische Inhaltserstellungsvorgang während der Bereitstellung fehlschlägt. Siehe Statische Inhaltsbereitstellung.

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

Ersetzen Sie bei der Bereitstellung die Adobe Commerce-Basis-URLs in der Datenbank durch die von der MAGENTO_CLOUD_ROUTES angegebenen Projekt-URLs. Diese Konfiguration ist für die lokale Entwicklung nützlich, bei der Basis-URLs für Ihre lokale Umgebung eingerichtet werden. Bei der Bereitstellung in einer Cloud-Umgebung werden die URLs aktualisiert, damit Sie über die Projekt-URLs auf Ihre Storefront und Ihren Admin zugreifen können.

Wenn Sie URLs bei der Bereitstellung in Pro- oder Starter-Staging- und Produktionsumgebungen aktualisieren müssen, verwenden Sie die Variable FORCE_UPDATE_URLS .

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

Aktivieren oder deaktivieren Sie die Symfony Debug-Ausführlichkeitsstufe für bin/magento CLI-Befehle, die während der Bereitstellungsphase ausgeführt werden.

Wählen Sie den Detaillierungsgrad der Protokolle aus:

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"