Merge pull request #175 from magento-commerce/MCLOUD-13455

MCLOUD-13455 Make valkey compatible with ece-tools

Author: prateek-karanpuria-adobe

config/eol.yaml

@@ -78,3 +78,6 @@ redis:
     eol: 2023-08-15
   - version: '7.2'
     eol: 2025-08-31
+valkey:
+  - version: '8.0'
+    eol: 2029-04-16

config/schema.error.yaml

@@ -179,6 +179,12 @@
     step: 'pre-deploy: clean-redis-cache'
     stage: deploy
     type: critical
+!php/const Magento\MagentoCloud\App\Error::DEPLOY_VALKEY_CACHE_CLEAN_FAILED:
+    title: 'Failed to clean the Valkey cache'
+    suggestion: 'Failed to clean the Valkey cache. Check that the Valkey cache configuration is correct and that the Valkey service is available. See [Setup Valkey service](https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/configure/service/valkey.html).'
+    step: 'pre-deploy: clean-valkey-cache'
+    stage: deploy
+    type: critical
 !php/const Magento\MagentoCloud\App\Error::DEPLOY_MAINTENANCE_MODE_ENABLING_FAILED:
     step: 'pre-deploy: set-production-mode'
     title: 'Command `/bin/magento maintenance:enable` failed'
@@ -491,6 +497,11 @@
     stage: deploy
     step: 'pre-deploy:cache'
     type: warning
+!php/const Magento\MagentoCloud\App\Error::WARN_VALKEY_SERVICE_NOT_AVAILABLE:
+    title: 'Cache is configured for a Valkey service that is not available. Configuration will be ignored.'
+    stage: deploy
+    step: 'pre-deploy:cache'
+    type: warning
 !php/const Magento\MagentoCloud\App\Error::WARN_WRONG_SPLIT_DB_CONFIG:
     title: 'The configured state is not ideal'
     stage: deploy

config/schema.yaml

@@ -270,6 +270,20 @@ variables:
       - stage:
           deploy:
             REDIS_USE_SLAVE_CONNECTION: true
+  VALKEY_USE_SLAVE_CONNECTION:
+    description: Set to true to automatically use a read-only connection to a Valkey instance to receive read-only
+      traffic on a non-master node. This improves performance through load balancing because only one node needs to
+      handle read-write traffic.
+    type: boolean
+    stages:
+      - global
+      - deploy
+    default:
+      deploy: false
+    examples:
+      - stage:
+          deploy:
+            VALKEY_USE_SLAVE_CONNECTION: true
   MYSQL_USE_SLAVE_CONNECTION:
     description: Set to true to automatically use a read-only connection to the database to receive read-only traffic on
       a non-master node. This improves performance through load balancing, because only one node needs to
@@ -446,6 +460,21 @@ variables:
       - stage:
           deploy:
             REDIS_BACKEND: '\Magento\Framework\Cache\Backend\Redis'
+  VALKEY_BACKEND:
+    description: "Configuration the backend model for valkey cache."
+    type: string
+    allowed:
+      - 'Cm_Cache_Backend_Redis'
+      - '\Magento\Framework\Cache\Backend\Valkey'
+      - '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'
+    stages:
+      - deploy
+    default:
+      deploy: 'Cm_Cache_Backend_Redis'
+    examples:
+      - stage:
+          deploy:
+            VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\Valkey'
   CACHE_CONFIGURATION:
     description: "Replace or modify the Magento cache configuration generated during the deployment process.
       To replace the existing configuration, specify values for each configuration option required for your environment.

scenario/deploy.xml

@@ -15,6 +15,7 @@
                 <item name="clean-file-cache" xsi:type="object" priority="500">Magento\MagentoCloud\Step\Deploy\PreDeploy\CleanFileCache</item>
                 <item name="restore-writable-dirs" xsi:type="object" priority="600">Magento\MagentoCloud\Step\Deploy\PreDeploy\RestoreWritableDirectories</item>
                 <item name="set-production-mode" xsi:type="object" priority="700">Magento\MagentoCloud\Step\SetProductionMode</item>
+                <item name="clean-valkey-cache" xsi:type="object" priority="800">Magento\MagentoCloud\Step\Deploy\PreDeploy\CleanValkeyCache</item>
             </argument>
         </arguments>
     </step>

src/App/Error.php

@@ -79,6 +79,7 @@ class Error
     public const DEPLOY_OS_CANNOT_CONNECT = 137;
     public const DEPLOY_OS_SERVICE_NOT_INSTALLED = 138;
     public const DEPLOY_MAGENTO_VERSION_DOES_NOT_SUPPORT_OS = 139;
+    public const DEPLOY_VALKEY_CACHE_CLEAN_FAILED = 140;
 
     public const PD_DEPLOY_IS_FAILED = 201;
     public const PD_ENV_PHP_IS_NOT_WRITABLE = 202;
@@ -145,6 +146,7 @@ class Error
     public const WARN_DEPRECATED_SPLIT_DB = 2029;
     public const WARN_OS_ES_SERVICES_BOTH_INSTALLED = 2030;
     public const WARN_REMOTE_STORAGE_CANNOT_BE_DISABLED = 2031;
+    public const WARN_VALKEY_SERVICE_NOT_AVAILABLE = 2032;
 
     /**
      * Post-deploy

src/Command/Wizard/MasterSlave.php

@@ -69,6 +69,9 @@ public function execute(InputInterface $input, OutputInterface $output): int
             $errors[] = 'Redis slave connection is not configured';
         }
 
+        if (!$this->deployConfig->get(DeployInterface::VAR_VALKEY_USE_SLAVE_CONNECTION)) {
+            $errors[] = 'Valkey slave connection is not configured';
+        }
         foreach ($errors as $error) {
             $this->outputFormatter->writeItem($output, $error);
         }