Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

vulcand (1) Versions 0.1.0

Installs/Configures vulcand

Berkshelf/Librarian
Policyfile
Knife
cookbook 'vulcand', '~> 0.1.0'
cookbook 'vulcand', '~> 0.1.0', :supermarket
knife cookbook site install vulcand
knife cookbook site download vulcand
README
Dependencies
Changelog
Quality

vulcand Cookbook

This cookbook installs and configures Vulcand load-balancer/proxy

Requirements

Cookbooks

  • docker - If the docker or source_docker install method is chosen
  • golang - If the source install method is chosen

Packages

  • etcd - Vulcand use Etcd to store its configuration

Attributes

vulcand::default

JSON: ['value'] == node['vulcand']['value']

<table> <caption>Docker-specific options</caption> <tr> <th>Resource</th> <th>JSON</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> <tr> <td><tt>:vulcand_docker_repo</tt></td> <td><tt>['vulcand_docker_repo']</tt></td> <td>String</td> <td>Docker repo</td> <td><tt>'mailgun/vulcand'</tt></td> </tr> <tr> <td><tt>:vulcand_docker_tag</tt></td> <td><tt>['vulcand_docker_tag']</tt></td> <td>String</td> <td>Docker tag to pull</td> <td><tt>'v0.8.0-beta.2'</tt></td> </tr> <tr> <td><tt>:golang_docker_repo</tt></td> <td><tt>['golang_docker_repo']</tt></td> <td>String</td> <td>Golang repo for <tt>source_docker</tt></td> <td><tt>'golang'</tt></td> </tr> <tr> <td><tt>:golang_docker_tag</tt></td> <td><tt>['golang_docker_tag']</tt></td> <td>String</td> <td>Golang tag for <tt>source_docker</tt></td> <td><tt>'latest'</tt></td> </tr> <tr> <td><tt>:bin_path</tt></td> <td><tt>['bin_path']</tt></td> <td>String</td> <td>Bin directory for service</td> <td><tt>'/usr/local/bin'</tt></td> </tr> <tr> <td><tt>:conf_dir</tt></td> <td><tt>['conf_dir']</tt></td> <td>String</td> <td>Conf directory for service</td> <td><tt>'/etc/vulcand'</tt></td> </tr> <tr> <td><tt>:install_method</tt></td> <td><tt>['install_method']</tt></td> <td>String</td> <td>See Usage section</td> <td><tt>'source_docker'</tt></td> </tr> <tr> <td><tt>:src_command</tt></td> <td><tt>['src_command']</tt></td> <td>String</td> <td>Compile command for <tt>source_docker</tt></td> <td>See attributes.rb</td> </tr> </table>

<table> <caption>General run options</caption> <tr> <th>Resource</th> <th>JSON</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> <tr> <td><tt>:apiInterface</tt></td> <td><tt>['run_opts']['apiInterface']</tt></td> <td>String</td> <td>Interface to for API to bind to</td> <td><tt>'0.0.0.0'</tt></td> </tr> <tr> <td><tt>:apiPort</tt></td> <td><tt>['run_opts']['apiPort']</tt></td> <td>String</td> <td>Port to provide api on</td> <td><tt>'8182'</tt></td> </tr> <tr> <td><tt>:certPath</tt></td> <td><tt>['run_opts']['certPath']</tt></td> <td>String</td> <td>KeyPair to use (enables TLS)</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:default_listener</tt></td> <td><tt>['run_opts']['default_listener']</tt></td> <td>String</td> <td>Enables the default listener on startup</td> <td><tt>true</tt></td> </tr> <tr> <td><tt>:endpointDialTimeout</tt></td> <td><tt>['run_opts']['endpointDialTimeout']</tt></td> <td>String</td> <td>Endpoint dial timeout</td> <td><tt>'5s'</tt></td> </tr> <tr> <td><tt>:endpointReadTimeout</tt></td> <td><tt>['run_opts']['endpointReadTimeout']</tt></td> <td>String</td> <td>Endpoint read timeout</td> <td><tt>'50s'</tt></td> </tr> <tr> <td><tt>:etcd</tt></td> <td><tt>['run_opts']['etcd']</tt></td> <td>String</td> <td>Etcd discovery service API endpoints</td> <td><tt>['http://localhost:4001']</tt></td> </tr> <tr> <td><tt>:etcdCaFile</tt></td> <td><tt>['run_opts']['etcdCaFile']</tt></td> <td>String</td> <td>Path to CA file for etcd communication</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:etcdCertFile</tt></td> <td><tt>['run_opts']['etcdCertFile']</tt></td> <td>String</td> <td>Path to cert file for etcd communication</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:etcdConsistency</tt></td> <td><tt>['run_opts']['etcdConsistency']</tt></td> <td>String</td> <td>Etcd consistency</td> <td><tt>'STRONG'</tt></td> </tr> <tr> <td><tt>:etcdKey</tt></td> <td><tt>['run_opts']['etcdKey']</tt></td> <td>String</td> <td>Etcd key for storing configuration</td> <td><tt>'vulcand'</tt></td> </tr> <tr> <td><tt>:etcdKeyFile</tt></td> <td><tt>['run_opts']['etcdKeyFile']</tt></td> <td>String</td> <td>Path to key file for etcd communication</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:etcdSyncIntervalSeconds</tt></td> <td><tt>['run_opts']['etcdSyncIntervalSeconds']</tt></td> <td>String</td> <td>Interval between updating etcd cluster information. 0 to disable sync</td> <td><tt>0</tt></td> </tr> <tr> <td><tt>:interface</tt></td> <td><tt>['run_opts']['interface']</tt></td> <td>String</td> <td>Interface to bind to</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:log</tt></td> <td><tt>['run_opts']['log']</tt></td> <td>String</td> <td>Logging to use (console, json, syslog or logstash)</td> <td><tt>'console'</tt></td> </tr> <tr> <td><tt>:logSeverity</tt></td> <td><tt>['run_opts']['logSeverity']</tt></td> <td>String</td> <td>logs at or above this level to the logging output</td> <td><tt>'warning'</tt></td> </tr> <tr> <td><tt>:pidPath</tt></td> <td><tt>['run_opts']['pidPath']</tt></td> <td>String</td> <td>Path to write PID file to</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:port</tt></td> <td><tt>['run_opts']['port']</tt></td> <td>String</td> <td>Port to listen on</td> <td><tt>'8181'</tt></td> </tr> <tr> <td><tt>:readTimeout</tt></td> <td><tt>['run_opts']['readTimeout']</tt></td> <td>String</td> <td>HTTP server read timeout</td> <td><tt>'1m0s'</tt></td> </tr> <tr> <td><tt>:sealKey</tt></td> <td><tt>['run_opts']['sealKey']</tt></td> <td>String</td> <td>Seal key used to store encrypted data in the backend</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:serverMaxHeaderBytes</tt></td> <td><tt>['run_opts']['serverMaxHeaderBytes']</tt></td> <td>String</td> <td>Maximum size of request headers</td> <td><tt>1048576</tt></td> </tr> <tr> <td><tt>:serverReadTimeout</tt></td> <td><tt>['run_opts']['serverReadTimeout']</tt></td> <td>String</td> <td>HTTP server read timeout</td> <td><tt>'1m0s'</tt></td> </tr> <tr> <td><tt>:serverWriteTimeout</tt></td> <td><tt>['run_opts']['serverWriteTimeout']</tt></td> <td>String</td> <td>HTTP server write timeout</td> <td><tt>'1m0s'</tt></td> </tr> <tr> <td><tt>:statsdAddr</tt></td> <td><tt>['run_opts']['statsdAddr']</tt></td> <td>String</td> <td>Statsd address in form of 'host:port'</td> <td><tt>nil</tt></td> </tr> <tr> <td><tt>:statsdPrefix</tt></td> <td><tt>['run_opts']['statsdPrefix']</tt></td> <td>String</td> <td>Statsd prefix will be appended to the metrics emitted by this instance</td> <td><tt>nil</tt></td> </tr> </table>

