#include <userver/storages/secdist/component.hpp>

Detailed Description

Component that stores security related data (keys, passwords, ...).

The component must be configured in service config.

Secdist requires a provider storages::secdist::SecdistProvider You can implement your own or use components::DefaultSecdistProvider

Static configuration example:

# yaml
        secdist:                                         # Component that stores configuration of hosts and passwords
            provider: default-secdist-provider
        default-secdist-provider:                        # Component that loads configuration of hosts and passwords
            config: /etc/redis_service/secure_data.json  # Values are supposed to be stored in this file
            missing-ok: true                             # ... but if the file is missing it is still ok
            environment-secrets-key: SECDIST_CONFIG      # ... values will be loaded from this environment value

Static options:

Name	Description	Default value
provider	optional secdist provider component name	'default-secdist-provider'
config	path to the config file with data	''
format	config format, either `json` or `yaml`	'json'
missing-ok	do not terminate components load if no file found by the config option	false
environment-secrets-key	name of environment variable from which to load additional data	-
update-period	period between data updates in utils::StringToDuration() suitable format ('0s' for no updates)	0s
blocking-task-processor	name of task processor for background blocking operations	–

Examples: samples/digest_auth_service/auth_digest.cpp, samples/production_service/production_service.cpp, and samples/redis_service/redis_service.cpp.

Definition at line 42 of file component.hpp.

Inheritance diagram for components::Secdist:

Collaboration diagram for components::Secdist:

Public Member Functions
	Secdist (const ComponentConfig &, const ComponentContext &)

const storages::secdist::SecdistConfig &	Get () const

rcu::ReadablePtr< storages::secdist::SecdistConfig >	GetSnapshot () const

storages::secdist::Secdist &	GetStorage ()

Public Member Functions inherited from components::LoggableComponentBase
	LoggableComponentBase (const ComponentConfig &, const ComponentContext &)

	LoggableComponentBase (LoggableComponentBase &&)=delete

	LoggableComponentBase (const LoggableComponentBase &)=delete

	~LoggableComponentBase () override=default

ComponentHealth	GetComponentHealth () const override

void	OnLoadingCancelled () override

void	OnAllComponentsLoaded () override

void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Member Functions inherited from components::LoggableComponentBase
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "secdist"
	The default name of components::Secdist.

The documentation for this class was generated from the following file:

userver/storages/secdist/component.hpp

Detailed Description

Static configuration example:

Static options:

Public Member Functions

Static Public Member Functions

Static Public Attributes