microsoft / microsoft/AzureTRE
Enhance Documentation for Setting `resource_processor_number_processes_per_instance`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 235
- Forks
- 192
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 13
Description
Description
At present we can set the number of processes that are running on each resource processor instance, but there isn't any clear documentation on how to pick a "good" number for this.
The .env (and new .yaml config) sets this to a default of 5.
The code has a default of 1 if not config is set.
However, in neither location do we say how to set this value.
e.g.
- Is it OK to set this to 1?
- Is it OK to set this value to 10?
- Do the number of CPUs on an instance have some bearing on this value?
- What value ranges (if any) have we tested?
Some guidance (even if it's vague and simply says "set between X and Y") would be good.
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 locating the .env and new .yaml configuration documentation for resource_processor_number_processes_per_instance, then compare them with the code default of 1 and configured default of 5. Document how CPU count affects the setting, whether values such as 1 or 10 are supported, and any tested or recommended range.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100