google/marmot

Marmot workflow execution engine

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.

marmot's Issues

Examples

Hi,
Do you have examples of how this could be used in practice? Tried looking at the COG documentation but couldn't make sense out of it either. In any case, it sounds very interesting and useful.
Thanks!

Security Policy violation Binary Artifacts

This issue was automatically created by Allstar.

Security Policy Violation
Project is out of compliance with Binary Artifacts policy: binaries present in source code

Rule Description
Binary Artifacts are an increased security risk in your repository. Binary artifacts cannot be reviewed, allowing the introduction of possibly obsolete or maliciously subverted executables. For more information see the Security Scorecards Documentation for Binary Artifacts.

Remediation Steps
To remediate, remove the generated executable artifacts from the repository.

Artifacts Found

• testing/cogs/tester/tester

Additional Information
This policy is drawn from Security Scorecards, which is a tool that scores a project's adherence to security best practices. You may wish to run a Scorecards scan directly on this repository for more details.

---

Allstar has been installed on all Google managed GitHub orgs. Policies are gradually being rolled out and enforced by the GOSST and OSPO teams. Learn more at http://go/allstar

This issue will auto resolve when the policy is in compliance.

Issue created by Allstar. See https://github.com/ossf/allstar/ for more information. For questions specific to the repository, please contact the owner or maintainer.