Umgebungsvariablen für die Bereitstellung konfigurieren

Die Datei ".magento.env.yaml"verwendet Umgebungsvariablen, um die Verwaltung von Build- und Bereitstellungsaktionen in allen Ihren Umgebungen zu zentralisieren, einschließlich Pro Staging und Produktion. Um eindeutige Aktionen in jeder Umgebung zu konfigurieren, müssen Sie diese Datei in jeder Umgebung ändern.

Dateistruktur

Die Datei .magento.env.yaml enthält zwei Abschnitte: stage und log. Der Abschnitt stage steuert Aktionen, die in den Phasen des Cloud-Bereitstellungsprozesses auftreten.

Umgebungsvariablen

Das Paket ece-tools legt Werte in der Datei env.php basierend auf Werten aus Cloud-Variablen, Variablen, die in der Konfigurationsdatei Cloud Console festgelegt sind, und .magento.env.yaml fest. Die Umgebungsvariablen in der Datei .magento.env.yaml passen die Cloud-Umgebung an, indem Sie Ihre vorhandene Commerce-Konfiguration überschreiben. Wenn der Standardwert Not Set ist, nimmt das ece-tools -Paket die Aktion NO an und verwendet den Standardwert Commerce oder den Wert aus der MAGENTO_CLOUD_RELATIONSHIPS -Konfiguration. Wenn der Standardwert festgelegt ist, wird dieser Standardwert durch das Paket ece-tools festgelegt.

Die folgenden Themen enthalten detaillierte Definitionen aller Variablen, die Sie in der Datei .magento.env.yaml verwenden können, z. B. ob ein Standardwert festgelegt ist oder nicht:

Konfigurationsdatei über CLI erstellen

Sie können eine .magento.env.yaml -Konfigurationsdatei für eine Cloud-Umgebung mit den folgenden ece-tools -Befehlen generieren.

Erstellt eine Konfigurationsdatei

php ./vendor/bin/ece-tools cloud:config:create `<configuration-json>`

Aktualisieren von Werten in der Konfigurationsdatei

php ./vendor/bin/ece-tools cloud:config:update `<configuration-json>`

Beide Befehle erfordern ein einzelnes Argument: ein JSON-formatiertes Array, das einen Wert für mindestens eine Build-, Bereitstellungs- oder Post-deploy-Variable angibt. Der folgende Befehl legt beispielsweise Werte für die Variablen SCD_THREADS und CLEAN_STATIC_FILES fest:

php vendor/bin/ece-tools cloud:config:create '{"stage":{"build":{"SCD_THREADS":5}, "deploy":{"CLEAN_STATIC_FILES":false}}}'

Erstellen Sie eine .magento.env.yaml -Datei mit den folgenden Einstellungen:

stage:
  build:
    SCD_THREADS: 5
  deploy:
    CLEAN_STATIC_FILES: false

Sie können den Befehl cloud:config:update verwenden, um die neue Datei zu aktualisieren. Beispielsweise ändert der folgende Befehl den Wert SCD_THREADS und fügt die Konfiguration SCD_COMPRESSION_TIMEOUT hinzu:

php vendor/bin/ece-tools cloud:config:update '{"stage":{"build":{"SCD_THREADS":3, "SCD_COMPRESSION_TIMEOUT":1000}}}'

Die aktualisierte Datei enthält die folgende Konfiguration:

stage:
  build:
    SCD_THREADS: 3
    SCD_COMPRESSION_TIMEOUT: 1000
  deploy:
    CLEAN_STATIC_FILES: false

Konfigurationsdatei überprüfen

Verwenden Sie den folgenden ece-tools-Befehl, um die Konfigurationsdatei .magento.env.yaml zu validieren, bevor Sie Änderungen an die Remote-Cloud-Umgebung senden.

php ./vendor/bin/ece-tools cloud:config:validate

Die folgende Beispielantwort enthält eine Liste der zu korrigierenden Elemente:

Environment configuration is not valid. Correct the following items in your .magento.env.yaml file:
The SCD_THREADS variable contains an invalid value of type string. Use the following type: integer.
The SCD_STRATEGY variable contains an invalid value fast. Use one of the available value options: compact, quick, standard.
The NOT_EXIST_OPTION variable is not allowed in configuration.

PHP-Konstanten

Sie können PHP-Konstanten in .magento.env.yaml -Dateidefinitionen anstelle von Hartkodierungswerten verwenden. Im folgenden Beispiel wird der driver_options mithilfe einer PHP-Konstante definiert:

stage:
  deploy:
    DATABASE_CONFIGURATION:
      connection:
        default:
          driver_options:
            !php/const:\PDO::MYSQL_ATTR_LOCAL_INFILE : 1
        indexer:
          driver_options:
            !php/const:\PDO::MYSQL_ATTR_LOCAL_INFILE : 1
      _merge: true

Umgang mit Fehlern

Wenn ein Fehler aufgrund eines unerwarteten Werts in der Konfigurationsdatei .magento.env.yaml auftritt, erhalten Sie eine Fehlermeldung. Beispielsweise enthält die folgende Fehlermeldung eine Liste der vorgeschlagenen Änderungen an jedem Element mit einem unerwarteten Wert und manchmal gültige Optionen:

- Environment configuration is not valid. Please correct .magento.env.yaml file with next suggestions:
  Item CRON_CONSUMERS_RUNNER is not supposed to be in stage build. Please move it to one of possible stages: global, deploy
  Item SKIP_SCD has unexpected type string. Please use one of next types: boolean
  Item VERBOSE_COMMANDS has unexpected type boolean. Please use one of next types: string
  Item SKIP_HTML_MINIFICATION has unexpected type string. Please use one of next types: boolean
  Item CRON_CONSUMERS_RUNNER has unexpected type boolean. Please use one of next types: array
  Item VAR_WARM_UP_PAGES is not allowed in configuration.
  Item WARM_UP_PAGES has unexpected type string. Please use one of next types: array

Nehmen Sie alle Korrekturen vor, übertragen Sie die Änderungen und übertragen Sie sie. Wenn Sie keine Fehlermeldung erhalten, werden die Änderungen an Ihrer Konfigurationsdatei erfolgreich validiert.

Optimierung der Konfigurationsverwaltung

Wenn Sie Configuration Management nach dem Ablegen der Konfigurationen aktiviert haben, sollten Sie die SCD_*-Variablen aus der Bereitstellung in die Build-Phase verschieben. Siehe Bereitstellungsstrategien für statische Inhalte.

Vor der Konfigurationsverwaltung:

  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      consumers: []
    SCD_STRATEGY: compact
    SCD_MATRIX:
      ...
    REDIS_USE_SLAVE_CONNECTION: 1

Nachdem Sie Configuration Management aktiviert haben, verschieben Sie die SCD_*-Variablen in die Build-Phase:

  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      consumers: []
    REDIS_USE_SLAVE_CONNECTION: 1
  build:
    SCD_STRATEGY: compact
    SCD_MATRIX:
      ...