How-to Setup Storage Profiles
Configure a Storage Profile for Keeping Media with Third-Party Cloud Providers
With Live Clipping you can have clips stored directly to your preferred third-party cloud storage provider. This gives you additional control over storage costs and manage usage of media clips.
Not Available for Recordings
At this time, Recordings cannot be configured to use a third-party cloud storage provider directly. You should follow the How-to Get Media Assets guide to identify recordings for download and then you can upload them to your preferred provider of choice.
Similarly, timelines will always be stored in Dolby's storage subject to expiration rules.
Configuring Account Storage Profile
You can start by adding a storage profile that will persist across the account so that you can reuse the configuration by name on all future Create Clip requests or as the default setting.
Use the Create Account Storage Profile endpoint to create a new storage profile.
name
: The label you can use to reference the profile.default
: Whether to use this storage profile for all future requests as the default setting.type
: Configuration for S3 or GCS storage locations.options
: Additional configuration specific for each storage provider- bucketName: the name of the bucket
- objectPrefix: similar to a folder path to help organize clips
- bucketRegion: the region to use with your storage provider (optional)
The storage profile will have a unique profileId
that is an assigned GUID that can be used in clipping requests. You do not need to include the protocol s3://
or gs://
in this configuration as that is indicated by the type.
Your choice of storage provider may have a limitation on allowed characters for object names. You should follow the same guidelines when choosing clip naming rules.
How-to Validate the Storage Profile
Use the Validate Third Party Storage Setup endpoint to test whether or not a storage profile is properly configured. This will transfer a small test file to make sure that it can be written to your cloud storage provider.
curl --request POST \
--url https://api.millicast.com/api/v3/account/media/storage/validate \
--header 'authorization: Bearer abc123' \
--data '
{
"profileId": "xz23dk75fb4ac6a2949c39ef454a885adkde",
"type": "gcs",
"options": {
"objectPrefix": "/streams/clips",
"bucketName": "my-org-bucket"
}
}
'
Setting Up Cloud Storage
Dolby storage is used by default, but to use your own storage you will need to provide authorization to access.
Google Cloud Storage
For the storage profile use the following settings:
Key | Description |
---|---|
type | Identify the storage provider, specifically gcs. |
bucketName | The name of the bucket you want to use for storing clips. You can create multiple storage profiles if you have more than one bucket. |
objectPrefix | Each object has a gsutil URI file path that contains an object prefix to use. You can find this from your Google Cloud Storage configuration Objects tab for a specific bucket. |
bucketRegion | (optional) To specify a specific cloud region. Typically not used for Google Cloud Storage. |
Configuration:
Cloud Provider | Service Account |
---|---|
Google Cloud Storage | [email protected] |
How-to Grant Authorization to a Bucket
The following procedure explains how to grant Dolby upload access to Google Cloud Storage buckets. Upon completion, the Dolby service account will have the storage object creator role for the selected storage bucket.
-
Log in to your GCP account.
-
Within your GCP console, navigate to the bucket you wish to grant access to Dolby.io and select the Permissions tab.
-
Click the Grant Access link.
-
On the side panel that appears, enter the Dolby.io service account email ([email protected]) into the New Principals text box, and select the Storage Object Creator role. These are the minimum recommended permissions for enabling reliable upload access to your storage bucket.
-
Click Save to confirm the provided details.
-
Check if the newly added service account is visible on the permissions list.
AWS S3
To configure Amazon's Simple Storage Service (S3) you need to provide authorization to our service.
- Create an AWS S3 Bucket. See the official AWS Getting Started docs for instructions.
- Update the bucket policy with credentials that permit Dolby to read and put objects.
How-to Set the Bucket Policy
Visit the official AWS Adding a bucket policy documentation for instructions.
Be sure to substitute the name of the bucket in the placeholder field ${BUCKET_NAME}
:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "read",
"Effect": "Allow",
"Principal": {
"AWS": [
"arn:aws:iam::123456:role/millicast-recording-service"
]
},
"Action": "s3:PutObject*",
"Resource": "arn:aws:s3:::${BUCKET_NAME}/*"
}
]
}
Updated 30 days ago