config

Documentation

Overview

Package config contains the service configuration protos.

Index

• Variables
• func AssignmentDuration(ctx context.Context) time.Duration
• func Import(ctx context.Context) error
• func Instance(ctx context.Context) string
• func Middleware(ctx *router.Context, next router.Handler)
• func Use(ctx context.Context, c *Config) context.Context
• type AccessGroups
  • func (*AccessGroups) Descriptor() ([]byte, []int)
  • func (x *AccessGroups) GetDrones() string
  • func (x *AccessGroups) GetInspectors() string
  • func (x *AccessGroups) GetInventoryProviders() string
  • func (*AccessGroups) ProtoMessage()
  • func (x *AccessGroups) ProtoReflect() protoreflect.Message
  • func (x *AccessGroups) Reset()
  • func (x *AccessGroups) String() string
• type Config
  • func Get(ctx context.Context) *Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (x *Config) GetAccessGroups() *AccessGroups
  • func (x *Config) GetAssignmentDuration() *durationpb.Duration
  • func (x *Config) GetInstance() string
  • func (*Config) ProtoMessage()
  • func (x *Config) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (x *Config) String() string

Variables

var File_infra_appengine_drone_queen_internal_config_config_proto protoreflect.FileDescriptor

Functions

func AssignmentDuration

func AssignmentDuration(ctx context.Context) time.Duration

AssignmentDuration returns the configured drone assignment duration.

func Import

func Import(ctx context.Context) error

Import fetches the most recent config and stores it in the datastore.

Must be called periodically to make sure Get and Middleware use the freshest config.

func Instance

func Instance(ctx context.Context) string

Instance returns the configured instance of the service.

func Middleware

func Middleware(ctx *router.Context, next router.Handler)

Middleware loads the service config and installs it into the context.

func Use

func Use(ctx context.Context, c *Config) context.Context

Use installs the config into ctx.

Types

type AccessGroups

type AccessGroups struct {

	// drones is the group for calling drone RPCs.
	Drones string `protobuf:"bytes,1,opt,name=drones,proto3" json:"drones,omitempty"`
	// inventory_providers is the group for calling inventory RPCs.
	InventoryProviders string `protobuf:"bytes,2,opt,name=inventory_providers,json=inventoryProviders,proto3" json:"inventory_providers,omitempty"`
	// inspectors is the group for calling inspection RPCs.
	Inspectors string `protobuf:"bytes,3,opt,name=inspectors,proto3" json:"inspectors,omitempty"`
	// contains filtered or unexported fields
}

AccessGroups holds access group configuration

func (*AccessGroups) Descriptor

func (*AccessGroups) Descriptor() ([]byte, []int)

Deprecated: Use AccessGroups.ProtoReflect.Descriptor instead.

func (*AccessGroups) GetDrones

func (x *AccessGroups) GetDrones() string

func (*AccessGroups) GetInspectors

func (x *AccessGroups) GetInspectors() string

func (*AccessGroups) GetInventoryProviders

func (x *AccessGroups) GetInventoryProviders() string

func (*AccessGroups) ProtoMessage

func (*AccessGroups) ProtoMessage()

func (*AccessGroups) ProtoReflect

func (x *AccessGroups) ProtoReflect() protoreflect.Message

func (*AccessGroups) Reset

func (x *AccessGroups) Reset()

func (*AccessGroups) String

func (x *AccessGroups) String() string

type Config

type Config struct {

	// access_groups are the luci-auth groups controlling access to RPC endpoints.
	AccessGroups *AccessGroups `protobuf:"bytes,1,opt,name=access_groups,json=accessGroups,proto3" json:"access_groups,omitempty"`
	// assignment_duration is the duration before expiration for drone
	// assignments.
	AssignmentDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=assignment_duration,json=assignmentDuration,proto3" json:"assignment_duration,omitempty"`
	// instance identifies which instance of the service this is.  For
	// example, this could be prod for the prod instance.
	Instance string `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
	// contains filtered or unexported fields
}

Config is the configuration data served by luci-config for this app.

func Get

func Get(ctx context.Context) *Config

Get gets the config in the context. If the context does not have a config, return a nil config.

See also Use and Middleware.

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetAccessGroups

func (x *Config) GetAccessGroups() *AccessGroups

func (*Config) GetAssignmentDuration

func (x *Config) GetAssignmentDuration() *durationpb.Duration

func (*Config) GetInstance

func (x *Config) GetInstance() string

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string