docs(scheduler): update documentation for CoreOS/Fleet/cluster changes

Refs #707.

Author: mboersma

.gitignore

@@ -60,5 +60,3 @@ Vagrantfile.local
 .chef
 contrib/vagrant/knife-config/admin.pem
 contrib/vagrant/knife-config/chef-validator.pem
-controller/provider/vagrant-util/nodes/
-controller/provider/vagrant-util/.host_nodes_dir

README.md

@@ -9,17 +9,17 @@ Deis is an open source PaaS that makes it easy to deploy, scale and manage Docke
 
 # Installation
 
-Deis is a set of Docker containers that can be deployed anywhere including public cloud, private cloud, bare metal or your workstation.  You will need Docker and Vagrant to get started.
+Deis is a set of Docker containers that can be deployed anywhere including public cloud, private cloud, bare metal or your workstation. You will need [Docker](https://www.docker.io/) and [Vagrant](http://www.vagrantup.com/) to get started.
 
 ## Boot CoreOS
 
-Start a CoreOS virtual machine on VirtualBox.
+First, start a CoreOS virtual machine on VirtualBox. From a command prompt, `cd` to the root of the Deis project code and type:
 
 ```
 vagrant up
 ```
 
-Export some environment variables so you can connect to the VM using the `docker` and `fleetctl` clients on your workstation.
+Export some environment variables so you can connect to the VM using the `docker` and [`fleetctl`](https://github.com/coreos/fleet#building) clients on your workstation.
 
 ```
 export DOCKER_HOST=tcp://172.17.8.100:4243
@@ -44,13 +44,14 @@ make run
 ```
 
 ## Install the Deis Client
-Use `pip` to install the latest Deis Client, download pre-compiled binares, or symlink `client/deis.py` to use the latest version.
+Either use `pip install deis` to install the latest [Deis Client](https://pypi.python.org/pypi/deis/), download [pre-compiled binaries](https://github.com/opdemand/deis/tree/master/client#get-started), or symlink `client/deis.py` to use your local development version.
 
 ```
 ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
 ```
 
 ## Register a User
+
 Use the Deis Client to register a new user.
 
 ```

client/README.rst

@@ -20,16 +20,15 @@ Deis controller, providing a Heroku-inspired PaaS workflow.
 What is Deis?
 -------------
 
-Deis is an open source PaaS that makes it easy to deploy and scale LXC
-containers and Chef nodes used to host applications, databases, middleware
-and other services. Deis leverages Chef, Docker and Heroku Buildpacks to
-provide a private PaaS that is lightweight and flexible.
+Deis is an open source PaaS that makes it easy to deploy and scale containers
+to host applications, databases, middleware and other services. Deis leverages
+Docker, CoreOS and Heroku Buildpacks to provide a private PaaS that is
+lightweight and flexible.
 
 Deis comes with out-of-the-box support for Ruby, Python, Node.js, Java,
 Clojure, Scala, Play, PHP, Perl, Dart and Go. However, Deis can deploy
-anything using Heroku Buildpacks, Docker images or Chef recipes. Deis is
-designed to work with any cloud provider. Currently Amazon EC2, Rackspace,
-and DigitalOcean are supported.
+anything using Docker images or Heroku Buildpacks. Deis is designed to work
+with any cloud provider. Currently Amazon EC2 and Rackspace are supported.
 
 
 Why Deis?
@@ -39,31 +38,31 @@ Deploy anything
 ---------------
 
 Deploy a wide range of languages and frameworks with a simple git push
-using Heroku Buildpacks or Dockerfiles. Use custom Chef layers
-to deploy databases, middleware and other add-on services.
+using Heroku Buildpacks or Dockerfiles.
 
 
 Control everything
 ------------------
 
-Choose your hosting provider configuration. Define a formation with your
-own proxy and runtime layers. Retain full root access to every node.
-Manage your platform with a private Deis controller.
+Choose your hosting provider configuration. Define a cluster to meet your own
+needs. Retain full root access to every node. Manage your platform with a
+private Deis controller.
 
 
 Scale effortlessly
 ------------------
 
-Scale nodes and containers with a single command. Node provisioning,
-container balancing and proxy reconfiguration are completely automated.
+Add nodes automatically and scale containers with a single command. Smart
+scheduling, container balancing and proxy reconfiguration are completely
+automated.
 
 
 100% Open Source
 ----------------
 
 Free, transparent and easily customized. Join the open-source PaaS
 and DevOps community by using Deis and complimentary projects like
-Docker, Chef and Heroku Buildpacks.
+Docker, CoreOS and Heroku Buildpacks.
 
 
 Get Started
@@ -86,7 +85,7 @@ version of the Deis client for Mac OS X, Windows, or Debian Linux:
 
 .. code-block:: console
 
-    $ deis register http://deis.example.com
+    $ deis register http://local.deisapp.com:8000
     $ deis keys:add
 
 

controller/dev_requirements.txt

@@ -10,7 +10,7 @@ PyInstaller==2.1
 # Deis documentation requirements
 Sphinx>=1.2.2
 smartypants>=1.8.3
-sphinxcontrib-httpdomain>=1.2.0
+sphinxcontrib-httpdomain>=1.2.1
 
 # Run "make coverage" for the % of code exercised during tests
 coverage>=3.7.1

docs/contributing/overview.rst

@@ -1,5 +1,5 @@
 :title: Contributor Overview
-:description: Interested in contributing to the Deis project? There are lots of ways to help. 
+:description: Interested in contributing to the Deis project? There are lots of ways to help.
 :keywords: Deis
 
 .. _contributor:
@@ -21,18 +21,6 @@ We are always looking to improve and expand our
 documentation. Most docs reside in the main repository under the `docs/`_
 directory. Simply fork the project, update docs and send us a pull request.
 
-Enhance Chef Integration
-------------------------
-We want Chef users to feel at home using Deis. Got an
-idea for improving our Chef integration? Have some thoughts on making the
-`deis-cookbook`_ more reusable? Open a `GitHub issue`_ and let us know!
-
-Add New Cloud Providers
------------------------
-Want to see Deis extended to a new cloud provider? Go
-for it! Adding new providers is easy. Just follow the `EC2 example`_ and make
-sure you provide test coverage in your pull request.
-
 Improve Deis Core
 -----------------
 Deis core is a Django/Celery application with a Python CLI.
@@ -42,4 +30,4 @@ coverage. Interested in contributing to Deis core? Let’s chat in IRC.
 .. _`Github issue`: https://github.com/opdemand/deis/issues/new
 .. _`docs/`: https://github.com/opdemand/deis/tree/master/docs
 .. _`deis-cookbook`: https://github.com/opdemand/deis-cookbook
-.. _`EC2 Example`: https://github.com/opdemand/deis/blob/master/celerytasks/ec2.py
+.. _`EC2 Example`: https://github.com/opdemand/deis/blob/master/celerytasks/ec2.py

docs/docs_requirements.txt

@@ -17,6 +17,7 @@ djangorestframework==2.3.12
 dop==0.1.6
 gunicorn==18.0
 paramiko==1.12.1
+psycopg2==2.5.2
 pyrax==1.6.2
 python-etcd==0.3.0
 PyYAML==3.10
@@ -28,4 +29,4 @@ docopt==0.6.1
 # Deis documentation requirements
 Sphinx>=1.2.2
 smartypants>=1.8.3
-sphinxcontrib-httpdomain>=1.2.0
+sphinxcontrib-httpdomain>=1.2.1

docs/faq.rst

@@ -16,13 +16,3 @@ FAQ
     DAY-iss
 
 .. _dais: https://en.wiktionary.org/wiki/dais
-
-- How can I use custom buildpacks with Deis?
-
-    1. Clone the `deis-cookbook`_ repository.
-    2. Change the *buildpacks* definition in *recipes/build.rb*.
-    3. Upload the changed cookbook to the Chef server
-       with ``berks upload --force``.
-    4. SSH into your Deis controller and run ``sudo chef-client``.
-
-.. _`deis-cookbook`: https://github.com/opdemand/deis-cookbook.git

docs/gettingstarted/concepts.rst

@@ -8,7 +8,7 @@ Concepts
 ========
 
 Deis is an application platform that deploys and scales `Twelve Factor`_ apps
-using formations of `Chef`_ nodes, `Docker`_ containers and `Nginx`_ proxies.
+using clusters of `CoreOS`_ nodes, `Docker`_ containers and `Nginx`_ proxies.
 
 Formations
 ----------
@@ -91,7 +91,7 @@ See Also
 * `The Twelve Factor App <http://12factor.net/>`_
 
 .. _`Twelve Factor`: http://12factor.net/
-.. _`Chef`: http://www.opscode.com/chef/
+.. _`CoreOS`: https://coreos.com/
 .. _`Docker`: http://docker.io/
 .. _`Nginx`: http://wiki.nginx.org/Main
 .. _`Chef Databag`: http://docs.opscode.com/essentials_data_bags.html

docs/server/index.rst

@@ -26,5 +26,12 @@ Server Reference
     api.utils
     api.views
 
+    registry.mock
+    registry.private
+
+    scheduler.coreos
+    scheduler.mock
+
+    web.templatetags.gravatar_tags
     web.urls
     web.views

docs/server/registry.mock.rst

@@ -0,0 +1,14 @@
+:description: Python API Reference for the Deis registry.mock module
+:keywords: deis, registry.mock, python, api
+
+=============
+registry.mock
+=============
+
+.. contents::
+    :local:
+.. currentmodule:: registry.mock
+
+.. automodule:: registry.mock
+    :members:
+    :undoc-members: