Crafting Reusable Resources

Crafting Reusable Cookbooks
Ian Henry
Jennifer Davis (remote)
Network Name: ChefConf
Access Code: ChefConf2016
✨ Crafting Reusable Cookbooks #chefconf✨ 1

Instructor
4 Ian Henry

TA's
4 Robb Kidd
4 Matt Stratton
4 David Echols
4 Stephen Lauck
4 Bill Meyer

Communication
4 Jennifer Davis Twitter: @sig je
4 Ian Henry Twitter: @Eeyun___
Hashtag: #chefconf

Feedback
4 Constructive feedback
4 What did you find helpful?
4 What would you like to see more/less of?
4 Was there anything you found unclear?

Why are we here?

Expectations
4 Code of Conduct
4 Safe space to share experiences, learn from each
other.
4 Learn effective patterns for developing reusable
cookbooks.

Agenda

Collaboration
Individuals working together with shared interactions
and input, building towards a common goal.

Collaboration
4 Multiple types of collaboration
4 Monitoring for single points of failure
4 Monitoring burnout

Smarter Teams
build better value

Tools
Accelerators of culture that if used effectively can
enhance and support a culture of collaboration and
affinity.

Team
4 Common purpose
4 Defined beliefs
4 Empowered

Diversity in Teams
4 Professional
4 Personal
4 Goals
4 Cognitive Styles

Critical Habits for Teams
4 Code Review
4 Pairing

Code Review
4 Max 90 minutes in one setting

Pairing
4 Agile software development
4 2 people work together on 1 workstation
4 Driver - writes code
4 Observer - reviews each line
4 Roles switch frequently

Types of Pairing
4 Expert-expert
4 Expert-novice
4 Novice-novice

Team Activity 1
4 Meet your team!
4 What are motivations?
4 What are objectives?
4 Skills? Gaps in skills?
4 git, chef, docker, continuous integration,
continuous delivery
If you haven't filled out the skills assessment please do✨ Crafting Reusable Cookbooks #chefconf✨ 19

Local Development Environment (LDE)
4 Consistent set of tools across the team
4 Ability to quickly onboard new engineers

Team Activity 2
4 Share with your team:
4 Do you have a team common local development
environment?
4 What current tools are you using in chef
development?
Time: 10 minutes

Provisioned Node - LDE
4 AWS instance node
4 Chef DK
4 Test Kitchen
4 Ruby
4 ChefSpec, ServerSpec
4 Git

Introduction to Lab 1
4 Log into node and configure git
4 Create GitHub identity if you don't have one
already.
4 Set up GitHub keys.
4 Share team tools from Activity 2.

Lab 1
Time: 30 minutes

Supermarket
4 Community site with a number of cookbooks
Class Supermarket: https://
supermarket.reusablechef.com

Chef DK
4 Chef development kit
4 Includes a number of utilities and software to
facilitate cookbook creation
4 Free download off of the website

Berkshelf
4 Dependency management
4 Included with Chef DK

Test Kitchen
4 Included with Chef DK
4 Test harness
4 Sandbox automation

.kitchen.yml
4 driver
4 provisioner
4 platforms
4 suites

.kitchen.yml driver
4 virtualization or cloud provider
Example: vagrant, docker

.kitchen.yml provisioner
4 application to configure the node
Example: chef_zero

.kitchen.yml platforms
4 target operating systems
Example: centos-6.5

.kitchen.yml suites
4 target configurations
Example:
name:default
run_list:
- recipe[apache::default]
attributes:

4 Create cookbook
Lab 2

Lab 2
Time: 20 minutes

Runbook to Recipes

Introducing MongoDB

MongoDB terminology
4 document - basic unit of data for MongoDB, ordered
set of keys with associated values
4 collection - group of documents. analogous to table.
4 instance - MongoDB can host multiple independent
databases, each of which can have its own
collections.

MongoDB Shell
4 mongo
full featured JavaScript interpreter

Translate a runbook for installing MongoDB into chef.
[Lab 3]https://github.com/iennae/crc-training/blob/
master/labs/lab_3.md)

Lab 3
Time: 20 minutes

Quality Cookbooks

Iterative

Issue Management
4 Should be clear where to file bugs, request features.
4 Should be regularly groomed

Clear and Specific Licensing
For reusable cookbooks across the community
4 Apache 2.0
4 GNU Public License 2.0
4 GNU Public License 3.0
4 MIT

Multiple Collaborators
4 More than 1 person with the ability to release new
cookbooks
4 More than 1 person with ability to merge pull
requests

Test Everything
4 Use integration tests
4 Assert the state of the converged node to ensure
it's in the desired state

Foodcritic and Rubocop
4 Chef and Ruby linters pass cleanly

Multiple Platforms
4 As applicable, supports multiple platforms

Documentation
4 Clear and specific
4 Includes contributing guidelines

No binaries
4 Binaries should be stored in signed artifact
repositories separate from the cookbook

Existence of a test
cookbook

No duplication of code

Valid kitchen configuration
4 Ability for others to replicate and test cookbook
easily

Custom Resources over Attributes
4 Attribute driven
4 Resources

