config

package
Version: v0.0.0-...-325d0e7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2021 License: Apache-2.0 Imports: 5 Imported by: 10

Documentation

Overview

Package config contains luci-config protobuf definitions.

Copied from:

Repo: https://chromium.googlesource.com/infra/luci/luci-py/ Revision: 220c97e227bb420292e8ade4e5de7323997ac025 Path: appengine/components/components/config/proto/*.proto

Modification: added luci.* options.

Index

Constants

This section is empty.

Variables

View Source
var (
	ValidationResponseMessage_Severity_name = map[int32]string{
		0:  "UNKNOWN",
		10: "DEBUG",
		20: "INFO",
		30: "WARNING",
		40: "ERROR",
		50: "CRITICAL",
	}
	ValidationResponseMessage_Severity_value = map[string]int32{
		"UNKNOWN":  0,
		"DEBUG":    10,
		"INFO":     20,
		"WARNING":  30,
		"ERROR":    40,
		"CRITICAL": 50,
	}
)

Enum value maps for ValidationResponseMessage_Severity.

View Source
var File_go_chromium_org_luci_common_proto_config_project_config_proto protoreflect.FileDescriptor
View Source
var File_go_chromium_org_luci_common_proto_config_service_config_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AclCfg

type AclCfg struct {

	// Name of the group that has access to all projects/* config sets.
	// Only trusted services should be in this group.
	ProjectAccessGroup string `protobuf:"bytes,2,opt,name=project_access_group,json=projectAccessGroup,proto3" json:"project_access_group,omitempty"`
	// Name of the group that has access to all services/* config sets.
	// Only trusted services should be in this group.
	ServiceAccessGroup string `protobuf:"bytes,7,opt,name=service_access_group,json=serviceAccessGroup,proto3" json:"service_access_group,omitempty"`
	// Name of the group that has admin access to the app.
	AdminGroup string `protobuf:"bytes,3,opt,name=admin_group,json=adminGroup,proto3" json:"admin_group,omitempty"`
	// Name of the group that may call validation API.
	ValidationGroup string `protobuf:"bytes,5,opt,name=validation_group,json=validationGroup,proto3" json:"validation_group,omitempty"`
	// Name of the group that may call reimport API.
	ReimportGroup string `protobuf:"bytes,6,opt,name=reimport_group,json=reimportGroup,proto3" json:"reimport_group,omitempty"`
	// contains filtered or unexported fields
}

Schema of acl.cfg file. Next tag: 8.

func (*AclCfg) Descriptor deprecated

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

Deprecated: Use AclCfg.ProtoReflect.Descriptor instead.

func (*AclCfg) GetAdminGroup

func (x *AclCfg) GetAdminGroup() string

func (*AclCfg) GetProjectAccessGroup

func (x *AclCfg) GetProjectAccessGroup() string

func (*AclCfg) GetReimportGroup

func (x *AclCfg) GetReimportGroup() string

func (*AclCfg) GetServiceAccessGroup

func (x *AclCfg) GetServiceAccessGroup() string

func (*AclCfg) GetValidationGroup

func (x *AclCfg) GetValidationGroup() string

func (*AclCfg) ProtoMessage

func (*AclCfg) ProtoMessage()

func (*AclCfg) ProtoReflect

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

func (*AclCfg) Reset

func (x *AclCfg) Reset()

func (*AclCfg) String

func (x *AclCfg) String() string

type ConfigPattern

