README
¶
Marmot
One line summary
Marmot is a service for processing workflows targeting DevOps/SRE needs.
NOTICE This product is still in development and is not production ready.
The long summary
Marmot is a GRPC service that executes workflow descriptions against infrastructure (network devices, servers, kubernetes pods, ...). This allows top level services/scripts to simply test the output for the correct workflow descriptors instead of complex mocking, concurrency checks, ... This in turn provides code reuse and reduces code duplication. It also provides safety by having a single system responsible for execution and not hundreds of scripts/services. Mamort provides:
- Structured workflow description language with health checks
- Support for concurrency inside workflows
- Plugin architecture allows feature expansion/updates without service rebuilds
- Streaming execution updates
- Clients for Go and Python
- Support for emergency pausing or stopping of all workflows, classes of workflows or single workflows
- Web UI for viewing workflows Marmot is based on an internal Google project which processes tens of thousands of workflows per week for several internal SRE/DevOps organizations.
Use cases
Marmot has been designed as a DevOps/SRE tool for handling infrastructure changes, though it is not limited to this role. Marmot is well suited for any type of operation that must be performed in steps with certain pacing and may require state checks for health. Examples include:
- Updating packages on servers
- Rolling out a new service version on Kubernetes
- Configuration changes to routing infrastructure
- Updating firmware on devices
- Turning up new devices via a mix of BOOTP/Console/SSH
- Automatic acceptance of code changes into a master repository from staging
- ...
Disclaimers
This is not an official Google product.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package client provides a client for interacting with the Marmot Workflow Service.
|
Package client provides a client for interacting with the Marmot Workflow Service. |
|
Package instance holds functions for creating a Marmot instance and methods for running the instance.
|
Package instance holds functions for creating a Marmot instance and methods for running the instance. |
|
proto
|
|
|
marmot
Package marmot is a generated protocol buffer package.
|
Package marmot is a generated protocol buffer package. |
|
Package service implements the GRPC service for Marmot.
|
Package service implements the GRPC service for Marmot. |
|
cogs/storage
Package storage provides Cogs with access to storage mechanisms that hold data that a Cog may need for operations.
|
Package storage provides Cogs with access to storage mechanisms that hold data that a Cog may need for operations. |
|
cogs/storage/toml
Package toml implements a key/value store using TOML for Cogs to query.
|
Package toml implements a key/value store using TOML for Cogs to query. |
|
coordinator
Package coordinator coordinates the running of Labors within the system.
|
Package coordinator coordinates the running of Labors within the system. |
|
storage/inmemory
Package inmemory provides an inmemory storage mechanism for Labors as they get processed.
|
Package inmemory provides an inmemory storage mechanism for Labors as they get processed. |
|
storage/testing
Package testing tests all storage implementations.
|
Package testing tests all storage implementations. |
|
testing
|
|
|
cogs/proto/tester
Package marmot_tester is a generated protocol buffer package.
|
Package marmot_tester is a generated protocol buffer package. |
|
etoe
Package etoe exists only to allow the etoe_test.go file for running end to end tests.
|
Package etoe exists only to allow the etoe_test.go file for running end to end tests. |
|
Package work provides mechanisms for executing a workflow, which is represented by the Labor object.
|
Package work provides mechanisms for executing a workflow, which is represented by the Labor object. |