puppetlabs / puppetlabs/puppet-resource_api
Create an example of a regular local resource
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 27
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
When getting started with the Resource API, examples help with understanding the new approach. Our only examples currently are for remote resources (hue, panos, ios, etc). To also show how local resources can be wrapped with the Resource API, we need an example without transport. Possible candidates are apt_key (see apt_key2 prototype for a start) and java_ks
Additional Context
This was originally filed as https://tickets.puppetlabs.com/browse/PDK-1130
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing remote-resource examples, then compare the apt_key2 prototype at lib/puppet/provider/apt_key2/apt_key2.rb and the java_ks type at lib/puppet/type/java_ks.rb. Done means adding an example of a regular local resource that uses the Resource API without transport.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100