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

acmesmith (1) Versions 0.1.0

Installs/Configures acmesmith

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

acmesmith Cookbook

Cookbook to get Acmesmith to manage SSL certificates

Requirements

Platforms

  • Ubuntu 16.04

Chef

  • Chef 12.0 or later

Attributes

acmesmith::default

Key Type Description Default
['acmesmith']['version'] String Version number of gem to be used. '0.6.1'
['acmesmith']['config']['path'] String Path of the config file '/tmp' # set this
['acmesmith']['bindir'] String Directory where the gem's executables will reside. '/usr/local/bin'
['acmesmith']['config']['endpoint'] String The ACME endpoint for authorization/request of SSL certificates. 'https://acme-staging.api.letsencrypt.org/' # set this
['acmesmith']['config']['storage_type'] String (Possible values: 's3'(recommended) or 'filesystem') Location repo for the requested certificates. 's3'
['acmesmith']['config']['storage']['s3_region'] String S3 Region 'us-east-1' # set this
['acmesmith']['config']['storage']['s3_bucket_name'] String Name of the S3 bucket 'some-bucket' # set this
['acmesmith']['config']['storage']['s3_prefix'] String Prefix/Namespace under which the certificates will be stored on S# ''
['acmesmith']['config']['storage']['s3_access_key_id'] String AWS S3 Access Key ID '' # set this
['acmesmith']['config']['storage']['s3_secret_access_key'] String AWS S3 Access Secret '' # set this
['acmesmith']['config']['storage']['filesystem_path'] String Need to set if 'filesystem' is chosen as the storage_type '/tmp/keys'
['acmesmith']['config']['challenge_responder_type'] String Challenge responder, presently only 'route53' is available. 'route53'
['acmesmith']['config']['challenge_responder']['route53_access_key_id'] String AWS R53 Access Key ID '' # set this
['acmesmith']['config']['challenge_responder']['route53_secret_access_key'] String AWS R53 Access Secret '' # set this
['acmesmith']['config']['challenge_responder']['route53_session_token'] String AWS R53 Session Token '' # set this
['acmesmith']['config']['hosted_zone_map_domain_name'] String Hosted Zone Domain Name (eg: abc.com.) ''
['acmesmith']['config']['hosted_zone_map_id'] String Hosted Zone Map ID (eg: /hosted_zone/DEADBEEF) ''
['acmesmith']['config']['account_key_passphrase'] String Account Key Passphrase 'password' # set this
['acmesmith']['config']['certificate_key_passphrase'] String Cerificate Key Passphrase 'secret' # set this
['acmesmith']['domain'] String Domain for which SSL certificates need to be fetched (eg. abc.com) '' # set this
['acmesmith']['common_name'] String Common Name for which SSL certificates need to be fetched (eg. xyz.abc.com) '' # set this
['acmesmith']['contact'] String Email ID of owner (eg. someone@something.com) '' # set this
['acmesmith']['sans'] Array of Strings Comma seperated SANs (Subject Alternative Names) []
['acmesmith']['certificate_path'] String Path where Certificate will be written to (Set this according to your web server's configuration) '' # set this
['acmesmith']['private_key_path'] String Path where Private Key will be written to (Set this according to your web server's configuration) '' # set this
['acmesmith']['auto_renew_days'] String Renew certificates which being expired soon '5'
['acmesmith']['auto_renew_log_path'] String Logs for cron that renews certificates '/tmp/acmesmith-renewal.log'

The below variables need to be set (where default values might fail) :

  • ['acmesmith']['config']['storage']['s3_region']
  • ['acmesmith']['config']['storage']['s3_bucket_name']
  • ['acmesmith']['config']['storage']['s3_access_key_id']
  • ['acmesmith']['config']['storage']['s3_secret_access_key']
  • ['acmesmith']['config']['challenge_responder']['route53_access_key_id']
  • ['acmesmith']['config']['challenge_responder']['route53_secret_access_key']
  • ['acmesmith']['config']['challenge_responder']['route53_session_token']
  • ['acmesmith']['config']['account_key_passphrase']
  • ['acmesmith']['config']['certificate_key_passphrase']
  • ['acmesmith']['domain']
  • ['acmesmith']['common_name']
  • ['acmesmith']['contact']
  • ['acmesmith']['certificate_path']
  • ['acmesmith']['private_key_path']

Usage

acmesmith::default

e.g. Just include acmesmith in your node's run_list:

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

Contributing

  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:

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

acmesmith CHANGELOG

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

0.1.0

  • [bitsapien] - Initial release of acmesmith

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: acmesmith/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: acmesmith/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

acmesmith 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 failed this metric

acmesmith should declare what platform(s) it supports.

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