druid/docs/development/extensions-contrib/aliyun-oss-extensions.md
frank chen 60c6bd5b4c
support Aliyun OSS service as deep storage (#9898)
* init commit, all tests passed

* fix format

Signed-off-by: frank chen <frank.chen021@outlook.com>

* data stored successfully

* modify config path

* add doc

* add aliyun-oss extension to project

* remove descriptor deletion code to avoid warning message output by aliyun client

* fix warnings reported by lgtm-com

* fix ci warnings

Signed-off-by: frank chen <frank.chen021@outlook.com>

* fix errors reported by intellj inspection check

Signed-off-by: frank chen <frank.chen021@outlook.com>

* fix doc spelling check

Signed-off-by: frank chen <frank.chen021@outlook.com>

* fix dependency warnings reported by ci

Signed-off-by: frank chen <frank.chen021@outlook.com>

* fix warnings reported by CI

Signed-off-by: frank chen <frank.chen021@outlook.com>

* add package configuration to support showing extension info

Signed-off-by: frank chen <frank.chen021@outlook.com>

* add IT test cases and fix bugs

Signed-off-by: frank chen <frank.chen021@outlook.com>

* 1. code review comments adopted
2. change schema from 'aliyun-oss' to 'oss'

Signed-off-by: frank chen <frank.chen021@outlook.com>

* add license info

Signed-off-by: frank chen <frank.chen021@outlook.com>

* fix doc

Signed-off-by: frank chen <frank.chen021@outlook.com>

* exclude execution of IT testcases of OSS extension from CI

Signed-off-by: frank chen <frank.chen021@outlook.com>

* put the extensions under contrib group and add to distribution

* fix names in test cases

* add unit test to cover OssInputSource

* fix names in test cases

* fix dependency problem reported by CI

Signed-off-by: frank chen <frank.chen021@outlook.com>
2020-07-01 22:20:53 -07:00

2.6 KiB

id title
aliyun-oss Aliyun OSS

To use this Apache Druid extension, make sure to include aliyun-oss-extensions extension.

Deep Storage

Aliyun is the 3rd largest cloud infrastructure provider in the world. It provides its own storage solution known as OSS, Object Storage Service.

To use aliyun OSS as deep storage, first config as below

Property Description Possible Values Default
druid.oss.accessKey the AccessKey ID of your account which can be used to access the bucket Must be set.
druid.oss.secretKey the AccessKey Secret of your account which can be used to access the bucket Must be set.
druid.oss.endpoint the endpoint url of your OSS storage Must be set.

if you want to use OSS as deep storage, use the configurations below

Property Description Possible Values Default
druid.storage.type Global deep storage provider. Must be set to oss to make use of this extension. oss Must be set.
druid.storage.oss.bucket storage bucket name. Must be set.
druid.storage.oss.prefix a prefix string prepended to the file names for the segments published to aliyun OSS deep storage druid/segments

To save index logs to OSS, apply the configurations below:

Property Description Possible Values Default
druid.indexer.logs.type Global deep storage provider. Must be set to oss to make use of this extension. oss Must be set.
druid.indexer.logs.oss.bucket the bucket used to keep logs Must be set.
druid.indexer.logs.oss.prefix a prefix string prepended to the log files.