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://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. 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.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

young8 / workflow