Awesome
Deis Workflow Manager
This repository contains the manager component for Deis Workflow. Deis (pronounced DAY-iss) 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 on your own servers.
For more information about Deis Workflow, please visit the main project page at https://github.com/teamhephy/workflow.
We welcome your input! If you have feedback on Workflow Manager, please submit an issue. If you'd like to participate in development, please read the "Development" section below and submit a pull request.
Stay up to date
One of the primary goals for Workflow Manager is notifying operators of component freshness. Workflow Manager will regularly check your cluster against the latest stable components. If components are missing due to failure or are simply out of date, Workflow operators will know at a glance.
By default, Workflow Manager will make version checks to an external service.
This submits component and version information to our versions service running
at https://versions.deis.com. If you prefer this
check not happen, you may disable the function by setting
WORKFLOW_MANAGER_CHECKVERSIONS to false in the Workflow Manager's
Replication Controller.
Workflow Doctor
Deployed closest to any potential problem, Workflow Manager is also designed to help when things aren't going well. To aid troubleshooting efforts cluster operators will be able to easily gather and securely submit cluster health and status information to the Deis team.
Functionality will be added in a later release.
Development
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 #1234in your PR description (where#1234is the number of the issue you're closing)
- If your PR fixes any issues, make sure you write
- The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with
LGTM1andLGTM2(respectively). Once that happens, a contributor will merge it
Docker Based Development Environment
The preferred environment for development uses the go-dev Docker
image. The tools described in this
section are used to build, test, package and release each version of Deis.
To use it yourself, you must have make installed and Docker installed and running on your local development machine.
If you don't have Docker installed, please go to https://www.docker.com/ to install it.
After you have those dependencies, bootstrap dependencies with make bootstrap,
build your code with make build and execute unit tests with make test.
Native Go Development Environment
You can also use the standard go toolchain to build and test if you prefer.
To do so, you'll need glide 0.9 or
above and Go 1.6 or above installed.
After you have those dependencies, you can build and unit-test your code with
go build and go test $(glide nv), respectively.
Note that you will not be able to build or push Docker images using this method of development.
Testing
The Deis project requires that as much code as possible is unit tested, but the core contributors also recognize that some code must be tested at a higher level (functional or integration tests, for example).