robusta icon indicating copy to clipboard operation
robusta copied to clipboard

Hierarchy for robusta playbooks

Open kranurag7 opened this issue 3 years ago • 5 comments
trafficstars

  • As of now all the robusta playbooks are within one single folder
  • We are intending to add many more playbooks in the future Reference.
  • We need to set up the hierarchy either based on k8s resources or based on different categories.

kranurag7 avatar Feb 26 '22 21:02 kranurag7

+1

@arikalon1 any thoughts on how we should organize them?

aantn avatar Feb 26 '22 21:02 aantn

Can we organize playbooks in separated playbook repos? Will that be good enough?

arikalon1 avatar Feb 27 '22 08:02 arikalon1

I'm not sure. I'm in favor of keeping most of the playbooks in the current repo so using them is smoother and we can release them alongside Robusta versions.

However, we already have 30 or so files in the robusta_playbooks directory. In the docs we're organizing them by category, but in the source code we're not.

For me it's easy to find what I'm looking for because I wrote it and know where to look. For new contributors I think it's probably much harder.

aantn avatar Feb 27 '22 08:02 aantn

I agree with @aantn in this case. For new contributors it's tough to find. Also in future if we will get more actions live then it will be easy to document and if we maintain a hierarchy then filtering out will be smooth as well.

kranurag7 avatar Feb 27 '22 12:02 kranurag7

ok. So splitting the playbooks into logical categories, where each category is a folder? What categories would you choose?

arikalon1 avatar Feb 27 '22 18:02 arikalon1

It's been two years, so closing this. We're OK keeping the current organization for now.

aantn avatar Feb 14 '24 17:02 aantn