An open API service indexing awesome lists of open source software.

https://github.com/andygrunwald/chef-grimoire

Chef cookbook for *Grimoire-Toolset (e.g. MetricsGrimoire or VizGrimoire). Tools to crawl + visualize Software Repositories
https://github.com/andygrunwald/chef-grimoire

Last synced: about 2 months ago
JSON representation

Chef cookbook for *Grimoire-Toolset (e.g. MetricsGrimoire or VizGrimoire). Tools to crawl + visualize Software Repositories

Awesome Lists containing this project

README

          

grimoire Cookbook
==========================
Installs/Configures tools from *Grimoire (e.g. [MetricsGrimoire](https://github.com/MetricsGrimoire/) or [VizGrimoire](https://github.com/VizGrimoire/)) .

Supported tools:
* [Mailing List Stats](https://github.com/MetricsGrimoire/MailingListStats)
* [RepositoryHandler](https://github.com/MetricsGrimoire/RepositoryHandler)
* [CVSAnalY](https://github.com/MetricsGrimoire/CVSAnalY)

If you want to try out Mailing List Stats or CVSAnalY you can use the example [Vagrant setup for MetricsGrimoire toolset](https://github.com/andygrunwald/Vagrant-MetricsGrimoire).

Requirements
------------

#### Databases
Depends on your needs which storage backend you prefer.
Database server itselfs will not be installed, but is necessary if you want to use a tool from the [MetricsGrimoire](https://github.com/MetricsGrimoire/) toolset.
Please have a detailled look at the used tool itselfs to identify which storage backends are supported.

* MySQL
* SQLite
* PostreSQL

#### Cookbooks
- `git`
- `subversion`
- `python`

Attributes
----------
#### grimoire::default


Key
Type
Description
Default


[:grimoire][:mlstats][:repository]
String
Git-Repository / Source of Mailing List Stats
https://github.com/MetricsGrimoire/MailingListStats.git


[:grimoire][:mlstats][:version]
String
Branch / Tag which will be installed
master


[:grimoire][:mlstats][:destination]
String
Path where :repository will be cloned
/tmp/MetricsGrimoire/mlstats


[:grimoire][:mlstats][:owner]
String
Owner of :destination
root


[:grimoire][:mlstats][:group]
String
Group of :destination
root


[:grimoire][:repositoryhandler][:repository]
String
Git-Repository / Source of RepositoryHandler
https://github.com/MetricsGrimoire/RepositoryHandler.git


[:grimoire][:repositoryhandler][:version]
String
Branch / Tag which will be installed
master


[:grimoire][:repositoryhandler][:destination]
String
Path where :repository will be cloned
/tmp/MetricsGrimoire/RepositoryHandler


[:grimoire][:repositoryhandler][:owner]
String
Owner of :destination
root


[:grimoire][:repositoryhandler][:group]
String
Group of :destination
root


[:grimoire][:cvsanaly][:repository]
String
Git-Repository / Source of CVSAnalY
https://github.com/MetricsGrimoire/CVSAnalY.git


[:grimoire][:cvsanaly][:version]
String
Branch / Tag which will be installed
master


[:grimoire][:cvsanaly][:destination]
String
Path where :repository will be cloned
/tmp/MetricsGrimoire/CVSAnalY


[:grimoire][:cvsanaly][:owner]
String
Owner of :destination
root


[:grimoire][:cvsanaly][:group]
String
Group of :destination
root

Usage
-----
#### grimoire::default

The default recipe is empty.
Please include the recipe of the application you want to install.

### grimoire::mlstats

It will install [Mailing List Stats](https://github.com/MetricsGrimoire/MailingListStats).
Just include `grimoire::mlstats` in your node's `run_list`:

```json
{
"name":"my_node",
"run_list": [
"recipe[grimoire::mlstats]"
]
}
```

### grimoire::repositoryhandler

It will install [RepositoryHandler](https://github.com/MetricsGrimoire/RepositoryHandler).
Just include `grimoire::repositoryhandler` in your node's `run_list`:

```json
{
"name":"my_node",
"run_list": [
"recipe[grimoire::repositoryhandler]"
]
}
```

### grimoire::cvsanaly

It will install [CVSAnalY](https://github.com/MetricsGrimoire/CVSAnalY).
Just include `grimoire::repositoryhandler` in your node's `run_list`:

```json
{
"name":"my_node",
"run_list": [
"recipe[grimoire::cvsanaly]"
]
}
```

License
------------
This code is released under the terms of the [Apache License in version 2.0](http://www.apache.org/licenses/LICENSE-2.0).