SIG.DevKit

Mission

Develop an SDK for OpenVox to replace PDK, using vox's existing tooling for everything possible and building what we're missing.

Organization

• Slack channel:
  • #sig-devkit
  • synced to the #voxpupuli-sig-devkit IRC channel

Members

• Lumiere
• Yury Bushmelev

Requirements

Functions (minimally required)

1. Create a module directory from a template (default or specified)
   • Create a class (+unit test)
   • Create a defined resource (+unit test)
2. Update the module directory to match the template (default of specified)
3. Validate the module with validators (all or specified) on all or specified files
4. Run unit tests (all or specified)
5. Manage versions of Puppet/Ruby/etc so that tools can be run on different versions of OpenVox without a complete reinstall cycle.

Key points

• relatively low effort for users to install and use
• mainly for interactive use, but may be used in a CI/CD pipeline also
• based on existing tools in the Puppet/OpenVox ecosystem
• integrates well with VoxPupuli other tools
• dependencies should be easy manageable
• keep in mind strict and airgapped environments

Resources

• Issues related

  • Provide a Vox Pupuli alternative to PDK

• Potential tools to include in the SDK

  • https://github.com/binford2k/binford2k-itemize
  • https://github.com/binford2k/puppet-function-updater
  • https://github.com/binford2k/denmark
  • https://github.com/binford2k/r10k-resolve
  • https://github.com/nwops/retrospec
  • https://github.com/nwops/puppet-retrospec
  • https://github.com/puppetlabs-toy-chest/pct
  • plugin(s) for version managers
    • https://mise.jdx.dev
    • https://asdf-vm.com
  • plugin(s) for templating systems
    • https://www.cookiecutter.io/
    • https://github.com/copier-org/copier