Using the puppet debugger for lightweight exploration
- 1. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Using the Puppet Debugger for lightweight exploration Kill the bugs, not your patience.
- 2. • Twitter: @cosman2001 • Github: logicminds, nwops • Blog: logicminds.github.io • Slack: nwops • Email: corey@nwops.io • Telegram: opselite • Devops Toolsmith and Consultant • Puppet Service Delivery Partner • Ruby, Node, Go Developer • Crypto Miner and Developer • Privacy and Security Advocator • Retrospec-puppet • Vim and VSCode User • Puppet User since 2009 (10 years Corey Osman
- 3. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Efficient Development “Speed (or velocity, if you prefer) is how quickly you can accomplish a task. Efficiency is a comparison - - a ratio -- of the useful work performed by a machine or in a process to the total work needed to complete a process. Speed and efficiency are related, but they're not synonymous.” Input / Output
- 4. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Progressive Development • Gain perspective. • Evaluate your methods and procedures. • Learn your editor and surrounding tools. • Optimize yourself and the environment around you. • Share with others often. • Be aware of tools that can help you. • Change is hard. Deal with it! There is always a better way.
- 5. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io What is a Debugger? • Tool used to test and debug other programs from source code • Expression evaluator • Allows you to step through code • Record and playback • Interactive
- 6. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Why We Need a Debugger • Understand how values are interpolated • Understand what functions do • Understand how scopes work • Understand how iterators work • Understand how hashes and variables work • Share code easily with the play function • Step through your code with breakpoints
- 7. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Antiquated workflows make us inefficient. Puppet Apply takes too much time.
- 8. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Play Interactively!
- 9. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Testing Thoughts • Instant feedback when compared to unit tests • Test datatypes in real time • Test regular expressions in real time • Test functions in real time • Test lookup constructs in real time
- 10. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Short Feedback Loop • Build a scale model • Bring the environment to you • facts • hieradata • classification • puppetdb
- 11. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Mocking Operating Systems FacterDB allows the Debugger to mock a variety of operating systems. • Mock AIX, Windows, linux distros, OSX, BSD… FacterDB (https://github.com/camptocamp/facterdb) puppet debugger --facterdb-filter ‘kernel=AIX and kernelmajversion=7100’ puppet debugger --facterdb-filter ‘operatingsystem=windows'
- 12. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Hiera Debugging • View lookup logs (set loglevel debug) • Find out what hiera / lookup is doing • Determine why Puppet is not loading the value you expect.
- 13. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Node Classification • Node classification retrieval • See top scope variables • even from ENC (ie. Foreman) • Site.pp evaluation • Real node facts
- 14. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Break Into Your Puppet Code • Set a breakpoint in your Puppet code (Linux support only) • Inspect variables in any scope • Inject the Debugger from any of the following: • puppet apply • spec test • puppet debugger command • pdk console • pdk test
- 15. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Parameter Resolution • Instantly find out the value of the parameters or variables. ls or ls <filter>
- 16. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Integration with PDK • PDK 1.14+ ships with the console command that invokes the Debugger • Works only within modules and control repos at this time • Control repo must have a Gemfile • Can use PDK test unit and debug::break() function • Interchangeable rubies and puppets • https://github.com/puppetlabs/pdk#pdk-console-command
- 17. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io How To Get • Package: gem install puppet-debugger • PDK Version (1.14+ ) • Demo: https://demo.puppet-debugger.com • Project Page: https://puppet-debugger.com
- 19. PuppetizePDX 2019 NWOPS, LLC https://www.nwops.io Questions? • https://logicminds.github.io/ • https://puppet-debugger.com
Editor's Notes
- #4: How much input must you provide to equal the output of others? What makes you different? How do you become more efficient? By learning how things work and not rely on google.
- #5: Spread the word by sharing what you learn. You must measure the effort vs reward, not everything is worth doing Continuous Improvement Who here considers themselves a sysadmin? False! Everyone is a developer in here.
- #6: One way to become more efficient is to speed up the your feedback loop and method of learning. Remove the search engine delay if possible. A debugger can help.
- #7: Do I need to specify quotes in hash key name? How does the dig function work? Don’t just bang on the keyboard. Bang on the keyboard with purpose!
- #8: Is there a better way? I had perspective from the programming world.
- #9: Put down your abacus and play inactively.
- #10: We can’t test thoughts with unit tests (us humans are too lazy) Don’t think, know. Validate your thoughts in the debugger.
- #11: The goal is to bring the environment as close as possible, build scale models at home before you build an interstate.
- #14: Overall goal is to completely replicate the catalog compilation process without the server or a real environment. This is an advanced feature and requires access to the puppet infrastructure