Skip to content

Latest commit

 

History

History
123 lines (86 loc) · 3.15 KB

README.md

File metadata and controls

123 lines (86 loc) · 3.15 KB
Raw

wgisrv 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

depends 'nc_base' depends 'server_utils'

Usage

The following environmental variables must be defined: DS = web Gui Server Name: ncd DSR = Ram for Server: 2048 DSC = CPUs for Server: 1 DSD = Disk Size for Server: 40960 DSP = Server IP: 10.1.1.42 chef_release = Version of Chef: 15.1.36 DSG = Disk Size in Gigs: 40G

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 wgisrv cookbook in your cookbook's metadata.rb.

depends 'wgisrv'

Then, in a recipe:

include_recipe 'wgisrv::make_nc_wg'

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['wgisrv']['my_attribute']: Describe the purpose or usage of this attribute. Defaults to somevalue. 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
wgisrv_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
wgisrv_resource_name 'some value' do
  property_name 'another value'
  property_name2 'foo bar'
  action :another_action
end