Skip to content

Commit d5aa3dd

Browse files
mboersmaMatthew Fisher
mboersma
authored and
Matthew Fisher
committed
docs(scheduler): add and update README.md files
Fixes #705.
1 parent 36e578d commit d5aa3dd

10 files changed

Lines changed: 288 additions & 50 deletions

File tree

‎builder/README.md‎

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,46 @@
11
# Deis Builder
22

3-
A Docker image that builds Docker images, for use in the [Deis](http://deis.io) open source PaaS.
3+
A Docker image that builds Docker images, for use in the
4+
[Deis](http://deis.io) open source PaaS.
45

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

78
[**Trusted Build**](https://index.docker.io/u/deis/builder/)
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/builder* image inside a vagrant VM
20+
* `make run` installs and starts *deis/builder*, then displays log
21+
output from the container
22+
23+
## Environment Variables
24+
25+
* **DEBUG** enables verbose output if set
26+
* **ETCD_PORT** sets the TCP port on which to connect to the local etcd
27+
daemon (default: *4001*)
28+
* **ETCD_PATH** sets the etcd directory where the builder announces
29+
its configuration (default: */deis/builder*)
30+
* **ETCD_TTL** sets the time-to-live before etcd purges a configuration
31+
value, in seconds (default: *10*)
32+
* **PORT** sets the TCP port on which the builder listens (default: *2222*)
1633

1734
## License
1835

19-
Copyright 2014 OpDemand LLC
36+
© 2014 OpDemand LLC
2037

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

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

‎cache/README.md‎

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,45 @@
11
# Deis Cache
22

3-
A Docker image containing a cache server, for use in the [Deis](http://deis.io) open source PaaS.
3+
A cache server for use in the [Deis](http://deis.io) open source PaaS.
44

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

77
[**Trusted Build**](https://index.docker.io/u/deis/cache/)
88

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.
9+
This Docker image is based on the trusted build
10+
[deis/base](https://index.docker.io/u/deis/base/), which itself is based
11+
on the official [ubuntu:12.04](https://index.docker.io/_/ubuntu/) image.
1012

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

1316
## Usage
1417

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

1733
## License
1834

19-
Copyright 2014 OpDemand LLC
35+
© 2014 OpDemand LLC
2036

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

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

‎contrib/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Deis Contrib
2+
3+
Scripts, tools and documentation that are not part of the core
4+
Deis system.
5+
6+
The contents of this directory may be vendor-specific, address a
7+
limited audience, or be too experimental to be included in Deis' core.
8+
This does not preclude their usefulness.
9+
10+
Please add any issues you find with this software to the
11+
[Deis project](https://github.com/opdemand/deis/issues).

‎controller/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.

‎database/README.md‎

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,57 @@
11
# Deis Database
22

3-
A Docker image containing a PostgreSQL 9.3 database, for use in the [Deis](http://deis.io) open source PaaS.
3+
A PostgreSQL database 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/database/)
67

78
[**Trusted Build**](https://index.docker.io/u/deis/database/)
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/database* image inside a vagrant VM
20+
* `make run` installs and starts *deis/database*, then displays log
21+
output from the container
22+
23+
## Environment Variables
24+
25+
* **DEBUG** enables verbose output if set
26+
* **ETCD_PORT** sets the TCP port on which to connect to the local etcd
27+
daemon (default: *4001*)
28+
* **ETCD_PATH** sets the etcd directory where the database announces
29+
its configuration (default: */deis/database*)
30+
* **ETCD_TTL** sets the time-to-live before etcd purges a configuration
31+
value, in seconds (default: *10*)
32+
* **PG_ADMIN_USER** sets the database admin user name (default: *postgres*)
33+
* **PG_ADMIN_PASS** sets the database admin user password
34+
(default: *changeme123*)
35+
* **PG_CONFIG** sets the PostgreSQL configuration file location
36+
(default: */etc/postgresql/9.3/main/postgresql.conf*)
37+
* **PG_LISTEN** sets the addresses on which the database will listen
38+
(default: *)
39+
* **PG_USER_NAME** sets the database user name for Deis (default: *deis*)
40+
* **PG_USER_PASS** sets the database user password for Deis
41+
(default: *changeme123*)
42+
* **PG_USER_DB** sets the database name used by Deis (default: *deis*)
43+
* **PORT** sets the TCP port on which the database listens (default: *5432*)
1644

1745
## License
1846

19-
Copyright 2014 OpDemand LLC
47+
© 2014 OpDemand LLC
2048

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

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

‎docs/README.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Deis Documentation
2+
3+
Source files for <http://docs.deis.io>, the documentation home of Deis.
4+
5+
Documentation in this tree consists of plain text files named with the
6+
`.rst` suffix. These can be read in any text viewer, or processed by the
7+
[Sphinx](http://sphinx-doc.org/) system to create an HTML version.
8+
9+
Please add any issues you find with this documentation to the
10+
[Deis project](https://github.com/opdemand/deis/issues).
11+
12+
## Usage
13+
14+
1. Install Sphinx and other requirements:
15+
16+
```console
17+
$ virtualenv venv -q --prompt='(docs)' && . venv/bin/activate
18+
(docs)$ pip install -r docs_requirements.txt
19+
Downloading/unpacking boto==2.23.0
20+
...
21+
Successfully installed psycopg2 pyrax python-etcd PyYAML ...
22+
Cleaning up...
23+
(docs)$
24+
```
25+
26+
See comments at the top of the ``docs_requirements.txt`` file if you
27+
have problems with this step on Mac OS X Mavericks.
28+
29+
2. Build the documentation and host it on a local web server:
30+
31+
```console
32+
(docs)$ make server
33+
sphinx-build -b dirhtml -d _build/doctrees . _build/dirhtml
34+
Making output directory...
35+
Running Sphinx v1.2.2
36+
...
37+
Build finished. The HTML pages are in _build/dirhtml.
38+
Serving HTTP on 0.0.0.0 port 8000 ...
39+
```
40+
41+
3. Open a web browser to http://127.0.0.1:8000/ and learn about Deis,
42+
a lightweight, flexible and powerful open source PaaS.
43+
44+
4. Fork this repository and send your changes or additions to Deis'
45+
documentation as GitHub
46+
[Pull Requests](https://github.com/opdemand/deis/pulls). Thank you!

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484

8585
# List of patterns, relative to source directory, that match files and
8686
# directories to ignore when looking for source files.
87-
exclude_patterns = ['_build']
87+
exclude_patterns = ['_build', 'venv']
8888

8989
# The reST default role (used for this markup: `text`) to use for all documents.
9090
#default_role = None

‎logger/README.md‎

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,45 @@
11
# Deis Logger
22

3-
A Docker image containing a system logger, for use in the [Deis](http://deis.io) open source PaaS.
3+
A system logger for use in the [Deis](http://deis.io) open source PaaS.
44

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

77
[**Trusted Build**](https://index.docker.io/u/deis/logger/)
88

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.
9+
This Docker image is based on the trusted build
10+
[deis/base](https://index.docker.io/u/deis/base/), which itself is based
11+
on the official [ubuntu:12.04](https://index.docker.io/_/ubuntu/) image.
1012

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

1316
## Usage
1417

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

1733
## License
1834

19-
Copyright 2014 OpDemand LLC
35+
© 2014 OpDemand LLC
2036

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

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

0 commit comments

Comments
 (0)