Skip to content
Permalink
Browse files

Updated Readme File

Updated Readme and License Files
  • Loading branch information...
Cloud Solutions Team
Cloud Solutions Team committed Feb 11, 2014
1 parent 0d3a9d0 commit 3c92cb3be18a89b1f59a8a89ca092cfbf6e8d6d4
0 LICENSE 100644 → 100755
No changes.
@@ -0,0 +1,13 @@
Copyright 2013 Google Inc. All Rights Reserved.

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.
0 README.md 100644 → 100755
No changes.
@@ -9,9 +9,6 @@ The cookbook depends on the ruby gem "knife-google".

Attributes
----------

e.g.
#### gceutil::default
<table>
<tr>
<th>Key</th>
@@ -20,28 +17,52 @@ e.g.
<th>Default</th>
</tr>
<tr>
<td><tt>['gceutil']['bacon']</tt></td>
<td>Boolean</td>
<td>whether to include bacon</td>
<td><tt>true</tt></td>
<td><tt>['gceutil']['zone']</tt></td>
<td>String</td>
<td>The name of the Google Compute Engine zone.</td>
<td><tt>""</tt></td>
</tr>
<tr>
<td><tt>['gceutil']['disk_size_gb']</tt></td>
<td>Integer</td>
<td>Persistent disk size in GB.</td>
<td><tt>10</tt></td>
</tr>
<tr>
<td><tt>['gceutil']['disk']</tt></td>
<td>String</td>
<td>The name of persistent disk.</td>
<td><tt>"sample-disk"</tt></td>
</tr>
<tr>
<td><tt>['gceutil']['device']</tt></td>
<td>String</td>
<td>The device name when attaching a persistent disk to an instance.</td>
<td><tt>"pd0"</tt></td>
</tr>
<tr>
<td><tt>['gceutil']['mountdir']</tt></td>
<td>String</td>
<td>The name of the directory where the disk is mounted.</td>
<td><tt>"sample_data"</tt></td>
</tr>
</table>

Usage
-----
#### gceutil::default
Demonstrates you could create, attach a disk to an instance, detach the disk,
and delete the disk.
e.g.
Just include `gceutil` in your node's `run_list`:
and delete the disk. To use it, just include `gceutil` in your node's
`run_list` and configure the attributes such as the compute zone and disk size
etc.

```json
<code>
{
"name":"my_node",
"run_list": [
"recipe[gceutil]"
]
}
</code>

#### gceutil::create_disk
Creates a new persistent disk.
@@ -57,15 +78,8 @@ Deletes an existing persistent disk.

Contributing
------------
1. Developed the sample Cookbook.

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: ntang@google.com.
License
--------
Licensed under the Apache License, Version 2.0
@@ -14,37 +14,66 @@ Requirements

Attributes
----------

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['mymongodb']['zone']</tt></td>
<td>String</td>
<td>The name of the Google Compute Engine zone.</td>
<td><tt>""</tt></td>
</tr>
<tr>
<td><tt>['mymongodb']['disk']['size']</tt></td>
<td>Integer</td>
<td>Persistent disk size in GB.</td>
<td><tt>10</tt></td>
</tr>
<tr>
<td><tt>['mymongodb']['disk']['name']</tt></td>
<td>String</td>
<td>The name of persistent disk.</td>
<td><tt>"sample-disk"</tt></td>
</tr>
<tr>
<td><tt>['mymongodb']['device']</tt></td>
<td>String</td>
<td>The device name when attaching a persistent disk to an instance.</td>
<td><tt>"pd"</tt></td>
</tr>
<tr>
<td><tt>['mymongodb']['dbpath']</tt></td>
<td>String</td>
<td>The name of the directory where the disk is mounted as well as the mongdb dbpath.</td>
<td><tt>"/mongodb/data"</tt></td>
</tr>
</table>

Usage
-----
#### mymongodb::default
Creates a persistent disk, attach the disk, and then install and run mongodb
using the disk as storage.

e.g.
Just include `mymongodb` in your node's `run_list`:
using the disk as storage. To use it, just include `mymongodb` in your node's
`run_list` and configure the attributes such as the compute zone and disk size
etc.

```json
<code>
{
"name":"my_node",
"run_list": [
"recipe[mymongodb]"
]
}
```
</code>

Contributing
------------
1. Developed the sample Cookbook.

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: ntang@google.com
License
--------
Licensed under the Apache License, Version 2.0
@@ -2,5 +2,4 @@
default[:mymongodb][:disk][:size] = 100
default[:mymongodb][:device] = "pd"
default[:mymongodb][:dbpath] = "/mongodb_data"
default[:mymongodb][:device] = "pd"
default[:mymongodb][:zone] = "rtb-us-west1-b"
default[:mymongodb][:zone] = ""

0 comments on commit 3c92cb3

Please sign in to comment.
You can’t perform that action at this time.