From c693264e767aeb7b07b609e026812c7b5048ffb2 Mon Sep 17 00:00:00 2001 From: markuszilch Date: Wed, 20 Mar 2024 16:56:52 +0100 Subject: [PATCH] remove doc and references to removed parameters; add missing doc stumps --- REFERENCE.md | 63 +++---------------- .../provider/graylog_api/graylog_api.rb | 1 + .../provider/graylog_dashboard/graylog_api.rb | 1 + .../graylog_dashboard_layout/graylog_api.rb | 1 + .../graylog_dashboard_widget/graylog_api.rb | 1 + .../provider/graylog_extractor/graylog_api.rb | 1 + .../graylog_grok_pattern/graylog_api.rb | 1 + .../provider/graylog_index_set/graylog_api.rb | 1 + .../provider/graylog_input/graylog_api.rb | 1 + .../graylog_ldap_settings/graylog_api.rb | 1 + .../graylog_lookup_adapter/graylog_api.rb | 1 + .../graylog_lookup_cache/graylog_api.rb | 1 + .../graylog_lookup_table/graylog_api.rb | 1 + .../provider/graylog_pipeline/graylog_api.rb | 1 + .../graylog_pipeline_rule/graylog_api.rb | 1 + .../graylog_plugin_auth_sso/graylog_api.rb | 1 + .../provider/graylog_role/graylog_api.rb | 1 + .../provider/graylog_stream/graylog_api.rb | 1 + .../provider/graylog_user/graylog_api.rb | 1 + manifests/extractor/regex_replace.pp | 2 +- manifests/input/cef_udp.pp | 3 - manifests/input/syslog_tcp.pp | 26 -------- types/pipeline/stage.pp | 2 + types/pipeline/stage/loose.pp | 2 + 24 files changed, 33 insertions(+), 83 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 248e2d7..0e2cb0b 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -44,8 +44,8 @@ ### Data types -* [`Graylog_api::Pipeline::Stage`](#Graylog_api--Pipeline--Stage) -* [`Graylog_api::Pipeline::Stage::Loose`](#Graylog_api--Pipeline--Stage--Loose) +* [`Graylog_api::Pipeline::Stage`](#Graylog_api--Pipeline--Stage): Custom Type for Graylog_api pipeline stage +* [`Graylog_api::Pipeline::Stage::Loose`](#Graylog_api--Pipeline--Stage--Loose): custom type for graylog_api pipeline stage loose ## Defined types @@ -160,13 +160,12 @@ The following parameters are available in the `graylog_api::extractor::regex_rep * [`input`](#-graylog_api--extractor--regex_replace--input) * [`source_field`](#-graylog_api--extractor--regex_replace--source_field) * [`target_field`](#-graylog_api--extractor--regex_replace--target_field) -* [`regex_value`](#-graylog_api--extractor--regex_replace--regex_value) +* [`regex`](#-graylog_api--extractor--regex_replace--regex) * [`cut_or_copy`](#-graylog_api--extractor--regex_replace--cut_or_copy) * [`condition_type`](#-graylog_api--extractor--regex_replace--condition_type) * [`condition_value`](#-graylog_api--extractor--regex_replace--condition_value) * [`converters`](#-graylog_api--extractor--regex_replace--converters) * [`order`](#-graylog_api--extractor--regex_replace--order) -* [`regex`](#-graylog_api--extractor--regex_replace--regex) * [`replacement`](#-graylog_api--extractor--regex_replace--replacement) * [`replace_all`](#-graylog_api--extractor--regex_replace--replace_all) @@ -202,10 +201,14 @@ Choose a field name to store the extracted value. It can only contain alphanumer Default value: `''` -##### `regex_value` +##### `regex` + +Data type: `String` Title of the input this extractor is attached to. +Default value: `''` + ##### `cut_or_copy` Data type: `Optional[String]` @@ -246,14 +249,6 @@ Sort index for this extractor. Default value: `undef` -##### `regex` - -Data type: `String` - - - -Default value: `''` - ##### `replacement` Data type: `String` @@ -840,7 +835,6 @@ The following parameters are available in the `graylog_api::input::cef_udp` defi * [`static_fields`](#-graylog_api--input--cef_udp--static_fields) * [`timezone`](#-graylog_api--input--cef_udp--timezone) * [`use_full_names`](#-graylog_api--input--cef_udp--use_full_names) -* [`use_null_delimiter`](#-graylog_api--input--cef_udp--use_null_delimiter) ##### `ensure` @@ -929,11 +923,6 @@ specification). Default value: `false` -##### `use_null_delimiter` - -Whether to use a null byte as a frame delimiter. If false, a newline is -used as the delimiter instead. - ### `graylog_api::input::gelf_http` Defines an input accepting GELF-formatted JSON over HTTP POST. @@ -1396,16 +1385,12 @@ Defines an input accepting Syslog messages over TCP. The following parameters are available in the `graylog_api::input::syslog_tcp` defined type: * [`ensure`](#-graylog_api--input--syslog_tcp--ensure) -* [`allow_override_date`](#-graylog_api--input--syslog_tcp--allow_override_date) * [`bind_address`](#-graylog_api--input--syslog_tcp--bind_address) -* [`expand_structured_data`](#-graylog_api--input--syslog_tcp--expand_structured_data) -* [`force_rdns`](#-graylog_api--input--syslog_tcp--force_rdns) * [`override_source`](#-graylog_api--input--syslog_tcp--override_source) * [`port`](#-graylog_api--input--syslog_tcp--port) * [`recv_buffer_size`](#-graylog_api--input--syslog_tcp--recv_buffer_size) * [`scope`](#-graylog_api--input--syslog_tcp--scope) * [`static_fields`](#-graylog_api--input--syslog_tcp--static_fields) -* [`store_full_message`](#-graylog_api--input--syslog_tcp--store_full_message) * [`tcp_keepalive`](#-graylog_api--input--syslog_tcp--tcp_keepalive) * [`tls_cert_file`](#-graylog_api--input--syslog_tcp--tls_cert_file) * [`tls_client_auth`](#-graylog_api--input--syslog_tcp--tls_client_auth) @@ -1413,7 +1398,6 @@ The following parameters are available in the `graylog_api::input::syslog_tcp` d * [`tls_enable`](#-graylog_api--input--syslog_tcp--tls_enable) * [`tls_key_file`](#-graylog_api--input--syslog_tcp--tls_key_file) * [`tls_key_password`](#-graylog_api--input--syslog_tcp--tls_key_password) -* [`use_null_delimiter`](#-graylog_api--input--syslog_tcp--use_null_delimiter) ##### `ensure` @@ -1423,11 +1407,6 @@ Whether this input should exist. Default value: `'present'` -##### `allow_override_date` - -Whether to allow setting the message timestamp to the current server time, -if the timstamp in the message failed to parse. Defaults to true. - ##### `bind_address` Data type: `String` @@ -1436,18 +1415,6 @@ The IP address to listen on. Defaults to 0.0.0.0. Default value: `'0.0.0.0'` -##### `expand_structured_data` - -Whether to expand structured data elements by prefixing attributes with -their SD-ID. Defaults to true. - -##### `force_rdns` - -Whether to force reverse DNS resolution of sender's hostname. Use if the -hostname in the message cannot be parsed. Default value is false. -NOTE: Be careful with this setting if you are sending DNS server logs into -this input as it can cause a feedback loop. - ##### `override_source` Data type: `Optional[String]` @@ -1493,11 +1460,6 @@ Static fields to assign to this input. Default value: `undef` -##### `store_full_message` - -Whether to store the full original syslog message as full_message. Defaults -to true. - ##### `tcp_keepalive` Data type: `Boolean` @@ -1565,11 +1527,6 @@ blank if not using TLS, or if the key is not encrypted. Default value: `''` -##### `use_null_delimiter` - -Whether to use a null byte as a frame delimiter. If false, a newline is -used as the delimiter instead. - ### `graylog_api::input::syslog_udp` Defines an input accepting Syslog messages over UDP. @@ -3313,7 +3270,7 @@ usually discover the appropriate provider for your platform. ### `Graylog_api::Pipeline::Stage` -The Graylog_api::Pipeline::Stage data type. +Custom Type for Graylog_api pipeline stage Alias of @@ -3326,7 +3283,7 @@ Struct[{ ### `Graylog_api::Pipeline::Stage::Loose` -The Graylog_api::Pipeline::Stage::Loose data type. +custom type for graylog_api pipeline stage loose Alias of `Variant[Graylog_api::Pipeline::Stage, Array[String,1], String]` diff --git a/lib/puppet/provider/graylog_api/graylog_api.rb b/lib/puppet/provider/graylog_api/graylog_api.rb index 535265a..1dea013 100644 --- a/lib/puppet/provider/graylog_api/graylog_api.rb +++ b/lib/puppet/provider/graylog_api/graylog_api.rb @@ -7,6 +7,7 @@ require 'httparty' if Puppet.features.httparty? Puppet::Type.type(:graylog_api).provide(:graylog_api) do + @doc = "Graylog Api base type" confine feature: :retries confine feature: :httparty diff --git a/lib/puppet/provider/graylog_dashboard/graylog_api.rb b/lib/puppet/provider/graylog_dashboard/graylog_api.rb index 91cc054..f9269a2 100644 --- a/lib/puppet/provider/graylog_dashboard/graylog_api.rb +++ b/lib/puppet/provider/graylog_dashboard/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_dashboard).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog dashboard" mk_resource_methods attr_accessor :widgets diff --git a/lib/puppet/provider/graylog_dashboard_layout/graylog_api.rb b/lib/puppet/provider/graylog_dashboard_layout/graylog_api.rb index df67c68..ef1a1c5 100644 --- a/lib/puppet/provider/graylog_dashboard_layout/graylog_api.rb +++ b/lib/puppet/provider/graylog_dashboard_layout/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_dashboard_layout).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog dashboard layout" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_dashboard_widget/graylog_api.rb b/lib/puppet/provider/graylog_dashboard_widget/graylog_api.rb index 7304878..74eda14 100644 --- a/lib/puppet/provider/graylog_dashboard_widget/graylog_api.rb +++ b/lib/puppet/provider/graylog_dashboard_widget/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_dashboard_widget).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog dashboard widget" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_extractor/graylog_api.rb b/lib/puppet/provider/graylog_extractor/graylog_api.rb index 4769163..5235bd9 100644 --- a/lib/puppet/provider/graylog_extractor/graylog_api.rb +++ b/lib/puppet/provider/graylog_extractor/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_extractor).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog extractor" EXTRACTOR_TYPES = { copy_input: 'COPY_INPUT', grok: 'GROK', diff --git a/lib/puppet/provider/graylog_grok_pattern/graylog_api.rb b/lib/puppet/provider/graylog_grok_pattern/graylog_api.rb index 1aa4a5e..7581198 100644 --- a/lib/puppet/provider/graylog_grok_pattern/graylog_api.rb +++ b/lib/puppet/provider/graylog_grok_pattern/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_grok_pattern).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog grok pattern" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_index_set/graylog_api.rb b/lib/puppet/provider/graylog_index_set/graylog_api.rb index 6c332c2..a3b4efa 100644 --- a/lib/puppet/provider/graylog_index_set/graylog_api.rb +++ b/lib/puppet/provider/graylog_index_set/graylog_api.rb @@ -2,6 +2,7 @@ require 'date' Puppet::Type.type(:graylog_index_set).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog index set" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_input/graylog_api.rb b/lib/puppet/provider/graylog_input/graylog_api.rb index 20dc53d..8fb51cd 100644 --- a/lib/puppet/provider/graylog_input/graylog_api.rb +++ b/lib/puppet/provider/graylog_input/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_input).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog input" INPUT_TYPES = { gelf_tcp: 'org.graylog2.inputs.gelf.tcp.GELFTCPInput', gelf_udp: 'org.graylog2.inputs.gelf.udp.GELFUDPInput', diff --git a/lib/puppet/provider/graylog_ldap_settings/graylog_api.rb b/lib/puppet/provider/graylog_ldap_settings/graylog_api.rb index 8895925..7c4c1bb 100644 --- a/lib/puppet/provider/graylog_ldap_settings/graylog_api.rb +++ b/lib/puppet/provider/graylog_ldap_settings/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_ldap_settings).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog ldap settings" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_lookup_adapter/graylog_api.rb b/lib/puppet/provider/graylog_lookup_adapter/graylog_api.rb index 94605fa..6837ffc 100644 --- a/lib/puppet/provider/graylog_lookup_adapter/graylog_api.rb +++ b/lib/puppet/provider/graylog_lookup_adapter/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_lookup_adapter).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog lookup adapter" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_lookup_cache/graylog_api.rb b/lib/puppet/provider/graylog_lookup_cache/graylog_api.rb index 45c3a89..eac19ae 100644 --- a/lib/puppet/provider/graylog_lookup_cache/graylog_api.rb +++ b/lib/puppet/provider/graylog_lookup_cache/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_lookup_cache).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog lookup cache" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_lookup_table/graylog_api.rb b/lib/puppet/provider/graylog_lookup_table/graylog_api.rb index 945d709..ed98699 100644 --- a/lib/puppet/provider/graylog_lookup_table/graylog_api.rb +++ b/lib/puppet/provider/graylog_lookup_table/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_lookup_table).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog lookup table" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_pipeline/graylog_api.rb b/lib/puppet/provider/graylog_pipeline/graylog_api.rb index fa28636..fa2566c 100644 --- a/lib/puppet/provider/graylog_pipeline/graylog_api.rb +++ b/lib/puppet/provider/graylog_pipeline/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_pipeline).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog pipeline" mk_resource_methods def self.api_prefix diff --git a/lib/puppet/provider/graylog_pipeline_rule/graylog_api.rb b/lib/puppet/provider/graylog_pipeline_rule/graylog_api.rb index 4f5dab1..388c4f7 100644 --- a/lib/puppet/provider/graylog_pipeline_rule/graylog_api.rb +++ b/lib/puppet/provider/graylog_pipeline_rule/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_pipeline_rule).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog pipeline rule" mk_resource_methods def self.api_prefix diff --git a/lib/puppet/provider/graylog_plugin_auth_sso/graylog_api.rb b/lib/puppet/provider/graylog_plugin_auth_sso/graylog_api.rb index 0cb6462..0fd0d1f 100644 --- a/lib/puppet/provider/graylog_plugin_auth_sso/graylog_api.rb +++ b/lib/puppet/provider/graylog_plugin_auth_sso/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_plugin_auth_sso).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog plugin auth sso" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_role/graylog_api.rb b/lib/puppet/provider/graylog_role/graylog_api.rb index 8aea212..2d6b42d 100644 --- a/lib/puppet/provider/graylog_role/graylog_api.rb +++ b/lib/puppet/provider/graylog_role/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_role).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog role" mk_resource_methods attr_writer :permission_cache diff --git a/lib/puppet/provider/graylog_stream/graylog_api.rb b/lib/puppet/provider/graylog_stream/graylog_api.rb index 75f4b7e..31e860c 100644 --- a/lib/puppet/provider/graylog_stream/graylog_api.rb +++ b/lib/puppet/provider/graylog_stream/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_stream).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog stream" mk_resource_methods def self.instances diff --git a/lib/puppet/provider/graylog_user/graylog_api.rb b/lib/puppet/provider/graylog_user/graylog_api.rb index 26457c4..f385c1e 100644 --- a/lib/puppet/provider/graylog_user/graylog_api.rb +++ b/lib/puppet/provider/graylog_user/graylog_api.rb @@ -1,6 +1,7 @@ require_relative '../graylog_api' Puppet::Type.type(:graylog_user).provide(:graylog_api, parent: Puppet::Provider::GraylogAPI) do + @doc = "graylog api type for graylog user" mk_resource_methods def self.instances diff --git a/manifests/extractor/regex_replace.pp b/manifests/extractor/regex_replace.pp index f104591..770f3a6 100644 --- a/manifests/extractor/regex_replace.pp +++ b/manifests/extractor/regex_replace.pp @@ -13,7 +13,7 @@ # @param target_field # Choose a field name to store the extracted value. It can only contain alphanumeric characters and underscores. Example: http_response_code. # -# @param regex_value +# @param regex # Title of the input this extractor is attached to. # # @param cut_or_copy diff --git a/manifests/input/cef_udp.pp b/manifests/input/cef_udp.pp index 42cca15..90ab887 100644 --- a/manifests/input/cef_udp.pp +++ b/manifests/input/cef_udp.pp @@ -40,9 +40,6 @@ # Whether to use full field names in CEF messages (as defined in the CEF # specification). # -# @param use_null_delimiter -# Whether to use a null byte as a frame delimiter. If false, a newline is -# used as the delimiter instead. define graylog_api::input::cef_udp ( Enum['present','absent'] $ensure = 'present', String $bind_address = '0.0.0.0', diff --git a/manifests/input/syslog_tcp.pp b/manifests/input/syslog_tcp.pp index 20a6956..338c7c0 100644 --- a/manifests/input/syslog_tcp.pp +++ b/manifests/input/syslog_tcp.pp @@ -6,23 +6,9 @@ # @param ensure # Whether this input should exist. # -# @param allow_override_date -# Whether to allow setting the message timestamp to the current server time, -# if the timstamp in the message failed to parse. Defaults to true. -# # @param bind_address # The IP address to listen on. Defaults to 0.0.0.0. # -# @param expand_structured_data -# Whether to expand structured data elements by prefixing attributes with -# their SD-ID. Defaults to true. -# -# @param force_rdns -# Whether to force reverse DNS resolution of sender's hostname. Use if the -# hostname in the message cannot be parsed. Default value is false. -# NOTE: Be careful with this setting if you are sending DNS server logs into -# this input as it can cause a feedback loop. -# # @param override_source # The source is a hostname derived from the received packet by default. Set # this if you want to override it with a custom string. @@ -43,10 +29,6 @@ # @param static_fields # Static fields to assign to this input. # -# @param store_full_message -# Whether to store the full original syslog message as full_message. Defaults -# to true. -# # @param tcp_keepalive # Whether to enable TCP keepalive packets. # @@ -79,9 +61,6 @@ # The password to decrypt to private key specified in tls_key_file. Leave # blank if not using TLS, or if the key is not encrypted. # -# @param use_null_delimiter -# Whether to use a null byte as a frame delimiter. If false, a newline is -# used as the delimiter instead. define graylog_api::input::syslog_tcp ( Enum['present','absent'] $ensure = 'present', String $bind_address = '0.0.0.0', @@ -104,14 +83,10 @@ scope => $scope, static_fields => $static_fields, configuration => { - allow_override_date => $allow_override_date, bind_address => $bind_address, - expand_structured_data => $expand_structured_data, - force_rdns => $force_rdns, recv_buffer_size => $recv_buffer_size, override_source => $override_source, port => $port, - store_full_message => $store_full_message, tcp_keepalive => $tcp_keepalive, tls_cert_file => $tls_cert_file, tls_client_auth => $tls_client_auth, @@ -119,7 +94,6 @@ tls_enable => $tls_enable, tls_key_file => $tls_key_file, tls_key_password => $tls_key_password, - use_null_delimiter => $use_null_delimiter, }, } } diff --git a/types/pipeline/stage.pp b/types/pipeline/stage.pp index 499f57a..cb66d1d 100644 --- a/types/pipeline/stage.pp +++ b/types/pipeline/stage.pp @@ -1,3 +1,5 @@ +# @summary Custom Type for Graylog_api pipeline stage +# type Graylog_api::Pipeline::Stage = Struct[{ match => Enum['all','either'], rules => Array[String,1], diff --git a/types/pipeline/stage/loose.pp b/types/pipeline/stage/loose.pp index 3d6d6ae..3c263a4 100644 --- a/types/pipeline/stage/loose.pp +++ b/types/pipeline/stage/loose.pp @@ -1,3 +1,5 @@ +# @summary custom type for graylog_api pipeline stage loose +# type Graylog_api::Pipeline::Stage::Loose = Variant[ Graylog_api::Pipeline::Stage, Array[String,1],