Configure Object Storage
OpenMetadata saves the files that people upload, such as the files in Context Center > Documents, in object storage. Object storage is turned off by default. Turn it on before you let people upload files.Settings
Add theobjectStorage block to openmetadata.yaml, or set the environment variables shown for each setting. Restart OpenMetadata after you change them.
Amazon S3
OpenMetadata finds credentials in this order:
- If you set
s3.endpoint, it usess3.accessKeyands3.secretKey. - Otherwise, it uses the standard AWS credential chain, such as an IAM role on the server or pod, or the
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYenvironment variables. - If the chain finds nothing, it uses
s3.accessKeyands3.secretKey.
s3:PutObject, s3:GetObject, and s3:DeleteObject on the bucket and prefix.
MinIO and Other S3-Compatible Storage
Use providers3 and set s3.endpoint (ASSET_UPLOADER_S3_ENDPOINT) to the address of your storage server. OpenMetadata then uses the access key and secret key you configure.
Azure Blob Storage
OpenMetadata signs in with the default Azure credentials of the server or pod, such as a managed identity or the
AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET environment variables. That identity needs permission to read, write, and delete blobs in the container.
Check That It Works
- Upload a small file in Context Center > Documents.
- Download the same file. It should open normally.
- Check that a new object appears in your bucket or container, under the prefix you set.
- Storage is off or the server wasn’t restarted. Confirm that
objectStorage.enabledistrueand that you restarted OpenMetadata. - The provider is
inmemory. Files are lost when the server restarts, and a second server can’t read files saved by the first. Uses3orazure. - The upload failed on the storage side. With
s3orazure, a failed write makes the upload fail with an error, and OpenMetadata removes the new file entry. Read the server log from the moment of the upload for storage errors, such as access denied. - The credentials can’t write or read. Check the permissions in Amazon S3 or Azure Blob Storage.
- The file is too large. Raise
objectStorage.maxFileSize.