config

Documentation

Index

• Constants
• type Config
  • func Get() (*Config, error)
• type KafkaConfig

Constants

const KafkaTLSProtocolFlag = "TLS"

Types

type Config

type Config struct {
	AWSRegion                  string        `envconfig:"AWS_REGION"`
	BindAddr                   string        `envconfig:"BIND_ADDR"`
	CantabularExtURL           string        `envconfig:"CANTABULAR_API_EXT_URL"`
	CantabularURL              string        `envconfig:"CANTABULAR_URL"`
	ComponentTestUseLogFile    bool          `envconfig:"COMPONENT_TEST_USE_LOG_FILE"`
	DatasetAPIURL              string        `envconfig:"DATASET_API_URL"`
	DefaultRequestTimeout      time.Duration `envconfig:"DEFAULT_REQUEST_TIMEOUT"`
	DownloadServiceURL         string        `envconfig:"DOWNLOAD_SERVICE_URL"`
	EncryptionDisabled         bool          `envconfig:"ENCRYPTION_DISABLED"`
	GracefulShutdownTimeout    time.Duration `envconfig:"GRACEFUL_SHUTDOWN_TIMEOUT"`
	ExternalPrefixURL          string        `envconfig:"EXTERNAL_PREFIX_URL"`
	FilterAPIURL               string        `envconfig:"FILTER_API_URL"`
	HealthCheckCriticalTimeout time.Duration `envconfig:"HEALTHCHECK_CRITICAL_TIMEOUT"`
	HealthCheckInterval        time.Duration `envconfig:"HEALTHCHECK_INTERVAL"`
	Kafka                      KafkaConfig
	LocalObjectStore           string        `envconfig:"LOCAL_OBJECT_STORE"`
	MinioAccessKey             string        `envconfig:"MINIO_ACCESS_KEY"                           json:"-"`
	MinioSecretKey             string        `envconfig:"MINIO_SECRET_KEY"                           json:"-"`
	OTExporterOTLPEndpoint     string        `envconfig:"OTEL_EXPORTER_OTLP_ENDPOINT"`
	OTServiceName              string        `envconfig:"OTEL_SERVICE_NAME"`
	OTBatchTimeout             time.Duration `envconfig:"OTEL_BATCH_TIMEOUT"`
	OtelEnabled                bool          `envconfig:"OTEL_ENABLED"`
	PopulationTypesAPIURL      string        `envconfig:"POPULATION_TYPES_API_URL"`
	PublicBucket               string        `envconfig:"PUBLIC_BUCKET"`
	PrivateBucket              string        `envconfig:"PRIVATE_BUCKET"`
	ServiceAuthToken           string        `envconfig:"SERVICE_AUTH_TOKEN"                         json:"-"`
	StopConsumingOnUnhealthy   bool          `envconfig:"STOP_CONSUMING_ON_UNHEALTHY"`
	S3BucketURL                string        `envconfig:"PUBLIC_URL"`
	S3PublicURL                string        `envconfig:"S3_PUBLIC_URL"`
	VaultAddress               string        `envconfig:"VAULT_ADDR"`
	VaultPath                  string        `envconfig:"VAULT_PATH"`
	VaultToken                 string        `envconfig:"VAULT_TOKEN"                                json:"-"`
}

Config represents service configuration for dp-cantabular-metadata-exporter

func Get

func Get() (*Config, error)

Get returns the default config with any modifications through environment variables

type KafkaConfig

type KafkaConfig struct {
	Addr                          []string `envconfig:"KAFKA_ADDR"                            json:"-"`
	CantabularCSVCreatedTopic     string   `envconfig:"KAFKA_TOPIC_CANTABULAR_CSV_CREATED"`
	CantabularCSVWCreatedTopic    string   `envconfig:"KAFKA_TOPIC_CANTABULAR_CSVW_CREATED"`
	CantabularMetadataExportGroup string   `envconfig:"KAFKA_GROUP_CANTABULAR_METADATA_EXPORT"`
	ConsumerMinBrokersHealthy     int      `envconfig:"KAFKA_CONSUMER_MIN_BROKERS_HEALTHY"`
	MaxBytes                      int      `envconfig:"KAFKA_MAX_BYTES"`
	NumWorkers                    int      `envconfig:"KAFKA_NUM_WORKERS"`
	OffsetOldest                  bool     `envconfig:"KAFKA_OFFSET_OLDEST"`
	ProducerMinBrokersHealthy     int      `envconfig:"KAFKA_PRODUCER_MIN_BROKERS_HEALTHY"`
	SecCACerts                    string   `envconfig:"KAFKA_SEC_CA_CERTS"`
	SecClientCert                 string   `envconfig:"KAFKA_SEC_CLIENT_CERT"`
	SecClientKey                  string   `envconfig:"KAFKA_SEC_CLIENT_KEY"                  json:"-"`
	SecProtocol                   string   `envconfig:"KAFKA_SEC_PROTO"`
	SecSkipVerify                 bool     `envconfig:"KAFKA_SEC_SKIP_VERIFY"`
	Version                       string   `envconfig:"KAFKA_VERSION"`
}

KafkaConfig contains the config required to connect to Kafka