Document Configuring Infra with Infra
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
Is your feature request related to a problem? Please describe.
Every Infra user needs to manage how Infra runs on nodes. We provide a series of resources for doing this, but zero documentation on how to do it. This is one of those key places where customers are falling over because we've never given guidance on a thing they need to actually use the product.
Describe the solution you'd like
Create a document that covers these topics:
- Setting up Infra Client to run on a schedule with one of the platform specific resources
- chef_client_systemd_timer
- chef_client_scheduled_task
- chef_client_cron
- chef_client_launcd
- Using the chef_client_config resource to push out configuration
- Using chef_client_trusted_certificate resource to push out new certs
- Using the /ohai directory in cookbooks to push out custom ohai plugins
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context or screenshots about the feature request here.
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 Infra documentation structure and the listed Infra Client resources: chef_client_systemd_timer, chef_client_scheduled_task, chef_client_cron, chef_client_launcd, chef_client_config, chef_client_trusted_certificate, and the /ohai cookbook directory. The documentation is done when it explains scheduling, configuration, trusted certificates, and custom Ohai plugins with usable examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100