update ref

Author: sasudi90

REFERENCE.md

@@ -21,7 +21,7 @@
 
 ### <a name="vault"></a>`vault`
 
-install hashicorp vault
+Agent specific parameters
 
 #### Parameters
 
@@ -249,215 +249,215 @@ Default value: `'1.12.0'`
 
 Data type: `Enum['server', 'agent']`
 
-start vault in server or agent mode
+Whether to start vault in 'server' or 'agent' mode
 
 Default value: `'server'`
 
 ##### <a name="-vault--extra_config"></a>`extra_config`
 
 Data type: `Hash`
 
-
+Hash containing extra configuration options to merge with the generated config
 
 Default value: `{}`
 
 ##### <a name="-vault--enable_ui"></a>`enable_ui`
 
 Data type: `Optional[Boolean]`
 
-
+Whether to enable the Vault web UI
 
 Default value: `undef`
 
 ##### <a name="-vault--arch"></a>`arch`
 
 Data type: `Any`
 
-
+System architecture for the Vault binary (automatically determined)
 
 Default value: `$vault::params::arch`
 
 ##### <a name="-vault--os"></a>`os`
 
 Data type: `Any`
 
-
+Operating system for the Vault binary (automatically determined)
 
 Default value: `downcase($facts['kernel'])`
 
 ##### <a name="-vault--manage_download_dir"></a>`manage_download_dir`
 
 Data type: `Any`
 
-
+Whether to manage the download directory
 
 Default value: `false`
 
 ##### <a name="-vault--download_dir"></a>`download_dir`
 
 Data type: `Any`
 
-
+Directory where the Vault archive will be downloaded
 
 Default value: `'/tmp'`
 
 ##### <a name="-vault--package_ensure"></a>`package_ensure`
 
 Data type: `Any`
 
-
+The state the package should be in (installed, absent, latest)
 
 Default value: `'installed'`
 
 ##### <a name="-vault--package_name"></a>`package_name`
 
 Data type: `Any`
 
-
+Name of the Vault package
 
 Default value: `'vault'`
 
 ##### <a name="-vault--install_method"></a>`install_method`
 
 Data type: `Any`
 
-
+Installation method: 'archive' or 'repo'
 
 Default value: `$vault::params::install_method`
 
 ##### <a name="-vault--manage_file_capabilities"></a>`manage_file_capabilities`
 
 Data type: `Any`
 
-
+Whether to manage Linux file capabilities for vault binary
 
 Default value: `undef`
 
 ##### <a name="-vault--disable_mlock"></a>`disable_mlock`
 
 Data type: `Any`
 
-
+Whether to disable the memory lock capability
 
 Default value: `undef`
 
 ##### <a name="-vault--max_lease_ttl"></a>`max_lease_ttl`
 
 Data type: `Optional[String]`
 
-
+Specifies the maximum possible lease duration for tokens and secrets
 
 Default value: `undef`
 
 ##### <a name="-vault--default_lease_ttl"></a>`default_lease_ttl`
 
 Data type: `Optional[String]`
 
-
+Specifies the default lease duration for tokens and secrets
 
 Default value: `undef`
 
 ##### <a name="-vault--telemetry"></a>`telemetry`
 
 Data type: `Optional[Hash]`
 
-
+Hash containing Vault telemetry configuration
 
 Default value: `undef`
 
 ##### <a name="-vault--disable_cache"></a>`disable_cache`
 
 Data type: `Optional[Boolean]`
 
-
+Disable caching
 
 Default value: `undef`
 
 ##### <a name="-vault--seal"></a>`seal`
 
 Data type: `Optional[Hash]`
 
-
+Hash containing seal configuration options
 
 Default value: `undef`
 
 ##### <a name="-vault--ha_storage"></a>`ha_storage`
 
 Data type: `Optional[Hash]`
 
-
+Hash containing storage configuration for HA setup
 
 Default value: `undef`
 
 ##### <a name="-vault--listener"></a>`listener`
 
 Data type: `Variant[Hash, Array[Hash]]`
 
-
+Hash or Array of hashes containing listener configuration
 
 Default value: `{ 'tcp' => { 'address' => '127.0.0.1:8200', 'tls_disable' => 1 }, }`
 
 ##### <a name="-vault--manage_storage_dir"></a>`manage_storage_dir`
 
 Data type: `Any`
 
-
+Whether to manage the storage directory
 
 Default value: `false`
 
 ##### <a name="-vault--storage"></a>`storage`
 
 Data type: `Hash`
 
-
+Hash containing storage configuration
 
 Default value: `{ 'file' => { 'path' => '/var/lib/vault' } }`
 
 ##### <a name="-vault--manage_service_file"></a>`manage_service_file`
 
 Data type: `Optional[Boolean]`
 
-
+Whether to manage the service file
 
 Default value: `$vault::params::manage_service_file`
 
 ##### <a name="-vault--service_ensure"></a>`service_ensure`
 
 Data type: `Any`
 
-
+Desired state of the Vault service (running, stopped)
 
 Default value: `'running'`
 
 ##### <a name="-vault--service_enable"></a>`service_enable`
 
 Data type: `Any`
 
-
+Whether to enable the Vault service on boot
 
 Default value: `true`
 
 ##### <a name="-vault--manage_config_file"></a>`manage_config_file`
 
 Data type: `Any`
 
-
+Whether to manage the Vault config file
 
 Default value: `true`
 
 ##### <a name="-vault--download_filename"></a>`download_filename`
 
 Data type: `Any`
 
-
+Filename for the downloaded archive
 
 Default value: `'vault.zip'`
 
 ##### <a name="-vault--manage_config_dir"></a>`manage_config_dir`
 
 Data type: `Boolean`
 
-enable/disable the directory management. not required for package based installations
+Whether to manage the configuration directory
 
 Default value: `$install_method == 'archive'`