metadata.json

{
  "name": "databox",
  "description": "Setup a database server that runs multiple MySQL and PostgreSQL databases.",
  "long_description": "# Chef cookbook - databox (v0.1.1)\n\nSetup a **database server** that runs multiple MySQL and PostgreSQL databases.\n\n\n## Install\n\nTo install with **Berkshelf**, add this into `Berksfile`:\n\n```\ncookbook 'databox'\n```\n\n## Usage\n\nAdd `databox::default` recipe into run list, or include the recipe in your code:\n\n```\ninclude_recipe \"databox::default\"\n```\n\nAnd overwrite attributes to customize the cookbook.\n\nSee also [teohm/kitchen-sample](https://github.com/teohm/kitchen-example) for `databox` usage example with chef-solo.\n\n## Attributes\n\nYou **should** set the database root password:\n\n * `node[\"databox\"][\"db_root_password\"]` (default: `nil`) - password string.\n   * for **MySQL**, it overwrites the following passwords in `mysql` cookbook:\n     * `node.set[\"mysql\"][\"server_root_password\"]`\n     * `node.set[\"mysql\"][\"server_repl_password\"]`\n     * `node.set[\"mysql\"][\"server_debian_password\"]`\n   * for **PostgreSQL**, it overwrites `postgres` user password in `postgresql` cookbook:\n     * `node.set[\"postgresql\"][\"password\"][\"postgres\"]`\n \nTo install **MySQL**, provide a list of database entries:\n\n  * `node[\"databox\"][\"databases\"][\"mysql\"]` (default: `[]`)\n    \n    ```\n    # Example:\n    node.set[\"databox\"][\"databases\"][\"mysql\"] = [\n      {\n        \"database_name\" => \"app1_production\",\n        \"username\" => \"app1\",\n        \"password\" => \"app1_pass\"\n      }\n      {\n        \"database_name\" => \"app2_production\",\n        \"username\" => \"app2\",\n        \"password\" => \"app2_pass\",\n        \"encoding\" => \"UTF8\",\n        \"collation\" => \"utf8_unicode_ci\"\n      }\n    ]\n    ```\n    \n    Each database entry may contain resource parameters specified in [`database`](https://github.com/opscode-cookbooks/database) cookbook:\n\n    * [`database_user`](https://github.com/opscode-cookbooks/database#attribute-parameters-1) resource parameters:\n      * username\n      * password\n      * database_name\n      * connection\n      * privileges\n      * host\n      * table\n    * [`database`](https://github.com/opscode-cookbooks/database/blob/master/libraries/resource_database.rb) resource parameters needed by MySQL:\n      * collation\n      * encoding\n\nTo install **PostgreSQL**, provide a list of database entries:\n\n  * `node[\"databox\"][\"databases\"][\"postgresql\"]` (default: `[]`)\n    \n    ```\n    # Example:\n    node.set[\"databox\"][\"databases\"][\"postgresql\"] = [\n      {\n        \"database_name\" => \"app1_production\",\n        \"username\" => \"app1\",\n        \"password\" => \"app1_pass\"\n      }\n      {\n        \"database_name\" => \"app2_production\",\n        \"username\" => \"app2\",\n        \"password\" => \"app2_pass\",\n        \"encoding\" => \"UTF8\",\n        \"collation\" => en_US.utf8\"\n      }\n    ]\n    ```\n    \n    Each database entry may contain resource parameters specified in [`database`](https://github.com/opscode-cookbooks/database) cookbook:\n\n    * [`database_user`](https://github.com/opscode-cookbooks/database#attribute-parameters-1) resource parameters:\n      * username\n      * password\n      * database_name\n      * connection\n      * privileges\n      * host\n      * table\n    * [`database`](https://github.com/opscode-cookbooks/database/blob/master/libraries/resource_database.rb) resource parameters:\n      * template\n      * collation\n      * encoding\n      * tablespace\n      * connection_limit\n      * owner\n\n\n## Recipes\n\n * `databox::default` - run all recipes.\n * `databox::mysql` - install MySQL and create MySQL databases.\n * `databox::postgresql` - install PostgreSQL and create PostgreSQL databases.\n\n## Requirements\n\n### Supported Platforms\n\n * `ubuntu` - tested on Ubuntu 12.10\n * `debian` - should work\n \nPull requests, issue and test reports are welcomed to better support your platform.\n \n### Cookbook Dependencies\n\n * Depends on these cookbooks:\n   * mysql\n   * postgresql\n   * database\n   \n## Change History\n\nSee [CHANGELOG](CHANGELOG.md).\n\n## License and Authors\n\n * Author:: Huiming Teo <teohuiming@gmail.com>\n\nCopyright 2013, Huiming Teo\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
  "maintainer": "Huiming Teo",
  "maintainer_email": "teohuiming@gmail.com",
  "license": "Apache License 2.0",
  "platforms": {
    "ubuntu": ">= 0.0.0",
    "debian": ">= 0.0.0"
  },
  "dependencies": {
    "database": ">= 0.0.0",
    "mysql": ">= 0.0.0",
    "postgresql": ">= 0.0.0"
  },
  "recommendations": {
  },
  "suggestions": {
  },
  "conflicting": {
  },
  "providing": {
  },
  "replacing": {
  },
  "attributes": {
  },
  "groupings": {
  },
  "recipes": {
    "databox": "Includes all recipes.",
    "databox::mysql": "Install MySQL and create MySQL databases.",
    "databox::postgresql": "Install PostgreSQL and create PostgreSQL databases."
  },
  "version": "0.1.1"
}