Determine list of starter Puppet Content Templates

[jpogran]

Evaluate existing set of PCT experimentations to see if any are worthy first example templates. Evaluate whether any new template should be created. End goal is a short list of example templates that showcase using PCT Do not create templates for this ticket

[sanfrancrisko]

The current aim is to base a set of templates off what the minimum requirements would be to follow the Beginner's Guide to writing modules. This would require:

• [x] A puppet-module-base project:
  • This may borrow heavily from @jpogran 's existing puppet-module project template
  • At a minimum, the following commands should work:
  • [x] pdk test unit
  • [ ] pdk build
  • [ ] STRETCH: This should pass pdk validate
• [x] A puppet-class item:
  • This may borrow heavily from @jpogran 's existing puppet-class item template
  • [x] At a minimum, once deployed, this should pass pdk test unit

[sanfrancrisko]

A potentially compelling addition would be to:

• Make the puppet-module-base project non-licensed Linux only (i.e. Ubuntu, Debian, CentOS)
• Add an item that generates a Github workflow using Litmus to provision and execute acceptance tests

[sanfrancrisko]

Proposed PCT Starter Templates

Audience

As a potential Puppet module developer, I want to be able to quickly build a module that I can put on the forge and have other collaborators work on it with me

Part I

OK, how do I create a basic module...nothing in it, just the base minimum requirements?

• Create a bare bones module using pct new puppet-module-base
  • Demo configuring pct-config parameters for metadata.json (Windows, Linux support)

Cool, OK, I need a class now as a starter

• Create a class using pct new puppet-class
  • Demo configuring pct-config parameters for Puppet Class
• pdk test unit should work on this, even though there's nothing there
• Flesh out the class and test file, pdk test unit cycle, until complete

Good, now I want other people to enhance it but make sure there's tests on their contributions

• Create a Github Actions Workflow to run spec tests using pct new ghactions-module-spec
  • Demo configuring GHActions parameters using pct-config (TBC)

Part II (Stretch)

OK, let's go to the next level of testing and do some acceptance testing! I've heard Litmus is quite good for acceptance testing? Do you have a template for that?

Part III (Stretch)

How did I create that Github Action Workflow? How can I create my own template items like that, because we have our own CI I'd like to create a template for!

Templates Overview

puppet-module-base

Type: project

• Is capable of running RSpec Spec tests and has necessary dependencies set up

puppet-class

Type: item

• Adds a new class to a Puppet module
• pdk test unit should work after generation (assuming it has been deployed in to a puppet-module type template)

github-actions-spec-tests

Type: item

• Adds a Github Action workflow that executes spec tests

[sanfrancrisko]

Starter templates will be held here: https://github.com/puppetlabs/baker-round/tree/pct-poc-templates

[jpogran]

I think this ticket is complete and can be closed.