module Fluent::KafkaPluginUtil::SaslSettings

Public Class Methods

included(klass) click to toggle source
# File lib/fluent/plugin/kafka_plugin_util.rb, line 36
def self.included(klass)
  klass.instance_eval {
    config_param :principal, :string, :default => nil,
                 :desc => "a Kerberos principal to use with SASL authentication (GSSAPI)."
    config_param :keytab, :string, :default => nil,
                 :desc => "a filepath to Kerberos keytab. Must be used with principal."
    config_param :username, :string, :default => nil,
                 :desc => "a username when using PLAIN/SCRAM SASL authentication"
    config_param :password, :string, :default => nil, secret: true,
                 :desc => "a password when using PLAIN/SCRAM SASL authentication"
    config_param :scram_mechanism, :string, :default => nil,
                 :desc => "if set, use SCRAM authentication with specified mechanism. When unset, default to PLAIN authentication"
  }
end