userver: components::Secdist Class Reference
⚠️ This is the documentation for an old userver version. Click here to switch to the latest version.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts

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

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

+ Inheritance diagram for components::Secdist:
+ Collaboration diagram for components::Secdist:

Public Member Functions

 Secdist (const ComponentConfig &, const ComponentContext &)
 
const storages::secdist::SecdistConfigGet () const
 
rcu::ReadablePtr< storages::secdist::SecdistConfigGetSnapshot () const
 
storages::secdist::SecdistGetStorage ()
 
- 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.
 

Detailed Description

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

The component must be configured in service config.

Static options:

Name Description Default value
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/production_service/production_service.cpp, and samples/redis_service/redis_service.cpp.

Definition at line 34 of file component.hpp.


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