Skip to content

Commit b4c97b0

Browse files
author
Matthew Fisher
committed
docs(README): update component information
The component name has changed to deis/controller but the README had not yet been updated.
1 parent fbf45db commit b4c97b0

1 file changed

Lines changed: 11 additions & 16 deletions

File tree

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# Deis Workflow v2
1+
# Deis Controller
22

33
[![Build Status](https://travis-ci.org/deis/controller.svg?branch=master)](https://travis-ci.org/deis/controller)
44
[![codecov.io](https://codecov.io/github/deis/controller/coverage.svg?branch=master)](https://codecov.io/github/deis/controller?branch=master)
55
[![Docker Repository on Quay](https://quay.io/repository/deisci/controller/status "Docker Repository on Quay")](https://quay.io/repository/deisci/controller)
66

7-
Deis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any [Kubernetes](http://kubernetes.io) cluster, making it easy to deploy and manage applications on your own servers.
7+
The Controller is the central API server for [Deis Workflow][workflow]. It is installed on a [Kubernetes](http://kubernetes.io) cluster, making it easy to deploy and manage applications on your own cluster. Below is a non-exhaustive list of things it can do:
88

9-
For more information about the Deis Workflow, please visit the main project page at https://github.com/deis/workflow.
9+
* Create a new application
10+
* Delete an application
11+
* Scale an application
12+
* Configure an application
13+
* Create a new user
1014

1115
## Beta Status
1216

@@ -18,16 +22,6 @@ The following features are not ready in Beta, but will be coming soon.
1822
- Backup and restore features
1923
- Persistent storage (though it can be manually configured)
2024

21-
# About
22-
23-
The controller is the central API for the entire Deis Platform. Below is a non-exhaustive list of things it can do:
24-
25-
* Create a new application
26-
* Delete an application
27-
* Scale an application
28-
* Configure an application
29-
* Create a new user
30-
3125
# Development
3226

3327
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.
@@ -38,11 +32,11 @@ The Deis project welcomes contributions from all developers. The high level proc
3832
* 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)
3933
* 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, the contributors will merge it
4034

41-
## Prerequisities
35+
## Prerequisites
4236

4337
### Kubernetes
4438

45-
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:
39+
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 Controller currently targets version 1.1 with the following requirements:
4640

4741
* Docker's `insecure-registry` parameter must include the subnets used by your Kubernetes installation
4842
* If you are testing the logger components, you must enable `DaemonSet` experimental APIs via `--runtime-config=extensions/v1beta1/daemonsets=true`
@@ -105,5 +99,6 @@ Unless required by applicable law or agreed to in writing, software distributed
10599

106100
[install-k8s]: http://kubernetes.io/gettingstarted/
107101
[repl-controller]: http://kubernetes.io/docs/user-guide/replication-controller/
108-
[issues]: https://github.com/deis/workflow/issues
102+
[issues]: https://github.com/deis/controller/issues
109103
[prs]: https://github.com/deis/controller/pulls
104+
[workflow]: https://github.com/deis/workflow

0 commit comments

Comments
 (0)