Skip to content

Commit d6b3783

Browse files
mboersmaMatthew Fisher
authored andcommitted
docs(scheduler): add and update README.md files
Fixes #705.
1 parent 46ae6fc commit d6b3783

1 file changed

Lines changed: 33 additions & 8 deletions

File tree

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,48 @@
1-
# Deis Server
1+
# Deis Controller
22

3-
A Docker image containing a REST API and web server, for use in the [Deis](http://deis.io) open source PaaS.
3+
A RESTful API server for use in the [Deis](http://deis.io) open
4+
source PaaS.
45

56
[![image](https://d207aa93qlcgug.cloudfront.net/img/icons/framed-icon-checked-repository.svg)](https://index.docker.io/u/deis/controller/)
67

78
[**Trusted Build**](https://index.docker.io/u/deis/controller/)
89

9-
This Docker image is based on the trusted build [deis/base](https://index.docker.io/u/deis/base/), which itself is based on the official [ubuntu:12.04](https://index.docker.io/_/ubuntu/) base image.
10+
This Docker image is based on the trusted build
11+
[deis/base](https://index.docker.io/u/deis/base/), which itself is based
12+
on the official [ubuntu:12.04](https://index.docker.io/_/ubuntu/) image.
1013

11-
Please add any issues you find with this software to the parent [Deis project](https://github.com/opdemand/deis/issues).
14+
Please add any issues you find with this software to the
15+
[Deis project](https://github.com/opdemand/deis/issues).
1216

1317
## Usage
1418

15-
Coming Soon!
19+
* `make build` builds the *deis/controller* image inside a vagrant VM
20+
* `make run` installs and starts *deis/controller*, then displays log
21+
output from the container
22+
* `make test` runs unit tests for the controller and reports results
23+
24+
## Environment Variables
25+
26+
* **DEBUG** enables verbose output if set
27+
* **ETCD_PORT** sets the TCP port on which to connect to the local etcd
28+
daemon (default: *4001*)
29+
* **ETCD_PATH** sets the etcd directory where the controller announces
30+
its configuration (default: */deis/controller*)
31+
* **ETCD_TTL** sets the time-to-live before etcd purges a configuration
32+
value, in seconds (default: *10*)
33+
* **PORT** sets the TCP port on which the controller listens for API
34+
requests (default: *8000*)
1635

1736
## License
1837

19-
Copyright 2014 OpDemand LLC
38+
© 2014 OpDemand LLC
2039

21-
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>
40+
Licensed under the Apache License, Version 2.0 (the "License"); you may
41+
not use this file except in compliance with the License. You may obtain
42+
a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>
2243

23-
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.
44+
Unless required by applicable law or agreed to in writing, software
45+
distributed under the License is distributed on an "AS IS" BASIS,
46+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
47+
See the License for the specific language governing permissions and
48+
limitations under the License.

0 commit comments

Comments
 (0)