cmd

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func Run(flags *Flags, opts ...Option)
• type Config
• type Flags
  • func ParseFlags() *Flags
• type Option
  • func WithConfig(c Config) Option
  • func WithLogger(l *zap.Logger) Option
  • func WithMetrics(s tally.Scope) Option

Functions

func Run

func Run(flags *Flags, opts ...Option)

Run runs the build-index.

Types

type Config

type Config struct {
	ZapLogging     zap.Config                   `yaml:"zap"`
	Metrics        metrics.Config               `yaml:"metrics"`
	Backends       []backend.Config             `yaml:"backends"`
	Auth           backend.AuthConfig           `yaml:"auth"`
	TagServer      tagserver.Config             `yaml:"tagserver"`
	Remotes        tagreplication.RemotesConfig `yaml:"remotes"`
	TagReplication persistedretry.Config        `yaml:"tag_replication"`
	TagTypes       []tagtype.Config             `yaml:"tag_types"`
	Origin         upstream.ActiveConfig        `yaml:"origin"`
	LocalDB        localdb.Config               `yaml:"localdb"`
	Cluster        upstream.ActiveConfig        `yaml:"cluster"`
	TagStore       tagstore.Config              `yaml:"tag_store"`
	Store          store.SimpleStoreConfig      `yaml:"store"`
	WriteBack      persistedretry.Config        `yaml:"writeback"`
	Nginx          nginx.Config                 `yaml:"nginx"`
	TLS            httputil.TLSConfig           `yaml:"tls"`
}

Config defines build-index configuration.

type Flags

type Flags struct {
	Port          int
	ConfigFile    string
	KrakenCluster string
	SecretsFile   string
}

Flags defines build-index CLI flags.

func ParseFlags

func ParseFlags() *Flags

ParseFlags parses build-index CLI flags.

type Option

type Option func(*options)

Option defines an optional Run parameter.

func WithConfig

func WithConfig(c Config) Option

WithConfig ignores config/secrets flags and directly uses the provided config struct.

func WithLogger

func WithLogger(l *zap.Logger) Option

WithLogger ignores logging config and directly uses the provided logger.

func WithMetrics

func WithMetrics(s tally.Scope) Option

WithMetrics ignores metrics config and directly uses the provided tally scope.