{"action":"created","comment":{"url":"https://api.github.com/repos/deis/workflow/pulls/comments/56197157","id":56197157,"diff_hunk":"@@ -1,76 +1,89 @@\n # Deis Workflow v2\n \n-[![Build Status](https://travis-ci.org/deis/workflow.svg?branch=master)](https://travis-ci.org/deis/workflow) [![codecov.io](https://codecov.io/github/deis/workflow/coverage.svg?branch=master)](https://codecov.io/github/deis/workflow?branch=master)\n+[![Build Status](https://travis-ci.org/deis/workflow.svg?branch=master)](https://travis-ci.org/deis/workflow)\n+[![codecov.io](https://codecov.io/github/deis/workflow/coverage.svg?branch=master)](https://codecov.io/github/deis/workflow?branch=master)\n+[![Docker Repository on Quay](https://quay.io/repository/deisci/controller/status \"Docker Repository on Quay\")](https://quay.io/repository/deisci/controller)\n \n-Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage\n-applications on your own servers. Deis builds on [Kubernetes](http://kubernetes.io/) to provide\n-a lightweight, [Heroku-inspired](http://heroku.com) workflow.\n+Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage applications on your own servers. Deis builds on Kubernetes to provide a lightweight, easy and secure way to deploy your code to production.\n \n-## Work in Progress\n+For more information about the Deis Workflow, please visit the main project page at https://github.com/deis/workflow.\n \n-![Deis Graphic](https://s3-us-west-2.amazonaws.com/get-deis/deis-graphic-small.png)\n+## Beta Status\n \n-Deis Workflow v2 is currently in alpha. Your feedback and participation are more than welcome, but be\n-aware that this project is considered a work in progress.\n+This Deis component is currently in beta status, and we welcome your input! If you have feedback, please [submit an issue][issues]. If you'd like to participate in development, please read the \"Development\" section below and [submit a pull request][prs].\n \n-The following features are not ready in Alpha1, but will be coming\n-soon.\n+The following features are not ready in Beta, but will be coming soon.\n \n - Complete SSL support\n-- Dockerfile builds\n - Backup and restore features\n - Persistent storage (though it can be manually configured)\n \n-## Hacking Workflow\n+# About\n \n-First, [obtain a Kubernetes cluster][install-k8s]. Deis Workflow currently targets Kubernetes\n-v1.1 with the following requirements:\n+The controller is the central API for the entire Deis Platform. Below is a non-exhaustive list of things it can do:\n \n-* Configure Docker's `insecure-registry` parameter to include the subnets used by your Kubernetes installation\n-* If you are testing the logger components, you must enable `DaemonSet` experimental APIs via `--runtime-config=extensions/v1beta1/daemonsets=true`\n+* Create a new application\n+* Delete an application\n+* Scale an application\n+* Configure an application\n+* Create a new user\n \n-Next, install [helm](http://helm.sh). Next, add the deis repository to your chart list:\n+# Development\n \n-```console\n-$ helm repo add deis https://github.com/deis/charts\n-```\n+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.\n \n-Then, install Deis!\n+* Fork this repository\n+* Make your changes\n+* [Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible.\n+  * 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)\n+* 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, you may merge\n \n-To work off the latest stable\n+## Prerequisities\n \n-```console\n-$ helm install deis/deis\n-```\n+### Kubernetes\n \n-To work off the latest development version\n+In order to do development on this component, you'll need a working Kubernetes cluster. If you don't have one follow the [installation instructions][install-k8s] and note that Workflow currently targets version 1.1 with the following requirements:\n \n-```console\n-$ helm install deis/deis-dev\n-```\n+* Docker's `insecure-registry` parameter must include the subnets used by your Kubernetes installation\n+* If you are testing the logger components, you must enable `DaemonSet` experimental APIs via `--runtime-config=extensions/v1beta1/daemonsets=true`\n \n-Complete instructions for installing and managing a Deis cluster are\n-available at https://github.com/deis/docs-v2\n+### Helm\n \n-If you want to retrieve the latest client dev build for OS X or Linux, download the client:\n+After you have a working Kubernetes cluster, install [helm](http://helm.sh) and run the following commands to add the Deis chart repository and install Deis to your new cluster:\n \n ```console\n-$ curl -sSL http://deis.io/deis-cli/install-v2-alpha.sh | bash\n+helm repo add deis https://github.com/deis/charts\n+helm install deis/deis-dev\n ```\n \n-If you want to hack on a new feature, build the deis/workflow image and push it to a Docker\n-registry. The `$DEIS_REGISTRY` environment variable must point to a registry accessible to your\n-Kubernetes cluster. You may need to configure the Docker engines on your Kubernetes nodes to allow\n-`--insecure-registry 192.168.0.0/16` (or the appropriate address range).\n+Note that to work off the latest stable release, change the `helm install deis/deis-dev` command to `helm install deis/deis`.\n \n-When you want to test changes then commit the changes to your branch and run\n+## Testing Your Code\n+\n+When you've built your new feature or fixed a bug, make sure you've added appropriate unit tests and run `make test` to ensure your code works properly.\n+\n+Also, since this component is central to the platform, it's recommended that you manually test and verify that your feature or fix works as expected. To do so, ensure the following environment variables are set:\n+\n+* `DEIS_REGISTRY` - A Docker registry that you have push access to and your Kubernetes cluster can pull from\n+  * If this is [Docker Hub](https://hub.docker.com/), leave this variable empty\n+  * Otherwise, ensure it has a trailing `/`. For example, if you're using [Quay.io](https://quay.io), use `quay.io/`\n+* `IMAGE_PREFIX` - The name of the repository. This defaults to `deis`, but if you don't have access to that repository, set this to a repository that you have push access to.","path":"README.md","position":null,"original_position":108,"commit_id":"6f7bcccd05acfa1173beace869ddfcdac07953c8","original_commit_id":"89526e03677d212fb6479e0db599e40e5f883611","user":{"login":"arschles","id":70865,"avatar_url":"https://avatars.githubusercontent.com/u/70865?v=3","gravatar_id":"","url":"https://api.github.com/users/arschles","html_url":"https://github.com/arschles","followers_url":"https://api.github.com/users/arschles/followers","following_url":"https://api.github.com/users/arschles/following{/other_user}","gists_url":"https://api.github.com/users/arschles/gists{/gist_id}","starred_url":"https://api.github.com/users/arschles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arschles/subscriptions","organizations_url":"https://api.github.com/users/arschles/orgs","repos_url":"https://api.github.com/users/arschles/repos","events_url":"https://api.github.com/users/arschles/events{/privacy}","received_events_url":"https://api.github.com/users/arschles/received_events","type":"User","site_admin":false},"body":":+1: - changed in 6f7bcccd05acfa1173beace869ddfcdac07953c8","created_at":"2016-03-15T16:45:42Z","updated_at":"2016-03-15T16:45:42Z","html_url":"https://github.com/deis/workflow/pull/500#discussion_r56197157","pull_request_url":"https://api.github.com/repos/deis/workflow/pulls/500","_links":{"self":{"href":"https://api.github.com/repos/deis/workflow/pulls/comments/56197157"},"html":{"href":"https://github.com/deis/workflow/pull/500#discussion_r56197157"},"pull_request":{"href":"https://api.github.com/repos/deis/workflow/pulls/500"}}},"pull_request":{"url":"https://api.github.com/repos/deis/workflow/pulls/500","id":62834206,"html_url":"https://github.com/deis/workflow/pull/500","diff_url":"https://github.com/deis/workflow/pull/500.diff","patch_url":"https://github.com/deis/workflow/pull/500.patch","issue_url":"https://api.github.com/repos/deis/workflow/issues/500","number":500,"state":"open","locked":false,"title":"doc(README.md): update README to reflect beta status","user":{"login":"arschles","id":70865,"avatar_url":"https://avatars.githubusercontent.com/u/70865?v=3","gravatar_id":"","url":"https://api.github.com/users/arschles","html_url":"https://github.com/arschles","followers_url":"https://api.github.com/users/arschles/followers","following_url":"https://api.github.com/users/arschles/following{/other_user}","gists_url":"https://api.github.com/users/arschles/gists{/gist_id}","starred_url":"https://api.github.com/users/arschles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arschles/subscriptions","organizations_url":"https://api.github.com/users/arschles/orgs","repos_url":"https://api.github.com/users/arschles/repos","events_url":"https://api.github.com/users/arschles/events{/privacy}","received_events_url":"https://api.github.com/users/arschles/received_events","type":"User","site_admin":false},"body":"cc/ @helgi @mboersma @slack \r\n\r\nRef https://github.com/deis/deis/issues/4962","created_at":"2016-03-14T23:32:54Z","updated_at":"2016-03-15T16:45:42Z","closed_at":null,"merged_at":null,"merge_commit_sha":"a2f7603ee9840949084167c60d920da0c4bb59f7","assignee":{"login":"arschles","id":70865,"avatar_url":"https://avatars.githubusercontent.com/u/70865?v=3","gravatar_id":"","url":"https://api.github.com/users/arschles","html_url":"https://github.com/arschles","followers_url":"https://api.github.com/users/arschles/followers","following_url":"https://api.github.com/users/arschles/following{/other_user}","gists_url":"https://api.github.com/users/arschles/gists{/gist_id}","starred_url":"https://api.github.com/users/arschles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arschles/subscriptions","organizations_url":"https://api.github.com/users/arschles/orgs","repos_url":"https://api.github.com/users/arschles/repos","events_url":"https://api.github.com/users/arschles/events{/privacy}","received_events_url":"https://api.github.com/users/arschles/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/deis/workflow/milestones/2","html_url":"https://github.com/deis/workflow/milestones/v2.0-beta1","labels_url":"https://api.github.com/repos/deis/workflow/milestones/2/labels","id":1459752,"number":2,"title":"v2.0-beta1","description":"","creator":{"login":"mboersma","id":73019,"avatar_url":"https://avatars.githubusercontent.com/u/73019?v=3","gravatar_id":"","url":"https://api.github.com/users/mboersma","html_url":"https://github.com/mboersma","followers_url":"https://api.github.com/users/mboersma/followers","following_url":"https://api.github.com/users/mboersma/following{/other_user}","gists_url":"https://api.github.com/users/mboersma/gists{/gist_id}","starred_url":"https://api.github.com/users/mboersma/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mboersma/subscriptions","organizations_url":"https://api.github.com/users/mboersma/orgs","repos_url":"https://api.github.com/users/mboersma/repos","events_url":"https://api.github.com/users/mboersma/events{/privacy}","received_events_url":"https://api.github.com/users/mboersma/received_events","type":"User","site_admin":false},"open_issues":2,"closed_issues":198,"state":"open","created_at":"2015-12-14T17:45:25Z","updated_at":"2016-03-15T01:00:13Z","due_on":null,"closed_at":null},"commits_url":"https://api.github.com/repos/deis/workflow/pulls/500/commits","review_comments_url":"https://api.github.com/repos/deis/workflow/pulls/500/comments","review_comment_url":"https://api.github.com/repos/deis/workflow/pulls/comments{/number}","comments_url":"https://api.github.com/repos/deis/workflow/issues/500/comments","statuses_url":"https://api.github.com/repos/deis/workflow/statuses/6f7bcccd05acfa1173beace869ddfcdac07953c8","head":{"label":"arschles:readme-beta","ref":"readme-beta","sha":"6f7bcccd05acfa1173beace869ddfcdac07953c8","user":{"login":"arschles","id":70865,"avatar_url":"https://avatars.githubusercontent.com/u/70865?v=3","gravatar_id":"","url":"https://api.github.com/users/arschles","html_url":"https://github.com/arschles","followers_url":"https://api.github.com/users/arschles/followers","following_url":"https://api.github.com/users/arschles/following{/other_user}","gists_url":"https://api.github.com/users/arschles/gists{/gist_id}","starred_url":"https://api.github.com/users/arschles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arschles/subscriptions","organizations_url":"https://api.github.com/users/arschles/orgs","repos_url":"https://api.github.com/users/arschles/repos","events_url":"https://api.github.com/users/arschles/events{/privacy}","received_events_url":"https://api.github.com/users/arschles/received_events","type":"User","site_admin":false},"repo":{"id":46818016,"name":"deis-workflow","full_name":"arschles/deis-workflow","owner":{"login":"arschles","id":70865,"avatar_url":"https://avatars.githubusercontent.com/u/70865?v=3","gravatar_id":"","url":"https://api.github.com/users/arschles","html_url":"https://github.com/arschles","followers_url":"https://api.github.com/users/arschles/followers","following_url":"https://api.github.com/users/arschles/following{/other_user}","gists_url":"https://api.github.com/users/arschles/gists{/gist_id}","starred_url":"https://api.github.com/users/arschles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arschles/subscriptions","organizations_url":"https://api.github.com/users/arschles/orgs","repos_url":"https://api.github.com/users/arschles/repos","events_url":"https://api.github.com/users/arschles/events{/privacy}","received_events_url":"https://api.github.com/users/arschles/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/arschles/deis-workflow","description":"[MIRROR] PaaS workflow controller and client for Deis v2","fork":true,"url":"https://api.github.com/repos/arschles/deis-workflow","forks_url":"https://api.github.com/repos/arschles/deis-workflow/forks","keys_url":"https://api.github.com/repos/arschles/deis-workflow/keys{/key_id}","collaborators_url":"https://api.github.com/repos/arschles/deis-workflow/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/arschles/deis-workflow/teams","hooks_url":"https://api.github.com/repos/arschles/deis-workflow/hooks","issue_events_url":"https://api.github.com/repos/arschles/deis-workflow/issues/events{/number}","events_url":"https://api.github.com/repos/arschles/deis-workflow/events","assignees_url":"https://api.github.com/repos/arschles/deis-workflow/assignees{/user}","branches_url":"https://api.github.com/repos/arschles/deis-workflow/branches{/branch}","tags_url":"https://api.github.com/repos/arschles/deis-workflow/tags","blobs_url":"https://api.github.com/repos/arschles/deis-workflow/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/arschles/deis-workflow/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/arschles/deis-workflow/git/refs{/sha}","trees_url":"https://api.github.com/repos/arschles/deis-workflow/git/trees{/sha}","statuses_url":"https://api.github.com/repos/arschles/deis-workflow/statuses/{sha}","languages_url":"https://api.github.com/repos/arschles/deis-workflow/languages","stargazers_url":"https://api.github.com/repos/arschles/deis-workflow/stargazers","contributors_url":"https://api.github.com/repos/arschles/deis-workflow/contributors","subscribers_url":"https://api.github.com/repos/arschles/deis-workflow/subscribers","subscription_url":"https://api.github.com/repos/arschles/deis-workflow/subscription","commits_url":"https://api.github.com/repos/arschles/deis-workflow/commits{/sha}","git_commits_url":"https://api.github.com/repos/arschles/deis-workflow/git/commits{/sha}","comments_url":"https://api.github.com/repos/arschles/deis-workflow/comments{/number}","issue_comment_url":"https://api.github.com/repos/arschles/deis-workflow/issues/comments{/number}","contents_url":"https://api.github.com/repos/arschles/deis-workflow/contents/{+path}","compare_url":"https://api.github.com/repos/arschles/deis-workflow/compare/{base}...{head}","merges_url":"https://api.github.com/repos/arschles/deis-workflow/merges","archive_url":"https://api.github.com/repos/arschles/deis-workflow/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/arschles/deis-workflow/downloads","issues_url":"https://api.github.com/repos/arschles/deis-workflow/issues{/number}","pulls_url":"https://api.github.com/repos/arschles/deis-workflow/pulls{/number}","milestones_url":"https://api.github.com/repos/arschles/deis-workflow/milestones{/number}","notifications_url":"https://api.github.com/repos/arschles/deis-workflow/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/arschles/deis-workflow/labels{/name}","releases_url":"https://api.github.com/repos/arschles/deis-workflow/releases{/id}","deployments_url":"https://api.github.com/repos/arschles/deis-workflow/deployments","created_at":"2015-11-24T20:54:44Z","updated_at":"2016-02-04T16:39:56Z","pushed_at":"2016-03-15T16:45:33Z","git_url":"git://github.com/arschles/deis-workflow.git","ssh_url":"git@github.com:arschles/deis-workflow.git","clone_url":"https://github.com/arschles/deis-workflow.git","svn_url":"https://github.com/arschles/deis-workflow","homepage":"https://github.com/deis/workflow","size":15161,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"deis:master","ref":"master","sha":"be8934f8afda94fa096f93b058a6525c51c4b97c","user":{"login":"deis","id":6117407,"avatar_url":"https://avatars.githubusercontent.com/u/6117407?v=3","gravatar_id":"","url":"https://api.github.com/users/deis","html_url":"https://github.com/deis","followers_url":"https://api.github.com/users/deis/followers","following_url":"https://api.github.com/users/deis/following{/other_user}","gists_url":"https://api.github.com/users/deis/gists{/gist_id}","starred_url":"https://api.github.com/users/deis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deis/subscriptions","organizations_url":"https://api.github.com/users/deis/orgs","repos_url":"https://api.github.com/users/deis/repos","events_url":"https://api.github.com/users/deis/events{/privacy}","received_events_url":"https://api.github.com/users/deis/received_events","type":"Organization","site_admin":false},"repo":{"id":45704630,"name":"workflow","full_name":"deis/workflow","owner":{"login":"deis","id":6117407,"avatar_url":"https://avatars.githubusercontent.com/u/6117407?v=3","gravatar_id":"","url":"https://api.github.com/users/deis","html_url":"https://github.com/deis","followers_url":"https://api.github.com/users/deis/followers","following_url":"https://api.github.com/users/deis/following{/other_user}","gists_url":"https://api.github.com/users/deis/gists{/gist_id}","starred_url":"https://api.github.com/users/deis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deis/subscriptions","organizations_url":"https://api.github.com/users/deis/orgs","repos_url":"https://api.github.com/users/deis/repos","events_url":"https://api.github.com/users/deis/events{/privacy}","received_events_url":"https://api.github.com/users/deis/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/deis/workflow","description":"PaaS workflow controller and client for Deis v2","fork":false,"url":"https://api.github.com/repos/deis/workflow","forks_url":"https://api.github.com/repos/deis/workflow/forks","keys_url":"https://api.github.com/repos/deis/workflow/keys{/key_id}","collaborators_url":"https://api.github.com/repos/deis/workflow/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/deis/workflow/teams","hooks_url":"https://api.github.com/repos/deis/workflow/hooks","issue_events_url":"https://api.github.com/repos/deis/workflow/issues/events{/number}","events_url":"https://api.github.com/repos/deis/workflow/events","assignees_url":"https://api.github.com/repos/deis/workflow/assignees{/user}","branches_url":"https://api.github.com/repos/deis/workflow/branches{/branch}","tags_url":"https://api.github.com/repos/deis/workflow/tags","blobs_url":"https://api.github.com/repos/deis/workflow/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/deis/workflow/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/deis/workflow/git/refs{/sha}","trees_url":"https://api.github.com/repos/deis/workflow/git/trees{/sha}","statuses_url":"https://api.github.com/repos/deis/workflow/statuses/{sha}","languages_url":"https://api.github.com/repos/deis/workflow/languages","stargazers_url":"https://api.github.com/repos/deis/workflow/stargazers","contributors_url":"https://api.github.com/repos/deis/workflow/contributors","subscribers_url":"https://api.github.com/repos/deis/workflow/subscribers","subscription_url":"https://api.github.com/repos/deis/workflow/subscription","commits_url":"https://api.github.com/repos/deis/workflow/commits{/sha}","git_commits_url":"https://api.github.com/repos/deis/workflow/git/commits{/sha}","comments_url":"https://api.github.com/repos/deis/workflow/comments{/number}","issue_comment_url":"https://api.github.com/repos/deis/workflow/issues/comments{/number}","contents_url":"https://api.github.com/repos/deis/workflow/contents/{+path}","compare_url":"https://api.github.com/repos/deis/workflow/compare/{base}...{head}","merges_url":"https://api.github.com/repos/deis/workflow/merges","archive_url":"https://api.github.com/repos/deis/workflow/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/deis/workflow/downloads","issues_url":"https://api.github.com/repos/deis/workflow/issues{/number}","pulls_url":"https://api.github.com/repos/deis/workflow/pulls{/number}","milestones_url":"https://api.github.com/repos/deis/workflow/milestones{/number}","notifications_url":"https://api.github.com/repos/deis/workflow/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/deis/workflow/labels{/name}","releases_url":"https://api.github.com/repos/deis/workflow/releases{/id}","deployments_url":"https://api.github.com/repos/deis/workflow/deployments","created_at":"2015-11-06T20:06:05Z","updated_at":"2016-03-05T03:14:35Z","pushed_at":"2016-03-15T16:45:33Z","git_url":"git://github.com/deis/workflow.git","ssh_url":"git@github.com:deis/workflow.git","clone_url":"https://github.com/deis/workflow.git","svn_url":"https://github.com/deis/workflow","homepage":"http://deis.io","size":15288,"stargazers_count":16,"watchers_count":16,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":20,"mirror_url":null,"open_issues_count":63,"forks":20,"open_issues":63,"watchers":16,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/deis/workflow/pulls/500"},"html":{"href":"https://github.com/deis/workflow/pull/500"},"issue":{"href":"https://api.github.com/repos/deis/workflow/issues/500"},"comments":{"href":"https://api.github.com/repos/deis/workflow/issues/500/comments"},"review_comments":{"href":"https://api.github.com/repos/deis/workflow/pulls/500/comments"},"review_comment":{"href":"https://api.github.com/repos/deis/workflow/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/deis/workflow/pulls/500/commits"},"statuses":{"href":"https://api.github.com/repos/deis/workflow/statuses/6f7bcccd05acfa1173beace869ddfcdac07953c8"}}}}