Clustering with Amazon AWS S3¶
When setting up clustering, you can use Amazon AWS S3 as a binary handler, meaning AWS S3 will be used to store binary files.
Before you start, you should be familiar with the clustering documentation.
Set up AWS S3 account¶
- Go to https://aws.amazon.com/ and create an account. An existing Amazon account can be used.
- Choose a region.
The example below uses EU (Ireland):
- Create a bucket in your chosen region and make note of the bucket name: http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html.
- Go to the IAM Management Console and create a user. See http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html.
- Then create a group and assign the user to the group.
- Assign policies to the group. The
AmazonS3FullAccesspolicy gives read/write access to your bucket.
- Still in the IAM console, view the user you created. Click the "Security credentials" tab.
- Click "Create access key" and make note of the "Access key ID" and the "Secret access key". The secret key cannot be retrieved again after the key has been created, so don't lose it. (However, you can create new keys if needed.)
Make sure that your bucket is configured as Public to avoid facing 403 errors, as the current S3 handler is meant to store files publicly so they can be served directly from S3.
Set up Ibexa DXP for AWS S3¶
In your Ibexa DXP root directory, run
php composer require league/flysystem-aws-s3-v3:^2.0.
In your Ibexa DXP configuration, e.g.
config/packages/ibexa.yaml, set up the AWS S3 client:
1 2 3 4 5 6 7 8 9
In the same Ibexa DXP configuration, set up the Flysystem v2 adapter that uses the S3 client:
1 2 3 4 5 6 7
In the same place, set up the binary data handler for the S3 adapter:
1 2 3 4 5
aws_s3 is an arbitrary handler identifier that is used in the config block below.
You can configure multiple handlers.
For example, you could configure one called
gcloud_storage for a third-party (community-supported)
Google Cloud Storage adapter.
In your Ibexa DXP system settings, e.g.
config/packages/ibexa.yaml, enable the binary data handler:
1 2 3 4 5 6 7
Clear all caches and reload, and that's it.
Migrate your existing binary data to S3¶
You can migrate existing binary data to S3 using the
php bin/console ibexa:io:migrate-files command
which was added in EZP-25946.