druid/docs/operations/password-provider.md
Gian Merlino d007477742
Docusaurus build framework + ingestion doc refresh. (#8311)
* Docusaurus build framework + ingestion doc refresh.

* stick to npm instead of yarn

* fix typos

* restore some _bin

* Adjustments.

* detect and fix redirect anchors

* update anchor lint

* Web-console: remove specific column filters (#8343)

* add clear filter

* update tool kit

* remove usless check

* auto run

* add %

* Fix resource leak (#8337)

* Fix resource leak

* Patch comments

* Enable Spotbugs NP_NONNULL_RETURN_VIOLATION (#8234)

* Fixes from PR review.

* Fix more anchors.

* Preamble nix.

* Fix more anchors, headers

* clean up placeholder page

* add to website lint to travis config

* better broken link checking

* travis fix

* Fixed more broken links

* better redirects

* unfancy catch

* fix LGTM error

* link fixes

* fix md issues

* Addl fixes
2019-08-20 21:48:59 -07:00

2.7 KiB

id title
password-provider Password providers

Apache Druid (incubating) needs some passwords for accessing various secured systems like metadata store, Key Store containing server certificates etc. All these passwords have corresponding runtime properties associated with them, for example druid.metadata.storage.connector.password corresponds to the metadata store password.

By default users can directly set the passwords in plaintext for these runtime properties, for example druid.metadata.storage.connector.password=pwd sets the metadata store password to be used by Druid to connect to metadata store to pwd. Apart from this, users can use environment variables to get password in following way -

Environment variable password provider provides password by looking at specified environment variable. Use this in order to avoid specifying password in runtime.properties file. e.g

{ "type": "environment", "variable": "METADATA_STORAGE_PASSWORD" }

The values are described below.

Field Type Description Required
type String password provider type Yes: environment
variable String environment variable to read password from Yes

However, many times users may want their own way to optionally securely fetch password during runtime of the Druid process. Druid allows this by users to implement their own PasswordProvider interface and create a Druid extension to register this implementation at Druid process startup. Please have a look at "Adding a new Password Provider implementation" on this page to learn more.

To use this implementation, simply set the relevant password runtime property to something similar as was done for Environment variable password provider like -

{ "type": "<registered_password_provider_name>", "<jackson_property>": "<value>", ... }