Updating docs with information on using VMs. Fixes T680
ClosedPublic
Actions

Authored by tflink on Jan 14 2016, 10:11 PM.

Details

Reviewers

kparal
mkrizek
jskladan

Maniphest Tasks

T678: update libtaskotron quickstart with details about vm and no-vm execution

Commits

rLTRNe8d48a3fe91f: Updating docs with information on using VMs. Fixes T678

Summary

Adding simple information on using VMs with runtask

Test Plan

look at docs to make sure information is accurate and they render properly

Diff Detail

Repository

rLTRN libtaskotron

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

tflink retitled this revision from to Updating docs with information on using VMs. Fixes T680.Jan 14 2016, 10:11 PM

tflink updated this object.

tflink edited the test plan for this revision. (Show Details)

tflink added reviewers: mkrizek, kparal, jskladan.

Bah, I managed to use the wrong ticket in the commit message. Will fix when squashing and pushing to develop

LGTM, one minor nit though

docs/source/index.rst
120	I think we should mention the `--local` option somewhere which might be confusing for some.

This revision is now accepted and ready to land.Jan 15 2016, 9:49 AM

docs/source/index.rst
120	Do you think that it needs to be mentioned on the main page if the default execution mode is local if not in production?

docs/source/index.rst
107	Maybe "using virtual machines or remote machines"?
111	"virtual/remote"?
112	"single use (disposable)"? Because we use that terminology elsewhere.
114	Here I'd swap "virtual" for "remote".
118	And here I'd just use "disposable virtual machine".

docs/source/index.rst
120	OK, I take that back, for some reason I thought there is some hidden black magic behind --local, there isn't.

slight changes in terminology

Looks good.

Closed by commit rLTRNe8d48a3fe91f: Updating docs with information on using VMs. Fixes T678 (authored by tflink). · Explain WhyJan 22 2016, 11:29 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents

			Path	Packages
M			docs/source/index.rst (15 lines)
M			docs/source/quickstart.rst (11 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	1861	b170ace		Jan 14 2016, 10:11 PM	★	★
Diff 2	1869	b170ace	- slight changes in terminology	Jan 20 2016, 6:04 PM	★	★
Diff 3	1880	52cb048	Commit rLTRNe8d48a3fe91f1e5bc980c333d2e68c76a026381a	Jan 22 2016, 11:24 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
6a8472ab141b	53bb1bda4f9c	adb19ced0071	Tim Flink	slight changes in terminology	Jan 20 2016, 6:04 PM
adb19ced0071	dcc3b27a6ce8	b170acea27f7	Tim Flink	Updating docs with information on using VMs. Fixes T680 (Show More…)	Jan 14 2016, 10:10 PM

Diff 1880

View Options

docs/source/index.rst

Show First 20 Lines • Show All 98 Lines • ▼ Show 20 Line(s)
99	Rpmlint runs off of koji builds, so to run it against the x86_64 build of	99		Rpmlint runs off of koji builds, so to run it against the x86_64 build of
100	``foo-1.2-3.fc99`` (substitute a real build if you're going to run this)::	100		``foo-1.2-3.fc99`` (substitute a real build if you're going to run this)::
101		101
102	runtask -i foo-1.2-3.fc99 -t koji_build -a x86_64 rpmlint.yml	102		runtask -i foo-1.2-3.fc99 -t koji_build -a x86_64 rpmlint.yml
103		103
104	The build will be downloaded to a local tempdir, rpmlint will be run against	104		The build will be downloaded to a local tempdir, rpmlint will be run against
105	that build and the results will be printed to the console in :ref:`resultyaml-format`.	105		that build and the results will be printed to the console in :ref:`resultyaml-format`.
106		106
		107		Using Remote Machines
			kparalUnsubmitted Not Done Maybe "using virtual machines or remote machines"?
		108		----------------------
		109
		110		While the default execution path will run tasks on a local machine, it is also
		111		possible to delegate task execution to a remote machine or spawn a disposable
			kparalUnsubmitted Not Done "virtual/remote"?
		112		virtual machine for task execution.
			kparalUnsubmitted Not Done "single use (disposable)"? Because we use that terminology elsewhere.
		113
		114		To use a remote machine, use the ``--ssh <user>@<ip address>[:port]`` argument
			kparalUnsubmitted Not Done Here I'd swap "virtual" for "remote".
		115		to runtask. This will signal the executor to connect to the indicated machine
		116		and execute tasks there instead of locally.
		117
		118		To use a disposable client vm, use ``--libvirt`` but note that the image
			kparalUnsubmitted Not Done And here I'd just use "disposable virtual machine".
		119		available by default is very generic and this can add significantly to
		120		execution time.
			mkrizekUnsubmitted Not Done I think we should mention the `--local` option somewhere which might be confusing for some.
			tflinkAuthorUnsubmitted Not Done Do you think that it needs to be mentioned on the main page if the default execution mode is local if not in production?
			mkrizekUnsubmitted Not Done OK, I take that back, for some reason I thought there is some hidden black magic behind --local, there isn't.
		121
107		122
108	.. _contact-us:	123		.. _contact-us:
109		124
110	Contact Us	125		Contact Us
111	==========	126		==========
112	Please direct questions and comments to either the `Fedora QA Devel List	127		Please direct questions and comments to either the `Fedora QA Devel List
113	<https://admin.fedoraproject.org/mailman/listinfo/qa-devel>`_ or the #fedora-qa	128		<https://admin.fedoraproject.org/mailman/listinfo/qa-devel>`_ or the #fedora-qa
114	IRC channel on `Freenode <http://freenode.net/>`_.	129		IRC channel on `Freenode <http://freenode.net/>`_.
Show All 12 Lines