Overview

VOD Migrate Tool is an all-in-one tool that integrates data migration features. By writing a simple configuration file, you can quickly migrate media files at the source address to VOD.

Supported Data Sources

• Local folder
• URL list
• Tencent Cloud COS
• AWS S3
• Alibaba Cloud OSS
• Qiniu Kodo

Prerequisites

OS

Windows, Linux, and macOS.

Software dependency

• Python 2.7/3.4+.
• Latest version of pip.

Installation

Installing through pip (recommended)

You can install the SDK into your project through pip. If you haven't installed pip in your project environment yet, install it first as instructed at pip's official website.

pip install vodmigrate

Installing through source package

Click here to download the source code.
Download the latest code and decompress:

git clone https://github.com/tencentyun/vod-migrate.git
cd vod-migrate
python setup.py install

Use Cases

Run the following command:

vodmigrate config.toml

Note：

After the migration is completed, the result will be output to the directory corresponding to the configuration item migrateResultOutputPath, and the filename will be vod_migrate_result.txt.

Configuration File Description

The configuration file is in TOML format (for more information, please see config_template.toml. Make sure that the file is encoded in UTF-8). The file content can be divided into the following parts:

1. Configure the migration type

type indicates the migration type, which should be filled in based on your migration needs. For example, to migrate local data to VOD, you need to configure type=migrateLocal for [migrateType].

[migrateType]
type="migrateLocal"

Currently, the following migration types are supported:

2. Configure the migration task

You can configure a migration task based on your actual needs, including information configuration for VOD and task configuration.

# Common configuration for the migration tool
[common]
secretId = "SECRETID"
secretKey = "SECRETKEY"
region = 'REGION'
subAppId = 0
concurrency = 5
supportMediaClassification = [ 'video', 'audio', 'image' ]
excludeMediaType = [  ]
migrateDbStoragePath = ''
migrateResultOutputPath = ''

File type description:

• Video: MP4, TS, FLV, WMV, ASF, RM, RMVB, MPG, MPEG, 3GP, MOV, WEBM, MKV, AVI. HLS and DASH are not supported
• Audio: MP3, M4A, FLAC, OGG, WAV
• Image: JPG, JPEG, PNG, GIF, BMP, TIFF, AI, CDR, EPS

3. Configure the data source

Configure the applicable section according to the migration type described in [migrateType]. For example, if the configuration item of [migrateType] is type=migrateLocal, you only need to configure the [migrateLocal] section.

3.1. Configure a local data source (migrateLocal)

If you migrate data from a local system to VOD, configure this section. The specific configuration items and descriptions are as follows:

# Configuration section for migration from a local system to VOD
[migrateLocal]
localPath = ''
excludes = [ ]

3.2. Configure a URL list data source (migrateUrl)

If you migrate data from a specified URL list to VOD, configure this section. The specific configuration items and descriptions are as follows:

# Configuration section for migration from a URL list download to VOD
[migrateUrl]
urllistPath = 'D:\folder\urllist.txt'

3.3. Configure a COS data source (migrateCos)

If you migrate data from Tencent Cloud COS to VOD, configure this section. The specific configuration items and descriptions are as follows:

# Configuration section for migration from Tencent Cloud COS to VOD
[migrateCos]
region = 'ap-shanghai'
bucket = 'examplebucket-1250000000'
secretId = 'COS_SECRETID'
secretKey = 'COS_SECRETKEY'
prefix = ''

3.4. Configure an AWS S3 data source (migrateAws)

If you migrate data from AWS S3 to VOD, configure this section. The specific configuration items and descriptions are as follows:

# Configuration section for migration from AWS S3 to VOD
[migrateAws]
region = 'ap-northeast-2'
bucket = 'bucket-aws'
accessKeyId = 'AccessKeyId'
accessKeySecret = 'AccessKeySecret'
prefix = ''

3.5. Configure an Alibaba Cloud OSS data source (migrateAli)

If you migrate data from Alibaba Cloud OSS to VOD, configure this section. The specific configuration items and descriptions are as follows:

# Configuration section for migration from Alibaba Cloud OSS to VOD
[migrateAli]
bucket = 'bucket-aliyun'
accessKeyId = 'yourAccessKeyId'
accessKeySecret = 'yourAccessKeySecret'
endPoint = 'oss-cn-hangzhou.aliyuncs.com'
prefix = ''

3.6. Configure a Qiniu Kodo data source (migrateQiniu)

If you migrate data from Qiniu Kodo to VOD, configure this section. The specific configuration items and descriptions are as follows:

# Configuration section for migration from Qiniu Kodo to VOD
[migrateQiniu]
bucket = 'bucket-qiniu'
accessKeyId = 'AccessKey'
accessKeySecret = 'SecretKey'
endPoint = 'www.bkt.clouddn.com'
prefix = ''

Use Limits

• The tool is designed as a one-time migration tool. The migration is divided into three stages: origin server file scanning, migrating, and migration completed. After the file scan is completed, if the configuration needs to be changed, the db file must be cleared (i.e., deleting migrate.db or modifying the db storage path) to avoid errors with configuration file MD5 verification.
• The migrated files must be displayed with the file extension.
• HLS/DASH files cannot be migrated currently.
• After the migration, the directory relationship between the original videos cannot be maintained, and each video has an independent FileId, all of which are not related to each other.

Migration Process Overview

1. The configuration file is read, the corresponding configuration section is read according to the migration type, and parameters are checked.
2. The origin server is scanned according to the migration type, and migration tasks are generated.
3. After the scan is completed, the migration is performed, and the results of each task and the overall progress are printed.
4. After the migration is completed, the details are output to the result file.