Repository files navigation

	Deis Workflow is no longer maintained. Pleaseread the announcement for more detail.
09/07/2017	Deis Workflowv2.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 (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to anyKubernetes cluster, making it easy to deploy and manage applications on your own servers.

For more information about the Deis workflow, please visit the main project page athttps://github.com/deis/workflow.

We welcome your input! If you have feedback, please submit anissue. If you'd like to participate in development, please read the "Development" section below and submit apull request.

The Deis minio component provides anS3 API compatible object storage server, based onMinio, that can be run on Kubernetes. It's intended for use within theDeis v2 platform as an object storage server, but it's flexible enough to be run as a standalone pod on any Kubernetes cluster.

Note that in the defaultHelm chart for the Deis platform, this component is used as a storage location for the following components:

• deis/postgres
• deis/registry
• deis/builder

Also note that we aren't currently providing this component with any kind of persistent storage, but it may work withpersistent volumes.

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 apull request (PR) to this repository with your changes, and unit tests whenever possible.
• If your PR fixes anyissues, 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 withLGTM1 andLGTM2 (respectively). Once that happens, you may merge.

Also, note that theDockerfile uses anADD directive to download pre-built Minio binaries from aGoogle Cloud Storage bucket. The bucket is in thedeis-mirrors project, and if you have access to that project,this link should take you directly to that bucket.

To bump this component to use a newer build of Minio, simply add a new binary to the bucket (under thelinux-amd64 folder), check the checkbox under theShare publicly column, and update the URL in theADD directive in the aforementionedDockerfile.

The preferred environment for development uses thego-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 havemake installed and Docker installed and running on your local development machine.

If you don't have Docker installed, please go tohttps://www.docker.com/ to install it.

After you have those dependencies, build your code withmake build and execute unit tests withmake test.

You can also use the standard go toolchain to build and test if you prefer. To do so, you'll needglide 0.9 or above andGo 1.6 or above installed.

After you have those dependencies, you can build and unit-test your code withgo build andgo test $(glide nv), respectively.

Note that you will not be able to build or push Docker images using this method of development.

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).

Theend-to-end tests repository has our integration tests. Additionally, the core contributors and members of the community also regularlydogfood the platform.

Please seeREADME.md on the end-to-end tests reposotory for instructions on how to set up your testing environment and run the tests.

Please follow the instructions on theofficial Deis docs to install and configure your Deis cluster and all related tools, and deploy and configure an app on Deis.