Hephy Workflow

Hephy Workflow is the open source fork of Deis Workflow PaaS. Some of the old documentation and README are still preserved so they may reference "Deis Workflow". Hephy Workflow is the community continuation of the Deis Workflow project after it was end-of-lifed by the Deis team which moved on to do bigger projects at Microsoft Azure.

	Hephy Workflow is the open source fork of Deis Workflow. Please read the announcement for more detail.
05/08/2021	Hephy Workflow v2.23.0 release
01/02/2021	Hephy Workflow v2.22.3 patch release
11/15/2020	Hephy Workflow v2.22.2 patch release
10/12/2020	Hephy Workflow v2.22.1 patch release
10/02/2020	Hephy Workflow v2.22.0 release
05/26/2020	Hephy Workflow v2.21.6 patch release
04/23/2020	Hephy Workflow v2.21.5 patch release
12/31/2019	Hephy Workflow v2.21.4 patch release
09/11/2019	Hephy Workflow v2.21.3 patch release
08/11/2019	Hephy Workflow v2.21.2 patch release
06/21/2019	Hephy Workflow v2.21.1 patch release
05/05/2019	Hephy Workflow v2.21.0 release
03/08/2019	Hephy Workflow v2.20.2 patch release
02/14/2019	Hephy Workflow v2.20.1 patch release
11/29/2018	Hephy Workflow v2.20.0 new release
08/27/2018	Team Hephy blog comes online
08/20/2018	Deis #community slack goes dark
08/10/2018	Hephy Workflow [v2.19.4][] fourth patch release
08/08/2018	Deis website goes dark, then redirects to Azure Kubernetes Service
03/16/2018	Hephy Workflow website comes online
03/01/2018	End of Deis Workflow maintenance: critical patches no longer merged
12/11/2017	Team Hephy slack community invites first volunteers
09/07/2017	Deis Workflow v2.18 final release before entering maintenance mode
09/06/2017	Team Hephy slack community comes online

Deis Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any Kubernetes 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://docs.teamhephy.com for project documentation and to learn about its features and architecture.

Join us on Slack where we can help with issues, feature requests, and questions about running Hephy Workflow on Kubernetes on various cloud providers.

Visit the community maintained blog with tips, tricks, tutorials, and announcements about Hephy Workflow.

This repository contains the source code for Hephy 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. If you'd like to participate in development, please read the "Working on Documentation" section below and submit a pull request.

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 (PR) to this repository with your changes, and unit tests whenever possible.
  • If your PR fixes any 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://DOCKER_IP:8000.