type ConfigPattern struct {

	// A string pattern for config_set.
	ConfigSet string `protobuf:"bytes,1,opt,name=config_set,json=configSet,proto3" json:"config_set,omitempty"`
	// A string pattern for config file path.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Defines a pattern of a config identity. Both config_set and path must match.

func (*ConfigPattern) Descriptor deprecated

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

Deprecated: Use ConfigPattern.ProtoReflect.Descriptor instead.

func (*ConfigPattern) GetConfigSet

func (x *ConfigPattern) GetConfigSet() string

func (*ConfigPattern) GetPath

func (x *ConfigPattern) GetPath() string

func (*ConfigPattern) ProtoMessage

func (*ConfigPattern) ProtoMessage()

func (*ConfigPattern) ProtoReflect

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

func (*ConfigPattern) Reset

func (x *ConfigPattern) Reset()

func (*ConfigPattern) String

func (x *ConfigPattern) String() string

type GeneratorMetadata

type GeneratorMetadata struct {

	// Version of lucicfg binary used to generate the config.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Path to the main package relative to project.cfg.
	PackageDir string `protobuf:"bytes,5,opt,name=package_dir,json=packageDir,proto3" json:"package_dir,omitempty"`
	// Directory with generated LUCI project configs relative to the main package.
	ConfigDir string `protobuf:"bytes,2,opt,name=config_dir,json=configDir,proto3" json:"config_dir,omitempty"`
	// Name of the entry point Starlark file at the root of the main package.
	EntryPoint string `protobuf:"bytes,3,opt,name=entry_point,json=entryPoint,proto3" json:"entry_point,omitempty"`
	// Set of vars passed to lucicfg as "-var ...".
	Vars map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

GeneratorMetadata is produced by lucicfg to describe how it generated the config.

func (*GeneratorMetadata) Descriptor deprecated

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

Deprecated: Use GeneratorMetadata.ProtoReflect.Descriptor instead.

func (*GeneratorMetadata) GetConfigDir

func (x *GeneratorMetadata) GetConfigDir() string

func (*GeneratorMetadata) GetEntryPoint

func (x *GeneratorMetadata) GetEntryPoint() string

func (*GeneratorMetadata) GetPackageDir

func (x *GeneratorMetadata) GetPackageDir() string

func (*GeneratorMetadata) GetVars

func (x *GeneratorMetadata) GetVars() map[string]string

func (*GeneratorMetadata) GetVersion

func (x *GeneratorMetadata) GetVersion() string

func (*GeneratorMetadata) ProtoMessage

func (*GeneratorMetadata) ProtoMessage()

func (*GeneratorMetadata) ProtoReflect

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

func (*GeneratorMetadata) Reset

func (x *GeneratorMetadata) Reset()

func (*GeneratorMetadata) String

func (x *GeneratorMetadata) String() string

type GitilesLocation

type GitilesLocation struct {

	// URL of the Git repository.
	// Must not end with "/".
	// Must not end with ".git".
	// Must not have "/a/" prefix of a path component.
	//
	// Example:
	//   OK:
	//     https://chromium.googlesource.com/infra/infra
	//   Not OK:
	//     https://chromium.googlesource.com/a/infra/infra
	//     https://chromium.googlesource.com/infra/infra/
	//     https://chromium.googlesource.com/infra/infra.git
	Repo string `protobuf:"bytes,1,opt,name=repo,proto3" json:"repo,omitempty"`
	// Ref of the Git repository.
	// Must be a fully qualifed ref starting with "refs/".
	//
	// Example:
	//   OK:
	//     refs/heads/branch
	//     refs/heads/infra/config
	//     refs/branch-heads/beta
	//   Not OK:
	//     master
	//     HEAD
	//     origin/main
	//     tags/123
	Ref string `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// Path to the directory inside Git repository where configurations are stored.
	// Optional. If not specified, defaults to top-level folder of the git repo.
	// Must not start or end with "/".
	//
	// Example:
	//   OK:
	//     infra/config/generated
	//       (empty string)
	//   NOT OK:
	//     /
	//     /config
	//     infra/config/
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Use to specify configuration stored in Git repository importable via Gitiles API.

func (*GitilesLocation) Descriptor deprecated

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

Deprecated: Use GitilesLocation.ProtoReflect.Descriptor instead.

func (*GitilesLocation) GetPath

func (x *GitilesLocation) GetPath() string

func (*GitilesLocation) GetRef

func (x *GitilesLocation) GetRef() string

func (*GitilesLocation) GetRepo

func (x *GitilesLocation) GetRepo() string

func (*GitilesLocation) ProtoMessage

func (*GitilesLocation) ProtoMessage()

func (*GitilesLocation) ProtoReflect

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

func (*GitilesLocation) Reset

func (x *GitilesLocation) Reset()

func (*GitilesLocation) String

func (x *GitilesLocation) String() string

type IdentityConfig

type IdentityConfig struct {

	// ServiceAccountEmail is the full service account email to use when
	// LUCI acts on behalf of the project.
	//
	// Note: Due to token caching, it takes ~15 minutes for a config change
	// to become effective. Keep this in mind when migrating projects to a
	// new identity.
	ServiceAccountEmail string `protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
	// contains filtered or unexported fields
}

Used to define project specific identities for LUCI to act on behalf when interacting with external systems. This allows projects to use exclusive and isolated identities to not be accidentally affected by other projects.

func (*IdentityConfig) Descriptor deprecated

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

Deprecated: Use IdentityConfig.ProtoReflect.Descriptor instead.

func (*IdentityConfig) GetServiceAccountEmail

func (x *IdentityConfig) GetServiceAccountEmail() string

func (*IdentityConfig) ProtoMessage

func (*IdentityConfig) ProtoMessage()

func (*IdentityConfig) ProtoReflect

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

func (*IdentityConfig) Reset

func (x *IdentityConfig) Reset()

func (*IdentityConfig) String

func (x *IdentityConfig) String() string

type ImportCfg

type ImportCfg struct {

	// Configuration of import from Gitiles repositories.
	Gitiles *ImportCfg_Gitiles `protobuf:"bytes,1,opt,name=gitiles,proto3" json:"gitiles,omitempty"`
	// contains filtered or unexported fields
}

Schema for import.cfg. It specified how to import configuration files from external sources.

func (*ImportCfg) Descriptor deprecated

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

Deprecated: Use ImportCfg.ProtoReflect.Descriptor instead.

func (*ImportCfg) GetGitiles

func (x *ImportCfg) GetGitiles() *ImportCfg_Gitiles

func (*ImportCfg) ProtoMessage

func (*ImportCfg) ProtoMessage()

func (*ImportCfg) ProtoReflect

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

func (*ImportCfg) Reset

func (x *ImportCfg) Reset()

func (*ImportCfg) String

func (x *ImportCfg) String() string

type ImportCfg_Gitiles

type ImportCfg_Gitiles struct {

	// Request timeout in seconds when requesting commit log.
	FetchLogDeadline int32 `protobuf:"varint,1,opt,name=fetch_log_deadline,json=fetchLogDeadline,proto3" json:"fetch_log_deadline,omitempty"`
	// Request timeout in seconds when requesting directory archive.
	FetchArchiveDeadline int32 `protobuf:"varint,2,opt,name=fetch_archive_deadline,json=fetchArchiveDeadline,proto3" json:"fetch_archive_deadline,omitempty"`
	// DEPRECATED, ignored. TODO(nodir): remove.
	// Default ref for project configs.
	ProjectConfigDefaultRef string `` /* 134-byte string literal not displayed */
	// DEPRECATED, ignored. TODO(nodir): remove.
	// Default directory for project configs.
	ProjectConfigDefaultPath string `` /* 137-byte string literal not displayed */
	// Default directory for ref configs.
	RefConfigDefaultPath string `protobuf:"bytes,5,opt,name=ref_config_default_path,json=refConfigDefaultPath,proto3" json:"ref_config_default_path,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportCfg_Gitiles) Descriptor deprecated

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

Deprecated: Use ImportCfg_Gitiles.ProtoReflect.Descriptor instead.

func (*ImportCfg_Gitiles) GetFetchArchiveDeadline

func (x *ImportCfg_Gitiles) GetFetchArchiveDeadline() int32

func (*ImportCfg_Gitiles) GetFetchLogDeadline

func (x *ImportCfg_Gitiles) GetFetchLogDeadline() int32

func (*ImportCfg_Gitiles) GetProjectConfigDefaultPath

func (x *ImportCfg_Gitiles) GetProjectConfigDefaultPath() string

func (*ImportCfg_Gitiles) GetProjectConfigDefaultRef

func (x *ImportCfg_Gitiles) GetProjectConfigDefaultRef() string

func (*ImportCfg_Gitiles) GetRefConfigDefaultPath

func (x *ImportCfg_Gitiles) GetRefConfigDefaultPath() string

func (*ImportCfg_Gitiles) ProtoMessage

func (*ImportCfg_Gitiles) ProtoMessage()

func (*ImportCfg_Gitiles) ProtoReflect

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

func (*ImportCfg_Gitiles) Reset

func (x *ImportCfg_Gitiles) Reset()

func (*ImportCfg_Gitiles) String

func (x *ImportCfg_Gitiles) String() string

type Project

type Project struct {

	// Globally unique id of the project.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Where to import "projects/<id>" config set from.
	//
	// Types that are assignable to Location:
	//	*Project_GitilesLocation
	Location isProject_Location `protobuf_oneof:"location"`
	// IdentityConfig determines what identities are used when LUCI acts on
	// behalf of the project towards external services.
	IdentityConfig *IdentityConfig `protobuf:"bytes,3,opt,name=identity_config,json=identityConfig,proto3" json:"identity_config,omitempty"`
	// The Team `name` of the Team which owns this Project.
	//
	// Note that the same Team may be indicated for multiple different Projects.
	OwnedBy string `protobuf:"bytes,5,opt,name=owned_by,json=ownedBy,proto3" json:"owned_by,omitempty"`
	// contains filtered or unexported fields
}

A tenant of a service. Defined in projects.cfg.

func (*Project) Descriptor deprecated

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

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetGitilesLocation

func (x *Project) GetGitilesLocation() *GitilesLocation

func (*Project) GetId

func (x *Project) GetId() string

func (*Project) GetIdentityConfig

func (x *Project) GetIdentityConfig() *IdentityConfig

func (*Project) GetLocation

func (m *Project) GetLocation() isProject_Location

func (*Project) GetOwnedBy

func (x *Project) GetOwnedBy() string

func (*Project) ProtoMessage

func (*Project) ProtoMessage()

func (*Project) ProtoReflect

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

func (*Project) Reset

func (x *Project) Reset()

func (*Project) String

func (x *Project) String() string

type ProjectCfg

type ProjectCfg struct {

	// Full name of the project.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A list of identities that have read-only access to the project.
	//
	// An element is one of:
	// * "group:<group>", where group is defined on auth server.
	// * "<email>"
	// * "<kind>:<value>" (for non-email identities)
	//
	// If not specified, only admins and trusted services have access.
	// Talk to admins to determine the group name appropriate for your project.
	Access []string `protobuf:"bytes,2,rep,name=access,proto3" json:"access,omitempty"`
	// Populated when the config is generated by `lucicfg`.
	//
	// Contains information about how the config was generated.
	Lucicfg *GeneratorMetadata `protobuf:"bytes,3,opt,name=lucicfg,proto3" json:"lucicfg,omitempty"`
	// contains filtered or unexported fields
}

Schema for project.cfg

func (*ProjectCfg) Descriptor deprecated

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

Deprecated: Use ProjectCfg.ProtoReflect.Descriptor instead.

func (*ProjectCfg) GetAccess

func (x *ProjectCfg) GetAccess() []string

func (*ProjectCfg) GetLucicfg

func (x *ProjectCfg) GetLucicfg() *GeneratorMetadata

func (*ProjectCfg) GetName

func (x *ProjectCfg) GetName() string

func (*ProjectCfg) ProtoMessage

func (*ProjectCfg) ProtoMessage()

func (*ProjectCfg) ProtoReflect

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

func (*ProjectCfg) Reset

func (x *ProjectCfg) Reset()

func (*ProjectCfg) String

func (x *ProjectCfg) String() string

type Project_GitilesLocation

type Project_GitilesLocation struct {
	GitilesLocation *GitilesLocation `protobuf:"bytes,4,opt,name=gitiles_location,json=gitilesLocation,proto3,oneof"`
}

type ProjectsCfg

type ProjectsCfg struct {

	// All projects served by this instance of LUCI.
	Projects []*Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"`
	// All teams which own projects.
	Teams []*Team `protobuf:"bytes,2,rep,name=teams,proto3" json:"teams,omitempty"`
	// contains filtered or unexported fields
}

Schema of projects.cfg file. Represents LUCI tenants registry.

func (*ProjectsCfg) Descriptor deprecated

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

Deprecated: Use ProjectsCfg.ProtoReflect.Descriptor instead.

func (*ProjectsCfg) GetProjects

func (x *ProjectsCfg) GetProjects() []*Project

func (*ProjectsCfg) GetTeams

func (x *ProjectsCfg) GetTeams() []*Team

func (*ProjectsCfg) ProtoMessage

func (*ProjectsCfg) ProtoMessage()

func (*ProjectsCfg) ProtoReflect

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

func (*ProjectsCfg) Reset

func (x *ProjectsCfg) Reset()

func (*ProjectsCfg) String

func (x *ProjectsCfg) String() string

type RefsCfg

type RefsCfg struct {

	// List of refs that have configuration files and need to be fetched into
	// luci-config. Refs are accessible through get_refs() API endpoint.
	// A CI service can read all refs of all projects and build them.
	Refs []*RefsCfg_Ref `protobuf:"bytes,1,rep,name=refs,proto3" json:"refs,omitempty"`
	// contains filtered or unexported fields
}

DEPRECATED per crbug/924803. DO NOT USE in your project. Contact luci-team@ if you have a need for this.

Schema of refs.cfg.

func (*RefsCfg) Descriptor deprecated

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

Deprecated: Use RefsCfg.ProtoReflect.Descriptor instead.

func (*RefsCfg) GetRefs

func (x *RefsCfg) GetRefs() []*RefsCfg_Ref

func (*RefsCfg) ProtoMessage

func (*RefsCfg) ProtoMessage()

func (*RefsCfg) ProtoReflect

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

func (*RefsCfg) Reset

func (x *RefsCfg) Reset()

func (*RefsCfg) String

func (x *RefsCfg) String() string

type RefsCfg_Ref

type RefsCfg_Ref struct {

	// Name of the ref. Must start with "refs/".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Path to config directory for the ref. Defaults to "infra/config".
	ConfigPath string `protobuf:"bytes,3,opt,name=config_path,json=configPath,proto3" json:"config_path,omitempty"`
	// contains filtered or unexported fields
}

func (*RefsCfg_Ref) Descriptor deprecated

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

Deprecated: Use RefsCfg_Ref.ProtoReflect.Descriptor instead.

func (*RefsCfg_Ref) GetConfigPath

func (x *RefsCfg_Ref) GetConfigPath() string

func (*RefsCfg_Ref) GetName

func (x *RefsCfg_Ref) GetName() string

func (*RefsCfg_Ref) ProtoMessage

func (*RefsCfg_Ref) ProtoMessage()

func (*RefsCfg_Ref) ProtoReflect

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

func (*RefsCfg_Ref) Reset

func (x *RefsCfg_Ref) Reset()

func (*RefsCfg_Ref) String

func (x *RefsCfg_Ref) String() string

type SchemasCfg

type SchemasCfg struct {

	// List of known schemas. They are available at /schemas/<name> as a short
	// mutable link.
	Schemas []*SchemasCfg_Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// contains filtered or unexported fields
}

Schema of schemas.cfg

func (*SchemasCfg) Descriptor deprecated

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

Deprecated: Use SchemasCfg.ProtoReflect.Descriptor instead.

func (*SchemasCfg) GetSchemas

func (x *SchemasCfg) GetSchemas() []*SchemasCfg_Schema

func (*SchemasCfg) ProtoMessage

func (*SchemasCfg) ProtoMessage()

func (*SchemasCfg) ProtoReflect

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

func (*SchemasCfg) Reset

func (x *SchemasCfg) Reset()

func (*SchemasCfg) String

func (x *SchemasCfg) String() string

type SchemasCfg_Schema

type SchemasCfg_Schema struct {

	// Name of schema.
	// For service configs, "<config_set>:<path>"
	// For project configs, "projects:<path>"
	// For ref configs, "projects/refs:<path>"
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// URL to the schema definition, e.g. to a .proto file in a repository.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*SchemasCfg_Schema) Descriptor deprecated

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

Deprecated: Use SchemasCfg_Schema.ProtoReflect.Descriptor instead.

func (*SchemasCfg_Schema) GetName

func (x *SchemasCfg_Schema) GetName() string

func (*SchemasCfg_Schema) GetUrl

func (x *SchemasCfg_Schema) GetUrl() string

func (*SchemasCfg_Schema) ProtoMessage

func (*SchemasCfg_Schema) ProtoMessage()

func (*SchemasCfg_Schema) ProtoReflect

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

func (*SchemasCfg_Schema) Reset

func (x *SchemasCfg_Schema) Reset()

func (*SchemasCfg_Schema) String

func (x *SchemasCfg_Schema) String() string

type Service

type Service struct {

	// Globally unique id of the service. Required.
	// Used in "services/<service_id>" config set name.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Email addresses of responsible and point-of-contacts for the service.
	Owners []string `protobuf:"bytes,2,rep,name=owners,proto3" json:"owners,omitempty"`
	// An HTTPS endpoint that returns JSON-encoded ServiceDynamicMetadata in body.
	MetadataUrl string `protobuf:"bytes,4,opt,name=metadata_url,json=metadataUrl,proto3" json:"metadata_url,omitempty"`
	// A list of identities that have access to this service's configs.
	// of:
	// * "group:<group>", where group is defined on auth server.
	// * "<email>"
	// * "<kind>:<value>" (for non-email identities)
	//
	// If not specified, only admins and trusted services have access.
	Access []string `protobuf:"bytes,5,rep,name=access,proto3" json:"access,omitempty"`
	// If set, use JWT auth in requests to services. This is usually used for
	// Cloud Endpoints v2 support.
	JwtAuth *Service_JWTAuth `protobuf:"bytes,6,opt,name=jwt_auth,json=jwtAuth,proto3" json:"jwt_auth,omitempty"`
	// contains filtered or unexported fields
}

Describes one LUCI service.

func (*Service) Descriptor deprecated

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

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetAccess

func (x *Service) GetAccess() []string

func (*Service) GetId

func (x *Service) GetId() string

func (*Service) GetJwtAuth

func (x *Service) GetJwtAuth() *Service_JWTAuth

func (*Service) GetMetadataUrl

func (x *Service) GetMetadataUrl() string

func (*Service) GetOwners

func (x *Service) GetOwners() []string

func (*Service) ProtoMessage

func (*Service) ProtoMessage()

func (*Service) ProtoReflect

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

func (*Service) Reset

func (x *Service) Reset()

func (*Service) String

func (x *Service) String() string

type ServiceDynamicMetadata

type ServiceDynamicMetadata struct {

	// Format version. Supported versions: 1.0.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// What configs this service can validate and how to validate them.
	Validation *Validator `protobuf:"bytes,2,opt,name=validation,proto3" json:"validation,omitempty"`
	// contains filtered or unexported fields
}

Machine-generated service metadata, exposed by a service endpoint. Typically implemented by config component, embedded in an app: see appengine/components/components/config/endpoint.py

If you add a field here, also add it to ServiceDynamicMetadata in endpoint.py

func (*ServiceDynamicMetadata) Descriptor deprecated

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

Deprecated: Use ServiceDynamicMetadata.ProtoReflect.Descriptor instead.

func (*ServiceDynamicMetadata) GetValidation

func (x *ServiceDynamicMetadata) GetValidation() *Validator

func (*ServiceDynamicMetadata) GetVersion

func (x *ServiceDynamicMetadata) GetVersion() string

func (*ServiceDynamicMetadata) ProtoMessage

func (*ServiceDynamicMetadata) ProtoMessage()

func (*ServiceDynamicMetadata) ProtoReflect

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

func (*ServiceDynamicMetadata) Reset

func (x *ServiceDynamicMetadata) Reset()

func (*ServiceDynamicMetadata) String

func (x *ServiceDynamicMetadata) String() string

type Service_JWTAuth

type Service_JWTAuth struct {

	// Value for the 'aud' field in the JSON Web Token claim.
	Audience string `protobuf:"bytes,1,opt,name=audience,proto3" json:"audience,omitempty"`
	// contains filtered or unexported fields
}

func (*Service_JWTAuth) Descriptor deprecated

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

Deprecated: Use Service_JWTAuth.ProtoReflect.Descriptor instead.

func (*Service_JWTAuth) GetAudience

func (x *Service_JWTAuth) GetAudience() string

func (*Service_JWTAuth) ProtoMessage

func (*Service_JWTAuth) ProtoMessage()

func (*Service_JWTAuth) ProtoReflect

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

func (*Service_JWTAuth) Reset

func (x *Service_JWTAuth) Reset()

func (*Service_JWTAuth) String

func (x *Service_JWTAuth) String() string

type ServicesCfg

type ServicesCfg struct {

	// A list of all LUCI services. Should be sorted by id.
	Services []*Service `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
	// contains filtered or unexported fields
}

Schema of services.cfg

func (*ServicesCfg) Descriptor deprecated

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

Deprecated: Use ServicesCfg.ProtoReflect.Descriptor instead.

func (*ServicesCfg) GetServices

func (x *ServicesCfg) GetServices() []*Service

func (*ServicesCfg) ProtoMessage

func (*ServicesCfg) ProtoMessage()

func (*ServicesCfg) ProtoReflect

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

func (*ServicesCfg) Reset

func (x *ServicesCfg) Reset()

func (*ServicesCfg) String

func (x *ServicesCfg) String() string

type Team

type Team struct {

	// The name of this team; Used for the Project.team field, but also may
	// be used in e.g. email as the addressee for maintenance messages, like:
	//
	//   Hello ${Team.name} LUCI maintainers,
	//
	// Examples:
	//   GOOD: "ChOps Foundation"
	//   BAD:  "cft"
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// One or more contact emails for this team.
	//
	// ALL of these email addresses will be used by the LUCI system owners to
	// contact the team with maintenance requests/deprecation notices. For
	// example, if some LUCI functionality is deprecated and needs to be migrated,
	// then an email would be sent to all contacts listed in this field.
	//
	// We recommend setting this to your team's dev-group email.
	MaintenanceContact []string `protobuf:"bytes,2,rep,name=maintenance_contact,json=maintenanceContact,proto3" json:"maintenance_contact,omitempty"`
	// One or more fallback emails for this team.
	//
	// If the LUCI system owners attempt to contact the team via
	// `maintenance_contact` and there's no response, these emails will be
	// CC'd in increasing order until we get in contact with someone.
	//
	// If the LUCI system owners cannot contact anyone in `maintenance_contact` or
	// in `escalation_contact`, we may need to disable the associated LUCI
	// project(s).
	//
	// We recommend setting this to one or two individual people who are
	// responsible for your team's LUCI integration, and finally a
	// wider email group (or groups) than those in maintenance_contact.
	EscalationContact []string `protobuf:"bytes,3,rep,name=escalation_contact,json=escalationContact,proto3" json:"escalation_contact,omitempty"`
	// contains filtered or unexported fields
}

Represents a group of humans who are responsible for one or more LUCI projects.

LUCI system maintainers will use the contact addresses associated with this Team in order to contact that group of humans about maintenance actions which this Team needs to perform in order to keep current with LUCI.

We recommend subscribing to the following mailing lists as well:

* luci-announce@ - Announcements of new LUCI functionality.
* luci-outages@ - Announcements of LUCI system outages/downtime.
* luci-releases@ - (noisy) Announcements of new LUCI service deployments.

We also recommend directing LUCI questions/discussion to:

* go/luci-users-chat - Chatroom open to all users of LUCI. Good place to
  ask/answer questions about the use of LUCI services.
* go/luci-dev-chat - Chatroom for developing LUCI services, or
  systems which tightly interact with LUCI services.
* luci-eng@ - Email list for LUCI related questions.

Bugs should be filed to:

* go/bug-a-trooper - General bug reports related to the operation of
  specific builders/machines which happen to run in LUCI. This is a general
  Chrome-area bug and will be triaged (usually within 24h).
* go/luci-bug - Bug reports/feature requests for LUCI services.
* go/luci-trooper-bug - Bug reports against LUCI services which
  need quick attention from a trooper.
* oncall/chrome-ops-foundation - Oncall rotation for ChOps Foundation
  (primary responders for LUCI service outages). It's a good idea to check
  go/luci-users-chat and luci-outages@ too.

For some migrations, LUCI system maintainers may need to send CLs against your project's configuration. The best way to enable this is to maintain an OWNERS file in your project configuration repo, otherwise we'll have to start guessing at reviewers :).

To allow LUCI system maintainers to send CLs, please ensure that eng@ has the ability to read+send CLs to your configuration repo. If we're unable to send a CL (e.g. the repo is super-secret), we'll instead send an email for you to apply the change yourself.

func (*Team) Descriptor deprecated

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

Deprecated: Use Team.ProtoReflect.Descriptor instead.

func (*Team) GetEscalationContact

func (x *Team) GetEscalationContact() []string

func (*Team) GetMaintenanceContact

func (x *Team) GetMaintenanceContact() []string

func (*Team) GetName

func (x *Team) GetName() string

func (*Team) ProtoMessage

func (*Team) ProtoMessage()

func (*Team) ProtoReflect

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

func (*Team) Reset

func (x *Team) Reset()

func (*Team) String

func (x *Team) String() string

type ValidationRequestMessage

type ValidationRequestMessage struct {

	// Config set of the config file to validate.
	ConfigSet string `protobuf:"bytes,1,opt,name=config_set,json=configSet,proto3" json:"config_set,omitempty"`
	// Path of the config file to validate.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// Contents of the file.
	Content []byte `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

This message is used only in JSON form. It is sent as request body to an external validation endpoint in order to validate a config.

func (*ValidationRequestMessage) Descriptor deprecated

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

Deprecated: Use ValidationRequestMessage.ProtoReflect.Descriptor instead.

func (*ValidationRequestMessage) GetConfigSet

func (x *ValidationRequestMessage) GetConfigSet() string

func (*ValidationRequestMessage) GetContent

func (x *ValidationRequestMessage) GetContent() []byte

func (*ValidationRequestMessage) GetPath

func (x *ValidationRequestMessage) GetPath() string

func (*ValidationRequestMessage) ProtoMessage

func (*ValidationRequestMessage) ProtoMessage()

func (*ValidationRequestMessage) ProtoReflect

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

func (*ValidationRequestMessage) Reset

func (x *ValidationRequestMessage) Reset()

func (*ValidationRequestMessage) String

func (x *ValidationRequestMessage) String() string

type ValidationResponseMessage

type ValidationResponseMessage struct {

	// Errors, warnings and other information found during validation.
	// If at least one error is found, the config is considered invalid.
	Messages []*ValidationResponseMessage_Message `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

This message is used only in JSON form. It is expected from an external validation endpoint that validates a config.

func (*ValidationResponseMessage) Descriptor deprecated

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

Deprecated: Use ValidationResponseMessage.ProtoReflect.Descriptor instead.

func (*ValidationResponseMessage) GetMessages

func (*ValidationResponseMessage) ProtoMessage

func (*ValidationResponseMessage) ProtoMessage()

func (*ValidationResponseMessage) ProtoReflect

func (*ValidationResponseMessage) Reset

func (x *ValidationResponseMessage) Reset()

func (*ValidationResponseMessage) String

func (x *ValidationResponseMessage) String() string

type ValidationResponseMessage_Message

type ValidationResponseMessage_Message struct {

	// Path of the config file that has an error.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// If an error, a config is considered invalid. Defaults to INFO.
	Severity ValidationResponseMessage_Severity `protobuf:"varint,2,opt,name=severity,proto3,enum=config.ValidationResponseMessage_Severity" json:"severity,omitempty"`
	// Textual representation of the message.
	Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

A message that explains why a config is valid or not.

func (*ValidationResponseMessage_Message) Descriptor deprecated

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

Deprecated: Use ValidationResponseMessage_Message.ProtoReflect.Descriptor instead.

func (*ValidationResponseMessage_Message) GetPath

func (*ValidationResponseMessage_Message) GetSeverity

func (*ValidationResponseMessage_Message) GetText

func (*ValidationResponseMessage_Message) ProtoMessage

func (*ValidationResponseMessage_Message) ProtoMessage()

func (*ValidationResponseMessage_Message) ProtoReflect

func (*ValidationResponseMessage_Message) Reset

func (*ValidationResponseMessage_Message) String

type ValidationResponseMessage_Severity

type ValidationResponseMessage_Severity int32

Severity of a validation response message. In JSON encoded as a string.

const (
	ValidationResponseMessage_UNKNOWN  ValidationResponseMessage_Severity = 0
	ValidationResponseMessage_DEBUG    ValidationResponseMessage_Severity = 10
	ValidationResponseMessage_INFO     ValidationResponseMessage_Severity = 20
	ValidationResponseMessage_WARNING  ValidationResponseMessage_Severity = 30
	ValidationResponseMessage_ERROR    ValidationResponseMessage_Severity = 40
	ValidationResponseMessage_CRITICAL ValidationResponseMessage_Severity = 50
)

func (ValidationResponseMessage_Severity) Descriptor

func (ValidationResponseMessage_Severity) Enum

func (ValidationResponseMessage_Severity) EnumDescriptor deprecated

func (ValidationResponseMessage_Severity) EnumDescriptor() ([]byte, []int)

Deprecated: Use ValidationResponseMessage_Severity.Descriptor instead.

func (ValidationResponseMessage_Severity) Number

func (ValidationResponseMessage_Severity) String

func (ValidationResponseMessage_Severity) Type

type Validator

type Validator struct {

	// A list of configuration patterns that this validator can validate.
	Patterns []*ConfigPattern `protobuf:"bytes,1,rep,name=patterns,proto3" json:"patterns,omitempty"`
	// URL of a validation endpoint. The config service will send an HTTP POST
	// request to the endpoint, where body is JSON-encoded
	// ValidationRequestMessage. The endpoint is expected to respond with
	// HTTP status 200 and JSON-encoded ValidationResponseMessage.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

Describes what configuration can be validated and how to validate them.

func (*Validator) Descriptor deprecated

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

Deprecated: Use Validator.ProtoReflect.Descriptor instead.

func (*Validator) GetPatterns

func (x *Validator) GetPatterns() []*ConfigPattern

func (*Validator) GetUrl

func (x *Validator) GetUrl() string

func (*Validator) ProtoMessage

func (*Validator) ProtoMessage()

func (*Validator) ProtoReflect

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

func (*Validator) Reset

func (x *Validator) Reset()

func (*Validator) String

func (x *Validator) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL