PuppetConf 2016: How Not to Freak Out When You Start Writing Puppet Modules for Windows – Glenn Sarti, Puppet
•Download as PPTX, PDF•
1 like•788 views
Here are the slides from Glenn Sarti's PuppetConf 2016 presentation called How Not to Freak Out When You Start Writing Puppet Modules for Windows. Watch the videos at https://www.youtube.com/playlist?list=PLV86BgbREluVjwwt-9UL8u2Uy8xnzpIqa
Recommended
More Related Content
What's hot
What's hot (20)
Viewers also liked
Viewers also liked (20)
Similar to PuppetConf 2016: How Not to Freak Out When You Start Writing Puppet Modules for Windows – Glenn Sarti, Puppet
Similar to PuppetConf 2016: How Not to Freak Out When You Start Writing Puppet Modules for Windows – Glenn Sarti, Puppet (20)
More from Puppet
More from Puppet (20)
Recently uploaded
Recently uploaded (20)
PuppetConf 2016: How Not to Freak Out When You Start Writing Puppet Modules for Windows – Glenn Sarti, Puppet
- 1. How not to freak out … … when you start writing Puppet modules on Windows
- 2. before we start ...
- 3. Me • Senior Software Engineer at Puppet Specialising in Windows • 15 years in Desktop Engineering and IT Navy, Government, Mining, Finance, Corporate • DevOps advocate
- 4. The setup …
- 9. What do we need? • Setting up a development environment • Create a Puppet module • Debugging tools
- 10. What do we need? • Testing tools • Publish the module • Next steps
- 11. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 12. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 13. Tools you probably already have • Windows computer • Text editor • Puppet Agent Tools you probably need to install • Source Control • Ruby and Ruby Dev Kit
- 14. Why Source Control? • Made a change and realised it was a mistake and wanted to revert back? • Lost a modules or had a backup that was too old? • Wanted to see the difference between two (or more) versions of your modules? • Wanted to prove that a change broke or fixed a piece of modules? • Wanted to review the history of a modules? • Wanted to submit a change to someone else's modules? • Wanted to share your modules, or let other people work on your modules? • Wanted to see how much work is being done, and where, when and by whom? • Wanted to quickly experiment something new without breaking anything? …
- 15. Why Source Control? • Undo mistakes • Be kind to you future self
- 16. Why Source Control? Prefer git for Puppet Module work • Lightweight • Doesn’t require a central server • Very common But, choose something that’s appropriate for you …
- 17. Why Ruby? Q: Why use ruby? A: Because, Puppet.
- 18. Why Ruby? Q: Doesn’t that already come with Puppet Agent? A: Yes, but…
- 19. Which text editor? Common - Atom, Notepad++, VS Code Some have ruby and puppet plugins to help with development Lots of other options though….
- 20. Which text editor? Common problems • CRLF vs LF Probably best to use LF • Text Encoding and BOM Unrecognised character at Line 1, Pos 1
- 21. How do we install these tools? • Manual installation • Chocolatey https://chocolatey.org
- 22. How do we install these tools? PS> choco install git PS> choco install puppet-agent PS> choco install visualstudiocode PS> choco install ruby ruby2.devkit
- 23. How do we install these tools? Common problems • Ruby Devkit can be tricky to install Manually install the devkit into your ruby installation
- 24. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 25. Create a Module – Where to start? • Beginner’s Guide to Modules • Module fundamentals
- 26. Creating a Module - Tools Puppet Module Tool bundler rake
- 28. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 29. Debugging tools • pry Console driven debugger for ruby • pry-byebug Pry plugin to add step-by-step and stack debugging • pry-stack_explorer Pry plugin to navigate the call stack in ruby
- 30. Debugging tools • Modify Gemfile • Bundle install … gem "pry" gem "pry-byebug" gem "pry-stack_explorer"
- 31. Debugging tools require "pry"; binding.pry
- 33. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 34. Why should I test?
- 35. • The “un-happy” path • Document the intent • Avoid regression Why should I test?
- 36. • Acceptance • Integration • Unit Types of tests
- 37. Types of tests Where should I start? Start with unit and integration tests using automated tools
- 38. Unit and Integration tests • rspec • rspec-mocks or mocha • rspec-puppet Testing tools
- 39. Acceptance tests • beaker • beaker-rspec Testing tools
- 41. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 44. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 45. • Setup environment • Create module • Debug tools • Test tools • Publish module • Next steps
- 46. • Read up on testing • Learn more ruby • Add automated acceptance tests What’s next
- 47. • Custom types and providers • Test your Windows modules on Linux nodes What’s next
- 49. Links Source Control • The Release Pipeline Module http://aka.ms/thereleasepipelinemodelpdf • Ruby Installation http://rubyinstaller.org/downloads/ • Ruby DevKit https://github.com/oneclick/rubyinstaller/wiki/Development-Kit • What is the BOM https://en.wikipedia.org/wiki/Byte_order_mark • Chocolatey https://chocolatey.org/ • Puppet Extension for Visual Studio Code https://marketplace.visualstudio.com/items?itemName=Borke.Puppet Modules • Puppet Enterprise quick start guide for Windows users https://docs.puppet.com/pe/latest/quick_start_windows_intro.html • Beginner’s Guide to Modules https://docs.puppet.com/guides/module_guides/bgtm.html • Module fundamentals https://docs.puppet.com/puppet/latest/reference/modules_fundamentals.html • Ruby Bundler http://bundler.io/ • puppet module generate https://docs.puppet.com/puppet/latest/reference/modules_fundamentals.html#writing-modules
- 50. Links Debugging • Pry http://pryrepl.org/ https://www.sitepoint.com/rubyists-time-pry-irb/ • pry-byebug https://github.com/deivid-rodriguez/pry-byebug • pry-stack_explorer https://github.com/pry/pry-stack_explorer Testing • Rspec http://rspec.info/ • rspec-puppet http://rspec-puppet.com/ • rspec-mocks https://github.com/rspec/rspec-mocks • mocha http://gofreerange.com/mocha/docs/ • beaker https://github.com/puppetlabs/beaker/blob/master/docs/README.md • beaker-rspec https://github.com/puppetlabs/beaker-rspec
- 51. Links Publishing • puppet-blacksmith https://github.com/voxpupuli/puppet-blacksmith • Publishing modules on the forge https://docs.puppet.com/puppet/4.7/reference/modules_publishing.html • The metadata.json file https://docs.puppet.com/puppet/4.7/reference/modules_metadata.html Other • Puppet REPL A REPL for the puppet language https://github.com/nwops/puppet-repl • Puppet Skeleton Module Generator https://github.com/garethr/puppet-module-skeleton • Puppet Strings The next generation Puppet documentation extraction and presentation tool https://github.com/puppetlabs/puppet-strings
Editor's Notes
- Scenario 1. Starting out with Puppet using modules from the Forge 2. There's something you want to do but no module for it, so you resort to Exec's! 3. Then you need a Fact or some custom function and everything gets a little hard! 4. You start to investigate …
- Find all these terms in your searches…beaker, pry, bye-bug, uru, pik …. All this stuff just so you can create a module??!?!?! And then you … (freak out)
- BOOM you freak out….
- Smoke coming out of your ears and yours are bugging out….. and all you just want to do is write a puppet module…. …
- Today we’re going to go through creating a Puppet module for windows…that doesn’t involve you freaking out….. So the first thing we need to do is……Take a breath and walk through the things we need to do….
- Firstly, we need to setup or desktop/laptop with the tools we require…. We can then create a Puppet module, hopefully from a template of some kind, or from another example We know we’ll make errors so we need a way to debug out module
- We should have some tests….Tests are good Once we’ve got a working module, what do we do with it? Publish it What next?
- Not enough time in this session to go over ALL the reasons but here are some reasons
- Bottom line You will see the value of source control when you make a mistake Be kind to your future self. In 6 months (or 6 days in my case) time, you may forget WHY wrote that piece of code. This helps alot
- Do your developers already use git, or svn or mercurial, may be good to use that Do your friends, colleagues use something other than git. It’s good to have people you can ask for help
- Why should we be using ruby at all? Because Puppet is written in ruby and Puppet modules, testing etc. are all in ruby.
- Using ruby that’s installed as part of puppet-agent is ok, only if you never have any bugs and you don’t need to debug We need to install some ruby gems with native extensions which requires the ruby-devkit. which is not available in the puppet-agent ruby installation
- I’ll be using VS Code with the ruby and puppet plugins for this demo. Why VS Code – xplat support, great multi-lang support (Powershell, batch, ruby, puppet)
- LF is more commonly used but it’s up to you BOMs break things
- Manual installs – they work initially but … Chocolatey is a package manager for windows which makes installing these tools much easier. Come to Rob Reynolds talk about Chocolatey after lunch if you want to learn more about it
- Choco commands to install it all No demo for this as it’s not very exciting….
- Should probably read these two documents from Puppet first. The direct links for these are at the end of the presentation. Even if you don’t fully understand everything the first time you read them, it will come in useful later when you actually start writing the module. e.g. what’s the template directory for, oh yeah I saw that in the beginner’s guide or where do I put facts
- Puppet module generate will create the beginnings of a module for us Rake is build automation tool. This is installed by default. It makes it easy to execute common tasks which we’ll use later. The gitignore file is used so that temporary files don’t show up when you’re using source control, in this case git.
- Demo create
- There are some IDEs that do offer debugging (Jetbrains Rubymine) but not everyone uses those instead we use a console driven debugger Pry - Pry is the main debugging tool which provides an interactive debug session during a ruby session, for example when you run puppet. You can view source code, inspect variables, modify variables inline and a bunch of useful things Pry-byebug Pry-byebug is a plugin for pry which adds step-by-step debugging and call stack navigation. Which we’ll show a bit alter Pry-stack_explorer pry-stack_explorer is a plugin for the Pry REPL that enables the user to navigate the call-stack. From the point a Pry session is started, the user can move up the stack through parent frames, examine state, and even evaluate code. Inside ruby a function calls a function calls a function calls a function etc. And the stack explorer can show each of those function calls so we can see exactly how we’re traversing our ruby code. Which we’ll show a bit later.
- How do we install these tools? Modify the gemfile, bundle install
- Inside our source code we add “require pry; binding.pry” to enter a debug session at that point
- Demo debug
- Firstly, I will not be able to do this subject justice in the time I have. There are a LOT of resources about testing, and testing infrastructure as code, but here are my top 3 reasons why you should test your puppet module…
- The un-happy path ------ We all test the Happy path when we’re writing a module, where everything works, but what about the un-happy path? What happens to our module if the user puts in bad data? A string instead of a number? How do we handle errors? Documentation of intent --- The tests actually serve as documentation. E.g. Most tests are written as “Given these inputs it should do this behaviour” This is a good way to document our module and the intent of how it should be behave Avoid regression ---- When you find an issue, write a test for it. From then on you can be sure it won’t happen again ‘
- There are MANY types of tests and to help not us not freak out, I’ll go through three types. Unit tests exercise a single component of a Puppet Module, typically that’s a function or a single fact. These are normally very quick. In our code example, we would write unit tests for the dotnet_version fact Integration tests exercise how components interact. In the case of a Puppet Module, a complex one like the Powershell Module, we have multiple complex functions so we test how they interact with each other. Or it may require interacting with operating system e.g. In Puppet we test our user resources by creating a temporary user account in Windows and then querying it using our functions.. These are typically a little slower than unit tests and as I said may require a specific operating system. Acceptance or End to End tests are the most time consuming. In these tests we would create a Puppet Master and Agent, put manifests on the Master and test that they have the intended behaviour. They are normally laid out in a pyramid because you normally want many unit tests, then less integration and then less acceptance. The higher up the pyramid, the more costly and time consuming the tests are and the slower you’ll get feedback on errors.
- Start with creating unit and integration tests. Manual acceptance tests are ok to start off with, but remember they take a lot of time are prone to error. Just remember “Your code is always tested, just differs by who. You the module writer or in production”
- Rspec (ruby spec) --- The standard testing tool for ruby and forms the basis for all testing Mocha --- Mocking support for rspec. This allows us to fake out responses during unit tests. For example, in out dotnetversion fact we can mock that dotnet is installed/not installed/ or gives a really weird response (unhappy path) Rspec-puppet ---- Adds extensions to rspec for puppet specific tasks, particularly useful for testing manifest based modules. E.g. checking resource compilation, mocking facts (without mocha) All of these tools are set in your gemfile via puppet generate so we already have these tools installed. Also as they’re all still ruby, you can use your debugging tools inside the tests.
- Beaker --- Is Puppet’s acceptance test harness. It helps coordinate creating Virtual Machines (or docker containers!) for masters and agents Beaker-rspec (optional) --- Like rspec-puppet, it adds helpers into rpsec to help with beaker operations e.g. Apply this puppet manifest on this host, or run this command on the node.
- Demo testing
- So we’ve got our working and tested module, now what!
- If we want to create a puppet module we can distribute either to the Forge or your own module repositories, we can use the ‘rake build’ task. This will create a tarball for us Puppet-blacksmith is a ruby gem that can help with automating the deployment to the Forge (no humans required)!
- Demo PMT
- Summarise what we went through
- Read up on testing as that will give you biggest reward for the effort. Add automated acceptance tests when you’re comfortable
- Read up on testing as that will give you biggest reward for the effort. Add automated acceptance tests when you’re comfortable If you’re in a mixed environment, test your Windows modules on Linux. Both our experience in Puppet and customers too, some Windows only modules behave a little odd when they’re run under linux. Also test out Linux modules in Windows!