Create guide for distributed tests

[javaducky]

This is not a comprehensive guide for all available options of the operator. We'll be expanding documentation for the operator in a new section at a later time.

[github-actions]

There's a version of the docs published here:

https://mdr-ci.staging.k6.io/docs/refs/pull/1251/merge

It will be deleted automatically in 30 days.

[yorugac]

Thanks for putting this together, Paul!

For the "1st iteration" of the guide, I think it's pretty good: straight-forward and precise. I've only left a few small suggestions for improvements.

Overall, most noticeable is, of course, that not all options are being mentioned, e.g. LocalFile or cleanup. But probably adding everything here will make the guide quite unwieldy and hard to read through so it makes sense to keep it brief. I guess if at some point we could add a "k6-operator reference" page where we can keep a list of all supported options, that'd be a solution. OTOH, current Readme also contains things like "Multi-file tests" with k6 archive suggestion: a very common question which is neither a part of API reference nor part of a guide. More like a "howto" or "k6-operator tricks"... Either way, 👍 to have a guide for now 😄

[javaducky]

we could add a "k6-operator reference" page where we can keep a list of all supported options

Absolutely. My goal is to have an operator section similar to what is available for the xk6-disruptor. A goal will be to provide architecture information, a comprehensive listing of options, and very specific usage examples.

[javaducky]

@yorugac, I pushed some updates. Let me know what you think.

[yorugac]

@javaducky, after more reading I've found a couple of typos and possible improvement suggestions - please see the comments. The most funny part is likely the "Custom Resource" terminology: it seems to me that even Kubernetes docs can be seen as confusing on the topic...

[javaducky]

@yorugac, here are some more updates as we discussed.

[yorugac]

Subsections about PVC flow better now, IMHO. Though I wonder if we should pull volumes out completely as a separate guide some time and keep this guide simple, with only one "path of execution" via configmaps...

Overall, LGTM 🙌 Thanks for the updates!