README
ΒΆ
Taskcluster
The task execution framework that supports Mozilla's continuous integration and release processes.
Usage
This repository is used to develop, build, and release the Taskcluster services.
Table of Contents
- Clients
- Taskcluster Database
- Development Documentation
- Infrastructure
- Internal Go Packages
- Libraries
- Services
- Tools
- Taskcluster UI
- Workers
Team Mentions
Do you need to reach a specific subset of the team? Use the team handles to mention us with GitHub's @mention feature.
| Team Name | Use To... |
|---|---|
@taskcluster/Core |
ping members of the Taskcluster team at Mozilla |
@taskcluster/services-reviewers |
ping reviewers for changes to platform services and libraries |
@taskcluster/frontend-reviewers |
ping people who can review changes to frontend (and related) code in the services monorepo |
@taskcluster/security-folks |
ping people who do security things |
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
Directories
ΒΆ
| Path | Synopsis |
|---|---|
|
clients
|
|
|
client-go/codegenerator/model
Package model contains the core logic of the code generation process.
|
Package model contains the core logic of the code generation process. |
|
client-go/integrationtest
Package integrationtest stores all the integration tests that run against the taskcluster cluster client
|
Package integrationtest stores all the integration tests that run against the taskcluster cluster client |
|
client-go/tcauth
Authentication related API end-points for Taskcluster and related services.
|
Authentication related API end-points for Taskcluster and related services. |
|
client-go/tcauthevents
The auth service is responsible for storing credentials, managing assignment of scopes, and validation of request signatures from other services.
|
The auth service is responsible for storing credentials, managing assignment of scopes, and validation of request signatures from other services. |
|
client-go/tcgithub
The github service is responsible for creating tasks in response to GitHub events, and posting results to the GitHub UI.
|
The github service is responsible for creating tasks in response to GitHub events, and posting results to the GitHub UI. |
|
client-go/tcgithubevents
The github service publishes a pulse message for supported github events, translating Github webhook events into pulse messages.
|
The github service publishes a pulse message for supported github events, translating Github webhook events into pulse messages. |
|
client-go/tchooks
The hooks service provides a mechanism for creating tasks in response to events.
|
The hooks service provides a mechanism for creating tasks in response to events. |
|
client-go/tchooksevents
The hooks service is responsible for creating tasks at specific times orin .
|
The hooks service is responsible for creating tasks at specific times orin . |
|
client-go/tcindex
The index service is responsible for indexing tasks.
|
The index service is responsible for indexing tasks. |
|
client-go/tcnotify
The notification service listens for tasks with associated notifications and handles requests to send emails and post pulse messages.
|
The notification service listens for tasks with associated notifications and handles requests to send emails and post pulse messages. |
|
client-go/tcnotifyevents
This pretty much only contains the simple free-form message that can be published from this service from a request by anybody with the proper scopes.
|
This pretty much only contains the simple free-form message that can be published from this service from a request by anybody with the proper scopes. |
|
client-go/tcobject
The object service provides HTTP-accessible storage for large blobs of data.
|
The object service provides HTTP-accessible storage for large blobs of data. |
|
client-go/tcpurgecache
The purge-cache service is responsible for tracking cache-purge requests.
|
The purge-cache service is responsible for tracking cache-purge requests. |
|
client-go/tcpurgecacheevents
The purge-cache service, typically available at `purge-cache.taskcluster.net`, is responsible for publishing a pulse message for workers, so they can purge cache upon request.
|
The purge-cache service, typically available at `purge-cache.taskcluster.net`, is responsible for publishing a pulse message for workers, so they can purge cache upon request. |
|
client-go/tcqueue
The queue service is responsible for accepting tasks and tracking their state as they are executed by workers, in order to ensure they are eventually resolved.
|
The queue service is responsible for accepting tasks and tracking their state as they are executed by workers, in order to ensure they are eventually resolved. |
|
client-go/tcqueueevents
The queue service is responsible for accepting tasks and track their state as they are executed by workers.
|
The queue service is responsible for accepting tasks and track their state as they are executed by workers. |
|
client-go/tcsecrets
The secrets service provides a simple key/value store for small bits of secret data.
|
The secrets service provides a simple key/value store for small bits of secret data. |
|
client-go/tcworkermanager
This service manages workers, including provisioning for dynamic worker pools.
|
This service manages workers, including provisioning for dynamic worker pools. |
|
client-go/tcworkermanagerevents
These exchanges provide notifications when a worker pool is created or updated.This is so that the provisioner running in a differentprocess at the other end can synchronize to the changes.
|
These exchanges provide notifications when a worker pool is created or updated.This is so that the provisioner running in a differentprocess at the other end can synchronize to the changes. |
|
client-shell/apis
Package apis implements all the API endpoints.
|
Package apis implements all the API endpoints. |
|
client-shell/client
Package client contains integration code for taskcluster-client-go.
|
Package client contains integration code for taskcluster-client-go. |
|
client-shell/cmds/completions
Package completions implements command completion support.
|
Package completions implements command completion support. |
|
client-shell/cmds/config
Package configCmd implements the config subcommands.
|
Package configCmd implements the config subcommands. |
|
client-shell/cmds/from-now
Package fromNow implements the from-now command.
|
Package fromNow implements the from-now command. |
|
client-shell/cmds/group
Package group implements the group interaction subcommands.
|
Package group implements the group interaction subcommands. |
|
client-shell/cmds/root
Package root defines the root of the application command tree.
|
Package root defines the root of the application command tree. |
|
client-shell/cmds/signin
Package signin implements the signin command.
|
Package signin implements the signin command. |
|
client-shell/cmds/slugid
Package slugid implements the slugid subcommands.
|
Package slugid implements the slugid subcommands. |
|
client-shell/cmds/task
Package task implements the task subcommands.
|
Package task implements the task subcommands. |
|
client-shell/cmds/validate-json
Package validatejson impliments validate-json command
|
Package validatejson impliments validate-json command |
|
client-shell/cmds/version
Package version implements the version subcommand.
|
Package version implements the version subcommand. |
|
client-shell/config
Package config implements the configuration management system.
|
Package config implements the configuration management system. |
|
mocktc/tc
The interfaces in this package contain the methods of each taskcluster service, allowing the use of fakes that provide the same methods.
|
The interfaces in this package contain the methods of each taskcluster service, allowing the use of fakes that provide the same methods. |
|
scopes
Package scopes provides utilities for manipulating and interpreting Taskcluster scopes.
|
Package scopes provides utilities for manipulating and interpreting Taskcluster scopes. |
|
tools
|
|
|
jsonschema2go
Package jsonschema2go allows you to translate json schemas like this:
|
Package jsonschema2go allows you to translate json schemas like this: |
|
jsonschema2go/jsonschema2go
jsonschema2go is the command invoked by go generate in order to generate the go client library.
|
jsonschema2go is the command invoked by go generate in order to generate the go client library. |
|
jsonschema2go/text
Package text contains utility functions for manipulating raw text strings
|
Package text contains utility functions for manipulating raw text strings |
|
websocktunnel/client
Package client wraps a wsmux client session in a net.Listener interface.
|
Package client wraps a wsmux client session in a net.Listener interface. |
|
websocktunnel/wsmux
wsmux multiplexes multiple bidirectional streams over a single websocket.
|
wsmux multiplexes multiple bidirectional streams over a single websocket. |
|
websocktunnel/wsproxy
Package wsproxy is a Layer-7 proxy implementation which uses WebSockets to communicate with clients.
|
Package wsproxy is a Layer-7 proxy implementation which uses WebSockets to communicate with clients. |
|
worker-runner/logging
The logging package is an internal logging abstraction, designed to handle both structured and unstructured data.
|
The logging package is an internal logging abstraction, designed to handle both structured and unstructured data. |
|
worker-runner/provider/azure
This package reads from the Azure metadata service; see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service#custom-data
|
This package reads from the Azure metadata service; see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service#custom-data |
|
workerproto
The workerproto package implements both sides of the Taskcluster Worker / Runner protocol.
|
The workerproto package implements both sides of the Taskcluster Worker / Runner protocol. |
|
workers
|
|
|
generic-worker/expose
Expose serves as an abstract mechanism for exposing local services to the world.
|
Expose serves as an abstract mechanism for exposing local services to the world. |
|
generic-worker/gdm3
package gdm3 provides functions for interfacing with Gnome Desktop Manager 3
|
package gdm3 provides functions for interfacing with Gnome Desktop Manager 3 |
|
generic-worker/host
Package host provides facilities for interfacing with the host operating system, logging activities performed.
|
Package host provides facilities for interfacing with the host operating system, logging activities performed. |
|
generic-worker/interactive
Package interactive provides a way to run an interactive shell in a task.
|
Package interactive provides a way to run an interactive shell in a task. |
|
generic-worker/kc
Package kc provides functions for encoding/decoding darwin user passwords, for use in the /etc/kcpassword file.
|
Package kc provides functions for encoding/decoding darwin user passwords, for use in the /etc/kcpassword file. |
|
generic-worker/livelog
Package livelog provides a simple wrapper around the livelog executable.
|
Package livelog provides a simple wrapper around the livelog executable. |
|
generic-worker/process
Package process provides a mechanism for running processes under a different user account to the current process
|
Package process provides a mechanism for running processes under a different user account to the current process |
|
generic-worker/tcproxy
Package tcproxy provides a simple wrapper around the tcproxy executable.
|
Package tcproxy provides a simple wrapper around the tcproxy executable. |
Click to show internal directories.
Click to hide internal directories.