Prechádzať zdrojové kódy

Add application cookbook with updated documentation.

jtimberman 14 rokov pred
rodič
commit
b670e61d24
2 zmenil súbory, kde vykonal 38 pridanie a 3 odobranie
  1. 9 3
      README.txt
  2. 29 0
      metadata.json

+ 9 - 3
README.txt

@@ -1,5 +1,3 @@
-This is an unreleased cookbook, posted here for example purposes and will be released to the cookbooks.opscode.com when it is really ready.
-
 Application cookbook
 ====================
 
@@ -9,6 +7,8 @@ This cookbook is initially designed to be able to describe and deploy web applic
 
 Other application stacks (PHP, DJango, JBoss, etc) will be supported as new recipes at a later date.
 
+This cookbook aims to provide primitives to install/deploy any kind of application driven entirely by data defined in an abstract way through a data bag.
+
 ---
 Recipes
 =======
@@ -18,7 +18,9 @@ The application cookbook contains the following recipes.
 default
 -------
 
-Searches the `apps` data bag and checks that a server role in the app exists on this node, adds the app to the run state and uses the role for the app to locate the recipes that need to be used. See below regarding the application data bag structure.
+Searches the `apps` data bag and checks that a server role in the app exists on this node, adds the app to the run state and uses the role for the app to locate the recipes that need to be used. The recipes listed in the "type" part of the data bag are included by this recipe, so only the "application" recipe needs to be in the node or role `run_list`.
+
+See below regarding the application data bag structure.
 
 rails
 -----
@@ -60,6 +62,8 @@ The applications data bag expects certain values in order to configure parts of
 
 The application used in examples is named `my_app` and the environment is `production`. Most top-level keys are Arrays, and each top-level key has an entry that describes what it is for, followed by the example entries. Entries that are hashes themselves will have the description in the value.
 
+Note about "type": the recipes listed in the "type" will be included in the run list via `include_recipe` in the application default recipe.
+
 Note about `databases`, the data specified will be rendered as the `database.yml` file.
 
 Note about gems and packages, the version is optional. If specified, the version will be passed as a parameter to the resource. Otherwise it will use the latest available version per the default `:install` action for the package provider.
@@ -152,6 +156,8 @@ To use the application cookbook, we recommend creating a role named after the ap
       "recipe[application]"
     )
 
+The idea with this recipe is that the additional recipes you need for the application are handled by specifying them in the application data bag's "type".
+
 If you need other recipes, such as `mysql::client` add those as well. Then upload the role to the Chef Server.
 
     % knife role from file roles/my_app.rb

Rozdielové dáta súboru neboli zobrazené, pretože súbor je príliš veľký
+ 29 - 0
metadata.json


Niektoré súbory nie sú zobrazené, pretože je v týchto rozdielových dátach zmenené mnoho súborov