Documentation ¶
Index ¶
- type AuthSettings
- func (*AuthSettings) Descriptor() ([]byte, []int)
- func (m *AuthSettings) GetAdminsGroup() string
- func (m *AuthSettings) GetBotBootstrapGroup() string
- func (m *AuthSettings) GetPrivilegedUsersGroup() string
- func (m *AuthSettings) GetUsersGroup() string
- func (m *AuthSettings) GetViewAllBotsGroup() string
- func (m *AuthSettings) GetViewAllTasksGroup() string
- func (*AuthSettings) ProtoMessage()
- func (m *AuthSettings) Reset()
- func (m *AuthSettings) String() string
- func (m *AuthSettings) XXX_DiscardUnknown()
- func (m *AuthSettings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *AuthSettings) XXX_Merge(src proto.Message)
- func (m *AuthSettings) XXX_Size() int
- func (m *AuthSettings) XXX_Unmarshal(b []byte) error
- type BotAuth
- func (*BotAuth) Descriptor() ([]byte, []int)
- func (m *BotAuth) GetIpWhitelist() string
- func (m *BotAuth) GetLogIfFailed() bool
- func (m *BotAuth) GetRequireGceVmToken() *BotAuth_GCE
- func (m *BotAuth) GetRequireLuciMachineToken() bool
- func (m *BotAuth) GetRequireServiceAccount() []string
- func (*BotAuth) ProtoMessage()
- func (m *BotAuth) Reset()
- func (m *BotAuth) String() string
- func (m *BotAuth) XXX_DiscardUnknown()
- func (m *BotAuth) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *BotAuth) XXX_Merge(src proto.Message)
- func (m *BotAuth) XXX_Size() int
- func (m *BotAuth) XXX_Unmarshal(b []byte) error
- type BotAuth_GCE
- func (*BotAuth_GCE) Descriptor() ([]byte, []int)
- func (m *BotAuth_GCE) GetProject() string
- func (*BotAuth_GCE) ProtoMessage()
- func (m *BotAuth_GCE) Reset()
- func (m *BotAuth_GCE) String() string
- func (m *BotAuth_GCE) XXX_DiscardUnknown()
- func (m *BotAuth_GCE) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *BotAuth_GCE) XXX_Merge(src proto.Message)
- func (m *BotAuth_GCE) XXX_Size() int
- func (m *BotAuth_GCE) XXX_Unmarshal(b []byte) error
- type BotGroup
- func (*BotGroup) Descriptor() ([]byte, []int)
- func (m *BotGroup) GetAuth() []*BotAuth
- func (m *BotGroup) GetBotConfigScript() string
- func (m *BotGroup) GetBotConfigScriptContent() []byte
- func (m *BotGroup) GetBotId() []string
- func (m *BotGroup) GetBotIdPrefix() []string
- func (m *BotGroup) GetDimensions() []string
- func (m *BotGroup) GetOwners() []string
- func (m *BotGroup) GetSystemServiceAccount() string
- func (*BotGroup) ProtoMessage()
- func (m *BotGroup) Reset()
- func (m *BotGroup) String() string
- func (m *BotGroup) XXX_DiscardUnknown()
- func (m *BotGroup) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *BotGroup) XXX_Merge(src proto.Message)
- func (m *BotGroup) XXX_Size() int
- func (m *BotGroup) XXX_Unmarshal(b []byte) error
- type BotMonitoring
- func (*BotMonitoring) Descriptor() ([]byte, []int)
- func (m *BotMonitoring) GetDimensionKey() []string
- func (m *BotMonitoring) GetName() string
- func (*BotMonitoring) ProtoMessage()
- func (m *BotMonitoring) Reset()
- func (m *BotMonitoring) String() string
- func (m *BotMonitoring) XXX_DiscardUnknown()
- func (m *BotMonitoring) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *BotMonitoring) XXX_Merge(src proto.Message)
- func (m *BotMonitoring) XXX_Size() int
- func (m *BotMonitoring) XXX_Unmarshal(b []byte) error
- type BotsCfg
- func (*BotsCfg) Descriptor() ([]byte, []int)
- func (m *BotsCfg) GetBotGroup() []*BotGroup
- func (m *BotsCfg) GetTrustedDimensions() []string
- func (*BotsCfg) ProtoMessage()
- func (m *BotsCfg) Reset()
- func (m *BotsCfg) String() string
- func (m *BotsCfg) XXX_DiscardUnknown()
- func (m *BotsCfg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *BotsCfg) XXX_Merge(src proto.Message)
- func (m *BotsCfg) XXX_Size() int
- func (m *BotsCfg) XXX_Unmarshal(b []byte) error
- type CipdPackage
- func (*CipdPackage) Descriptor() ([]byte, []int)
- func (m *CipdPackage) GetPackageName() string
- func (m *CipdPackage) GetVersion() string
- func (*CipdPackage) ProtoMessage()
- func (m *CipdPackage) Reset()
- func (m *CipdPackage) String() string
- func (m *CipdPackage) XXX_DiscardUnknown()
- func (m *CipdPackage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CipdPackage) XXX_Merge(src proto.Message)
- func (m *CipdPackage) XXX_Size() int
- func (m *CipdPackage) XXX_Unmarshal(b []byte) error
- type CipdSettings
- func (*CipdSettings) Descriptor() ([]byte, []int)
- func (m *CipdSettings) GetDefaultClientPackage() *CipdPackage
- func (m *CipdSettings) GetDefaultServer() string
- func (*CipdSettings) ProtoMessage()
- func (m *CipdSettings) Reset()
- func (m *CipdSettings) String() string
- func (m *CipdSettings) XXX_DiscardUnknown()
- func (m *CipdSettings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CipdSettings) XXX_Merge(src proto.Message)
- func (m *CipdSettings) XXX_Size() int
- func (m *CipdSettings) XXX_Unmarshal(b []byte) error
- type ExternalSchedulerConfig
- func (*ExternalSchedulerConfig) Descriptor() ([]byte, []int)
- func (m *ExternalSchedulerConfig) GetAddress() string
- func (m *ExternalSchedulerConfig) GetAllDimensions() []string
- func (m *ExternalSchedulerConfig) GetAllowEsFallback() bool
- func (m *ExternalSchedulerConfig) GetAnyDimensions() []string
- func (m *ExternalSchedulerConfig) GetDimensions() []string
- func (m *ExternalSchedulerConfig) GetEnabled() bool
- func (m *ExternalSchedulerConfig) GetFallbackWhenEmpty() booldeprecated
- func (m *ExternalSchedulerConfig) GetId() string
- func (*ExternalSchedulerConfig) ProtoMessage()
- func (m *ExternalSchedulerConfig) Reset()
- func (m *ExternalSchedulerConfig) String() string
- func (m *ExternalSchedulerConfig) XXX_DiscardUnknown()
- func (m *ExternalSchedulerConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ExternalSchedulerConfig) XXX_Merge(src proto.Message)
- func (m *ExternalSchedulerConfig) XXX_Size() int
- func (m *ExternalSchedulerConfig) XXX_Unmarshal(b []byte) error
- type ExternalServices
- func (*ExternalServices) Descriptor() ([]byte, []int)
- func (m *ExternalServices) GetCipd() *ExternalServices_CIPD
- func (m *ExternalServices) GetIsolate() *ExternalServices_Isolate
- func (*ExternalServices) ProtoMessage()
- func (m *ExternalServices) Reset()
- func (m *ExternalServices) String() string
- func (m *ExternalServices) XXX_DiscardUnknown()
- func (m *ExternalServices) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ExternalServices) XXX_Merge(src proto.Message)
- func (m *ExternalServices) XXX_Size() int
- func (m *ExternalServices) XXX_Unmarshal(b []byte) error
- type ExternalServices_CIPD
- func (*ExternalServices_CIPD) Descriptor() ([]byte, []int)
- func (m *ExternalServices_CIPD) GetClientVersion() string
- func (m *ExternalServices_CIPD) GetServer() string
- func (*ExternalServices_CIPD) ProtoMessage()
- func (m *ExternalServices_CIPD) Reset()
- func (m *ExternalServices_CIPD) String() string
- func (m *ExternalServices_CIPD) XXX_DiscardUnknown()
- func (m *ExternalServices_CIPD) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ExternalServices_CIPD) XXX_Merge(src proto.Message)
- func (m *ExternalServices_CIPD) XXX_Size() int
- func (m *ExternalServices_CIPD) XXX_Unmarshal(b []byte) error
- type ExternalServices_Isolate
- func (*ExternalServices_Isolate) Descriptor() ([]byte, []int)
- func (m *ExternalServices_Isolate) GetNamespace() string
- func (m *ExternalServices_Isolate) GetServer() string
- func (*ExternalServices_Isolate) ProtoMessage()
- func (m *ExternalServices_Isolate) Reset()
- func (m *ExternalServices_Isolate) String() string
- func (m *ExternalServices_Isolate) XXX_DiscardUnknown()
- func (m *ExternalServices_Isolate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ExternalServices_Isolate) XXX_Merge(src proto.Message)
- func (m *ExternalServices_Isolate) XXX_Size() int
- func (m *ExternalServices_Isolate) XXX_Unmarshal(b []byte) error
- type IsolateSettings
- func (*IsolateSettings) Descriptor() ([]byte, []int)
- func (m *IsolateSettings) GetDefaultNamespace() string
- func (m *IsolateSettings) GetDefaultServer() string
- func (*IsolateSettings) ProtoMessage()
- func (m *IsolateSettings) Reset()
- func (m *IsolateSettings) String() string
- func (m *IsolateSettings) XXX_DiscardUnknown()
- func (m *IsolateSettings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *IsolateSettings) XXX_Merge(src proto.Message)
- func (m *IsolateSettings) XXX_Size() int
- func (m *IsolateSettings) XXX_Unmarshal(b []byte) error
- type Pool
- func (*Pool) Descriptor() ([]byte, []int)
- func (m *Pool) GetAllowedServiceAccount() []string
- func (m *Pool) GetAllowedServiceAccountGroup() []string
- func (m *Pool) GetBotMonitoring() string
- func (m *Pool) GetExternalSchedulers() []*ExternalSchedulerConfig
- func (m *Pool) GetName() []string
- func (m *Pool) GetOwners() []string
- func (m *Pool) GetSchedulers() *Schedulers
- func (m *Pool) GetTaskDeploymentScheme() isPool_TaskDeploymentScheme
- func (m *Pool) GetTaskTemplateDeployment() string
- func (m *Pool) GetTaskTemplateDeploymentInline() *TaskTemplateDeployment
- func (*Pool) ProtoMessage()
- func (m *Pool) Reset()
- func (m *Pool) String() string
- func (m *Pool) XXX_DiscardUnknown()
- func (m *Pool) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Pool) XXX_Merge(src proto.Message)
- func (*Pool) XXX_OneofWrappers() []interface{}
- func (m *Pool) XXX_Size() int
- func (m *Pool) XXX_Unmarshal(b []byte) error
- type Pool_TaskTemplateDeployment
- type Pool_TaskTemplateDeploymentInline
- type PoolsCfg
- func (*PoolsCfg) Descriptor() ([]byte, []int)
- func (m *PoolsCfg) GetBotMonitoring() []*BotMonitoring
- func (m *PoolsCfg) GetDefaultExternalServices() *ExternalServices
- func (m *PoolsCfg) GetPool() []*Pool
- func (m *PoolsCfg) GetTaskTemplate() []*TaskTemplate
- func (m *PoolsCfg) GetTaskTemplateDeployment() []*TaskTemplateDeployment
- func (*PoolsCfg) ProtoMessage()
- func (m *PoolsCfg) Reset()
- func (m *PoolsCfg) String() string
- func (m *PoolsCfg) XXX_DiscardUnknown()
- func (m *PoolsCfg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *PoolsCfg) XXX_Merge(src proto.Message)
- func (m *PoolsCfg) XXX_Size() int
- func (m *PoolsCfg) XXX_Unmarshal(b []byte) error
- type Schedulers
- func (*Schedulers) Descriptor() ([]byte, []int)
- func (m *Schedulers) GetGroup() []string
- func (m *Schedulers) GetTrustedDelegation() []*TrustedDelegation
- func (m *Schedulers) GetUser() []string
- func (*Schedulers) ProtoMessage()
- func (m *Schedulers) Reset()
- func (m *Schedulers) String() string
- func (m *Schedulers) XXX_DiscardUnknown()
- func (m *Schedulers) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Schedulers) XXX_Merge(src proto.Message)
- func (m *Schedulers) XXX_Size() int
- func (m *Schedulers) XXX_Unmarshal(b []byte) error
- type SettingsCfg
- func (*SettingsCfg) Descriptor() ([]byte, []int)
- func (m *SettingsCfg) GetAuth() *AuthSettings
- func (m *SettingsCfg) GetBotDeathTimeoutSecs() int32
- func (m *SettingsCfg) GetBotIsolateGrpcProxy() string
- func (m *SettingsCfg) GetBotSwarmingGrpcProxy() string
- func (m *SettingsCfg) GetCipd() *CipdSettings
- func (m *SettingsCfg) GetDisplayServerUrlTemplate() string
- func (m *SettingsCfg) GetEnableTsMonitoring() bool
- func (m *SettingsCfg) GetExtraChildSrcCspUrl() []string
- func (m *SettingsCfg) GetForceBotsToSleepAndNotRunTask() bool
- func (m *SettingsCfg) GetGoogleAnalytics() string
- func (m *SettingsCfg) GetIsolate() *IsolateSettings
- func (m *SettingsCfg) GetMaxBotSleepTime() int32
- func (m *SettingsCfg) GetReusableTaskAgeSecs() int32
- func (m *SettingsCfg) GetUiClientId() string
- func (m *SettingsCfg) GetUseLifo() bool
- func (*SettingsCfg) ProtoMessage()
- func (m *SettingsCfg) Reset()
- func (m *SettingsCfg) String() string
- func (m *SettingsCfg) XXX_DiscardUnknown()
- func (m *SettingsCfg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *SettingsCfg) XXX_Merge(src proto.Message)
- func (m *SettingsCfg) XXX_Size() int
- func (m *SettingsCfg) XXX_Unmarshal(b []byte) error
- type TaskTemplate
- func (*TaskTemplate) Descriptor() ([]byte, []int)
- func (m *TaskTemplate) GetCache() []*TaskTemplate_CacheEntry
- func (m *TaskTemplate) GetCipdPackage() []*TaskTemplate_CipdPackage
- func (m *TaskTemplate) GetEnv() []*TaskTemplate_Env
- func (m *TaskTemplate) GetInclude() []string
- func (m *TaskTemplate) GetName() string
- func (*TaskTemplate) ProtoMessage()
- func (m *TaskTemplate) Reset()
- func (m *TaskTemplate) String() string
- func (m *TaskTemplate) XXX_DiscardUnknown()
- func (m *TaskTemplate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TaskTemplate) XXX_Merge(src proto.Message)
- func (m *TaskTemplate) XXX_Size() int
- func (m *TaskTemplate) XXX_Unmarshal(b []byte) error
- type TaskTemplateDeployment
- func (*TaskTemplateDeployment) Descriptor() ([]byte, []int)
- func (m *TaskTemplateDeployment) GetCanary() *TaskTemplate
- func (m *TaskTemplateDeployment) GetCanaryChance() int32
- func (m *TaskTemplateDeployment) GetName() string
- func (m *TaskTemplateDeployment) GetProd() *TaskTemplate
- func (*TaskTemplateDeployment) ProtoMessage()
- func (m *TaskTemplateDeployment) Reset()
- func (m *TaskTemplateDeployment) String() string
- func (m *TaskTemplateDeployment) XXX_DiscardUnknown()
- func (m *TaskTemplateDeployment) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TaskTemplateDeployment) XXX_Merge(src proto.Message)
- func (m *TaskTemplateDeployment) XXX_Size() int
- func (m *TaskTemplateDeployment) XXX_Unmarshal(b []byte) error
- type TaskTemplate_CacheEntry
- func (*TaskTemplate_CacheEntry) Descriptor() ([]byte, []int)
- func (m *TaskTemplate_CacheEntry) GetName() string
- func (m *TaskTemplate_CacheEntry) GetPath() string
- func (*TaskTemplate_CacheEntry) ProtoMessage()
- func (m *TaskTemplate_CacheEntry) Reset()
- func (m *TaskTemplate_CacheEntry) String() string
- func (m *TaskTemplate_CacheEntry) XXX_DiscardUnknown()
- func (m *TaskTemplate_CacheEntry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TaskTemplate_CacheEntry) XXX_Merge(src proto.Message)
- func (m *TaskTemplate_CacheEntry) XXX_Size() int
- func (m *TaskTemplate_CacheEntry) XXX_Unmarshal(b []byte) error
- type TaskTemplate_CipdPackage
- func (*TaskTemplate_CipdPackage) Descriptor() ([]byte, []int)
- func (m *TaskTemplate_CipdPackage) GetPath() string
- func (m *TaskTemplate_CipdPackage) GetPkg() string
- func (m *TaskTemplate_CipdPackage) GetVersion() string
- func (*TaskTemplate_CipdPackage) ProtoMessage()
- func (m *TaskTemplate_CipdPackage) Reset()
- func (m *TaskTemplate_CipdPackage) String() string
- func (m *TaskTemplate_CipdPackage) XXX_DiscardUnknown()
- func (m *TaskTemplate_CipdPackage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TaskTemplate_CipdPackage) XXX_Merge(src proto.Message)
- func (m *TaskTemplate_CipdPackage) XXX_Size() int
- func (m *TaskTemplate_CipdPackage) XXX_Unmarshal(b []byte) error
- type TaskTemplate_Env
- func (*TaskTemplate_Env) Descriptor() ([]byte, []int)
- func (m *TaskTemplate_Env) GetPrefix() []string
- func (m *TaskTemplate_Env) GetSoft() bool
- func (m *TaskTemplate_Env) GetValue() string
- func (m *TaskTemplate_Env) GetVar() string
- func (*TaskTemplate_Env) ProtoMessage()
- func (m *TaskTemplate_Env) Reset()
- func (m *TaskTemplate_Env) String() string
- func (m *TaskTemplate_Env) XXX_DiscardUnknown()
- func (m *TaskTemplate_Env) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TaskTemplate_Env) XXX_Merge(src proto.Message)
- func (m *TaskTemplate_Env) XXX_Size() int
- func (m *TaskTemplate_Env) XXX_Unmarshal(b []byte) error
- type TrustedDelegation
- func (*TrustedDelegation) Descriptor() ([]byte, []int)
- func (m *TrustedDelegation) GetPeerId() string
- func (m *TrustedDelegation) GetRequireAnyOf() *TrustedDelegation_TagList
- func (*TrustedDelegation) ProtoMessage()
- func (m *TrustedDelegation) Reset()
- func (m *TrustedDelegation) String() string
- func (m *TrustedDelegation) XXX_DiscardUnknown()
- func (m *TrustedDelegation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TrustedDelegation) XXX_Merge(src proto.Message)
- func (m *TrustedDelegation) XXX_Size() int
- func (m *TrustedDelegation) XXX_Unmarshal(b []byte) error
- type TrustedDelegation_TagList
- func (*TrustedDelegation_TagList) Descriptor() ([]byte, []int)
- func (m *TrustedDelegation_TagList) GetTag() []string
- func (*TrustedDelegation_TagList) ProtoMessage()
- func (m *TrustedDelegation_TagList) Reset()
- func (m *TrustedDelegation_TagList) String() string
- func (m *TrustedDelegation_TagList) XXX_DiscardUnknown()
- func (m *TrustedDelegation_TagList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TrustedDelegation_TagList) XXX_Merge(src proto.Message)
- func (m *TrustedDelegation_TagList) XXX_Size() int
- func (m *TrustedDelegation_TagList) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthSettings ¶
type AuthSettings struct { // Members of this group have full administrative access. // // Grants: // - config view and edit // - delete any bot // - all of bot_bootstrap_group membership // - all of privileged_users_group membership AdminsGroup string `protobuf:"bytes,1,opt,name=admins_group,json=adminsGroup,proto3" json:"admins_group,omitempty"` // Members of this group can fetch swarming bot code and bootstrap bots. // // Grants: // - bot create: create a token to anonymously fetch the bot code. BotBootstrapGroup string `protobuf:"bytes,2,opt,name=bot_bootstrap_group,json=botBootstrapGroup,proto3" json:"bot_bootstrap_group,omitempty"` // Members of this group can schedule tasks and see everyone else's tasks. // // Grants: // - cancel any task // - edit (terminate) any bot // - all of view_all_bots_group membership // - all of view_all_tasks_group membership PrivilegedUsersGroup string `protobuf:"bytes,3,opt,name=privileged_users_group,json=privilegedUsersGroup,proto3" json:"privileged_users_group,omitempty"` // Members of this group can schedule tasks and see only their own tasks. // // Grants: // - create a task // - view and edit own task UsersGroup string `protobuf:"bytes,4,opt,name=users_group,json=usersGroup,proto3" json:"users_group,omitempty"` // Members of this group can view all bots. This is a read-only group. // // Grants: // - view all bots ViewAllBotsGroup string `protobuf:"bytes,5,opt,name=view_all_bots_group,json=viewAllBotsGroup,proto3" json:"view_all_bots_group,omitempty"` // Members of this group can view all tasks. This is a read-only group. // // Grants: // - view all tasks ViewAllTasksGroup string `protobuf:"bytes,6,opt,name=view_all_tasks_group,json=viewAllTasksGroup,proto3" json:"view_all_tasks_group,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*AuthSettings) Descriptor ¶
func (*AuthSettings) Descriptor() ([]byte, []int)
func (*AuthSettings) GetAdminsGroup ¶
func (m *AuthSettings) GetAdminsGroup() string
func (*AuthSettings) GetBotBootstrapGroup ¶
func (m *AuthSettings) GetBotBootstrapGroup() string
func (*AuthSettings) GetPrivilegedUsersGroup ¶
func (m *AuthSettings) GetPrivilegedUsersGroup() string
func (*AuthSettings) GetUsersGroup ¶
func (m *AuthSettings) GetUsersGroup() string
func (*AuthSettings) GetViewAllBotsGroup ¶
func (m *AuthSettings) GetViewAllBotsGroup() string
func (*AuthSettings) GetViewAllTasksGroup ¶
func (m *AuthSettings) GetViewAllTasksGroup() string
func (*AuthSettings) ProtoMessage ¶
func (*AuthSettings) ProtoMessage()
func (*AuthSettings) Reset ¶
func (m *AuthSettings) Reset()
func (*AuthSettings) String ¶
func (m *AuthSettings) String() string
func (*AuthSettings) XXX_DiscardUnknown ¶
func (m *AuthSettings) XXX_DiscardUnknown()
func (*AuthSettings) XXX_Marshal ¶
func (m *AuthSettings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*AuthSettings) XXX_Merge ¶
func (m *AuthSettings) XXX_Merge(src proto.Message)
func (*AuthSettings) XXX_Size ¶
func (m *AuthSettings) XXX_Size() int
func (*AuthSettings) XXX_Unmarshal ¶
func (m *AuthSettings) XXX_Unmarshal(b []byte) error
type BotAuth ¶
type BotAuth struct { // If true, log an error (but proceed) if this method didn't succeed. // // This field is totally optional and makes sense only when there are more // than one auth method. Affects only logging levels. // // Doesn't apply to methods that were skipped because some method before them // succeeded. Thus methods that have 'log_if_failed' should be in front of // BotGroup.auth list. // // This is useful when migrating from one auth method to another to verify // the new method is used in 100% of cases, while still keeping a fallback // to an old method. LogIfFailed bool `protobuf:"varint,5,opt,name=log_if_failed,json=logIfFailed,proto3" json:"log_if_failed,omitempty"` // If true, the bot should provide valid X-Luci-Machine-Token header. // // The machine FQDN embedded in the token should have hostname equal to the // bot_id. RequireLuciMachineToken bool `` /* 135-byte string literal not displayed */ // If set, the bot should use OAuth access token belonging to any of these // service accounts. // // The token should have "https://www.googleapis.com/auth/userinfo.email" // scope. RequireServiceAccount []string `` /* 126-byte string literal not displayed */ // If set, the bot should provide valid X-Luci-Gce-Vm-Token header. // // This header should contain JWT with signed VM metadata with the following // expectations: // * Audience matches https://[*-dot-]<app>.appspot.com // * google.compute_engine.project_id field matches the value of 'project'. // * instance_name matches bot_id reported by the bot (case insensitive). RequireGceVmToken *BotAuth_GCE `protobuf:"bytes,4,opt,name=require_gce_vm_token,json=requireGceVmToken,proto3" json:"require_gce_vm_token,omitempty"` // If set, defines an IP whitelist name (in auth_service database) with a set // of IPs allowed to be used by the bots in this group. // // Works in conjunction with other checks, e.g. if require_luci_machine_token // is true, both valid X-Luci-Machine-Token and a whitelisted IP are needed to // successfully authenticate. // // Can also be used on its own (when all other fields are empty). In that case // the IP whitelist is the primary authentication mechanism. Note that in this // case all bots that share the IP whitelist are effectively in a single trust // domain (any bot can pretend to be some other bot). IpWhitelist string `protobuf:"bytes,3,opt,name=ip_whitelist,json=ipWhitelist,proto3" json:"ip_whitelist,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Defines what kind of authentication to perform when handling requests from bots belonging to some bot group.
The following combinations are valid:
- Either one of require_* alone.
- IP whitelist alone.
- IP + require_luci_machine_token: requires both to pass.
- IP + require_service_account: requires both to pass.
- IP + require_gce_vm_token: requires both to pass.
Next ID: 6.
func (*BotAuth) Descriptor ¶
func (*BotAuth) GetIpWhitelist ¶
func (*BotAuth) GetLogIfFailed ¶
func (*BotAuth) GetRequireGceVmToken ¶
func (m *BotAuth) GetRequireGceVmToken() *BotAuth_GCE
func (*BotAuth) GetRequireLuciMachineToken ¶
func (*BotAuth) GetRequireServiceAccount ¶
func (*BotAuth) ProtoMessage ¶
func (*BotAuth) ProtoMessage()
func (*BotAuth) XXX_DiscardUnknown ¶
func (m *BotAuth) XXX_DiscardUnknown()
func (*BotAuth) XXX_Marshal ¶
func (*BotAuth) XXX_Unmarshal ¶
type BotAuth_GCE ¶
type BotAuth_GCE struct { Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
See require_gce_vm_token below.
func (*BotAuth_GCE) Descriptor ¶
func (*BotAuth_GCE) Descriptor() ([]byte, []int)
func (*BotAuth_GCE) GetProject ¶
func (m *BotAuth_GCE) GetProject() string
func (*BotAuth_GCE) ProtoMessage ¶
func (*BotAuth_GCE) ProtoMessage()
func (*BotAuth_GCE) Reset ¶
func (m *BotAuth_GCE) Reset()
func (*BotAuth_GCE) String ¶
func (m *BotAuth_GCE) String() string
func (*BotAuth_GCE) XXX_DiscardUnknown ¶
func (m *BotAuth_GCE) XXX_DiscardUnknown()
func (*BotAuth_GCE) XXX_Marshal ¶
func (m *BotAuth_GCE) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*BotAuth_GCE) XXX_Merge ¶
func (m *BotAuth_GCE) XXX_Merge(src proto.Message)
func (*BotAuth_GCE) XXX_Size ¶
func (m *BotAuth_GCE) XXX_Size() int
func (*BotAuth_GCE) XXX_Unmarshal ¶
func (m *BotAuth_GCE) XXX_Unmarshal(b []byte) error
type BotGroup ¶
type BotGroup struct { // Explicit enumeration of bot IDs belonging to this group. // // It supports subset of bash brace expansion syntax, in particular ranges // and lists. For example: // * vm{1..3}-m1 will expand into vm1-m1, vm2-m1 and vm3-m1. // * vm{100,150,200}-m1 will expand into vm100-m1, vm150-m1 and vm200-m1. // // There can be only one "{...}" section in the string. BotId []string `protobuf:"bytes,1,rep,name=bot_id,json=botId,proto3" json:"bot_id,omitempty"` // A prefix to match against bot ID string. BotIdPrefix []string `protobuf:"bytes,2,rep,name=bot_id_prefix,json=botIdPrefix,proto3" json:"bot_id_prefix,omitempty"` // Defines authentication methods for bots from this group. // // Evaluated sequentially until first match. Auth []*BotAuth `protobuf:"bytes,20,rep,name=auth,proto3" json:"auth,omitempty"` // Emails of owners of these bots. Optional. Owners []string `protobuf:"bytes,21,rep,name=owners,proto3" json:"owners,omitempty"` // List of dimensions to assign to these bots. // // Each dimension is a "<key>:<value>" pair. Dimensions []string `protobuf:"bytes,22,rep,name=dimensions,proto3" json:"dimensions,omitempty"` // Path to an additional config script to inject into the swarming bot upon // handshake. // // The path is relative to 'scripts/' directory in the service config repo. BotConfigScript string `protobuf:"bytes,23,opt,name=bot_config_script,json=botConfigScript,proto3" json:"bot_config_script,omitempty"` // The actual body of the config script to inject into the swarming bot upon // handshake (in whatever encoding it happened to be in the config repo). // // For internal use (unless you fancy writing python scripts as single line // escaped text proto string). If present, overrides 'bot_config_script'. BotConfigScriptContent []byte `` /* 132-byte string literal not displayed */ // A service account to use on bots when authenticating calls to various // system-level services (like Isolate and CIPD), required for correct // operation of the bot. // // Tasks will be able to access this account too, but it is not recommended // and should be used extremely rare. // // If set to a service account email (*@*.iam.gserviceaccount.com), bots will // use this account, generating access token through Swarming server. For this // to work, the server account (<app-id>@appspot.gserviceaccount.com) must // have "serviceAccountActor" IAM role set on the account. // // If set to a special string "bot", bots will use exact same token they use // when authenticating calls to Swarming server itself. This works only if // bots use OAuth for authentication (see 'require_service_account' in // BotAuth). This mode exists for cases when proliferation of various service // accounts is undesirable. Note that in this mode Swarming processes won't be // able to request a system account token with some new scopes: they get exact // same token as returned by get_authentication_headers bot_config.py hook. // // If not set, bots will not use authentication at all. SystemServiceAccount string `protobuf:"bytes,24,opt,name=system_service_account,json=systemServiceAccount,proto3" json:"system_service_account,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A group of bots that share authentication method, dimensions and owners.
Union of bot_id and bot_id_prefix define a set of bots that belong to this group. The rest of the fields define properties of this group.
If bot_id and bot_id_prefix are both missing, the group defines all bots that didn't fit into other groups. There can be only one such "default" group.
TODO(vadimsh): Introduce explicit field "use_as_default" instead.
func (*BotGroup) Descriptor ¶
func (*BotGroup) GetBotConfigScript ¶
func (*BotGroup) GetBotConfigScriptContent ¶
func (*BotGroup) GetBotIdPrefix ¶
func (*BotGroup) GetDimensions ¶
func (*BotGroup) GetSystemServiceAccount ¶
func (*BotGroup) ProtoMessage ¶
func (*BotGroup) ProtoMessage()
func (*BotGroup) XXX_DiscardUnknown ¶
func (m *BotGroup) XXX_DiscardUnknown()
func (*BotGroup) XXX_Marshal ¶
func (*BotGroup) XXX_Unmarshal ¶
type BotMonitoring ¶
type BotMonitoring struct { // Name is used by Pool to describe how to monitor bots in this pool. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Dimension keys to be used to bucket the bots. // // The algorithm for a key with multiple values is: // def simplify(values): // values = sorted(values) // return '|'.join( // v for i, v in enumerate(values) // if not any(v.startswith(value) for v in values[i+1:])) // // For example, if 'os' is specified and a bot has the values // ['Linux', 'Ubuntu', 'Ubuntu-16.04'], the bucket value used for this bot // will be 'Linux|Ubuntu-16.04'. // // Then whole algorithm then works for each key: // def bucket(keys, bot_dimensions): // return ';'.join( // '%s:%s' % (key, simplify(bot_dimensions.get(values, [])) // for key in keys) // // so the end result may look like: 'os:Linux|Ubuntu-16.04;pool:Testers'. // // More precisely, when this is used, the other bot dimensions are ignored. // 'pool' is always implicit. DimensionKey []string `protobuf:"bytes,2,rep,name=dimension_key,json=dimensionKey,proto3" json:"dimension_key,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Defines about how to monitor bots.
func (*BotMonitoring) Descriptor ¶
func (*BotMonitoring) Descriptor() ([]byte, []int)
func (*BotMonitoring) GetDimensionKey ¶
func (m *BotMonitoring) GetDimensionKey() []string
func (*BotMonitoring) GetName ¶
func (m *BotMonitoring) GetName() string
func (*BotMonitoring) ProtoMessage ¶
func (*BotMonitoring) ProtoMessage()
func (*BotMonitoring) Reset ¶
func (m *BotMonitoring) Reset()
func (*BotMonitoring) String ¶
func (m *BotMonitoring) String() string
func (*BotMonitoring) XXX_DiscardUnknown ¶
func (m *BotMonitoring) XXX_DiscardUnknown()
func (*BotMonitoring) XXX_Marshal ¶
func (m *BotMonitoring) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*BotMonitoring) XXX_Merge ¶
func (m *BotMonitoring) XXX_Merge(src proto.Message)
func (*BotMonitoring) XXX_Size ¶
func (m *BotMonitoring) XXX_Size() int
func (*BotMonitoring) XXX_Unmarshal ¶
func (m *BotMonitoring) XXX_Unmarshal(b []byte) error
type BotsCfg ¶
type BotsCfg struct { // List of dimension names that are provided by the server. // // If bot attempts to set such dimension, it'll be ignored. Trusted dimensions // are defined through bot_group configs below. Swarming users can trust such // dimensions, since they are set by the server based on validated credentials // (unlike other dimensions that can be arbitrary defined by the bot itself). TrustedDimensions []string `protobuf:"bytes,1,rep,name=trusted_dimensions,json=trustedDimensions,proto3" json:"trusted_dimensions,omitempty"` // A list of groups of bots. Each group defines a bunch of bots that all // have same dimensions and authenticate in the same way. // // The order of entries here is irrelevant. The server uses the following // search algorithm when trying to pick a group for a bot with some bot_id: // 1) First it tries to find a direct match: a group that lists the bot in // bot_id field. // 2) Next it tries to find a group with matching bot_id_prefix. The config // validation process makes sure prefixes do not "intersect", so there // will be at most one matching group. // 3) Finally, if there's a group with no defined bot_id or bot_id_prefix // fields (the "default" group), the bot is categorized to that group. // If there's no such group, the connection from the bot is rejected. // Config validation process ensures there can be only one such group. BotGroup []*BotGroup `protobuf:"bytes,2,rep,name=bot_group,json=botGroup,proto3" json:"bot_group,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Schema for bots.cfg service config file in luci-config.
It defines a function bot_id => (required credentials, trusted_dimensions, config), where
- "bot_id" is identifier of a bot as sent by the bot itself (usually machine hostname, short one, not FQDN)
- "required credentials" describes how server should authenticate calls from the bot.
- "trusted_dimensions" is a set of dimension set by the server itself. Such dimensions can't be spoofed by the bot.
- "config" is any additional bot configuration.
Connections from bots that do not appear in this config are rejected.
The default config (used if bots.cfg is missing) represents IP-whitelist only authentication, as was used before bots.cfg was implemented:
bot_group { auth { ip_whitelist: "<swarming-app-id>-bots" } }
func (*BotsCfg) Descriptor ¶
func (*BotsCfg) GetBotGroup ¶
func (*BotsCfg) GetTrustedDimensions ¶
func (*BotsCfg) ProtoMessage ¶
func (*BotsCfg) ProtoMessage()
func (*BotsCfg) XXX_DiscardUnknown ¶
func (m *BotsCfg) XXX_DiscardUnknown()
func (*BotsCfg) XXX_Marshal ¶
func (*BotsCfg) XXX_Unmarshal ¶
type CipdPackage ¶
type CipdPackage struct { // A template of a full CIPD package name, e.g. // "infra/tools/cipd/${platform}" // See also cipd.ALL_PARAMS. PackageName string `protobuf:"bytes,1,opt,name=package_name,json=packageName,proto3" json:"package_name,omitempty"` // Valid package version for all packages matched by package name. Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A CIPD package.
func (*CipdPackage) Descriptor ¶
func (*CipdPackage) Descriptor() ([]byte, []int)
func (*CipdPackage) GetPackageName ¶
func (m *CipdPackage) GetPackageName() string
func (*CipdPackage) GetVersion ¶
func (m *CipdPackage) GetVersion() string
func (*CipdPackage) ProtoMessage ¶
func (*CipdPackage) ProtoMessage()
func (*CipdPackage) Reset ¶
func (m *CipdPackage) Reset()
func (*CipdPackage) String ¶
func (m *CipdPackage) String() string
func (*CipdPackage) XXX_DiscardUnknown ¶
func (m *CipdPackage) XXX_DiscardUnknown()
func (*CipdPackage) XXX_Marshal ¶
func (m *CipdPackage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CipdPackage) XXX_Merge ¶
func (m *CipdPackage) XXX_Merge(src proto.Message)
func (*CipdPackage) XXX_Size ¶
func (m *CipdPackage) XXX_Size() int
func (*CipdPackage) XXX_Unmarshal ¶
func (m *CipdPackage) XXX_Unmarshal(b []byte) error
type CipdSettings ¶
type CipdSettings struct { // URL of the default CIPD server to use if it is not specified in a task. // Must start with "https://" or "http://", // e.g. "https://chrome-infra-packages.appspot.com". DefaultServer string `protobuf:"bytes,1,opt,name=default_server,json=defaultServer,proto3" json:"default_server,omitempty"` // Package of the default CIPD client to use if it is not specified in a // task. DefaultClientPackage *CipdPackage `protobuf:"bytes,2,opt,name=default_client_package,json=defaultClientPackage,proto3" json:"default_client_package,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Settings for Swarming-CIPD integration.
func (*CipdSettings) Descriptor ¶
func (*CipdSettings) Descriptor() ([]byte, []int)
func (*CipdSettings) GetDefaultClientPackage ¶
func (m *CipdSettings) GetDefaultClientPackage() *CipdPackage
func (*CipdSettings) GetDefaultServer ¶
func (m *CipdSettings) GetDefaultServer() string
func (*CipdSettings) ProtoMessage ¶
func (*CipdSettings) ProtoMessage()
func (*CipdSettings) Reset ¶
func (m *CipdSettings) Reset()
func (*CipdSettings) String ¶
func (m *CipdSettings) String() string
func (*CipdSettings) XXX_DiscardUnknown ¶
func (m *CipdSettings) XXX_DiscardUnknown()
func (*CipdSettings) XXX_Marshal ¶
func (m *CipdSettings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CipdSettings) XXX_Merge ¶
func (m *CipdSettings) XXX_Merge(src proto.Message)
func (*CipdSettings) XXX_Size ¶
func (m *CipdSettings) XXX_Size() int
func (*CipdSettings) XXX_Unmarshal ¶
func (m *CipdSettings) XXX_Unmarshal(b []byte) error
type ExternalSchedulerConfig ¶
type ExternalSchedulerConfig struct { // Service address of external scheduler. Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // Scheduler id within the external scheduler service to use. This value // is opaque to swarming. Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"` // Dimensions is a list of dimension strings in "key:value" format (e.g. // ["os:foo", "featureX:bar"]) that determines eligibility for a bot or task // to use this external scheduler. In particular: // - a bot will be eligible if it contains all of these dimensions. // - a task will be eligible if all its slices contain all these dimensions. // // Note of care: if this list is empty, that means all requests in the pool // are eligible to be forwarded to it. // // Note: To be deprecated, in favor of: any_dimensions and all_dimensions. Dimensions []string `protobuf:"bytes,3,rep,name=dimensions,proto3" json:"dimensions,omitempty"` // If not enabled, this external scheduler config will be ignored. This // makes it safer to add new configs (the naive approach of adding a config // with empty dimentions list would cause all requests to be routed to // that config). Enabled bool `protobuf:"varint,4,opt,name=enabled,proto3" json:"enabled,omitempty"` FallbackWhenEmpty bool `protobuf:"varint,5,opt,name=fallback_when_empty,json=fallbackWhenEmpty,proto3" json:"fallback_when_empty,omitempty"` // Deprecated: Do not use. // A task or bot must have all of these dimensions in order to match this // dimension set. // // Note: Support not yet implemented. AllDimensions []string `protobuf:"bytes,6,rep,name=all_dimensions,json=allDimensions,proto3" json:"all_dimensions,omitempty"` // If any_dimensions is defined, a task or bot must have any of these // dimensions in order to match this dimension set. // // Note: Support not yet implemented. AnyDimensions []string `protobuf:"bytes,7,rep,name=any_dimensions,json=anyDimensions,proto3" json:"any_dimensions,omitempty"` // If true, allows the swarming native scheduler to reap tasks that would // otherwise be owned by this external scheduler, if the external scheduler // returns no results. // // This field should be enabled temporarily when first turning on a new // external scheduler config, to allow tasks that existing prior to that time // to still have a chance to run. After prior tasks have aged out of the // system, this flag should be disabled, to get stricter consistency between // swarming's state and external scheduler's state. AllowEsFallback bool `protobuf:"varint,8,opt,name=allow_es_fallback,json=allowEsFallback,proto3" json:"allow_es_fallback,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Describes an external scheduler used by a particular swarming pool and dimension set, via the external scheduler API.
func (*ExternalSchedulerConfig) Descriptor ¶
func (*ExternalSchedulerConfig) Descriptor() ([]byte, []int)
func (*ExternalSchedulerConfig) GetAddress ¶
func (m *ExternalSchedulerConfig) GetAddress() string
func (*ExternalSchedulerConfig) GetAllDimensions ¶
func (m *ExternalSchedulerConfig) GetAllDimensions() []string
func (*ExternalSchedulerConfig) GetAllowEsFallback ¶
func (m *ExternalSchedulerConfig) GetAllowEsFallback() bool
func (*ExternalSchedulerConfig) GetAnyDimensions ¶
func (m *ExternalSchedulerConfig) GetAnyDimensions() []string
func (*ExternalSchedulerConfig) GetDimensions ¶
func (m *ExternalSchedulerConfig) GetDimensions() []string
func (*ExternalSchedulerConfig) GetEnabled ¶
func (m *ExternalSchedulerConfig) GetEnabled() bool
func (*ExternalSchedulerConfig) GetFallbackWhenEmpty
deprecated
func (m *ExternalSchedulerConfig) GetFallbackWhenEmpty() bool
Deprecated: Do not use.
func (*ExternalSchedulerConfig) GetId ¶
func (m *ExternalSchedulerConfig) GetId() string
func (*ExternalSchedulerConfig) ProtoMessage ¶
func (*ExternalSchedulerConfig) ProtoMessage()
func (*ExternalSchedulerConfig) Reset ¶
func (m *ExternalSchedulerConfig) Reset()
func (*ExternalSchedulerConfig) String ¶
func (m *ExternalSchedulerConfig) String() string
func (*ExternalSchedulerConfig) XXX_DiscardUnknown ¶
func (m *ExternalSchedulerConfig) XXX_DiscardUnknown()
func (*ExternalSchedulerConfig) XXX_Marshal ¶
func (m *ExternalSchedulerConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExternalSchedulerConfig) XXX_Merge ¶
func (m *ExternalSchedulerConfig) XXX_Merge(src proto.Message)
func (*ExternalSchedulerConfig) XXX_Size ¶
func (m *ExternalSchedulerConfig) XXX_Size() int
func (*ExternalSchedulerConfig) XXX_Unmarshal ¶
func (m *ExternalSchedulerConfig) XXX_Unmarshal(b []byte) error
type ExternalServices ¶
type ExternalServices struct { Isolate *ExternalServices_Isolate `protobuf:"bytes,1,opt,name=isolate,proto3" json:"isolate,omitempty"` Cipd *ExternalServices_CIPD `protobuf:"bytes,2,opt,name=cipd,proto3" json:"cipd,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ExternalServices) Descriptor ¶
func (*ExternalServices) Descriptor() ([]byte, []int)
func (*ExternalServices) GetCipd ¶
func (m *ExternalServices) GetCipd() *ExternalServices_CIPD
func (*ExternalServices) GetIsolate ¶
func (m *ExternalServices) GetIsolate() *ExternalServices_Isolate
func (*ExternalServices) ProtoMessage ¶
func (*ExternalServices) ProtoMessage()
func (*ExternalServices) Reset ¶
func (m *ExternalServices) Reset()
func (*ExternalServices) String ¶
func (m *ExternalServices) String() string
func (*ExternalServices) XXX_DiscardUnknown ¶
func (m *ExternalServices) XXX_DiscardUnknown()
func (*ExternalServices) XXX_Marshal ¶
func (m *ExternalServices) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExternalServices) XXX_Merge ¶
func (m *ExternalServices) XXX_Merge(src proto.Message)
func (*ExternalServices) XXX_Size ¶
func (m *ExternalServices) XXX_Size() int
func (*ExternalServices) XXX_Unmarshal ¶
func (m *ExternalServices) XXX_Unmarshal(b []byte) error
type ExternalServices_CIPD ¶
type ExternalServices_CIPD struct { // (required) URL of the default CIPD server to use, if it is not specified // in the task. // // Must start with "https://" or "http://". // // e.g. "https://chrome-infra-packages.appspot.com" Server string `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"` // (required) The version of the cipd client to use. This is the // 'infra/tools/cipd/${platform}' package, but because it's part of the // bootstrap needs special logic to handle its installation. ClientVersion string `protobuf:"bytes,2,opt,name=client_version,json=clientVersion,proto3" json:"client_version,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ExternalServices_CIPD) Descriptor ¶
func (*ExternalServices_CIPD) Descriptor() ([]byte, []int)
func (*ExternalServices_CIPD) GetClientVersion ¶
func (m *ExternalServices_CIPD) GetClientVersion() string
func (*ExternalServices_CIPD) GetServer ¶
func (m *ExternalServices_CIPD) GetServer() string
func (*ExternalServices_CIPD) ProtoMessage ¶
func (*ExternalServices_CIPD) ProtoMessage()
func (*ExternalServices_CIPD) Reset ¶
func (m *ExternalServices_CIPD) Reset()
func (*ExternalServices_CIPD) String ¶
func (m *ExternalServices_CIPD) String() string
func (*ExternalServices_CIPD) XXX_DiscardUnknown ¶
func (m *ExternalServices_CIPD) XXX_DiscardUnknown()
func (*ExternalServices_CIPD) XXX_Marshal ¶
func (m *ExternalServices_CIPD) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExternalServices_CIPD) XXX_Merge ¶
func (m *ExternalServices_CIPD) XXX_Merge(src proto.Message)
func (*ExternalServices_CIPD) XXX_Size ¶
func (m *ExternalServices_CIPD) XXX_Size() int
func (*ExternalServices_CIPD) XXX_Unmarshal ¶
func (m *ExternalServices_CIPD) XXX_Unmarshal(b []byte) error
type ExternalServices_Isolate ¶
type ExternalServices_Isolate struct { // (required) URL of the default isolate server to use if it is not // specified in the task. // // Must start with "https://" or "http://". // // e.g. "https://isolateserver.appspot.com" Server string `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"` // (required) Default namespace to use if it is not specified in a task, // e.g. "default-gzip" Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ExternalServices_Isolate) Descriptor ¶
func (*ExternalServices_Isolate) Descriptor() ([]byte, []int)
func (*ExternalServices_Isolate) GetNamespace ¶
func (m *ExternalServices_Isolate) GetNamespace() string
func (*ExternalServices_Isolate) GetServer ¶
func (m *ExternalServices_Isolate) GetServer() string
func (*ExternalServices_Isolate) ProtoMessage ¶
func (*ExternalServices_Isolate) ProtoMessage()
func (*ExternalServices_Isolate) Reset ¶
func (m *ExternalServices_Isolate) Reset()
func (*ExternalServices_Isolate) String ¶
func (m *ExternalServices_Isolate) String() string
func (*ExternalServices_Isolate) XXX_DiscardUnknown ¶
func (m *ExternalServices_Isolate) XXX_DiscardUnknown()
func (*ExternalServices_Isolate) XXX_Marshal ¶
func (m *ExternalServices_Isolate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ExternalServices_Isolate) XXX_Merge ¶
func (m *ExternalServices_Isolate) XXX_Merge(src proto.Message)
func (*ExternalServices_Isolate) XXX_Size ¶
func (m *ExternalServices_Isolate) XXX_Size() int
func (*ExternalServices_Isolate) XXX_Unmarshal ¶
func (m *ExternalServices_Isolate) XXX_Unmarshal(b []byte) error
type IsolateSettings ¶
type IsolateSettings struct { // URL of the default isolate server to use if it is not specified in a // task. Must start with "https://" or "http://", // e.g. "https://isolateserver.appspot.com" DefaultServer string `protobuf:"bytes,1,opt,name=default_server,json=defaultServer,proto3" json:"default_server,omitempty"` // Default namespace to use if it is not specified in a task, // e.g. "default-gzip" DefaultNamespace string `protobuf:"bytes,2,opt,name=default_namespace,json=defaultNamespace,proto3" json:"default_namespace,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Configuration for swarming-isolate integration.
func (*IsolateSettings) Descriptor ¶
func (*IsolateSettings) Descriptor() ([]byte, []int)
func (*IsolateSettings) GetDefaultNamespace ¶
func (m *IsolateSettings) GetDefaultNamespace() string
func (*IsolateSettings) GetDefaultServer ¶
func (m *IsolateSettings) GetDefaultServer() string
func (*IsolateSettings) ProtoMessage ¶
func (*IsolateSettings) ProtoMessage()
func (*IsolateSettings) Reset ¶
func (m *IsolateSettings) Reset()
func (*IsolateSettings) String ¶
func (m *IsolateSettings) String() string
func (*IsolateSettings) XXX_DiscardUnknown ¶
func (m *IsolateSettings) XXX_DiscardUnknown()
func (*IsolateSettings) XXX_Marshal ¶
func (m *IsolateSettings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*IsolateSettings) XXX_Merge ¶
func (m *IsolateSettings) XXX_Merge(src proto.Message)
func (*IsolateSettings) XXX_Size ¶
func (m *IsolateSettings) XXX_Size() int
func (*IsolateSettings) XXX_Unmarshal ¶
func (m *IsolateSettings) XXX_Unmarshal(b []byte) error
type Pool ¶
type Pool struct { // Names of the pools this config applies to. // // Tasks target the pool by specifying its name as 'pool' dimension, thus // names here should be valid dimension value. Name []string `protobuf:"bytes,1,rep,name=name,proto3" json:"name,omitempty"` // Contact information for people that own this pool. // // Not used in any ACLs, just informational field. Owners []string `protobuf:"bytes,2,rep,name=owners,proto3" json:"owners,omitempty"` // Defines who can schedule tasks in this pool. // // The checks here act as a second authorization layer, consulted after the // first server-global one (defined based on groups set in settings.cfg, see // AuthSettings in config.proto). Schedulers *Schedulers `protobuf:"bytes,3,opt,name=schedulers,proto3" json:"schedulers,omitempty"` // List of service account emails allowed to be used for tasks that target // this pool. Tasks specify the service account via 'service_account' field // in the tasks.New RPC. // // By associating accounts with pools in the config we make it more explicit // that a bot belonging to a pool eventually can get access to service // accounts of all tasks running in this pool (just by sitting there, grabbing // tasks and sniffing service account tokens). AllowedServiceAccount []string `` /* 126-byte string literal not displayed */ // Same as 'allowed_service_account', but the set of service accounts is // specified through an auth group. AllowedServiceAccountGroup []string `` /* 143-byte string literal not displayed */ // Types that are valid to be assigned to TaskDeploymentScheme: // *Pool_TaskTemplateDeployment // *Pool_TaskTemplateDeploymentInline TaskDeploymentScheme isPool_TaskDeploymentScheme `protobuf_oneof:"task_deployment_scheme"` // Refer to one bot_monitoring at the file level by name. BotMonitoring string `protobuf:"bytes,8,opt,name=bot_monitoring,json=botMonitoring,proto3" json:"bot_monitoring,omitempty"` // If specified, this is the description of the external schedulers to be used // for tasks and bots for this pool that match the dimension set of a scheduler. // For a given task or bot, the first entry in this list that matches based on // dimension eligibility will be used. ExternalSchedulers []*ExternalSchedulerConfig `protobuf:"bytes,9,rep,name=external_schedulers,json=externalSchedulers,proto3" json:"external_schedulers,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Properties of a single pool or a bunch of identically configured pools.
In particular contains authorization configuration.
func (*Pool) Descriptor ¶
func (*Pool) GetAllowedServiceAccount ¶
func (*Pool) GetAllowedServiceAccountGroup ¶
func (*Pool) GetBotMonitoring ¶
func (*Pool) GetExternalSchedulers ¶
func (m *Pool) GetExternalSchedulers() []*ExternalSchedulerConfig
func (*Pool) GetSchedulers ¶
func (m *Pool) GetSchedulers() *Schedulers
func (*Pool) GetTaskDeploymentScheme ¶
func (m *Pool) GetTaskDeploymentScheme() isPool_TaskDeploymentScheme
func (*Pool) GetTaskTemplateDeployment ¶
func (*Pool) GetTaskTemplateDeploymentInline ¶
func (m *Pool) GetTaskTemplateDeploymentInline() *TaskTemplateDeployment
func (*Pool) ProtoMessage ¶
func (*Pool) ProtoMessage()
func (*Pool) XXX_DiscardUnknown ¶
func (m *Pool) XXX_DiscardUnknown()
func (*Pool) XXX_OneofWrappers ¶
func (*Pool) XXX_OneofWrappers() []interface{}
XXX_OneofWrappers is for the internal use of the proto package.
func (*Pool) XXX_Unmarshal ¶
type Pool_TaskTemplateDeployment ¶
type Pool_TaskTemplateDeployment struct {
TaskTemplateDeployment string `protobuf:"bytes,6,opt,name=task_template_deployment,json=taskTemplateDeployment,proto3,oneof"`
}
type Pool_TaskTemplateDeploymentInline ¶
type Pool_TaskTemplateDeploymentInline struct {
TaskTemplateDeploymentInline *TaskTemplateDeployment `protobuf:"bytes,7,opt,name=task_template_deployment_inline,json=taskTemplateDeploymentInline,proto3,oneof"`
}
type PoolsCfg ¶
type PoolsCfg struct { // List of all defined pools. Pool []*Pool `protobuf:"bytes,1,rep,name=pool,proto3" json:"pool,omitempty"` // Configures the default isolate and CIPD services to use for all pools on // this server. DefaultExternalServices *ExternalServices `` /* 132-byte string literal not displayed */ // This is the "shared namespace" of task templates. // // Task templates allow pools to specify some property defaults (particularly // around caches, CIPD packages and Environment variables) for tasks created // within the pool. These templates can have 'include' statements, and those // include statements draw from this namespace. // // Swarming will do a 2-pass parse of these so order doesn't matter (i.e. If // A includes B, but is defined B-then-A, it's not an error). TaskTemplate []*TaskTemplate `protobuf:"bytes,3,rep,name=task_template,json=taskTemplate,proto3" json:"task_template,omitempty"` // This is the "shared namespace" of deployments. // // When pools specify a task_template_deployment, it draws from this // namespace. TaskTemplateDeployment []*TaskTemplateDeployment `` /* 129-byte string literal not displayed */ // Defines about how to monitor bots in a pool. Each pool above may refer to // one of the BotMonitoring message by name, which permits reusing // BotMonitoring definitions. BotMonitoring []*BotMonitoring `protobuf:"bytes,5,rep,name=bot_monitoring,json=botMonitoring,proto3" json:"bot_monitoring,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Schema for pools.cfg service config file in luci-config.
It defined a set of Pool objects, each one corresponding to a single Swarming pool dimension. Each Swarming task resided in some pool, and each Swarming bot belongs to at least one pool.
Pools are used to isolate groups of tasks/bots from each other for security and capacity reasons. Two different pools should not interfere with each other at all (unless explicitly configured to share bots or accounts).
func (*PoolsCfg) Descriptor ¶
func (*PoolsCfg) GetBotMonitoring ¶
func (m *PoolsCfg) GetBotMonitoring() []*BotMonitoring
func (*PoolsCfg) GetDefaultExternalServices ¶
func (m *PoolsCfg) GetDefaultExternalServices() *ExternalServices
func (*PoolsCfg) GetTaskTemplate ¶
func (m *PoolsCfg) GetTaskTemplate() []*TaskTemplate
func (*PoolsCfg) GetTaskTemplateDeployment ¶
func (m *PoolsCfg) GetTaskTemplateDeployment() []*TaskTemplateDeployment
func (*PoolsCfg) ProtoMessage ¶
func (*PoolsCfg) ProtoMessage()
func (*PoolsCfg) XXX_DiscardUnknown ¶
func (m *PoolsCfg) XXX_DiscardUnknown()
func (*PoolsCfg) XXX_Marshal ¶
func (*PoolsCfg) XXX_Unmarshal ¶
type Schedulers ¶
type Schedulers struct { // Emails of individual end-users. // // Useful to avoid creating one-person groups. User []string `protobuf:"bytes,1,rep,name=user,proto3" json:"user,omitempty"` // List of groups with end-users. Group []string `protobuf:"bytes,2,rep,name=group,proto3" json:"group,omitempty"` // See TrustedDelegation comment. TrustedDelegation []*TrustedDelegation `protobuf:"bytes,3,rep,name=trusted_delegation,json=trustedDelegation,proto3" json:"trusted_delegation,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Defines who can schedule tasks in a pool.
func (*Schedulers) Descriptor ¶
func (*Schedulers) Descriptor() ([]byte, []int)
func (*Schedulers) GetGroup ¶
func (m *Schedulers) GetGroup() []string
func (*Schedulers) GetTrustedDelegation ¶
func (m *Schedulers) GetTrustedDelegation() []*TrustedDelegation
func (*Schedulers) GetUser ¶
func (m *Schedulers) GetUser() []string
func (*Schedulers) ProtoMessage ¶
func (*Schedulers) ProtoMessage()
func (*Schedulers) Reset ¶
func (m *Schedulers) Reset()
func (*Schedulers) String ¶
func (m *Schedulers) String() string
func (*Schedulers) XXX_DiscardUnknown ¶
func (m *Schedulers) XXX_DiscardUnknown()
func (*Schedulers) XXX_Marshal ¶
func (m *Schedulers) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Schedulers) XXX_Merge ¶
func (m *Schedulers) XXX_Merge(src proto.Message)
func (*Schedulers) XXX_Size ¶
func (m *Schedulers) XXX_Size() int
func (*Schedulers) XXX_Unmarshal ¶
func (m *Schedulers) XXX_Unmarshal(b []byte) error
type SettingsCfg ¶
type SettingsCfg struct { // id to inject into pages if applicable. GoogleAnalytics string `protobuf:"bytes,1,opt,name=google_analytics,json=googleAnalytics,proto3" json:"google_analytics,omitempty"` // The number of seconds an old task can be deduped from. // Default is one week: 7*24*60*60 = 604800 ReusableTaskAgeSecs int32 `protobuf:"varint,2,opt,name=reusable_task_age_secs,json=reusableTaskAgeSecs,proto3" json:"reusable_task_age_secs,omitempty"` // The amount of time that has to pass before a machine is considered dead. // Default is 600 (10 minutes). BotDeathTimeoutSecs int32 `protobuf:"varint,3,opt,name=bot_death_timeout_secs,json=botDeathTimeoutSecs,proto3" json:"bot_death_timeout_secs,omitempty"` // Enable ts_mon based monitoring. EnableTsMonitoring bool `protobuf:"varint,4,opt,name=enable_ts_monitoring,json=enableTsMonitoring,proto3" json:"enable_ts_monitoring,omitempty"` // (deprecated, see pools.proto) Configuration for swarming-isolate integration. Isolate *IsolateSettings `protobuf:"bytes,5,opt,name=isolate,proto3" json:"isolate,omitempty"` // (deprecated, see pools.proto) Configuration for swarming-cipd integration. Cipd *CipdSettings `protobuf:"bytes,6,opt,name=cipd,proto3" json:"cipd,omitempty"` // Emergency setting to disable bot task reaping. When set, all bots are // always put to sleep and are never granted task. ForceBotsToSleepAndNotRunTask bool `` /* 161-byte string literal not displayed */ // oauth client id for the ui. This is created in the developer's console // under Credentials. UiClientId string `protobuf:"bytes,9,opt,name=ui_client_id,json=uiClientId,proto3" json:"ui_client_id,omitempty"` // A url to a task display server (e.g. milo). This should have a %s where // a task id can go. DisplayServerUrlTemplate string `` /* 138-byte string literal not displayed */ // Sets a maximum sleep time in seconds for bots that limits the exponental // backoff. If missing, the task scheduler will provide the default maximum // (usually 60s, but see bot_code/task_scheduler.py for details). MaxBotSleepTime int32 `protobuf:"varint,12,opt,name=max_bot_sleep_time,json=maxBotSleepTime,proto3" json:"max_bot_sleep_time,omitempty"` // Names of the authorization groups used by components/auth. Auth *AuthSettings `protobuf:"bytes,13,opt,name=auth,proto3" json:"auth,omitempty"` // Sets the default gRPC proxy for the bot's Isolate server calls. BotIsolateGrpcProxy string `protobuf:"bytes,14,opt,name=bot_isolate_grpc_proxy,json=botIsolateGrpcProxy,proto3" json:"bot_isolate_grpc_proxy,omitempty"` // Sets the default gRPC proxy for the bot's Swarming server calls. BotSwarmingGrpcProxy string `` /* 126-byte string literal not displayed */ // Any extra urls that should be added to frame-src, e.g. anything that // will be linked to from the display server. // This originally added things to child-src, which was deprecated: // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/child-src ExtraChildSrcCspUrl []string `protobuf:"bytes,16,rep,name=extra_child_src_csp_url,json=extraChildSrcCspUrl,proto3" json:"extra_child_src_csp_url,omitempty"` // Whether tasks should be run in FIFO or LIFO order. UseLifo bool `protobuf:"varint,17,opt,name=use_lifo,json=useLifo,proto3" json:"use_lifo,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Schema for settings.cfg service config file in luci-config.
func (*SettingsCfg) Descriptor ¶
func (*SettingsCfg) Descriptor() ([]byte, []int)
func (*SettingsCfg) GetAuth ¶
func (m *SettingsCfg) GetAuth() *AuthSettings
func (*SettingsCfg) GetBotDeathTimeoutSecs ¶
func (m *SettingsCfg) GetBotDeathTimeoutSecs() int32
func (*SettingsCfg) GetBotIsolateGrpcProxy ¶
func (m *SettingsCfg) GetBotIsolateGrpcProxy() string
func (*SettingsCfg) GetBotSwarmingGrpcProxy ¶
func (m *SettingsCfg) GetBotSwarmingGrpcProxy() string
func (*SettingsCfg) GetCipd ¶
func (m *SettingsCfg) GetCipd() *CipdSettings
func (*SettingsCfg) GetDisplayServerUrlTemplate ¶
func (m *SettingsCfg) GetDisplayServerUrlTemplate() string
func (*SettingsCfg) GetEnableTsMonitoring ¶
func (m *SettingsCfg) GetEnableTsMonitoring() bool
func (*SettingsCfg) GetExtraChildSrcCspUrl ¶
func (m *SettingsCfg) GetExtraChildSrcCspUrl() []string
func (*SettingsCfg) GetForceBotsToSleepAndNotRunTask ¶
func (m *SettingsCfg) GetForceBotsToSleepAndNotRunTask() bool
func (*SettingsCfg) GetGoogleAnalytics ¶
func (m *SettingsCfg) GetGoogleAnalytics() string
func (*SettingsCfg) GetIsolate ¶
func (m *SettingsCfg) GetIsolate() *IsolateSettings
func (*SettingsCfg) GetMaxBotSleepTime ¶
func (m *SettingsCfg) GetMaxBotSleepTime() int32
func (*SettingsCfg) GetReusableTaskAgeSecs ¶
func (m *SettingsCfg) GetReusableTaskAgeSecs() int32
func (*SettingsCfg) GetUiClientId ¶
func (m *SettingsCfg) GetUiClientId() string
func (*SettingsCfg) GetUseLifo ¶
func (m *SettingsCfg) GetUseLifo() bool
func (*SettingsCfg) ProtoMessage ¶
func (*SettingsCfg) ProtoMessage()
func (*SettingsCfg) Reset ¶
func (m *SettingsCfg) Reset()
func (*SettingsCfg) String ¶
func (m *SettingsCfg) String() string
func (*SettingsCfg) XXX_DiscardUnknown ¶
func (m *SettingsCfg) XXX_DiscardUnknown()
func (*SettingsCfg) XXX_Marshal ¶
func (m *SettingsCfg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SettingsCfg) XXX_Merge ¶
func (m *SettingsCfg) XXX_Merge(src proto.Message)
func (*SettingsCfg) XXX_Size ¶
func (m *SettingsCfg) XXX_Size() int
func (*SettingsCfg) XXX_Unmarshal ¶
func (m *SettingsCfg) XXX_Unmarshal(b []byte) error
type TaskTemplate ¶
type TaskTemplate struct { // This gives the template a name for the 'include' field below. This only // applies to templates defined within the PoolsCfg message (i.e. the // top-level message), not to templates inlined into a TaskTemplateDeployment. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Includes properties from the named other TaskTemplate. This can only // include templates defined in the top-level PoolsCfg message. Include []string `protobuf:"bytes,2,rep,name=include,proto3" json:"include,omitempty"` // CacheEntries are keyed by `name`, and `path` is overridden wholesale. // // It is illegal to have any TaskTemplate with multiple cache entries mapping // to the same path. It is illegal to have any cache paths overlap with cipd // package paths. Cache []*TaskTemplate_CacheEntry `protobuf:"bytes,3,rep,name=cache,proto3" json:"cache,omitempty"` // CipdPackages are keyed by (path, name), and `version` is overridden // wholesale. // // It is illegal to have any cipd paths overlap with cache entry paths. CipdPackage []*TaskTemplate_CipdPackage `protobuf:"bytes,4,rep,name=cipd_package,json=cipdPackage,proto3" json:"cipd_package,omitempty"` // Env vars are keyed by the `var` field, // // `value` fields overwrite included values. // `soft` fields overwrite included values. // `prefix` fields append to included values. For example, Doing: // // {name: "1" env { var: "PATH" prefix: "a" }} // {name: "2" env { var: "PATH" prefix: "b" }} // {name: "3" include: "1" include: "2" } // // Is equivalent to: // // {name: "3" env { var: "PATH" prefix: "a" prefix: "b" }} // // // Full Example: // // env { // var: "PATH" // value: "/disable_system_path" // prefix: "a" // prefix: "b" // prefix: "c" // soft: true // } // env { // var: "OTHER" // value: "1" // } // env { // var: "PYTHONPATH" // prefix: "a" // } // // Results in, essentially: // // $PATH=/path/to/a:/path/to/b:/path/to/c:/disable_system_path // $OTHER=1 // $PYTHONPATH=/path/to/a:$PYTHONPATH Env []*TaskTemplate_Env `protobuf:"bytes,5,rep,name=env,proto3" json:"env,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A TaskTemplate describes a set of properties (caches, CIPD packages and envvars) which apply to tasks created within a swarming pool.
TaskTemplates may either be defined inline inside of a TaskTemplateDeployment, or in "shared namespace" of the PoolsCfg.task_template field.
TaskTemplates may also include other TaskTemplates by name from the "shared namespace" in PoolsCfg. Swarming calculates the final value for a given TaskTemplate by applying all of its `include` fields depth-first, and then by applying the properties in the body of the TaskTemplate. Includes may never be repeated, including transitively. This means that "diamond shaped dependencies" are forbidden (i.e. A<-B<-D and A<-C<-D would be forbidden because `A` is included in `D` twice (via both C and B)).
func (*TaskTemplate) Descriptor ¶
func (*TaskTemplate) Descriptor() ([]byte, []int)
func (*TaskTemplate) GetCache ¶
func (m *TaskTemplate) GetCache() []*TaskTemplate_CacheEntry
func (*TaskTemplate) GetCipdPackage ¶
func (m *TaskTemplate) GetCipdPackage() []*TaskTemplate_CipdPackage
func (*TaskTemplate) GetEnv ¶
func (m *TaskTemplate) GetEnv() []*TaskTemplate_Env
func (*TaskTemplate) GetInclude ¶
func (m *TaskTemplate) GetInclude() []string
func (*TaskTemplate) GetName ¶
func (m *TaskTemplate) GetName() string
func (*TaskTemplate) ProtoMessage ¶
func (*TaskTemplate) ProtoMessage()
func (*TaskTemplate) Reset ¶
func (m *TaskTemplate) Reset()
func (*TaskTemplate) String ¶
func (m *TaskTemplate) String() string
func (*TaskTemplate) XXX_DiscardUnknown ¶
func (m *TaskTemplate) XXX_DiscardUnknown()
func (*TaskTemplate) XXX_Marshal ¶
func (m *TaskTemplate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TaskTemplate) XXX_Merge ¶
func (m *TaskTemplate) XXX_Merge(src proto.Message)
func (*TaskTemplate) XXX_Size ¶
func (m *TaskTemplate) XXX_Size() int
func (*TaskTemplate) XXX_Unmarshal ¶
func (m *TaskTemplate) XXX_Unmarshal(b []byte) error
type TaskTemplateDeployment ¶
type TaskTemplateDeployment struct { // This gives the deployment a name for the 'task_template_deployment' field // in PoolCfg. // // When this TaskTemplateDeployment is inlined into another message (e.g. // `TaskTemplate.task_template_deployment_inline`), the name field must not be // specified. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Most Deployments will have a TaskTemplate with just a single include // directive. // // However, pools which substantially differ from other ones could define an // entire template inline without being forced to put it in the shared // namespace. // // The name field in this template (and the canary template) must not be // specified. Prod *TaskTemplate `protobuf:"bytes,2,opt,name=prod,proto3" json:"prod,omitempty"` // The canary template can be defined like the `prod` field above. If this is // defined and `canary_chance` is greater than 0, then this template will be // selected instead of `prod`. Canary *TaskTemplate `protobuf:"bytes,3,opt,name=canary,proto3" json:"canary,omitempty"` // range [0, 9999] where each tick corresponds to %0.01 chance of selecting // the template. Exactly 0 means 'canary is disabled', meaning that tasks // in this pool will always get the prod template. // // Examples: // * 1 ".01% chance of picking canary" // * 10 ".1% chance of picking canary" // * 100 "1% chance of picking canary" // * 1000 "10% chance of picking canary" // * 5000 "50% chance of picking canary" // * 7500 "75% chance of picking canary" // * 9999 "99.99% chance of picking canary" CanaryChance int32 `protobuf:"varint,4,opt,name=canary_chance,json=canaryChance,proto3" json:"canary_chance,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
This is a tuple of (prod template, canary template, canary_chance), so that it can be referenced from multiple pools simultaneously as a single unit.
func (*TaskTemplateDeployment) Descriptor ¶
func (*TaskTemplateDeployment) Descriptor() ([]byte, []int)
func (*TaskTemplateDeployment) GetCanary ¶
func (m *TaskTemplateDeployment) GetCanary() *TaskTemplate
func (*TaskTemplateDeployment) GetCanaryChance ¶
func (m *TaskTemplateDeployment) GetCanaryChance() int32
func (*TaskTemplateDeployment) GetName ¶
func (m *TaskTemplateDeployment) GetName() string
func (*TaskTemplateDeployment) GetProd ¶
func (m *TaskTemplateDeployment) GetProd() *TaskTemplate
func (*TaskTemplateDeployment) ProtoMessage ¶
func (*TaskTemplateDeployment) ProtoMessage()
func (*TaskTemplateDeployment) Reset ¶
func (m *TaskTemplateDeployment) Reset()
func (*TaskTemplateDeployment) String ¶
func (m *TaskTemplateDeployment) String() string
func (*TaskTemplateDeployment) XXX_DiscardUnknown ¶
func (m *TaskTemplateDeployment) XXX_DiscardUnknown()
func (*TaskTemplateDeployment) XXX_Marshal ¶
func (m *TaskTemplateDeployment) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TaskTemplateDeployment) XXX_Merge ¶
func (m *TaskTemplateDeployment) XXX_Merge(src proto.Message)
func (*TaskTemplateDeployment) XXX_Size ¶
func (m *TaskTemplateDeployment) XXX_Size() int
func (*TaskTemplateDeployment) XXX_Unmarshal ¶
func (m *TaskTemplateDeployment) XXX_Unmarshal(b []byte) error
type TaskTemplate_CacheEntry ¶
type TaskTemplate_CacheEntry struct { // The name of the cache (required). Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The path relative to the task root to mount the cache (required). Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*TaskTemplate_CacheEntry) Descriptor ¶
func (*TaskTemplate_CacheEntry) Descriptor() ([]byte, []int)
func (*TaskTemplate_CacheEntry) GetName ¶
func (m *TaskTemplate_CacheEntry) GetName() string
func (*TaskTemplate_CacheEntry) GetPath ¶
func (m *TaskTemplate_CacheEntry) GetPath() string
func (*TaskTemplate_CacheEntry) ProtoMessage ¶
func (*TaskTemplate_CacheEntry) ProtoMessage()
func (*TaskTemplate_CacheEntry) Reset ¶
func (m *TaskTemplate_CacheEntry) Reset()
func (*TaskTemplate_CacheEntry) String ¶
func (m *TaskTemplate_CacheEntry) String() string
func (*TaskTemplate_CacheEntry) XXX_DiscardUnknown ¶
func (m *TaskTemplate_CacheEntry) XXX_DiscardUnknown()
func (*TaskTemplate_CacheEntry) XXX_Marshal ¶
func (m *TaskTemplate_CacheEntry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TaskTemplate_CacheEntry) XXX_Merge ¶
func (m *TaskTemplate_CacheEntry) XXX_Merge(src proto.Message)
func (*TaskTemplate_CacheEntry) XXX_Size ¶
func (m *TaskTemplate_CacheEntry) XXX_Size() int
func (*TaskTemplate_CacheEntry) XXX_Unmarshal ¶
func (m *TaskTemplate_CacheEntry) XXX_Unmarshal(b []byte) error
type TaskTemplate_CipdPackage ¶
type TaskTemplate_CipdPackage struct { // The relative to the task root to unpack the CIPD package. A blank value // is permitted and means 'the root directory of the task'. Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` // The CIPD package name template to use (required). Pkg string `protobuf:"bytes,2,opt,name=pkg,proto3" json:"pkg,omitempty"` // The version of the CIPD package to use (required). Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*TaskTemplate_CipdPackage) Descriptor ¶
func (*TaskTemplate_CipdPackage) Descriptor() ([]byte, []int)
func (*TaskTemplate_CipdPackage) GetPath ¶
func (m *TaskTemplate_CipdPackage) GetPath() string
func (*TaskTemplate_CipdPackage) GetPkg ¶
func (m *TaskTemplate_CipdPackage) GetPkg() string
func (*TaskTemplate_CipdPackage) GetVersion ¶
func (m *TaskTemplate_CipdPackage) GetVersion() string
func (*TaskTemplate_CipdPackage) ProtoMessage ¶
func (*TaskTemplate_CipdPackage) ProtoMessage()
func (*TaskTemplate_CipdPackage) Reset ¶
func (m *TaskTemplate_CipdPackage) Reset()
func (*TaskTemplate_CipdPackage) String ¶
func (m *TaskTemplate_CipdPackage) String() string
func (*TaskTemplate_CipdPackage) XXX_DiscardUnknown ¶
func (m *TaskTemplate_CipdPackage) XXX_DiscardUnknown()
func (*TaskTemplate_CipdPackage) XXX_Marshal ¶
func (m *TaskTemplate_CipdPackage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TaskTemplate_CipdPackage) XXX_Merge ¶
func (m *TaskTemplate_CipdPackage) XXX_Merge(src proto.Message)
func (*TaskTemplate_CipdPackage) XXX_Size ¶
func (m *TaskTemplate_CipdPackage) XXX_Size() int
func (*TaskTemplate_CipdPackage) XXX_Unmarshal ¶
func (m *TaskTemplate_CipdPackage) XXX_Unmarshal(b []byte) error
type TaskTemplate_Env ¶
type TaskTemplate_Env struct { // The envvar you want to set (required). Var string `protobuf:"bytes,1,opt,name=var,proto3" json:"var,omitempty"` // The envvar value you want to set. Any prefixes are prepended to this // value. If the value is unset, prefixes will be prepended to the bot's // current value of this envvar (see examples) Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // Paths relative to the task root to prepend to this envvar on the bot. // These will be resolved to absolute paths on the bot. Prefix []string `protobuf:"bytes,3,rep,name=prefix,proto3" json:"prefix,omitempty"` // If true, tasks setting this EnvVar can overwrite the value and/or the // prefix. Otherwise, tasks will not be permitted to to set any env var or // env_prefix for this var. // // This should be True for envvars you expect tasks to extend, like $PATH. // Note that this only affects envvar manipulation at the Swarming API // level; once the task is running it can (of course) manipulate the env // however it wants. Soft bool `protobuf:"varint,4,opt,name=soft,proto3" json:"soft,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*TaskTemplate_Env) Descriptor ¶
func (*TaskTemplate_Env) Descriptor() ([]byte, []int)
func (*TaskTemplate_Env) GetPrefix ¶
func (m *TaskTemplate_Env) GetPrefix() []string
func (*TaskTemplate_Env) GetSoft ¶
func (m *TaskTemplate_Env) GetSoft() bool
func (*TaskTemplate_Env) GetValue ¶
func (m *TaskTemplate_Env) GetValue() string
func (*TaskTemplate_Env) GetVar ¶
func (m *TaskTemplate_Env) GetVar() string
func (*TaskTemplate_Env) ProtoMessage ¶
func (*TaskTemplate_Env) ProtoMessage()
func (*TaskTemplate_Env) Reset ¶
func (m *TaskTemplate_Env) Reset()
func (*TaskTemplate_Env) String ¶
func (m *TaskTemplate_Env) String() string
func (*TaskTemplate_Env) XXX_DiscardUnknown ¶
func (m *TaskTemplate_Env) XXX_DiscardUnknown()
func (*TaskTemplate_Env) XXX_Marshal ¶
func (m *TaskTemplate_Env) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TaskTemplate_Env) XXX_Merge ¶
func (m *TaskTemplate_Env) XXX_Merge(src proto.Message)
func (*TaskTemplate_Env) XXX_Size ¶
func (m *TaskTemplate_Env) XXX_Size() int
func (*TaskTemplate_Env) XXX_Unmarshal ¶
func (m *TaskTemplate_Env) XXX_Unmarshal(b []byte) error
type TrustedDelegation ¶
type TrustedDelegation struct { // Email of a trusted delegatee (the one who's minting the delegation token). PeerId string `protobuf:"bytes,1,opt,name=peer_id,json=peerId,proto3" json:"peer_id,omitempty"` // A list of tags to expected in the delegation token to allow the usage of // a pool. // // Presence of any of the specified tags are enough. The format of these tags // generally depends on what service is doing the delegation. RequireAnyOf *TrustedDelegation_TagList `protobuf:"bytes,2,opt,name=require_any_of,json=requireAnyOf,proto3" json:"require_any_of,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Defines a delegatee trusted to make authorization decisions for who can use a pool.
This is based on LUCI delegation protocol. Imagine an end user U calling Swarming through an intermediary service X. In this case U is a delegator and X is a delegatee. When X calls Swarming, it makes an RPC to the token server to make a delegation token that says "<X can call Swarming on behalf of U>".
This token is then sent to the Swarming with the RPC. Swarming sees that the direct peer it's talking to is X, but the call should be performed under the authority of U.
We extend this to also allow X make authorization decisions about whether U can use particular Swarming resource or not. The result of this decision is encoded in the delegation token as a set of "key:value" tags. Swarming then can treat presence of such tags as a signal that the particular call is allowed.
In this scenario we totally trust X to make the correct decision.
func (*TrustedDelegation) Descriptor ¶
func (*TrustedDelegation) Descriptor() ([]byte, []int)
func (*TrustedDelegation) GetPeerId ¶
func (m *TrustedDelegation) GetPeerId() string
func (*TrustedDelegation) GetRequireAnyOf ¶
func (m *TrustedDelegation) GetRequireAnyOf() *TrustedDelegation_TagList
func (*TrustedDelegation) ProtoMessage ¶
func (*TrustedDelegation) ProtoMessage()
func (*TrustedDelegation) Reset ¶
func (m *TrustedDelegation) Reset()
func (*TrustedDelegation) String ¶
func (m *TrustedDelegation) String() string
func (*TrustedDelegation) XXX_DiscardUnknown ¶
func (m *TrustedDelegation) XXX_DiscardUnknown()
func (*TrustedDelegation) XXX_Marshal ¶
func (m *TrustedDelegation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TrustedDelegation) XXX_Merge ¶
func (m *TrustedDelegation) XXX_Merge(src proto.Message)
func (*TrustedDelegation) XXX_Size ¶
func (m *TrustedDelegation) XXX_Size() int
func (*TrustedDelegation) XXX_Unmarshal ¶
func (m *TrustedDelegation) XXX_Unmarshal(b []byte) error
type TrustedDelegation_TagList ¶
type TrustedDelegation_TagList struct { Tag []string `protobuf:"bytes,1,rep,name=tag,proto3" json:"tag,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*TrustedDelegation_TagList) Descriptor ¶
func (*TrustedDelegation_TagList) Descriptor() ([]byte, []int)
func (*TrustedDelegation_TagList) GetTag ¶
func (m *TrustedDelegation_TagList) GetTag() []string
func (*TrustedDelegation_TagList) ProtoMessage ¶
func (*TrustedDelegation_TagList) ProtoMessage()
func (*TrustedDelegation_TagList) Reset ¶
func (m *TrustedDelegation_TagList) Reset()
func (*TrustedDelegation_TagList) String ¶
func (m *TrustedDelegation_TagList) String() string
func (*TrustedDelegation_TagList) XXX_DiscardUnknown ¶
func (m *TrustedDelegation_TagList) XXX_DiscardUnknown()
func (*TrustedDelegation_TagList) XXX_Marshal ¶
func (m *TrustedDelegation_TagList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TrustedDelegation_TagList) XXX_Merge ¶
func (m *TrustedDelegation_TagList) XXX_Merge(src proto.Message)
func (*TrustedDelegation_TagList) XXX_Size ¶
func (m *TrustedDelegation_TagList) XXX_Size() int
func (*TrustedDelegation_TagList) XXX_Unmarshal ¶
func (m *TrustedDelegation_TagList) XXX_Unmarshal(b []byte) error