conf

Documentation

Index

• Constants
• Variables
• type Config
  • func Load(filename string) *Config
• type ConfigType
• type CrawlerDefinition
• type DataSourceDefinition
• type KerberosDetails
• type TLSDetails

Constants

const (
	// Crawler ... crawler agent config type
	Crawler ConfigType = "crawler"
	// Catalogue ... catalogue config type
	Catalogue = "catalogue"
	// FeatureStore ... featurestore config type
	FeatureStore = "featurestore"
	// MVC config type
	Mvc = "mvc"
)

Variables

var Args struct {
	Config string `required:"true" arg:"-c,required"`
}

Args ... Arguments provided either as env vars or string args

Types

type Config

type Config struct {
	ConfigType           ConfigType           `yaml:"type"`
	Details              map[string]string    `yaml:"details,omitempty"`
	DataSourceDefinition DataSourceDefinition `yaml:"backend"`
}

Config ... Defines a model for the input config files

func Load

func Load(filename string) *Config

Load ... load configuration from file path

type ConfigType

type ConfigType string

ConfigType ... config type

type CrawlerDefinition

type CrawlerDefinition struct {
	CatalogueEndpoint string  `yaml:"catalogue-endpoint"`
	Root              string  `yaml:"root"`
	FilterFilename    string  `yaml:"filter-filename"`
	Schedule          *string `yaml:"schedule,omitempty"`
	StartNow          *bool   `yaml:"start-now,omitempty"`
}

CrawlerDefinition ... Config for a Crawler service

type DataSourceDefinition

type DataSourceDefinition struct {
	Name              string            `yaml:"name"`
	Type              string            `yaml:"type"`
	CrawlerDefinition CrawlerDefinition `yaml:"crawler,omitempty"`
	Settings          map[string]string `yaml:"settings,omitempty"`
	// optional kerberos section
	KerberosDetails *KerberosDetails `yaml:"kerberos"`
	// optional tls section
	TLSDetails *TLSDetails `yaml:"tls"`
}

DataSourceDefinition ... connection details for a data source connector

type KerberosDetails

type KerberosDetails struct {
	KrbConfigPath   string `yaml:"krb-config-path,omitempty"`
	SASLMechanism   string `yaml:"sasl-mech,omitempty"`
	EnableSASL      bool   `yaml:"enable-sasl,omitempty"`
	ServiceName     string `yaml:"service-name,omitempty"`
	Realm           string `yaml:"realm,omitempty"`
	Username        string `yaml:"username,omitempty"`
	AuthType        int    `yaml:"auth-type,omitempty"`
	Password        string `yaml:"password,omitempty"`
	KeytabPath      string `yaml:"keytab-path,omitempty"`
	DisablePAFXFAST bool   `yaml:"disable-pafx-fast,omitempty"`
}

KerberosDetails ... Connection details for Kerberos

type TLSDetails

type TLSDetails struct {
	Enable             bool   `yaml:"enable,omitempty"`
	InsecureSkipVerify bool   `yaml:"insecure-skip-verify,omitempty"`
	ClientCertFile     string `yaml:"client-cert-file"`
	ClientKeyFile      string `yaml:"client-key-file"`
	CaCertFile         string `yaml:"ca-cert-file"`
}

TLSDetails ... TLS Connection details