Permalink
Browse files

[all] readme format update

  • Loading branch information...
1 parent 83b4a86 commit 9a2e4edfd2edecb0c8dc67964fcf47eda8b92ef6 @mrusan mrusan committed Oct 31, 2012
@@ -16,7 +16,6 @@ section below.
This cookbook provides abstract 'repo' resource for managing code download from
GIT, SVN or ROS code repositories.
--------------
== REQUIREMENTS:
@@ -33,7 +32,6 @@ Replace this text with a description of cookbook requirements:
<tt>repo_ros</tt> cookbooks must be present in your cookbook repository ROS
implementation depends on the <tt>rightscale::install_tools</tt> recipe.
* Requires a virtual machine launched from a RightScale-managed RightImage.
--------------
== COOKBOOKS DEPENDENCIES:
@@ -48,7 +46,6 @@ Be sure to include a ticket number.
Currently only primary backups to Remote Object Storage (ROS) are supported for
KVM hypervisors (w-1234).
--------------
== SETUP/USAGE:
@@ -62,7 +59,6 @@ application server. When using a RightScale ServerTemplate, this will also
automatically add the common attributes to your ServerTemplate inputs. Set
'jdbc/ConnDB' as your datasource name to set up database connection with the
application server.
--------------
== DETAILS:
@@ -76,7 +72,6 @@ else that users need to know in order to properly use this cookbook.
This cookbook is intended to be used in conjunction with cookbooks that contain
Lightweight Providers which implement the <tt>repo</tt> interface. See the
RightScale repo_git cookbook for an example.
--------------
=== Attributes:
@@ -102,7 +97,6 @@ file.
processes to start. Default is 16.
* <tt>node[:apache][:prefork][:minspareservers]</tt> - minimum number of spare
server processes. Default 16.
--------------
=== Templates:
@@ -120,7 +114,6 @@ Add link to the production templates that use this cookbook.
Configuration for the server and server components used in the
<tt>chef-server::rubygems-install</tt> recipe.
--------------
=== Definitions:
@@ -158,7 +151,6 @@ Enable the ssl module, which also has a configuration template in
apache_module "ssl" do
conf true
end
--------------
=== Libraries-helpers:
@@ -186,7 +178,6 @@ Returns:
Raise:
<tt>RuntimeError::</tt> If nether a valid private nor public ip can be found
--------------
=== LWRPs:
@@ -219,9 +210,7 @@ http://support.rightscale.com/12-Guides/Chef_Cookbooks_Developer_Guide/08-Chef_D
Common attributes
<tt>:destination</tt> - Path to where project repo will be pulled
-
<tt>:repository</tt> - Repository Url
-
<tt>:revision</tt> - Remote repo Branch or revision
* Give provider usage examples.
@@ -258,7 +247,6 @@ This can be useful when decommissioning a running server that had previously
requested ports opened.
* All tag based actions are scoped to the deployment.
--------------
= LICENSE:
View
@@ -77,6 +77,7 @@ file's description.
== DETAILS:
=== General
+
This cookbook can only be used in conjunction with cookbooks that contain
Lightweight Providers which implement the 'app' interface. See the RightScale
<tt>app_php</tt> cookbook for an example.
@@ -115,7 +116,6 @@ This definition created specifically for the <tt>apache2</tt> cookbook at this t
app_add_listen_port php_port
-
=== Libraries-helpers:
===== RightScale::App::Helper.bind_ip(private_ips = [ ], public_ips = [ ])
@@ -136,7 +136,6 @@ on the specified listen ports.
<tt>RuntimeError::</tt> If neither a valid private nor public IP address can be found.
-
===== RightScale::App::Helper.bind_port()
Return the port that this application server listens on.
@@ -145,7 +144,6 @@ Return the port that this application server listens on.
<tt>node[:app][:port](integer)</tt> Port number
-
===== RightScale::App::Helper.vhosts(vhost_list)
Created to convert vhost names into an array from a comma-separated list.
@@ -158,7 +156,6 @@ Created to convert vhost names into an array from a comma-separated list.
<tt>Array::</tt> Array of vhosts
-
=== LWRPs:
This cookbook provides the abstract <tt>app</tt> resource, which will act as
@@ -174,39 +171,29 @@ cap if there is no other app_ Light Weight Provider implementation.
For more information about Lightweight Resources and Providers (LWRPs), please
see: {Lightweight Resources and Providers (LWRP)}[http://support.rightscale.com/12-Guides/Chef_Cookbooks_Developer_Guide/08-Chef_Development/Lightweight_Resources_and_Providers_(LWRP)].
-
===== App resource actions
All actions declared in this resource are intended to act as templates to typical
application server setup operations.
* <tt>:install</tt> - Install packages required for application server setup.
-
* <tt>:setup_vhost</tt> - Action designed to set up APP LWRP with common
parameters required for apache vhost file.
-
* <tt>:start</tt> - Action designed to set up a user defined start sequence for
the application server.
-
* <tt>:stop</tt> - Action designed to set up a user defined stop sequence for
the application server.
-
* <tt>:restart</tt> - Action designed to set up a user defined restart sequence for
the application server.
-
* <tt>:reload</tt> - Action designed to set up a user defined reload sequence for
the application server.
-
* <tt>:code_update</tt> - Action designed to perform project source code
update/download.
-
* <tt>:setup_db_connection</tt> - Action designed to perform database
configuration file creation.
-
* <tt>:setup_monitoring</tt> - Action designed to set up and install required
monitoring software.
-
===== App resource attributes
* <tt>packages</tt> - Set of installed packages
@@ -245,7 +232,6 @@ found in the <tt>do_*</tt> and <tt>setup_*</tt> recipes in the cookbook.
action :setup_vhost
end
-
== LICENSE:
Copyright RightScale, Inc. All rights reserved. All access and use subject to the
@@ -50,13 +50,11 @@ to install the database client.
<b>Apache</b>
Server version: Apache/2.2.15
-
Server built: Feb 13 2012 22:31:42
<b>Django</b>
Django version 1.4
-
Python version 2.6.6 (2012-06-18) (x86_64-linux), Pip version 1.1
also:
@@ -86,11 +84,13 @@ and re-run the <tt>app::default</tt> boot recipe.
Mix these recipes in any way to satisfy project requirements.
=== Attributes:
+
These are settings used in recipes and templates. Default values are noted.
Note: Only "internal" cookbook attributes are described here. Descriptions of attributes which have inputs you can find in metadata.rb cookbook file.
====== General attributes
+
* <tt>node[:app_django][:module_dependencies]</tt> - Modules required for Apache.
* <tt>node[:app_django][:app][:debug_mode]</tt> - Django application debug mode.
* <tt>node[:app_django][:apache][:serve_local_files]</tt> - Used to enable/disable the serve of any existing local files.
@@ -101,6 +101,7 @@ Note: Only "internal" cookbook attributes are described here. Descriptions of at
* <tt>node[:app_django][:project][:custom_cmd]</tt> - A list of python commands required for django application initialization.
====== Platform dependent
+
* <tt>node[:app_django][:apache][:log_dir]</tt> - Path to apache log directory.
=== Templates:
@@ -113,31 +114,17 @@ Note: Only "internal" cookbook attributes are described here. Descriptions of at
for project database connection used in the <tt>app::setup_db_connection</tt> recipe
and defined in <tt>:setup_db_connection</tt> action of the <tt>app_django</tt> LWRP.
-=== Definitions:
-none
-
-=== Libraries-helpers:
-none
-
-
=== LWRPs:
<tt>app_django</tt> Lightweight provider is defined in the providers/default.rb file, it contains source for the following actions:
* <tt>:install</tt>
-
* <tt>:setup_vhost</tt>
-
* <tt>:start</tt>
-
* <tt>:stop</tt>
-
* <tt>:restart</tt>
-
* <tt>:reload</tt>
-
* <tt>:code_update</tt>
-
* <tt>:setup_db_connection</tt>
For more info about these actions, please see the <tt>app</tt> cookbook README.
@@ -147,19 +134,12 @@ For normal operations it requires "app" resource which will act as the interface
===== Actions
* <tt>:install</tt> - Install packages required for application server setup.
-
* <tt>:setup_vhost</tt> - Set up apache vhost file with wsgi module directives included.
-
* <tt>:start</tt> - Start sequence for Django application server.
-
* <tt>:stop</tt> - Stop sequence for Django application server.
-
* <tt>:reload</tt> - Reload sequence for Django application server.
-
* <tt>:restart</tt> - Restart sequence for Django application server.
-
* <tt>:code_update</tt> - Perform project source code update/download using user selected "repo" LWRP. Set up logrotate configuration.
-
* <tt>:setup_db_connection</tt> - Perform project settings.py database connection configuration.
The driver type is specified as 'python' and the db_<provider> cookbook's
<tt>install_client_driver</tt> action performs necessary steps to install the
@@ -45,7 +45,6 @@ to install the database client.
<b>Apache</b>
Server version: Apache/2.2.3
-
Server built: Jun 6 2012 10:00:42
<b>Phusion Passenger</b>
@@ -76,11 +75,13 @@ ServerTemplate built on this cookbook can be combined in two modes:
Mix these recipes in any way to satisfy project requirements.
=== Attributes:
+
These are settings used in recipes and templates. Default values are noted.
Note: Only "internal" cookbook attributes are described here. Descriptions of attributes which have inputs you can find in metadata.rb cookbook file.
====== General attributes
+
* <tt>node[:app_passenger][:rails_spawn_method]</tt> - The spawn method used by the passenger.
* <tt>node[:app_passenger][:apache][:maintenance_page]</tt> - Path to html maintenance page, which will be displayed, when main application is unavailable.
* <tt>node[:app_passenger][:apache][:serve_local_files]</tt> - Used to enable/disable the serve of any existing local files.
@@ -103,31 +104,17 @@ Note: Only "internal" cookbook attributes are described here. Descriptions of at
* <tt>database.yml.erb</tt> - Configuration for project database connection config file used in the <tt>app::setup_db_connection</tt> recipe and defined in <tt>:setup_db_connection</tt> action of the <tt>app_passenger</tt> LWRP.
* <tt>rails_env.erb</tt> - Template for bash script which will set up ENV for the rails project used in the <tt>app::setup_db_connection</tt> recipe and defined in <tt>:setup_db_connection</tt> action of the <tt>app_passenger</tt> LWRP.
-=== Definitions:
-none
-
-=== Libraries-helpers:
-none
-
-
=== LWRPs:
<tt>app_passenger</tt> Lightweight provider is defined in the providers/default.rb file, it contains source for the following actions:
* <tt>:install</tt>
-
* <tt>:setup_vhost</tt>
-
* <tt>:start</tt>
-
* <tt>:stop</tt>
-
* <tt>:reload</tt>
-
* <tt>:restart</tt>
-
* <tt>:code_update</tt>
-
* <tt>:setup_db_connection</tt>
For more info about these actions, please see the <tt>app</tt> cookbook README.
@@ -137,19 +124,12 @@ For normal operations it requires "app" resource which will act as the interface
===== Actions
* <tt>:install</tt> - Install packages required for application server setup.
-
* <tt>:setup_vhost</tt> - Set up apache vhost file with passenger module directives included.
-
* <tt>:start</tt> - Start sequence for Passenger application server.
-
* <tt>:stop</tt> - Stop sequence for Passenger application server.
-
* <tt>:reload</tt> - Reload sequence for Passenger application server.
-
* <tt>:restart</tt> - Restart sequence for Passenger application server.
-
* <tt>:code_update</tt> - Perform project source code update/download using user selected "repo" LWRP. Set up logrotate configuration.
-
* <tt>:setup_db_connection</tt> - Perform project config/database.yml database connection configuration.
The driver type is specified as 'ruby' and the db_<provider> cookbook's
<tt>install_client_driver</tt> action performs necessary steps to install the
Oops, something went wrong.

0 comments on commit 9a2e4ed

Please sign in to comment.