OSDN Git Service

revises README documents.
authorwhitestar <whitestar@users.osdn.me>
Sat, 9 Dec 2017 02:22:24 +0000 (11:22 +0900)
committerwhitestar <whitestar@users.osdn.me>
Sat, 9 Dec 2017 02:22:24 +0000 (11:22 +0900)
cookbooks/ganglia/README.md
cookbooks/hadoop/README.md
cookbooks/hbase/README.md
cookbooks/zookeeper-grid/Berksfile [new file with mode: 0644]
cookbooks/zookeeper-grid/README.md

index 104b894..6c55e3f 100644 (file)
@@ -1,68 +1,80 @@
 ganglia Cookbook
 ================
-TODO: Enter the cookbook description here.
 
-e.g.
-This cookbook makes your favorite breakfast sandwhich.
+This cookbook sets up a ganglia cluster.
 
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+## Contents
 
-e.g.
-#### packages
-- `toaster` - ganglia needs toaster to brown your bagel.
+- [Requirements](#requirements)
+    - [platforms](#platforms)
+    - [cookbooks](#cookbooks)
+- [Attributes](#attributes)
+- [Usage](#usage)
+    - [Recipes](#recipes)
+        - [ganglia::default](#gangliadefault)
+        - [ganglia::gmetad](#gangliagmetad)
+        - [ganglia::gmond](#gangliagmond)
+        - [ganglia::web](#gangliaweb)
+    - [Role Examples](#role-examples)
+- [License and Authors](#license-and-authors)
 
-Attributes
-----------
-TODO: List you cookbook attributes here.
+## Requirements
+
+### platforms
+
+none.
+
+### cookbooks
+
+- node_commons
+
+## Attributes
+
+**TODO**: describe attributes details.
+
+|Key|Type|Description, example|Default|
+|:--|:--|:--|:--|
+
+## Usage
+
+### Recipes
 
-e.g.
-#### ganglia::default
-<table>
-  <tr>
-    <th>Key</th>
-    <th>Type</th>
-    <th>Description</th>
-    <th>Default</th>
-  </tr>
-  <tr>
-    <td><tt>['ganglia']['bacon']</tt></td>
-    <td>Boolean</td>
-    <td>whether to include bacon</td>
-    <td><tt>true</tt></td>
-  </tr>
-</table>
-
-Usage
------
 #### ganglia::default
-TODO: Write usage instructions for each cookbook.
-
-e.g.
-Just include `ganglia` in your node's `run_list`:
-
-```json
-{
-  "name":"my_node",
-  "run_list": [
-    "recipe[ganglia]"
-  ]
-}
-```
 
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write you change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This recipe does nothing.
+
+#### ganglia::gmetad
+
+This recipe sets up a gmetad service.
+
+#### ganglia::gmond
+
+This recipe sets up a gmond service.
+
+#### ganglia::web
+
+This recipe sets up a web UI service.
+
+### Role Examples
+
+**TODO**: describe role usage.
+
+## License and Authors
+
+- Author:: whitestar at osdn.jp
+
+```text
+Copyright 2013-2017, whitestar
+
+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
+
+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.
+```
index edf0a7b..73aa26a 100644 (file)
@@ -1,68 +1,92 @@
 hadoop Cookbook
 ===============
-TODO: Enter the cookbook description here.
 
-e.g.
-This cookbook makes your favorite breakfast sandwhich.
+This cookbook sets up a Hadoop cluster.
 
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+## Contents
 
-e.g.
-#### packages
-- `toaster` - hadoop needs toaster to brown your bagel.
+- [Requirements](#requirements)
+    - [platforms](#platforms)
+    - [cookbooks](#cookbooks)
+- [Attributes](#attributes)
+- [Usage](#usage)
+    - [Recipes](#recipes)
+        - [hadoop::default](#hadoopdefault)
+        - [hadoop::apache](#hadoopapache)
+        - [hadoop::build](#hadoopbuild)
+        - [hadoop::cdh](#hadoopcdh)
+        - [hadoop::hdp](#hadoophdp)
+        - [hadoop::lzo-build](#hadooplzo-build)
+    - [Role Examples](#role-examples)
+- [License and Authors](#license-and-authors)
 
-Attributes
-----------
-TODO: List you cookbook attributes here.
+## Requirements
+
+### platforms
+
+none.
+
+### cookbooks
+
+- commons
+- grid
+- java
+
+## Attributes
+
+**TODO**: describe attributes details.
+
+|Key|Type|Description, example|Default|
+|:--|:--|:--|:--|
+
+## Usage
+
+### Recipes
 
-e.g.
-#### hadoop::default
-<table>
-  <tr>
-    <th>Key</th>
-    <th>Type</th>
-    <th>Description</th>
-    <th>Default</th>
-  </tr>
-  <tr>
-    <td><tt>['hadoop']['bacon']</tt></td>
-    <td>Boolean</td>
-    <td>whether to include bacon</td>
-    <td><tt>true</tt></td>
-  </tr>
-</table>
-
-Usage
------
 #### hadoop::default
-TODO: Write usage instructions for each cookbook.
-
-e.g.
-Just include `hadoop` in your node's `run_list`:
-
-```json
-{
-  "name":"my_node",
-  "run_list": [
-    "recipe[hadoop]"
-  ]
-}
-```
 
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write you change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This recipe sets up a Hadoop node.
+
+#### hadoop::apache
+
+This recipe sets up a gmetad service by the Apache Hadoop distribution.
+
+#### hadoop::build
+
+This recipe sets up a Hadoop build environment.
+
+#### hadoop::cdh
+
+This recipe sets up a gmetad service by the CDH distribution.
+
+#### hadoop::hdp
+
+This recipe sets up a gmetad service by the HDP distribution.
+
+#### hadoop::lzo-build
+
+This recipe sets up a Hadoop-LZO build environment.
+
+### Role Examples
+
+**TODO**: describe role usage.
+
+## License and Authors
+
+- Author:: whitestar at osdn.jp
+
+```text
+Copyright 2013-2017, whitestar
+
+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
+
+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.
+```
index b8c5757..67aaff2 100644 (file)
@@ -1,68 +1,67 @@
 hbase Cookbook
 ==============
-TODO: Enter the cookbook description here.
 
-e.g.
-This cookbook makes your favorite breakfast sandwhich.
+This cookbook sets up a HBase cluster.
 
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+## Contents
 
-e.g.
-#### packages
-- `toaster` - hbase needs toaster to brown your bagel.
+- [Contents](#contents)
+- [Requirements](#requirements)
+    - [platforms](#platforms)
+    - [cookbooks](#cookbooks)
+- [Attributes](#attributes)
+- [Usage](#usage)
+    - [Recipes](#recipes)
+        - [hbase::default](#hbasedefault)
+    - [Role Examples](#role-examples)
+- [License and Authors](#license-and-authors)
 
-Attributes
-----------
-TODO: List you cookbook attributes here.
+## Requirements
+
+### platforms
+
+none.
+
+### cookbooks
+
+- grid
+- java
+
+## Attributes
+
+**TODO**: describe attributes details.
+
+|Key|Type|Description, example|Default|
+|:--|:--|:--|:--|
+
+## Usage
+
+### Recipes
 
-e.g.
-#### hbase::default
-<table>
-  <tr>
-    <th>Key</th>
-    <th>Type</th>
-    <th>Description</th>
-    <th>Default</th>
-  </tr>
-  <tr>
-    <td><tt>['hbase']['bacon']</tt></td>
-    <td>Boolean</td>
-    <td>whether to include bacon</td>
-    <td><tt>true</tt></td>
-  </tr>
-</table>
-
-Usage
------
 #### hbase::default
-TODO: Write usage instructions for each cookbook.
-
-e.g.
-Just include `hbase` in your node's `run_list`:
-
-```json
-{
-  "name":"my_node",
-  "run_list": [
-    "recipe[hbase]"
-  ]
-}
-```
 
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write you change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This recipe sets up a HBase node.
+
+### Role Examples
+
+**TODO**: describe role usage.
+
+## License and Authors
+
+- Author:: whitestar at osdn.jp
+
+```text
+Copyright 2013-2017, whitestar
+
+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
+
+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.
+```
diff --git a/cookbooks/zookeeper-grid/Berksfile b/cookbooks/zookeeper-grid/Berksfile
new file mode 100644 (file)
index 0000000..9da25d9
--- /dev/null
@@ -0,0 +1,19 @@
+#
+# Copyright 2017 whitestar
+#
+# 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
+#
+# 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.
+#
+
+source 'https://supermarket.chef.io'
+
+metadata
index 1ccb017..c0c0180 100644 (file)
@@ -1,5 +1,5 @@
-zookeeper Cookbook
-==================
+zookeeper-grid Cookbook
+=======================
 
 This cookbook sets up Zookeeper ensemble (cluster).