Configure remote storage for Commerce on Cloud infrastructure

Last update: May 16, 2023

CREATED FOR:

  • Experienced
  • Admin
  • Developer

Beginning with the ece-tools package 2002.1.5, you can use an environment variable to enable the Remote Storage module; however, the Remote Storage module has limited support on Adobe Commerce on cloud infrastructure. Adobe cannot fully troubleshoot the third-party storage adapter service.

Environment variable

The REMOTE_STORAGE variable is used during the deploy phase of a cloud infrastructure project.

REMOTE_STORAGE

  • Default—Not set
  • Version—Commerce 2.4.2 and later

Configure a storage adapter to store media files in a persistent, remote storage container using a storage service, such as AWS S3. Enable the Remote Storage module to improve performance on Cloud projects with complex, multi-server configurations that must share resources. The following is an example of remote storage configuration using the .magento.env.yaml file:

stage:
  deploy:
    REMOTE_STORAGE:
      driver: aws-s3 # Required
      prefix: cloud # Optional
      config:
        bucket: my-bucket # Required
        region: my-region # Required
        key: my-key # Optional
        secret: my-secret-key # Optional

Set variable with Cloud CLI

Set the REMOTE_STORAGE variable as an environmenet-level variable so that files are not shared between Production, Staging, and Integration environments. Setting the variables at the environment level gives the flexibility of only using remote storage on select environments, such as excluding the integration environment use of remote storage.

To add the remote storage variable using the Cloud CLI:

magento-cloud variable:create --level environment --name REMOTE_STORAGE --json true --inheritable false --value '{"driver":"aws-s3","prefix":"uat","config":{"bucket":"aws-bucket-id","region":"eu-west-1","key":"optional-key","secret":"optional-secret"}}'

This creates a REMOTE_STORAGE variable with the specified JSON configuration. The REMOTE_STORAGE variable takes a JSON string to configure remote storage. The following is an example JSON configuration:

{
  "driver": "aws-s3",
  "prefix": "uat",
  "config": {
    "bucket": "aws-bucket-id",
    "region": "aws-region-id",
    "key": "optional-key",
    "secret": "optional-secret"
  }
}

After you create the configuration and deploy, the deployment logs should include information about the remote storage configuration, for example INFO: Remote storage driver set to: "aws-s3"

Set variable with Project Web Interface

Alternatively, you can use the Project Web Interface to add the variable to the appropriate environment.

To add the remote storage variable using the Project Web Interface:

  1. In the Project Web Interface, select the environment from the left.

  2. Click the Configure environment icon.

  3. In the Configure Environment view, click the Variables tab.

  4. Click Add Variable.

  5. In the Name field, enter REMOTE_STORAGE

  6. In the Value field, add the JSON configuration.

  7. Select JSON value and Sensitive; deselect Inheritable by child environments.

  8. Click Add Variable.

Use optional authentication

The key and secret are optional. When you create the variable, you can hide the key and secret by selecting the sensitive option. With this setting, the values are not visible in the web interface. See Variable visibility in the Commerce on Cloud Infrastructure guide.

If you want to use an a different authentication method, omit the key and secret from the JSON configuration,. Configure the alternative authentication method, and verify that the server is authorized to the S3 bucket.

Sync the remote storage

After enabling the Remote Storage module, synchronize the current media files to the remote store location.

To start the synchronization:

  1. Use SSH to log in to the remote environment with remote storage configured.

  2. Start the sync.

bin/magento remote-storage:sync