Make warning about using performance tuning more explicit

[gdubicki]

partially fixes #2017

[scylla-operator-bot]

Hi @gdubicki. Thanks for your PR.

I'm waiting for a scylladb member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[tnozicka]

I think a general :::note to say that you should try performance tuning first on your staging cluster is ok, although that should be done for every change with any software when you care about your production availability. I'd avoid docs content based on issues that have just been opened / the colored wording

[tnozicka]

referencing one open issue that has not yet been even triaged, doesn't fit a general claim made here (were cases)

[gdubicki]

On second thought, I agree with you, @tnozicka. I was a bit emotional when I wrote this as I had spent most of the weekend fixing our cluster…

Can you just please reword the warning in this PR as you see fit?

[tnozicka]

np, how about something like this:

:::{note}
We recommend that you first try out the performance tuning on a pre-production instance.
Given the nature of the underlying tuning script, undoing the changes requires rebooting the Kubernetes node(s).
:::

[tnozicka]

/ok-to-test

[gdubicki]

I changed the wording to yours, but I feel that as a plain note it will not work as intended. The warning type is required in my opinion to make it stand out enough. Wdyt, @tnozicka?

[tnozicka]

/approve
/lgtm
thanks

[scylla-operator-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gdubicki, tnozicka

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [tnozicka]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[tnozicka]

/hold
please squash the commits

[gdubicki]

/hold please squash the commits

Sure, done! 😊

[tnozicka]

/lgtm
thanks