configpb

Documentation

Overview

Package configpb contains definition of CIPD client config schema.

Index

• Variables
• type ClientConfig
  • func (*ClientConfig) Descriptor() ([]byte, []int)
  • func (x *ClientConfig) GetPlugins() *ClientConfig_Plugins
  • func (*ClientConfig) ProtoMessage()
  • func (x *ClientConfig) ProtoReflect() protoreflect.Message
  • func (x *ClientConfig) Reset()
  • func (x *ClientConfig) String() string
• type ClientConfig_Plugins
  • func (*ClientConfig_Plugins) Descriptor() ([]byte, []int)
  • func (x *ClientConfig_Plugins) GetAdmission() *Plugin
  • func (*ClientConfig_Plugins) ProtoMessage()
  • func (x *ClientConfig_Plugins) ProtoReflect() protoreflect.Message
  • func (x *ClientConfig_Plugins) Reset()
  • func (x *ClientConfig_Plugins) String() string
• type Plugin
  • func (*Plugin) Descriptor() ([]byte, []int)
  • func (x *Plugin) GetArgs() []string
  • func (x *Plugin) GetCmd() string
  • func (*Plugin) ProtoMessage()
  • func (x *Plugin) ProtoReflect() protoreflect.Message
  • func (x *Plugin) Reset()
  • func (x *Plugin) String() string

Variables

var File_go_chromium_org_luci_cipd_client_cipd_configpb_config_proto protoreflect.FileDescriptor

Types

type ClientConfig

type ClientConfig struct {
	Plugins *ClientConfig_Plugins `protobuf:"bytes,1,opt,name=plugins,proto3" json:"plugins,omitempty"`
	// contains filtered or unexported fields
}

Schema of a CIPD client configuration file.

The configuration file is a text-proto encoded ClientConfig message which CIPD client reads from `/etc/chrome-infra/cipd.cfg` (Linux and OSX) or `C:\chrome-infra\cipd.cfg` (Windows).

If there's CIPD_CONFIG_FILE env var present and not empty, it defines where to read the config file from instead. A special value `-` means just to skip reading the default config file.

Any explicitly passed CLI flags or `CIPD_*` env vars take precedence over what's in the config file.

If the config file is present, but can't be read or parsed, all CIPD client calls will fail.

func (*ClientConfig) Descriptor

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

Deprecated: Use ClientConfig.ProtoReflect.Descriptor instead.

func (*ClientConfig) GetPlugins

func (x *ClientConfig) GetPlugins() *ClientConfig_Plugins

func (*ClientConfig) ProtoMessage

func (*ClientConfig) ProtoMessage()

func (*ClientConfig) ProtoReflect

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

func (*ClientConfig) Reset

func (x *ClientConfig) Reset()

func (*ClientConfig) String

func (x *ClientConfig) String() string

type ClientConfig_Plugins

type ClientConfig_Plugins struct {

	// Admission plugin decides if it's OK to install packages.
	Admission *Plugin `protobuf:"bytes,1,opt,name=admission,proto3" json:"admission,omitempty"`
	// contains filtered or unexported fields
}

Plugins the CIPD client will load.

func (*ClientConfig_Plugins) Descriptor

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

Deprecated: Use ClientConfig_Plugins.ProtoReflect.Descriptor instead.

func (*ClientConfig_Plugins) GetAdmission

func (x *ClientConfig_Plugins) GetAdmission() *Plugin

func (*ClientConfig_Plugins) ProtoMessage

func (*ClientConfig_Plugins) ProtoMessage()

func (*ClientConfig_Plugins) ProtoReflect

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

func (*ClientConfig_Plugins) Reset

func (x *ClientConfig_Plugins) Reset()

func (*ClientConfig_Plugins) String

func (x *ClientConfig_Plugins) String() string

type Plugin

type Plugin struct {

	// Path to the plugin binary to execute. Required.
	Cmd string `protobuf:"bytes,1,opt,name=cmd,proto3" json:"cmd,omitempty"`
	// Additional command line arguments to pass to the plugin binary, if any.
	Args []string `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

Plugin defines how to execute a plugin subprocess.

func (*Plugin) Descriptor

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

Deprecated: Use Plugin.ProtoReflect.Descriptor instead.

func (*Plugin) GetArgs

func (x *Plugin) GetArgs() []string

func (*Plugin) GetCmd

func (x *Plugin) GetCmd() string

func (*Plugin) ProtoMessage

func (*Plugin) ProtoMessage()

func (*Plugin) ProtoReflect

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

func (*Plugin) Reset

func (x *Plugin) Reset()

func (*Plugin) String

func (x *Plugin) String() string