AMSMigrate 1.2.2
The updated package to use
See the version list below for details.
dotnet tool install --global AMSMigrate --version 1.2.2
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local AMSMigrate --version 1.2.2
#tool dotnet:?package=AMSMigrate&version=1.2.2
nuke :add-package AMSMigrate --version 1.2.2
Azure Media Services Migration Tool
Overview
A rich and flexible command line tool to migrate your data from Azure Media Services. This tool helps you to migrate your media data from Azure Media Services (AMS). It can be used to just copy the data to other cloud storage like AWS S3 or GCS. Or can be packaged to be streamed directly from Azure storage without any service.
It has extensible support to migrate AMS assets to Azure storage or AWS S3 or GCS. Fairly easy to plugin another service (e.g mux.com or encoding.com) or another cloud storage if needed.
The tool supports both shaka-packager and ffmpeg to conver the videos to directly streamable format. The content is converted to CMAF format with both a DASH and HLS manifest to support a wide range of devices. The default is shaka packager because it can use pipes to reduce the temporary storage required but can changed via the command line.
Features
- Cross-Platform. Works on all platforms where .NET core is available.
- Simple command line interface. Intuitive and easy to use.
- Docker container to run anywhere or can be installed as a .NET tool.
- Support for packaging both VOD and live archive assets.
- Marks migrated assets and provides summary.
Types of Migration
The tool supports various forms of migration depending on the asset format and the command line options.
- It can simply copy and upload the files to the new storage account.
- For direct streaming, it can convert the assets to CMAF files with a DASH and HLS manifest.
- It can convert files to MP4 format and then upload for progressive download.
Supported Asset Types.
The below table summarizes the supported asset types.
Format | Copy | Packaging (DASH/HLS) |
---|---|---|
Single MP4 | Yes | No |
Multiple MP4 without .ism | Yes | No |
Multiple MP4 with .ism | Yes | Yes |
Smooth streaming asset | No | Yes |
Statically packaged HLS | No | Yes |
Asset with text tracks | Yes | Yes |
Storage encrypted assets | Yes | No |
Live archive | No | Yes |
Low-latency Live archive | No | Yes |
Encrypted Live archive | No | No |
Live archive with captions | No | Partial (captions not supported) |
Live archive with discontinuities | No | No (discontinuities not handled) |
Open Issues
- Support to migrate AMS transforms to AWS Elemental Media Convert Job Specification.
- Support to convert AMS transforms to GCS Trancsode API Job templates.
- Support to migrate AMS Keys to AWS KMS or GCP Secret Manager.
How to Run
Local
- Install .NET SDK for the platform you are running. Click here on how to download.
- Run the following command to install the tool
dotnet tool install -g amsmigrate
- Run the tool with -? to get more help. You may have to add the install location to PATH in some instances
amsmigrate -?
Typical command is of the form
amsmigrate command -s subscriptionid -g resourcegroup -n amsaccount [command specific options]
Running the tool in the Cloud.
The tool is packaged as a docker container and is available to run in the cloud.
docker pull ghcr.io/duggaraju/amsmigrate:main
Azure
If you want to run the migration tool in the azure cloud you can use Azure Container Instances or Azure Functions The example below uses ACI with user assigned managed identity that has access to the storage/media account as needed. Please refer to ACI for more details on container creation.
az container create --resource-group group --name amsmigrate --image ghcr.io/duggaraju/amsmigrate:main --assign-dentity /subscription/subcriptionid/resoruceGroups/group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myID --command-line "analyze -s subscription -g resourcegrup -n account" --restart-policy Never
Credentials used
The tools uses Azure Identity library for authentication. See here for various ways to authenticate and the settings needed. The identity used to migrate must have
- 'Media Services Media Contributor' role on the Azure Media Services account being migrated.
- 'Storage Blob Data Contributor' role on the Storage accounts used (source/destination)
Temporary storage needed.
The tool uses temporary storage space for format conversion and uses pipes where possible to minimize storage usage. Smooth Streaming assets or assets from live events dont need to be downloaded locally.
Linux
- The only storage needed is for manifests when using shaka packager.
- When using ffmpeg, if the asset files are MP4, it downloads the files locally before converting so storage is proportional to asset size.
Windows
- Shaka packager writes the packaged files to local disk first before uploading due to a windows specific bug.
- Using ffmpeg needs doulbe the local disk space when packaging MP4 files.
- Smooth Streaming assets or assets from live events dont need to be downloaded locally.
Destination for migration.
You can migrate your data to various clouds like AWS or GCP or keep within Azure by moving to a storage account.
Migrate to an Azure Storage Account.
Ensure that the Identity you are using to migrate has the following permissions
- 'Storage Blob Data Contributor' role on the storage account to which you are migrating.
Migrate to an AWS S3 account.
- If Running locally
- Create a bucket (or use an existing bucket) in your S3 account.
- Create an API access key and secret.
- Create a profile with those settings.
- Set the environment variable AWS_PROFILE to the profile name used in step above.
- Run the tool.
- Running in the cloud.
- TBD
Migrate to a GCS account.
To migrate to a Google cloud storage bucket
- If running locally
- Create or use an existing bucket in the region you want to migrate.
- Install gcloud CLI https://cloud.google.com/sdk/docs/install#installation_instructions
- If running locally install google cloud shell and run
gcloud auth application-default login
- Run the command by specifying the bucket name as part of the path template. e.g -t bucket_name/{AssetId}
- If running a container in the cloud
- Ensure the bucket to use is alread created.
- Create API keys and pass them as environment variables to the container
Migrate to a custom cloud/service.
If your want to migrate to a service or cloud other than the ones supported out of box, you can write your own custom migrator if needed
- Clone the source code locally.
- Implement your custom migration. Look in to aws/gcp folder for examples.
- Build and Run the code locally.
FFmpeg dependency
The tool optionally uses ffmpeg for media format conversion. It primarily uses shaka-packager but can be changed to use ffmpeg. It doesn't ship a copy of FFmpeg itself but uses the one in the PATH.
- On Windows you can use winget or chocolatey to install ffmpeg.
winget install ffmpeg
- On Ubuntu/Debian Linux use apt to install ffmpeg
sudo apt install -y ffmpeg
- On RedHat Linux use dnf to install ffmpeg.
sudo dnf install ffmpeg
- On MacOs use brew to install ffmpeg
brew install ffmpeg
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
This package has no dependencies.
Version | Downloads | Last updated | |
---|---|---|---|
1.4.4 | 273 | 7/11/2023 | |
1.4.3 | 281 | 7/11/2023 | |
1.4.2 | 244 | 7/11/2023 | |
1.4.1 | 241 | 7/10/2023 | |
1.4.0 | 255 | 7/8/2023 | |
1.3.1 | 273 | 7/6/2023 | |
1.3.0 | 270 | 7/4/2023 | |
1.2.8 | 286 | 6/30/2023 | |
1.2.7 | 246 | 6/30/2023 | |
1.2.6 | 282 | 6/30/2023 | |
1.2.5 | 271 | 6/29/2023 | |
1.2.4 | 364 | 6/29/2023 | |
1.2.3 | 344 | 6/28/2023 | |
1.2.2 | 356 | 6/28/2023 | |
1.2.0 | 312 | 6/23/2023 | |
1.1.7 | 308 | 6/21/2023 | |
1.1.6 | 318 | 6/21/2023 | |
1.1.5 | 343 | 6/20/2023 | |
1.1.4 | 324 | 6/20/2023 | |
1.1.2 | 355 | 6/14/2023 | |
1.1.1 | 295 | 6/13/2023 | |
1.1.0 | 307 | 6/13/2023 | |
1.0.16 | 278 | 6/9/2023 | |
1.0.15 | 309 | 6/8/2023 | |
1.0.14 | 337 | 6/5/2023 | |
1.0.13 | 287 | 6/3/2023 | |
1.0.12 | 298 | 6/2/2023 | |
1.0.11 | 297 | 5/31/2023 | |
1.0.10 | 308 | 5/26/2023 | |
1.0.9 | 309 | 5/26/2023 | |
1.0.8 | 299 | 5/26/2023 | |
1.0.7 | 289 | 5/25/2023 | |
1.0.6 | 316 | 5/24/2023 | |
1.0.5 | 287 | 5/24/2023 | |
1.0.4 | 330 | 5/23/2023 | |
1.0.3 | 273 | 5/23/2023 | |
1.0.2 | 278 | 5/20/2023 | |
1.0.1 | 248 | 5/19/2023 | |
1.0.0 | 206 | 5/19/2023 |