Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update README.rst's

  • Loading branch information...
commit a1a2b5f16a489491b2de33711a5faa9066a94fe7 1 parent 957e782
@jtriley authored
Showing with 43 additions and 48 deletions.
  1. +2 −48 README.rst
  2. +41 −0 plugins/package_loader/README.rst
View
50 README.rst
@@ -8,62 +8,16 @@ Plugins
The following plugins are included in this package:
- * ``PackageLoader`` - Loads packages recorded in /home/.starcluster-packages on
+ * PackageLoader - Loads packages recorded in /home/.starcluster-packages on
all nodes.
-PackageLoader Details
----------------------
-
-``PackageLoader`` will check for the file /home/.starcluster-packages and then
-load the files recorded there. In order for this to work, the user must only
-install packages on the cluster using the associated ``cluster-install``
-utility. This is an ``apt-get`` wrapper that will install the requested
-packages on all nodes and then records them in the appropriate place.
-
-PackageLoader Usage
--------------------
-
-**WARNING** - There are currently issues with how this is implemented. The main
-problems being that when the plugin runs it upgrades any old packages while it
-is installing the missing packages.
-
-Until I actually get this packaged as a Python module, you can just drop the
-packages.py into your ~/.starclusters/plugins directory and then add a plugin
-section to your starcluster config file as shown here::
-
- [plugin packageloader]
- setup_class = packages.PackageLoader
-
-and then in the clusters you want to add::
-
- PLUGINS = packageloader
-
-Then copy the ``cluster-install`` script to the master node. When installing
-packages, do so on the master, as root, with this script. For example::
-
- # cluster-install r-recommended ack-grep
-
-Todo
-====
-
- * Resolve upgrade issues with ``PackageLoader``. As AMIs age it will
- significantly increase cluster startup time.
-
- * Make the plugin copy ``cluster-install`` to the master node.
-
- * Package starcluster-extras as a python module.
-
- * Add more plugins.
-
License and Copyright
=====================
-Copyright 2010 Austin Godber <godber@uberhip.com>
-
This program is distributed under the terms of the Lesser GNU General Public
License
Contributors
============
- * Austin Godber ``<godber@uberhip.com>``
+ * Austin Godber <godber 'at' uberhip.com>
View
41 plugins/package_loader/README.rst
@@ -0,0 +1,41 @@
+PackageLoader Details
+---------------------
+
+Author: Austin Godber <godber 'at' uberhip.com>
+
+**PackageLoader** will check for the file /home/.starcluster-packages and then
+load the files recorded there. In order for this to work, the user must only
+install packages on the cluster using the associated *cluster-install*
+utility. This is an *apt-get* wrapper that will install the requested
+packages on all nodes and then records them in the appropriate place.
+
+PackageLoader Usage
+-------------------
+
+**WARNING** - There are currently issues with how this is implemented. The main
+problems being that when the plugin runs it upgrades any old packages while it
+is installing the missing packages.
+
+Until I actually get this packaged as a Python module, you can just drop the
+packages.py into your ~/.starclusters/plugins directory and then add a plugin
+section to your starcluster config file as shown here::
+
+ [plugin packageloader]
+ setup_class = packages.PackageLoader
+
+and then in the clusters you want to add::
+
+ PLUGINS = packageloader
+
+Then copy the *cluster-install* script to the master node. When installing
+packages, do so on the master, as root, with this script. For example::
+
+ # cluster-install r-recommended ack-grep
+
+Todo
+====
+
+ * Resolve upgrade issues with ``PackageLoader``. As AMIs age it will
+ significantly increase cluster startup time.
+
+ * Make the plugin copy ``cluster-install`` to the master node.
Please sign in to comment.
Something went wrong with that request. Please try again.