Serverless Workflow

Serverless Workflow Specification

Stars
647
Forks
140
Open issues
23
Closed issues
196
Last release
over 2 years ago
Last commit
5 months ago
Watchers
647
Total releases
4
Total commits
588
Open PRs
5
Closed PRs
449
Repo URL
Platform
License
apache-2.0
Category
Technology
Makefile
Offers premium version?
NO
Proprietary?
NO
About

About

CNCF Serverless Workflow defines a vendor-neutral, open-source, and fully community-driven ecosystem for defining and running DSL-based workflows that target the Serverless technology domain.

This project is composed of:

  • Specification for defining DSL-based workflows
  • Developer SDKs for different programming languages
  • Workflow runtimes supporting the specification
  • Developer tooling support for writing DSL-based workflows

CNCF Serverless Workflow is hosted by the Cloud Native Computing Foundation (CNCF) and was approved as a Cloud Native Sandbox level project on July 14, 2020.

Table of Contents
  • CNCF Landscape
  • Releases
  • Runtimes
  • SDKs
  • Tooling
  • Community
    • Communication
    • Code of Conduct
    • Weekly Meetings
  • Repository Structure
  • Support
CNCF Landscape

Serverless Workflow project falls under the CNCF "App Definition and Development" category.

It is a member project of the CNCF Serverless Working Group.

Check out our project DevStats here.

Releases

Latest release Latest release branch Working branch

Core Specification

Serverless Workflow v0.8 0.8.x main

Additional Components

Synapse 0.1.0-alpha1

main

GO SDK v2.0.0 1.0.x main

Java SDK 4.0.2.Final 4.0.x main

.NET SDK v0.7.4.4

main

TypeScript SDK v3.0.0 3.0.x main

Python SDK v1.0.0 1.0.x main

VSCode Extension 1.6.0

main

Runtimes

Serverless Workflow is open to host open-source runtime implementations that would like to be part and grow alongside the core specification.

Synapse is a Kubernetes-native workflow runtime which supports and is part of the Serverless Workflow eco-system.

SDKs

Serverless Workflow encourages development of SDKs dedicated to help developers with consuming, parsing, validating and testing their workflows that use the Serverless Workflow DSL.

Tooling

In order to enhance developer experience with the specification, we also provide a Visual Studio Code extension. The sources of the extension are found here.

Requirements

To generate the SVG diagram from the YAML or JSON file, you need to have the following tools installed:

Community

We have a growing community working together to build a community-driven and vendor-neutral workflow ecosystem. Community contributions are welcome and much needed to foster project growth.

See here for the list of community members that have contributed to the specification.

To learn how to contribute to the specification reference the 'how to contribute' doc.

If you have any copyright questions when contributing to a CNCF project like this one, reference the Ownership of Copyrights in CNCF Project Contributions doc.

Communication

Code of Conduct

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

See our full project Code of Conduct information here.

Weekly Meetings

The Serverless Workflow team meets weekly, every Thursday at 9AM ET (USA Eastern Time).

To register for meetings please visit the CNCF Community Calendar.

You can register for individual meetings or for the entire series.

The meeting minutes can be accessed in the discussions tab.

World Time Zone Converter.

Repository Structure

Here is the outline of the repository to help navigate the specification documents:

File/folder Description

specification.md The main specification document

OWNERS Defines the current specification maintainers and approvers

LICENSE Specification License doc

MAINTAINERS.md Project Maintainers Info

GOVERNANCE.md Project Governance Info

contributing.md Documentation on how to contribute to the spec

code-of-conduct.md Defines the spec Code of Conduct

usecases Specification Use Cases

schema Contains all specification JSON Schemas

roadmap Specification Roadmap

references References used for specification docs

media Includes all images used in spec docs

extensions Information on spec extensions

examples Specification examples

comparisons Comparisons of Serverless Workflow with other workflow DSLs

community Contains info on the spec community

annualreviews Contains the project annual reviews presented to the CNCF TOC

meetingminutes Contains the projects community meeting minutes

Support

Support our project by becoming a Sponsor.

Alternative Projects

Subscribe to Open Source Businees Newsletter

Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.

We'll never share your email with anyone else.