<table> <caption>Run options for docker</caption> <tr> <th>Resource</th> <th>JSON</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> <tr> <td><tt>:container_name</tt></td> <td><tt>['container_name']</tt></td> <td>String</td> <td>Vulcand container name</td> <td><tt>'vulcand'</tt></td> </tr> <tr> <td><tt>:container_port</tt></td> <td><tt>['container_port']</tt></td> <td>String</td> <td>Vulcand container port mapping</td> <td><tt>['8181:8181', '8282:8282']</tt></td> </tr> <tr> <td><tt>:network_mode</tt></td> <td><tt>['network_mode']</tt></td> <td>String</td> <td>Container network mode</td> <td><tt>'host'</tt></td> </tr> <tr> <td><tt>:vulcand_docker_bin</tt></td> <td><tt>['vulcand_docker_bin']</tt></td> <td>String</td> <td>Exec file location inside the container</td> <td><tt>'/go/bin/vulcand'</tt></td> </tr> </table>

Usage

vulcand::default

Include vulcand in your node's run_list to install the software:

{
  "name":"my_node",
  "run_list": [
    "recipe[vulcand]"
  ]
}

Possible install options are - docker - pulls vulcand docker image - source_docker - makes use of golang docker container to compile and install vulcand since many distros don't provide the version of Go fresh enough to compile vulcand - source - compiles vulcand using the local golang installation

vulcand_docker

Call vulcand_docker from your cookbook to start the docker container with the run options from node['vulcand']['run_opts']

vulcand_service

Create and configure the systemd service for vulcand. Requires env vars patch integration (see https://github.com/vulcand/vulcand/pull/286)

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 your 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: Petr Belyaev upcfrost@gmail.com

Dependent cookbooks

golang >= 0.0.0
docker >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

vulcand CHANGELOG

This file is used to list changes made in each version of the vulcand cookbook.

0.1.0

  • [your_name] - Initial release of vulcand

Check the Markdown Syntax Guide for help with Markdown.

The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.

Collaborator Number Metric
            

0.1.0 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

0.1.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

0.1.0 failed this metric

FC066: Ensure chef_version is set in metadata: vulcand/metadata.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

0.1.0 failed this metric

vulcand does not have a valid open source license.
Acceptable licenses include Apache-2.0, apachev2, Apache 2.0, MIT, mit, GPL-2.0, gplv2, GNU Public License 2.0, GPL-3.0, gplv3, GNU Public License 3.0.

No Binaries Metric
            

0.1.0 passed this metric

Publish Metric
            

0.1.0 passed this metric

Supported Platforms Metric
            

0.1.0 passed this metric

Testing File Metric
            

0.1.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

0.1.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number