cookbook 'server_utils', '= 1.1.0'
server_utils (4) Versions 1.1.0 Follow0
Installs/Configures server_utils
cookbook 'server_utils', '= 1.1.0', :supermarket
knife supermarket install server_utils
knife supermarket download server_utils
server_utils Cookbook
Todo: Put a description of your cookbook here. Include at a high level the
intent and purpose of why someone would use this cookbook.
Scope
Todo: Identify the scope of what exactly this cookbook addresses. Are there any
edge cases associated with your cookbook tasks that were decided not to be
supported?
Requirements
Todo: List any technical requirements for using this cookbook. Do you need to
install binaries from the network? Does the cookbook make other assumptions
about the environment for it to be used? Does the operating system need to have
any special configuration before using this cookbook (i.e. disable selinux)?
Also, tailor the subsections below:
Platforms
- Redhat 7.x+
Chef
- Chef 12
Dependencies
- lvm
- limits
- selinux
- hostsfile
Usage
Todo: This will be unique depending on how the cookbook is developed and the
tools it provides to configure nodes. Here's a simple example of using a
cookbook and it's recipe. You'll want to elaborate on your own steps and include
any necessary steps like setting required attributes.
Place a dependency on the server_utils
cookbook in your cookbook's
metadata.rb
.
depends 'server_utils'
Then, in a recipe:
include_recipe 'server_utils::default'
If your cookbook provides resources, be sure to include examples of how to use
those resources, in addition to the resources documentation section below.
Attributes
-
default['server_utils']['my_attribute']
: Describe the purpose or usage of this attribute. Defaults tosomevalue
. Indicate the attribute type if necessary.
Recipes
default.rb
Todo: Provide a description for the purpose of this recipe file. What does it
do? When would I use it? Does it invoke other recipes?
Custom Resources
Todo: You only need to provide documentation for custom resources if your
cookbook actually provides them. Not all cookbooks have custom resources. If you
don't known what this means, then your cookbook probably doesn't have them
either and can omit this documentation.
resource_name
Todo: Add a description or purpose for this resource. What does it do?
Actions
-
:do_something
: Description of this action -
:another_action
: Description of this action
Properties
-
property_name
- Description of this property. What is it used for? What is it's default value? -
property_name2
- Description of this property. What is it used for? What is it's default value?
Examples
todo: Describe this example and what it will accomplish.
# code samples are helpful server_utils_resource_name 'some value' do property_name 'another value' property_name2 'foo bar' action :do_something end
And don't forgot to show an example for your other actions.
# code samples are helpful server_utils_resource_name 'some value' do property_name 'another value' property_name2 'foo bar' action :another_action end
server_utils CHANGELOG
This file is used to list changes made in each version of the server_utils cookbook.
0.1.0
Initial release.
- change 0
- change 1
Collaborator Number Metric
1.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
1.1.0 passed this metric
Foodcritic Metric
1.1.0 passed this metric
No Binaries Metric
1.1.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
server_utils/templates/RPM-GPG-KEY-EPEL-7.erb
Testing File Metric
1.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
1.1.0 passed this metric
1.1.0 failed this metric
1.1.0 passed this metric
Foodcritic Metric
1.1.0 passed this metric
No Binaries Metric
1.1.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
server_utils/templates/RPM-GPG-KEY-EPEL-7.erb
Testing File Metric
1.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
1.1.0 passed this metric
1.1.0 passed this metric
1.1.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
server_utils/templates/RPM-GPG-KEY-EPEL-7.erb
Testing File Metric
1.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
1.1.0 passed this metric
1.1.0 failed this metric
1.1.0 passed this metric