api

Documentation

Index

• Variables
• type Config
• type Service
  • func New(cfg *Config) *Service
  • func (s *Service) FlagSet() *run.FlagSet
  • func (s *Service) GracefulStop()
  • func (s *Service) Name() string
  • func (s *Service) PreRun() (err error)
  • func (s *Service) Serve() error
  • func (s *Service) Validate() error

Variables

var (
	// Default binary version.
	DefaultBinaryVersion = "1.21.0"
	// Default download timeout.
	DefaultDownloadTimeout = 30 * time.Second
)

Types

type Config

type Config struct {
	Version string
	// Location where the binary will be downloaded.
	Dir         string
	Logger      telemetry.Logger
	ProxyConfig *bootstrapv3.Bootstrap
}

Config holds the configuration object for running auth_server.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service is a run.Service implementation that runs auth_server.

func New

func New(cfg *Config) *Service

New returns a new run.Service that wraps auth_server binary. Setting the cfg to nil, expecting setting the auth_server's --filter_config from a file.

func (*Service) FlagSet

func (s *Service) FlagSet() *run.FlagSet

FlagSet provides command line flags for external auth-service.

func (*Service) GracefulStop

func (s *Service) GracefulStop()

GracefulStop stops the underlying process by sending interrupt.

func (*Service) Name

func (s *Service) Name() string

Name returns the service name.

func (*Service) PreRun

func (s *Service) PreRun() (err error)

PreRun prepares the biany to run.

func (*Service) Serve

func (s *Service) Serve() error

Serve runs the binary.

func (*Service) Validate

func (s *Service) Validate() error

Validate validates the given configuration.