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

ssh-util (2) Versions 0.6.3

LWRPs for managing SSH known_hosts and config files

Berkshelf/Librarian
Policyfile
Knife
cookbook 'ssh-util', '~> 0.6.3'
cookbook 'ssh-util', '~> 0.6.3', :supermarket
knife cookbook site install ssh-util
knife cookbook site download ssh-util
README
Dependencies
Quality

Chef SSH

Description

Provides 2 LWRPs to manage system-wide and per-user ssh_config and known_host files.

Usage

When using SSH with Chef deployments, it's crucial to not get any prompts for input. Adding entries to known_hosts files and better managing your per-connection configuration can help with this.

Resources and Providers

known_hosts

Actions

<table> <thead> <tr> <th>Action</th><th>Description</th><th>Default</th> </tr> </thead> <tbody> <tr> <td>add</td> <td>Adds an entry for the given host to a known_hosts file</td> <td>Yes</td> </tr> <tr> <td>remove</td> <td>Removes entries for a host from a known_hosts file</td> <td> </td> </tbody> </table>

Attributes

<table> <thead> <tr> <th>Attribute</th><th>Description</th><th>Default Value</th> </tr> </thead> <tbody> <tr> <td>host</td> <td> <b>Name attribute:</b> the FQDN for a host to add to a known_hosts file </td> <td><code>nil</code></td> </tr> <tr> <td>hashed</td> <td>A Boolean indicating if SSH is configured to use a hashed known_hosts file. </td> <td><code>true</code></td> </tr> <tr> <td>key</td> <td>A full line to add to the file, instead of performing a lookup for the host. </td> <td><code>nil</code></td> </tr> <tr> <td>user</td> <td>A username to add the known_hosts entry for. If unspecified, the known_host will be added system-wide. <b>Note:</b> if specified, the user must already exist. </td> <td><code>nil</code></td> </tr> <tr> <td>path</td> <td>A full path to a known_hosts file. If used with the user attribute, this will take precedence over the path to a user's file, but the file will be created (if necessary) as that user. </td> <td><code>nil</code></td> </tr> </tbody> </table>

Example

ssh_known_hosts "github.com" do
  hashed true
  user 'webapp'
end

config

Actions

<table> <thead> <tr> <th>Action</th><th>Description</th><th>Default</th> </tr> </thead> <tbody> <tr> <td>add</td> <td>Adds an entry for the given host to a ssh_config file</td> <td>Yes</td> </tr> <tr> <td>remove</td> <td>Removes entries for a host from a ssh_config file</td> <td> </td> </tbody> </table>

Attributes

<table> <thead> <tr> <th>Attribute</th><th>Description</th><th>Default Value</th> </tr> </thead> <tbody> <tr> <td>host</td> <td> <b>Name attribute:</b> the string to match when connecting to a host. This can be an IP, FQDN (github.com), or contain wildcards (*.prod.corp) </td> <td><code>nil</code></td> </tr> <tr> <td>options</td> <td>A hash containing the key-values to write for the host in </td> <td><code>true</code></td> </tr> <tr> <td>user</td> <td>A username to add the ssh_config entry for. If unspecified, the known_host will be added system-wide. <b>Note:</b> if specified, the user must already exist. </td> <td><code>nil</code></td> </tr> <tr> <td>path</td> <td>A full path to a known_hosts file. If used with the user attribute, this will take precedence over the path to a user's file, but the file will be created (if necessary) as that user. </td> <td><code>nil</code></td> </tr> </tbody> </table>

Example

ssh_config "github.com" do
  options 'User' => 'git', 'IdentityFile' => '/var/apps/github_deploy_key'
  user 'webapp'
end

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

ssh_user Applicable Versions

Collaborator Number Metric
            

0.6.3 failed this metric

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

Contributing File Metric
            

0.6.3 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.6.3 failed this metric

FC017: LWRP does not notify when updated: ssh-util/providers/config.rb:2
FC017: LWRP does not notify when updated: ssh-util/providers/config.rb:11
FC017: LWRP does not notify when updated: ssh-util/providers/known_hosts.rb:4
FC017: LWRP does not notify when updated: ssh-util/providers/known_hosts.rb:26
FC059: LWRP provider does not declare use_inline_resources: ssh-util/providers/config.rb:1
FC059: LWRP provider does not declare use_inline_resources: ssh-util/providers/known_hosts.rb:1
FC064: Ensure issues_url is set in metadata: ssh-util/metadata.rb:1
FC065: Ensure source_url is set in metadata: ssh-util/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ssh-util/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: ssh-util/metadata.rb:1
FC069: Ensure standardized license defined in metadata: ssh-util/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: ssh-util/resources/config.rb:1
FC074: LWRP should use DSL to define resource's default action: ssh-util/resources/known_hosts.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

0.6.3 passed this metric

No Binaries Metric
            

0.6.3 passed this metric

Publish Metric
            

0.6.3 passed this metric

Supported Platforms Metric
            

0.6.3 failed this metric

ssh-util should declare what platform(s) it supports.

Testing File Metric
            

0.6.3 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.6.3 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