Custom Matchers when using Custom
Resources
Example: https://github.com/chef-cookbooks/tomcat/
blob/master/libraries/matchers.rb

Build Cookbooks for
Wrapping

Support the 95% use case

History of Customizing Chef
4 Attributes
4 Definitions
4 LWRP and HWRP
4 Custom Resources

Custom Resources
4 As of 12.5
4 compat_resource to bring custom resources to 12+

Translate our MongoDB cookbook from recipes into
resources.
Lab 4

Lab 4
Time: 30 minutes

Managing Risk
4 Test
4 Small frequent releases

Linting
4 Ensure code adheres to styles and conventions
4 Weave expectations into development
4 Encourages collaboration

Testing
4 Documenting objectives and intent
4 Measuring "done"

Code Correctness
4 foodcritic
4 rubocop

Integration Tests
4 ServerSpec
4 InSpec

Rubocop
4 Ruby linter
4 Analyzes source code to verify the syntax and
structure of our cookbooks.
4 Ruby style guide
4 Included with ChefDK

Why
4 identify simple errors early
4 improve the review process by eliminating stylistic
issues

Rubocop Example
$ rubocop cookbooks/COOKBOOK1 cookbooks/COOKBOOK2 cookbooks/COOKBOOK4

Reading Rubocop Output
Inspecting 8 files
CWCWCCCC
4 . means that the file contains no issues
4 C means a issue with convention
4 W means a warning
4 E means an error
4 F means an fatal error

Rubocop Cops
4 Lint
4 Rails
4 Style
Example: rubocop --lint.

Disabling Rubocop cops
Any configuration in .rubocop.yml is disabled.
To disable string literals:
StringLiterals:
Enabled: false

Foodcritic
4 Chef linter
4 Chef style guide
4 Included with ChefDK

Foodcritic Example
$ foodcritic cookbooks/setup

Reading Foodcritic Output
FC008: Generated cookbook metadata needs updating: ./metadata.rb:2

ServerSpec
4 Tests to verify servers functionality
4 Resource types
4 Package, service, user, and many others
4 Integrates with Test Kitchen
4 http://serverspec.org

ServerSpec Generic Form
describe "<subject>" do
it "<description>" do
expect(thing).to eq result
end
end

ServerSpec Potential Tests
4 Is the service running?
4 Is the port accessible?
4 Is the expected content being served?

ServerSpec Example
describe 'apache' do
it "is installed" do
expect(package 'httpd').to be_installed
end
it "is running" do
expect(service 'httpd').to be_running
end
end

Reading ServerSpec Output
app::default
httpd service is running
Finished in 0.26429 seconds (files took 0.7166 seconds to load)
1 example, 0 failures

InSpec
4 infrastructure specification
4 open-source testing framework for infrastructure
4 human and machine readable
4 compliance, security, and policy requirements
4 Based off of ServerSpec

InSpec Example
describe service 'ssh-agent' do
it { should be_running }
end

InSpec Example Run
$ inspec exec test.rb
.
Finished in 0.00901 seconds (files took 0.98501 seconds to load)
1 example, 0 failures

InSpec Remote Run
$ inspec exec test.rb -i ~/.aws/YOUR.pem -t ssh://ec2-user@54.152.7.203

InSpec Remote Run on Windows
$ inspec exec test.rb -t winrm://Admin@192.168.1.2 --password super

InSpec Docker Containers
$ inspec exec test.rb -t docker://3dda08e75838

More info on InSpec
https://github.com/chef/inspec/blob/master/docs/
ctl_inspec.rst

InSpec Audit Rules
4 lots of resources to facilitate auditing nodes

InSpec host resource example
describe host('example.com', port: 80, proto: 'tcp') do
it { should be_reachable }
end

InSpec login_defs resource example
describe login_defs do
its('PASS_MAX_DAYS') { should eq '180' }
its('PASS_MIN_DAYS') { should eq '1' }
its('PASS_MIN_LEN') { should eq '15' }
its('PASS_WARN_AGE') { should eq '30' }
end

Add Ubuntu platform to the mongodb cookbook.
Clean any rubocop and foodcritic issues reported.
Add tests to MongoDB cookbook.
Lab 5

Lab 5
Time: 30 minutes

Community Cookbooks
Community driven.
* Some managed by Chef. https://github.com/chef-
cookbooks
* Some partner managed.

CI/CD

Travis
4 free (for Open Source projects)
4 build files available

Chef Managed Community Cookbooks
CI
4 cookstyle (included with chef dk) https://github.com/
chef/cookstyle
4 allows for consistent rubocop testing across
cookbooks
4 use travis

Travis Sample
4 Tomcat Travis configuration
4 sudo: required (required when using docker with
travis)
4 limits branch to master
4 matrix set of platforms to test
4 script tests to be run

Extending Existing Cookbooks
Lab 6

Lab 6
Time: 1 hour

Lab 7

Lab 7
Time: 1 hour

Review

Crafting Reusable Resources

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Andere mochten auch

Andere mochten auch (20)

Ähnlich wie Crafting Reusable Resources

Ähnlich wie Crafting Reusable Resources (7)

Mehr von Jennifer Davis

Mehr von Jennifer Davis (20)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Crafting Reusable Resources