Bereitstellen von Variablen

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

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

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

CACHE_CONFIGURATION

Konfigurieren Sie die Seite "Redis"und die standardmäßige Zwischenspeicherung. Beim Festlegen des Parameters 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 Datei env.php. Sie können jedoch einen oder mehrere Werte für eine Dienstkonfiguration zusammenführen, ohne alle Werte zu überschreiben.

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

Im folgenden Beispiel werden neue Werte zu 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 Funktion Redis preload Feature 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 korrekte Validierung zu aktivieren, wie im folgenden Beispiel gezeigt:

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

CLEAN_STATIC_FILES

Aktiviert bzw. deaktiviert das Löschen von statischen Inhaltsdateien, die während der Build- oder Bereitstellungsphase generiert wurden. Verwenden Sie den Standardwert true in der Entwicklung als Best Practice.

Wenn Sie statischen Inhalt in einem separaten Prozess ändern, setzen Sie den Wert auf false.

stage:
  deploy:
    CLEAN_STATIC_FILES: false

Wenn statische Ansichtsdateien vor der Bereitstellung nicht bereinigt werden, kann dies zu Problemen führen, wenn Sie Aktualisierungen für vorhandene Dateien bereitstellen, ohne die vorherigen Versionen zu entfernen. Aufgrund von statischen Dateiausweichregeln 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 sicherzustellen, dass Nachrichtenwarteschlangen nach einer Bereitstellung ausgeführt werden.

Beispiel-Array, das bestimmte consumers und die multiple_processes ausführt, die für jeden Verbraucher erzeugt werden sollen:

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 für ein leeres Array, das alle consumers -Werte ausführt:

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

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

CONSUMERS_WAIT_FOR_MAX_MESSAGES

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

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

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

DATABASE_CONFIGURATION

Wenn Sie eine Datenbank in der Eigenschaft "Relations" 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 Datei env.php. Sie können jedoch einen oder mehrere Werte für eine Dienstkonfiguration zusammenführen, ohne alle Werte zu überschreiben.

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

Im folgenden Beispiel werden neue Werte zu 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 Tabellenpräfix ece_ mit den Standardverbindungseinstellungen verwendet, anstatt die Option _merge zu verwenden:

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 angepasste Elastic Suite Diensteinstellungen zwischen Bereitstellungen bei und verwendet sie im Abschnitt "system/default/smile_elasticsuite_core_base_settings"der Hauptkonfiguration Elastic Suite. Wenn das Paket Elastic Suite Composer 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 Datei env.php. Sie können jedoch einen oder mehrere Werte für eine Dienstkonfiguration zusammenführen, ohne alle Werte zu überschreiben.

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 Einschränkungen:

ENABLE_GOOGLE_ANALYTICS

Aktiviert und deaktiviert Google Analytics bei der Bereitstellung in Staging- und Integrationsumgebungen. Standardmäßig gilt Google Analytics nur für die Produktionsumgebung. Setzen Sie diesen Wert auf true , um Google Analytics in den Staging- und Integrationsumgebungen zu aktivieren.

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

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Bei der Bereitstellung in der Pro- oder Starter-Staging- und Produktionsumgebung ersetzt diese Variable die Basis-URLs der Adobe Commerce-Datenbank durch die in der Variable MAGENTO_CLOUD_ROUTES angegebenen Projekt-URLs. Verwenden Sie diese Einstellung, um das Standardverhalten der Bereitstellungsvariable UPDATE_URLS zu überschreiben, die 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 Sperranbieter file in der Produktionsumgebung. Starterumgebungen und die Pro-Integrationsumgebung verwenden nicht die Variable MAGENTO_CLOUD_LOCKS_DIR . Daher wendet ece-tools den Sperranbieter db automatisch an.

stage:
  deploy:
    LOCK_PROVIDER: "db"

Siehe Konfigurieren der Sperre im Installationshandbuch.

MYSQL_USE_SLAVE_CONNECTION

Adobe Commerce kann mehrere Datenbanken asynchron lesen. Auf true setzen, um automatisch eine schreibgeschützte Verbindung zur Datenbank zu verwenden, um schreibgeschützten Traffic auf einem Nicht-Master-Knoten zu empfangen. Diese Verbindung verbessert die Leistung durch Lastenausgleich, da nur ein Knoten Lese- und Schreibvorgänge-Traffic verarbeitet. Auf false setzen, um ein vorhandenes schreibgeschütztes Verbindungs-Array aus der env.php-Datei zu entfernen.

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

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

QUEUE_CONFIGURATION

Verwenden Sie diese Umgebungsvariable, um zwischen Bereitstellungen benutzerdefinierte AMQP-Diensteinstellungen beizubehalten. Wenn Sie beispielsweise einen vorhandenen Nachrichtenwarteschlangendienst verwenden möchten, anstatt ihn von der 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 Datei env.php. Sie können jedoch einen oder mehrere Werte für eine Dienstkonfiguration zusammenführen, ohne alle Werte zu überschreiben.

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

Im folgenden Beispiel werden neue Werte zu 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 umfasst 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. Auf true setzen, um automatisch eine schreibgeschützte Verbindung zu einer Redis-Instanz zu verwenden, um schreibgeschützten Traffic auf einem Nicht-Master-Knoten zu empfangen. Diese Verbindung verbessert die Leistung durch Lastenausgleich, da nur ein Knoten Lese- und Schreibvorgänge-Traffic verarbeitet. Auf false setzen, um ein vorhandenes schreibgeschütztes Verbindungs-Array aus der env.php-Datei zu entfernen.

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

Sie müssen einen Redis-Dienst in der Datei .magento.app.yaml und in der Datei services.yaml konfiguriert haben.

ECE-Tools Version 2002.0.18 und höher verwendet fehlertolerantere Einstellungen. Wenn Adobe Commerce keine Daten aus der Redis slave -Instanz lesen kann, werden Daten aus der Redis master -Instanz gelesen.

Die schreibgeschützte Verbindung kann nicht in der Integrationsumgebung verwendet werden oder wenn Sie die Variable CACHE_CONFIGURATIONverwenden.

RESOURCE_CONFIGURATION

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

Standardmäßig überschreibt der Bereitstellungsprozess alle Einstellungen in der Datei env.php. Sie können jedoch einen oder mehrere Werte für eine Dienstkonfiguration zusammenführen, ohne alle Werte zu überschreiben.

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

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

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

SCD_COMPRESSION_LEVEL

Gibt an, welche gzip-Komprimierungsstufe (0 bis 9) beim Komprimieren statischen Inhalts verwendet werden soll. 0 deaktiviert die Komprimierung.

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

Wenn die zum Komprimieren der statischen Assets benötigte Zeit das Zeitlimit für die Komprimierung überschreitet, wird der Bereitstellungsprozess unterbrochen. Legen Sie die maximale Ausführungszeit in Sekunden für den Befehl zur statischen Inhaltskomprimierung fest.

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

Sie können mehrere Gebietsschemata pro Design konfigurieren. Diese Anpassung beschleunigt den Implementierungsprozess, indem die Anzahl unnötiger Designdateien verringert 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 Gebietsschemas bereitgestellt:

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

Außerdem können Sie festlegen, dass nicht ein Design bereitstellt:

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

SCD_MAX_EXECUTION_TIME

Ermöglicht Ihnen, die maximale erwartete Ausführungszeit für die Bereitstellung statischer Inhalte zu erhöhen.

Standardmäßig wird von Adobe Commerce die maximal erwartete Ausführung auf 900 Sekunden festgelegt. In einigen Szenarien benötigen Sie jedoch möglicherweise mehr Zeit, um die Bereitstellung statischer Inhalte für ein Cloud-Projekt abzuschließen.

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

Legen Sie in der Bereitstellungsphase den Wert "SCD_NO_PARENT: true"fest, damit statische Inhalte für übergeordnete Designs nicht während der Bereitstellungsphase generiert werden. Diese Einstellung minimiert die Bereitstellungszeit und verhindert Site-Ausfallzeiten, die auftreten können, wenn der statische Inhaltserstellung während der Bereitstellung fehlschlägt. Siehe Bereitstellung statischer Inhalte.

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

Ermöglicht die Anpassung der Implementierungsstrategie für statischen Inhalt. 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 basierend auf der erkannten CPU-Thread-Anzahl festgelegt und überschreitet nicht den Wert 4. Durch die Erhöhung der Thread-Anzahl wird die Bereitstellung statischer Inhalte beschleunigt, und die Verringerung der Thread-Anzahl verlangsamt die Bereitstellung. Sie können den Thread-Wert festlegen, beispielsweise:

stage:
  deploy:
    SCD_THREADS: 2

Um die Bereitstellungszeit weiter zu verkürzen, verwenden Sie 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 -Implementierungen 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 Datei env.php. Sie können jedoch einen oder mehrere Werte für eine Dienstkonfiguration zusammenführen, ohne alle Werte zu überschreiben.

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 des Sitzungsspeichers für Redis. 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 Datei env.php. Sie können jedoch einen oder mehrere Werte für eine Dienstkonfiguration zusammenführen, ohne alle Werte zu überschreiben.

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

Setzen Sie dies auf "true", um die Bereitstellung statischer Inhalte während der Bereitstellungsphase zu überspringen.

Legen Sie in der Bereitstellungsphase SKIP_SCD: true fest, damit der statische Inhaltserstellung nicht während der Bereitstellungsphase erfolgt. Diese Einstellung minimiert die Bereitstellungszeit und verhindert Site-Ausfallzeiten, die auftreten können, wenn der statische Inhaltserstellung während der Bereitstellung fehlschlägt. Siehe Bereitstellung statischer Inhalte.

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

Ersetzen Sie bei der Bereitstellung die Adobe Commerce-Basis-URLs in der Datenbank durch die Projekt-URLs, die durch die Variable MAGENTO_CLOUD_ROUTES angegeben wurden. Diese Konfiguration ist für die lokale Entwicklung nützlich, bei der Basis-URLs für Ihre lokale Umgebung eingerichtet werden. Wenn Sie eine Bereitstellung in einer Cloud-Umgebung durchführen, werden die URLs aktualisiert, damit Sie über die Projekt-URLs auf Ihre Storefront und Ihren Administrator 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 Debugging-Ausführlichkeitsstufe für bin/magento CLI-Befehle, die während der Bereitstellungsphase ausgeführt werden.🔗

Wählen Sie den Detailgrad aus, der in den Protokollen angegeben wird:

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"