hosts

Documentation

Overview

Package hosts defines a LUCI Server module used to configure the hostnames of the services LUCI Analysis communicates with in a deplpoyment.

Index

• Variables
• func APIHost(ctx context.Context) (string, error)
• func NewModule(opts *ModuleOptions) module.Module
• func NewModuleFromFlags() module.Module
• func UseHosts(ctx context.Context, config ModuleOptions) context.Context
• type ModuleOptions
  • func (o *ModuleOptions) Register(f *flag.FlagSet)

Variables

var ModuleName = module.RegisterName("go.chromium.org/luci/analysis/internal/hosts")

ModuleName can be used to refer to this module when declaring dependencies.

Functions

func APIHost

func APIHost(ctx context.Context) (string, error)

APIHost returns the hostname of the LUCI Analysis pRPC client. E.g. "analysis.api.luci.app".

func NewModule

func NewModule(opts *ModuleOptions) module.Module

NewModule returns a server module that adds authentication settings to the context.

func NewModuleFromFlags

func NewModuleFromFlags() module.Module

NewModuleFromFlags is a variant of NewModule that initializes options through command line flags.

Calling this function registers flags in flag.CommandLine. They are usually parsed in server.Main(...).

func UseHosts

func UseHosts(ctx context.Context, config ModuleOptions) context.Context

UseHosts installs the configures hosts into the context.

Types

type ModuleOptions

type ModuleOptions struct {
	// The hostname to use for pRPC requests to LUCI Analysis (e.g. from UI).
	APIHost string
}

ModuleOptions contain configuration of the Hosts server module.

func (*ModuleOptions) Register

func (o *ModuleOptions) Register(f *flag.FlagSet)

Register registers the command line flags.