Add runtime instructions

[grisu48]

Adds instructions for installing dependencies and optional environment variables that might help users.

[dcermak]

Suggested change

	# export OS_VERSION=15.6 # Target SLES version
	# export CONTAINER_RUNTIME=podman # Defaults to podman
	# export TARGET=ibs-cr # ibs-cr = ToTest, ibs = Released, obs = Tumbleweed
	$ export OS_VERSION=15.6 # Target SLES version
	$ export CONTAINER_RUNTIME=podman # Defaults to podman
	$ export TARGET=ibs-cr # ibs-cr = ToTest, ibs = SUSE:SLE-15-SP*:Update:BCI, obs = devel:BCI:*

[grisu48]

Thanks for the correction. I now also added factory-totest

[dcermak]

Maybe add a --user flag here?

Suggested change

	$ pip3 --quiet install --upgrade pip
	$ pip3 --quiet install tox --ignore-installed six
	$ pip3 --quiet install --user --upgrade pip
	$ pip3 --quiet install --user tox --ignore-installed six

[dirkmueller]

I think we should advertise installation of packages, or if that is unwanted for some reason, advertise the use of venvs instead of pip install globally (or as user which is also not possible on tumbleweed)

[grisu48]

I do like to advertise the use of venvs more than using the --user flag, so I added instructions to use a virtualenv.

By using the --user flag we need to explain that this will only work outside of virtualenvs and it's also not what we are using in our test flow in openQA, so I think that's not what we should document.

[dirkmueller]

actually I'd prefer if we wouldn't use the pip method in openQA either from a supply chain security perspective..

[grisu48]

Let's make this a meeting point on Tuesday, that requires more more engineering work especially on older versions (12-SP5) but if we want to do this, it should be possible.

For now I suggest we decouple this initiative from this PR, because that's not easy to solve and not worth waiting for IMHO.

[dirkmueller]

why not simply install python3-pip (or python311-pip) instead? seems simpler than this process imho.

[grisu48]

But python3-pip is installed just in the line before. This is there to update pip, which we do, but I'm not sure if that's really needed.

[dirkmueller]

It's not needed. but you should be installing python311 instead which is 3.11 rather than 3.6.

[grisu48]

This also needs to work on older versions, so this is the most generic version that will work at least on Leap and Tumbleweed.

If we advance to specifying python311 it will not work on Leap and require us to update the documentation every time there is a Leap release or Tumbleweed updates the major python version in use.

For the sake of making the document age better, I would stay with the generic version.

[dirkmueller]

I think this is great, but we should have a section for each environment variable explaining what it means? happy to help with this myself.

[grisu48]

I've added a separate block now, please check again if that matches what you meant.

[dirkmueller]

so is this supposed to be run inside the venv or outside? if it's inside the venv, you don't need to install python3-pip anymore, it is provided by the venv.

[grisu48]

True only if running in a venv. I phrased the previous block as optional so in cases where people run this outside a venv (for whatever reasons) it would still be needed.