Documentation ¶
Overview ¶
Package config contains luci-config protobuf definitions.
The .proto files are copied from https://github.com/luci/luci-py/tree/45f3e27/appengine/components/components/config/proto with package name changed to "config" because golint does not like underscore in package names.
Package config is a generated protocol buffer package.
It is generated from these files:
github.com/luci/luci-go/common/proto/config/project_config.proto github.com/luci/luci-go/common/proto/config/service_config.proto
It has these top-level messages:
ProjectCfg RefsCfg ConfigSetLocation Project ProjectsCfg Service ServiceDynamicMetadata ServicesCfg AclCfg ImportCfg SchemasCfg ConfigPattern Validator ValidationRequestMessage ValidationResponseMessage
Index ¶
- Variables
- type AclCfg
- type ConfigPattern
- type ConfigSetLocation
- type ConfigSetLocation_StorageType
- type ImportCfg
- type ImportCfg_Gitiles
- func (*ImportCfg_Gitiles) Descriptor() ([]byte, []int)
- func (m *ImportCfg_Gitiles) GetFetchArchiveDeadline() int32
- func (m *ImportCfg_Gitiles) GetFetchLogDeadline() int32
- func (m *ImportCfg_Gitiles) GetProjectConfigDefaultPath() string
- func (m *ImportCfg_Gitiles) GetProjectConfigDefaultRef() string
- func (m *ImportCfg_Gitiles) GetRefConfigDefaultPath() string
- func (*ImportCfg_Gitiles) ProtoMessage()
- func (m *ImportCfg_Gitiles) Reset()
- func (m *ImportCfg_Gitiles) String() string
- type Project
- type ProjectCfg
- type ProjectsCfg
- type RefsCfg
- type RefsCfg_Ref
- type SchemasCfg
- type SchemasCfg_Schema
- type Service
- func (*Service) Descriptor() ([]byte, []int)
- func (m *Service) GetAccess() []string
- func (m *Service) GetConfigLocation() *ConfigSetLocation
- func (m *Service) GetId() string
- func (m *Service) GetMetadataUrl() string
- func (m *Service) GetOwners() []string
- func (*Service) ProtoMessage()
- func (m *Service) Reset()
- func (m *Service) String() string
- type ServiceDynamicMetadata
- func (*ServiceDynamicMetadata) Descriptor() ([]byte, []int)
- func (m *ServiceDynamicMetadata) GetValidation() *Validator
- func (m *ServiceDynamicMetadata) GetVersion() string
- func (*ServiceDynamicMetadata) ProtoMessage()
- func (m *ServiceDynamicMetadata) Reset()
- func (m *ServiceDynamicMetadata) String() string
- type ServicesCfg
- type ValidationRequestMessage
- func (*ValidationRequestMessage) Descriptor() ([]byte, []int)
- func (m *ValidationRequestMessage) GetConfigSet() string
- func (m *ValidationRequestMessage) GetContent() string
- func (m *ValidationRequestMessage) GetPath() string
- func (*ValidationRequestMessage) ProtoMessage()
- func (m *ValidationRequestMessage) Reset()
- func (m *ValidationRequestMessage) String() string
- type ValidationResponseMessage
- type ValidationResponseMessage_Message
- func (*ValidationResponseMessage_Message) Descriptor() ([]byte, []int)
- func (m *ValidationResponseMessage_Message) GetSeverity() ValidationResponseMessage_Severity
- func (m *ValidationResponseMessage_Message) GetText() string
- func (*ValidationResponseMessage_Message) ProtoMessage()
- func (m *ValidationResponseMessage_Message) Reset()
- func (m *ValidationResponseMessage_Message) String() string
- type ValidationResponseMessage_Severity
- type Validator
Constants ¶
This section is empty.
Variables ¶
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" json:"project_access_group,omitempty"` XXX_unrecognized []byte `json:"-"` }
Schema of acl.cfg file.
type ConfigPattern ¶
type ConfigPattern struct { // A string pattern for config_set. ConfigSet *string `protobuf:"bytes,1,opt,name=config_set,json=configSet" json:"config_set,omitempty"` // A string pattern for config file path. Path *string `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"` XXX_unrecognized []byte `json:"-"` }
Defines a pattern of a config identity. Both config_set and path must match.
func (*ConfigPattern) Descriptor ¶
func (*ConfigPattern) Descriptor() ([]byte, []int)
func (*ConfigPattern) GetConfigSet ¶
func (m *ConfigPattern) GetConfigSet() string
func (*ConfigPattern) GetPath ¶
func (m *ConfigPattern) GetPath() string
func (*ConfigPattern) ProtoMessage ¶
func (*ConfigPattern) ProtoMessage()
func (*ConfigPattern) Reset ¶
func (m *ConfigPattern) Reset()
func (*ConfigPattern) String ¶
func (m *ConfigPattern) String() string
type ConfigSetLocation ¶
type ConfigSetLocation struct { // URL of the repository where project-wide configurations are stored. Url *string `protobuf:"bytes,1,opt,name=url" json:"url,omitempty"` // Type of the configuration repository, e.g. GITILES. StorageType *ConfigSetLocation_StorageType `` /* 130-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
Used to specify project/service configuration location.
func (*ConfigSetLocation) Descriptor ¶
func (*ConfigSetLocation) Descriptor() ([]byte, []int)
func (*ConfigSetLocation) GetStorageType ¶
func (m *ConfigSetLocation) GetStorageType() ConfigSetLocation_StorageType
func (*ConfigSetLocation) GetUrl ¶
func (m *ConfigSetLocation) GetUrl() string
func (*ConfigSetLocation) ProtoMessage ¶
func (*ConfigSetLocation) ProtoMessage()
func (*ConfigSetLocation) Reset ¶
func (m *ConfigSetLocation) Reset()
func (*ConfigSetLocation) String ¶
func (m *ConfigSetLocation) String() string
type ConfigSetLocation_StorageType ¶
type ConfigSetLocation_StorageType int32
Depending on repository type, config service imports configuration files differently.
const ( // Will be used if storage_type is not set. ConfigSetLocation_UNSET ConfigSetLocation_StorageType = 0 // Gitiles REST API is used to fetch config files. ConfigSetLocation_GITILES ConfigSetLocation_StorageType = 1 )
func (ConfigSetLocation_StorageType) Enum ¶
func (x ConfigSetLocation_StorageType) Enum() *ConfigSetLocation_StorageType
func (ConfigSetLocation_StorageType) EnumDescriptor ¶
func (ConfigSetLocation_StorageType) EnumDescriptor() ([]byte, []int)
func (ConfigSetLocation_StorageType) String ¶
func (x ConfigSetLocation_StorageType) String() string
func (*ConfigSetLocation_StorageType) UnmarshalJSON ¶
func (x *ConfigSetLocation_StorageType) UnmarshalJSON(data []byte) error
type ImportCfg ¶
type ImportCfg struct { // Configuration of import from Gitiles repositories. Gitiles *ImportCfg_Gitiles `protobuf:"bytes,1,opt,name=gitiles" json:"gitiles,omitempty"` XXX_unrecognized []byte `json:"-"` }
Schema for import.cfg. It specified how to import configuration files from external sources.
func (*ImportCfg) GetGitiles ¶
func (m *ImportCfg) GetGitiles() *ImportCfg_Gitiles
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" 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" json:"fetch_archive_deadline,omitempty"` // Default ref for project configs. ProjectConfigDefaultRef *string `` /* 127-byte string literal not displayed */ // Default directory for project configs. ProjectConfigDefaultPath *string `` /* 130-byte string literal not displayed */ // Default directory for ref configs. RefConfigDefaultPath *string `protobuf:"bytes,5,opt,name=ref_config_default_path,json=refConfigDefaultPath" json:"ref_config_default_path,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*ImportCfg_Gitiles) Descriptor ¶
func (*ImportCfg_Gitiles) Descriptor() ([]byte, []int)
func (*ImportCfg_Gitiles) GetFetchArchiveDeadline ¶
func (m *ImportCfg_Gitiles) GetFetchArchiveDeadline() int32
func (*ImportCfg_Gitiles) GetFetchLogDeadline ¶
func (m *ImportCfg_Gitiles) GetFetchLogDeadline() int32
func (*ImportCfg_Gitiles) GetProjectConfigDefaultPath ¶
func (m *ImportCfg_Gitiles) GetProjectConfigDefaultPath() string
func (*ImportCfg_Gitiles) GetProjectConfigDefaultRef ¶
func (m *ImportCfg_Gitiles) GetProjectConfigDefaultRef() string
func (*ImportCfg_Gitiles) GetRefConfigDefaultPath ¶
func (m *ImportCfg_Gitiles) GetRefConfigDefaultPath() string
func (*ImportCfg_Gitiles) ProtoMessage ¶
func (*ImportCfg_Gitiles) ProtoMessage()
func (*ImportCfg_Gitiles) Reset ¶
func (m *ImportCfg_Gitiles) Reset()
func (*ImportCfg_Gitiles) String ¶
func (m *ImportCfg_Gitiles) String() string
type Project ¶
type Project struct { // Globally unique id of the project. Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Where to import "projects/<id>" config set from. ConfigLocation *ConfigSetLocation `protobuf:"bytes,2,opt,name=config_location,json=configLocation" json:"config_location,omitempty"` XXX_unrecognized []byte `json:"-"` }
A tenant of a service. Defined in projects.cfg.
func (*Project) GetConfigLocation ¶
func (m *Project) GetConfigLocation() *ConfigSetLocation
type ProjectCfg ¶
type ProjectCfg struct { // Full name of the project. Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // A list of identities that have read-only access to the. An element is one // of: // * "group:<group>", where group is defined on auth server. // * "<email>" // * "<identity>" // // 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" json:"access,omitempty"` XXX_unrecognized []byte `json:"-"` }
Schema for project.cfg
func (*ProjectCfg) Descriptor ¶
func (*ProjectCfg) Descriptor() ([]byte, []int)
func (*ProjectCfg) GetAccess ¶
func (m *ProjectCfg) GetAccess() []string
func (*ProjectCfg) GetName ¶
func (m *ProjectCfg) GetName() string
func (*ProjectCfg) ProtoMessage ¶
func (*ProjectCfg) ProtoMessage()
func (*ProjectCfg) Reset ¶
func (m *ProjectCfg) Reset()
func (*ProjectCfg) String ¶
func (m *ProjectCfg) String() string
type ProjectsCfg ¶
type ProjectsCfg struct { // All projects served by this instance of Luci. Projects []*Project `protobuf:"bytes,1,rep,name=projects" json:"projects,omitempty"` XXX_unrecognized []byte `json:"-"` }
Schema of projects.cfg file. Represents luci tenants registry.
func (*ProjectsCfg) Descriptor ¶
func (*ProjectsCfg) Descriptor() ([]byte, []int)
func (*ProjectsCfg) GetProjects ¶
func (m *ProjectsCfg) GetProjects() []*Project
func (*ProjectsCfg) ProtoMessage ¶
func (*ProjectsCfg) ProtoMessage()
func (*ProjectsCfg) Reset ¶
func (m *ProjectsCfg) Reset()
func (*ProjectsCfg) String ¶
func (m *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" json:"refs,omitempty"` XXX_unrecognized []byte `json:"-"` }
Schema of refs.cfg.
func (*RefsCfg) GetRefs ¶
func (m *RefsCfg) GetRefs() []*RefsCfg_Ref
type RefsCfg_Ref ¶
type RefsCfg_Ref struct { // Name of the ref. Must start with "refs/". Name *string `protobuf:"bytes,1,opt,name=name" 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" json:"config_path,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*RefsCfg_Ref) Descriptor ¶
func (*RefsCfg_Ref) Descriptor() ([]byte, []int)
func (*RefsCfg_Ref) GetConfigPath ¶
func (m *RefsCfg_Ref) GetConfigPath() string
func (*RefsCfg_Ref) GetName ¶
func (m *RefsCfg_Ref) GetName() string
func (*RefsCfg_Ref) ProtoMessage ¶
func (*RefsCfg_Ref) ProtoMessage()
func (*RefsCfg_Ref) Reset ¶
func (m *RefsCfg_Ref) Reset()
func (*RefsCfg_Ref) String ¶
func (m *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" json:"schemas,omitempty"` XXX_unrecognized []byte `json:"-"` }
Schema of schemas.cfg
func (*SchemasCfg) Descriptor ¶
func (*SchemasCfg) Descriptor() ([]byte, []int)
func (*SchemasCfg) GetSchemas ¶
func (m *SchemasCfg) GetSchemas() []*SchemasCfg_Schema
func (*SchemasCfg) ProtoMessage ¶
func (*SchemasCfg) ProtoMessage()
func (*SchemasCfg) Reset ¶
func (m *SchemasCfg) Reset()
func (*SchemasCfg) String ¶
func (m *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" 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" json:"url,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*SchemasCfg_Schema) Descriptor ¶
func (*SchemasCfg_Schema) Descriptor() ([]byte, []int)
func (*SchemasCfg_Schema) GetName ¶
func (m *SchemasCfg_Schema) GetName() string
func (*SchemasCfg_Schema) GetUrl ¶
func (m *SchemasCfg_Schema) GetUrl() string
func (*SchemasCfg_Schema) ProtoMessage ¶
func (*SchemasCfg_Schema) ProtoMessage()
func (*SchemasCfg_Schema) Reset ¶
func (m *SchemasCfg_Schema) Reset()
func (*SchemasCfg_Schema) String ¶
func (m *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" json:"id,omitempty"` // Email addresses of responsible and point-of-contacts for the service. Owners []string `protobuf:"bytes,2,rep,name=owners" json:"owners,omitempty"` // Where to import "services/<id>" config set from. If config_location.url is // relative, it is relative to the current configuration file. // If not specified, defaults to "../<id>/". ConfigLocation *ConfigSetLocation `protobuf:"bytes,3,opt,name=config_location,json=configLocation" json:"config_location,omitempty"` // An HTTPS endpoint that returns JSON-encoded ServiceDynamicMetadata in body. MetadataUrl *string `protobuf:"bytes,4,opt,name=metadata_url,json=metadataUrl" 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>" // * "<identity>" // // If not specified, only admins and trusted services have access. Access []string `protobuf:"bytes,5,rep,name=access" json:"access,omitempty"` XXX_unrecognized []byte `json:"-"` }
Describes one luci service.
func (*Service) GetConfigLocation ¶
func (m *Service) GetConfigLocation() *ConfigSetLocation
type ServiceDynamicMetadata ¶
type ServiceDynamicMetadata struct { // Format version. Supported versions: 1.0. Version *string `protobuf:"bytes,1,opt,name=version" json:"version,omitempty"` // What configs this service can validate and how to validate them. Validation *Validator `protobuf:"bytes,2,opt,name=validation" json:"validation,omitempty"` XXX_unrecognized []byte `json:"-"` }
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 ¶
func (*ServiceDynamicMetadata) Descriptor() ([]byte, []int)
func (*ServiceDynamicMetadata) GetValidation ¶
func (m *ServiceDynamicMetadata) GetValidation() *Validator
func (*ServiceDynamicMetadata) GetVersion ¶
func (m *ServiceDynamicMetadata) GetVersion() string
func (*ServiceDynamicMetadata) ProtoMessage ¶
func (*ServiceDynamicMetadata) ProtoMessage()
func (*ServiceDynamicMetadata) Reset ¶
func (m *ServiceDynamicMetadata) Reset()
func (*ServiceDynamicMetadata) String ¶
func (m *ServiceDynamicMetadata) 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" json:"services,omitempty"` XXX_unrecognized []byte `json:"-"` }
Schema of services.cfg
func (*ServicesCfg) Descriptor ¶
func (*ServicesCfg) Descriptor() ([]byte, []int)
func (*ServicesCfg) GetServices ¶
func (m *ServicesCfg) GetServices() []*Service
func (*ServicesCfg) ProtoMessage ¶
func (*ServicesCfg) ProtoMessage()
func (*ServicesCfg) Reset ¶
func (m *ServicesCfg) Reset()
func (*ServicesCfg) String ¶
func (m *ServicesCfg) 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" json:"config_set,omitempty"` // Path of the config file to validate. Path *string `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"` // Base64-encoded contents of the file. Content *string `protobuf:"bytes,3,opt,name=content" json:"content,omitempty"` XXX_unrecognized []byte `json:"-"` }
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 ¶
func (*ValidationRequestMessage) Descriptor() ([]byte, []int)
func (*ValidationRequestMessage) GetConfigSet ¶
func (m *ValidationRequestMessage) GetConfigSet() string
func (*ValidationRequestMessage) GetContent ¶
func (m *ValidationRequestMessage) GetContent() string
func (*ValidationRequestMessage) GetPath ¶
func (m *ValidationRequestMessage) GetPath() string
func (*ValidationRequestMessage) ProtoMessage ¶
func (*ValidationRequestMessage) ProtoMessage()
func (*ValidationRequestMessage) Reset ¶
func (m *ValidationRequestMessage) Reset()
func (*ValidationRequestMessage) String ¶
func (m *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" json:"messages,omitempty"` XXX_unrecognized []byte `json:"-"` }
This message is used only in JSON form. It is expected from an external validation endpoint that validates a config.
func (*ValidationResponseMessage) Descriptor ¶
func (*ValidationResponseMessage) Descriptor() ([]byte, []int)
func (*ValidationResponseMessage) GetMessages ¶
func (m *ValidationResponseMessage) GetMessages() []*ValidationResponseMessage_Message
func (*ValidationResponseMessage) ProtoMessage ¶
func (*ValidationResponseMessage) ProtoMessage()
func (*ValidationResponseMessage) Reset ¶
func (m *ValidationResponseMessage) Reset()
func (*ValidationResponseMessage) String ¶
func (m *ValidationResponseMessage) String() string
type ValidationResponseMessage_Message ¶
type ValidationResponseMessage_Message struct { // Textual representation of the message. Text *string `protobuf:"bytes,1,opt,name=text" json:"text,omitempty"` // If an error, a config is considered invalid. Defaults to INFO. Severity *ValidationResponseMessage_Severity `protobuf:"varint,2,opt,name=severity,enum=config.ValidationResponseMessage_Severity" json:"severity,omitempty"` XXX_unrecognized []byte `json:"-"` }
A message that explains why a config is valid or not.
func (*ValidationResponseMessage_Message) Descriptor ¶
func (*ValidationResponseMessage_Message) Descriptor() ([]byte, []int)
func (*ValidationResponseMessage_Message) GetSeverity ¶
func (m *ValidationResponseMessage_Message) GetSeverity() ValidationResponseMessage_Severity
func (*ValidationResponseMessage_Message) GetText ¶
func (m *ValidationResponseMessage_Message) GetText() string
func (*ValidationResponseMessage_Message) ProtoMessage ¶
func (*ValidationResponseMessage_Message) ProtoMessage()
func (*ValidationResponseMessage_Message) Reset ¶
func (m *ValidationResponseMessage_Message) Reset()
func (*ValidationResponseMessage_Message) String ¶
func (m *ValidationResponseMessage_Message) String() string
type ValidationResponseMessage_Severity ¶
type ValidationResponseMessage_Severity int32
Severity of a validation response message. In JSON encoded as a string.
const ( 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) Enum ¶
func (x ValidationResponseMessage_Severity) Enum() *ValidationResponseMessage_Severity
func (ValidationResponseMessage_Severity) EnumDescriptor ¶
func (ValidationResponseMessage_Severity) EnumDescriptor() ([]byte, []int)
func (ValidationResponseMessage_Severity) String ¶
func (x ValidationResponseMessage_Severity) String() string
func (*ValidationResponseMessage_Severity) UnmarshalJSON ¶
func (x *ValidationResponseMessage_Severity) UnmarshalJSON(data []byte) error
type Validator ¶
type Validator struct { // A list of configuration patterns that this validator can validate. Patterns []*ConfigPattern `protobuf:"bytes,1,rep,name=patterns" 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" json:"url,omitempty"` XXX_unrecognized []byte `json:"-"` }
Describes what configuration can be validated and how to validate them.
func (*Validator) GetPatterns ¶
func (m *Validator) GetPatterns() []*ConfigPattern