Skip to content

AWS S3 (or compatible) Requirements#

S3 storage is currently used to store Kafka Messages payloads when they exceed Kafka maximum payload sizes. But, its planned to become the primary storage solution for all binary/file storage in the MES ecosystem.

While designed for AWS S3, this implementation supports any S3-compatible storage provider (MinIO, Ceph, Google Cloud Storage, or other) that implements the required operations listed in section Used S3 APIs.

Minimum system requirements#

Item Requirement
Version --
Memory 4GB
CPU 2vCPUs

Table: Minimum system requirements for AWS S3 (or compatible)

Item Requirement
Version --
Memory 16GB
CPU 4vCPUs

Table: Recommended system requirements for AWS S3 (or compatible)

Required S3 APIs#

The following S3 APIs are used by Critical Manufacturing MES components for storage operations:

API Operation Purpose Required Permission
DoesS3BucketExist Validates bucket availability before performing operations s3:HeadBucket
GetObject Downloads and accesses stored data from S3 s3:GetObject
PutBucket Creates new S3 buckets for storage initialization s3:CreateBucket
Upload Stores data and files in S3 storage s3:PutObject

Table: S3 APIs used by CM MES

API Compatibility

Ensure your S3-compatible storage provider supports all listed operations for full CM MES functionality. Furthermore, ensure that the IAM role or service account used by CM MES has all the listed (or equivalent) permissions assigned.