docs

Author: mnink275

core/include/userver/storages/secdist/component.hpp

@@ -14,21 +14,17 @@ namespace components {
 
 /// @ingroup userver_components
 ///
-/// @brief Component that stores security related data (keys, passwords, ...).
+/// @brief Default implementation of components::SecdistComponentBase.
 ///
 /// 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:
 ///
 /// @snippet samples/redis_service/static_config.yaml Sample secdist static config
 ///
 /// ## 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
@@ -48,7 +44,7 @@ class Secdist final : public SecdistComponentBase {
 
   static yaml_config::Schema GetStaticConfigSchema();
 };
-
+/// [Sample secdist - default secdist]
 template <>
 inline constexpr bool kHasValidate<Secdist> = true;
 

core/include/userver/storages/secdist/component_base.hpp

@@ -15,28 +15,18 @@ namespace components {
 
 /// @ingroup userver_components
 ///
-/// @brief Component that stores security related data (keys, passwords, ...).
+/// @brief Base component that stores security related data (keys, passwords, ...).
 ///
-/// The component must be configured in service config.
+/// You can use a ready-made components::Secdist or implement your own.
 ///
-/// Secdist requires a provider storages::secdist::SecdistProvider
-/// You can implement your own or use components::DefaultSecdistProvider
+/// ### Writing your own secrets distributor:
+/// Implement a custom provider class that contains the settings.
+/// @snippet core/include/userver/storages/secdist/default_provider.hpp Sample secdist - default provider
 ///
-/// ## Static configuration example:
+/// Implement a custom secdist component, configure it's static config schema
+/// and pass the custom provider to the storages::secdist::SecdistConfig::Settings.
+/// @snippet core/include/userver/storages/secdist/component.сpp Sample secdist - default secdist
 ///
-/// @snippet samples/redis_service/static_config.yaml Sample secdist static config
-///
-/// ## 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 | --
-
 // clang-format on
 
 class SecdistComponentBase : public LoggableComponentBase {

core/include/userver/storages/secdist/default_provider.hpp

@@ -1,7 +1,7 @@
 #pragma once
 
-/// @file userver/storages/secdist/component.hpp
-/// @brief @copybrief components::DefaultSecdistProvider
+/// @file userver/storages/secdist/default_provider.hpp
+/// @brief @copybrief storages::secdist::DefaultProvider
 
 #include <string>
 
@@ -11,7 +11,15 @@
 USERVER_NAMESPACE_BEGIN
 
 namespace storages::secdist {
+// clang-format off
 
+/// @brief Default implementation of storages::secdist::SecdistProvider.
+///
+/// Provides components::Secdist configurations to the
+/// storages::secdist::SecdistConfig
+
+// clang-format on
+/// [Sample secdist - default provider]
 class DefaultProvider final : public storages::secdist::SecdistProvider {
  public:
   struct Settings {
@@ -29,7 +37,7 @@ class DefaultProvider final : public storages::secdist::SecdistProvider {
  private:
   Settings settings_;
 };
-
+/// [Sample secdist - default provider]
 }  // namespace storages::secdist
 
 USERVER_NAMESPACE_END

core/include/userver/storages/secdist/provider.hpp

@@ -10,6 +10,15 @@ namespace storages::secdist {
 
 class SecdistProvider {
  public:
+  SecdistProvider() = default;
+  virtual ~SecdistProvider() = default;
+
+  SecdistProvider(const SecdistProvider&) = delete;
+  SecdistProvider& operator=(const SecdistProvider&) = delete;
+
+  SecdistProvider(SecdistProvider&&) = default;
+  SecdistProvider& operator=(SecdistProvider&&) = default;
+
   virtual formats::json::Value Get() const = 0;
 };
 

core/src/storages/secdist/component.cpp

@@ -8,7 +8,7 @@
 #include <userver/yaml_config/merge_schemas.hpp>
 
 USERVER_NAMESPACE_BEGIN
-
+/// [Sample secdist - default secdist]
 namespace components {
 namespace {
 
@@ -87,5 +87,5 @@ additionalProperties: false
 }
 
 }  // namespace components
-
+/// [Sample secdist - default secdist]
 USERVER_NAMESPACE_END