| | Deis Workflow is no longer maintained.
Please read the announcement for more detail. | |---:|---| | 09/07/2017 | Deis Workflow [v2.18][] final release before entering maintenance mode | | 03/01/2018 | End of Workflow maintenance: critical patches no longer merged | | | Hephy is a fork of Workflow that is actively developed and accepts code contributions. |

Deis Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any [Kubernetes][k8s-home] cluster, making it easy to deploy and manage applications.

Deis Workflow is the second major release (v2) of the Deis PaaS. If you are looking for the CoreOS-based PaaS visit https://github.com/deis/deis.

To get started with Deis Workflow please read the Quick Start Guide.

Visit https://deis.com for more information on why you should use Deis Workflow or learn about its features.

This repository contains the source code for Deis Workflow documentation. If you're looking for individual components, they live in their own repositories.

Please see below for links and descriptions of each component:

• controller - Workflow API server
• builder - Git server and source-to-image component
• dockerbuilder - The builder for Docker based applications
• slugbuilder - The builder for slug/buildpack based applications
• slugrunner - The runner for slug/buildpack based applications
• fluentd - Backend log shipping mechanism for deis logs
• postgres - The central database
• registry - The Docker registry
• logger - The (in-memory) log buffer for deis logs
• monitor - The platform monitoring components
• router - The HTTP/s edge router
• minio - The in-cluster, ephemeral, development-only object storage system
• nsq - Realtime distributed messaging platform
• workflow-cli - Workflow CLI deis
• workflow-e2e - End-to-end tests for the entire platform
• workflow-manager - Manage, inspect, and debug a Workflow cluster

We welcome your input! If you have feedback, please [submit an issue][issues]. If you'd like to participate in development, please read the "Working on Documentation" section below and [submit a pull request][prs].

Working on Documentation

The Deis project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.

• Fork this repository.
• Make your changes.
• [Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible.

* If your PR fixes any [issues][issues], make sure you write Fixes #1234 in your PR description (where #1234 is the number of the issue you're closing).

• The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with LGTM1 and LGTM2 (respectively). Once that happens, a contributor will merge it.

Requirements

The documentation site requires either a local installation of [MkDocs][] or access to Docker.

Local Installation

Install [MkDocs][] and required dependencies:

make deps

Building Documentation

To build the documentation run: make build or make docker-build.

Serve Documentation Locally

To serve documenation run: make serve or make docker-serve.

Then view the documentation on http://localhost:8000 or http://DOCKERIP:8000.

[k8s-home]: http://kubernetes.io [install-k8s]: http://kubernetes.io/gettingstarted/ [mkdocs]: http://www.mkdocs.org/ [issues]: https://github.com/deis/workflow/issues [prs]: https://github.com/deis/workflow/pulls [v2.18]: https://github.com/deis/workflow/releases/tag/v2.18.0