Differential D398

adding initial sphinx docs project. Fixes T429
ClosedPublic
Actions

Authored by tflink on Jun 17 2015, 10:25 PM.

Details

Reviewers

roshi

Commits

rTCLOUD8182242541da: adding initial sphinx docs project ignoring conf.py for lint. Fixes T429

Summary

adds basic sphinx project to kick off better docs. readme still needs to be updated

Test Plan

none, docs build and work locally w/ firefox

Diff Detail

Repository

rTCLOUD testcloud

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 adding initial sphinx docs project. Fixes T429.Jun 17 2015, 10:25 PM

tflink updated this object.

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

tflink added a reviewer: roshi.

Herald added a subscriber: tflink. · View Herald TranscriptJun 17 2015, 10:25 PM

adding docs/source/conf.py to ignored files for flake8

Generated docs and diff look great. Thanks @tflink!

This revision is now accepted and ready to land.Jun 17 2015, 11:33 PM

Closed by commit rTCLOUD8182242541da: adding initial sphinx docs project ignoring conf.py for lint. Fixes T429 (authored by tflink). · Explain WhyJun 17 2015, 11:38 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents

		Path
A	M	docs/LICENSE (3 lines)
A	M	docs/Makefile (177 lines)
A	M	docs/source/api.rst (32 lines)
A	M	docs/source/conf.py (262 lines)
A	M	docs/source/indepth.rst (108 lines)
A	M	docs/source/index.rst (114 lines)
M		tox.ini (1 line)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	1054	05eb0cd		Jun 17 2015, 10:25 PM	★	★
Diff 2	1055	05eb0cd	- adding docs/source/conf.py to ignored files for flake8	Jun 17 2015, 10:46 PM	★	★
Diff 3	1057	d4ce225	Commit rTCLOUD8182242541da9580476aefb8eeccad9cc67505a3	Jun 17 2015, 11:37 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
8b7ca0cc90dd	c066b312db63	c144e586eaba	Tim Flink	adding docs/source/conf.py to ignored files for flake8	Jun 17 2015, 10:45 PM
c144e586eaba	52bd1a9e5134	05eb0cdd7f0e	Tim Flink	adding initial sphinx docs project. Fixes T429 (Show More…)	Jun 17 2015, 10:24 PM

Diff 1057

View Options

docs/LICENSE

This file was added.

		1		The documentation for testCloud contained in the docs/ directory is licensed
		2		under the Creative Commons Attribution 4.0 International License. To view a
		3		copy of this license, visit http://creativecommons.org/licenses/by/4.0/

View Options

docs/Makefile

This file was added.

		1		# Makefile for Sphinx documentation
		2		#
		3
		4		# You can set these variables from the command line.
		5		SPHINXOPTS =
		6		SPHINXBUILD = sphinx-build
		7		PAPER =
		8		BUILDDIR = build
		9
		10		# User-friendly check for sphinx-build
		11		ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
		12		$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
		13		endif
		14
		15		# Internal variables.
		16		PAPEROPT_a4 = -D latex_paper_size=a4
		17		PAPEROPT_letter = -D latex_paper_size=letter
		18		ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
		19		# the i18n builder cannot share the environment and doctrees with the others
		20		I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
		21
		22		.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
		23
		24		help:
		25		@echo "Please use \`make <target>' where <target> is one of"
		26		@echo " html to make standalone HTML files"
		27		@echo " dirhtml to make HTML files named index.html in directories"
		28		@echo " singlehtml to make a single large HTML file"
		29		@echo " pickle to make pickle files"
		30		@echo " json to make JSON files"
		31		@echo " htmlhelp to make HTML files and a HTML help project"
		32		@echo " qthelp to make HTML files and a qthelp project"
		33		@echo " devhelp to make HTML files and a Devhelp project"
		34		@echo " epub to make an epub"
		35		@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
		36		@echo " latexpdf to make LaTeX files and run them through pdflatex"
		37		@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
		38		@echo " text to make text files"
		39		@echo " man to make manual pages"
		40		@echo " texinfo to make Texinfo files"
		41		@echo " info to make Texinfo files and run them through makeinfo"
		42		@echo " gettext to make PO message catalogs"
		43		@echo " changes to make an overview of all changed/added/deprecated items"
		44		@echo " xml to make Docutils-native XML files"
		45		@echo " pseudoxml to make pseudoxml-XML files for display purposes"
		46		@echo " linkcheck to check all external links for integrity"
		47		@echo " doctest to run all doctests embedded in the documentation (if enabled)"
		48
		49		clean:
		50		rm -rf $(BUILDDIR)/*
		51
		52		html:
		53		$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
		54		@echo
		55		@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
		56
		57		dirhtml:
		58		$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
		59		@echo
		60		@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
		61
		62		singlehtml:
		63		$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
		64		@echo
		65		@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
		66
		67		pickle:
		68		$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
		69		@echo
		70		@echo "Build finished; now you can process the pickle files."
		71
		72		json:
		73		$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
		74		@echo
		75		@echo "Build finished; now you can process the JSON files."
		76
		77		htmlhelp:
		78		$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
		79		@echo
		80		@echo "Build finished; now you can run HTML Help Workshop with the" \
		81		".hhp project file in $(BUILDDIR)/htmlhelp."
		82
		83		qthelp:
		84		$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
		85		@echo
		86		@echo "Build finished; now you can run "qcollectiongenerator" with the" \
		87		".qhcp project file in $(BUILDDIR)/qthelp, like this:"
		88		@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/testCloud.qhcp"
		89		@echo "To view the help file:"
		90		@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/testCloud.qhc"
		91
		92		devhelp:
		93		$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
		94		@echo
		95		@echo "Build finished."
		96		@echo "To view the help file:"
		97		@echo "# mkdir -p $$HOME/.local/share/devhelp/testCloud"
		98		@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/testCloud"
		99		@echo "# devhelp"
		100
		101		epub:
		102		$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
		103		@echo
		104		@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
		105
		106		latex:
		107		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		108		@echo
		109		@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
		110		@echo "Run \`make' in that directory to run these through (pdf)latex" \
		111		"(use \`make latexpdf' here to do that automatically)."
		112
		113		latexpdf:
		114		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		115		@echo "Running LaTeX files through pdflatex..."
		116		$(MAKE) -C $(BUILDDIR)/latex all-pdf
		117		@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
		118
		119		latexpdfja:
		120		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		121		@echo "Running LaTeX files through platex and dvipdfmx..."
		122		$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
		123		@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
		124
		125		text:
		126		$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
		127		@echo
		128		@echo "Build finished. The text files are in $(BUILDDIR)/text."
		129
		130		man:
		131		$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
		132		@echo
		133		@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
		134
		135		texinfo:
		136		$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
		137		@echo
		138		@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
		139		@echo "Run \`make' in that directory to run these through makeinfo" \
		140		"(use \`make info' here to do that automatically)."
		141
		142		info:
		143		$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
		144		@echo "Running Texinfo files through makeinfo..."
		145		make -C $(BUILDDIR)/texinfo info
		146		@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
		147
		148		gettext:
		149		$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
		150		@echo
		151		@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
		152
		153		changes:
		154		$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
		155		@echo
		156		@echo "The overview file is in $(BUILDDIR)/changes."
		157
		158		linkcheck:
		159		$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
		160		@echo
		161		@echo "Link check complete; look for any errors in the above output " \
		162		"or in $(BUILDDIR)/linkcheck/output.txt."
		163
		164		doctest:
		165		$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
		166		@echo "Testing of doctests in the sources finished, look at the " \
		167		"results in $(BUILDDIR)/doctest/output.txt."
		168
		169		xml:
		170		$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
		171		@echo
		172		@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
		173
		174		pseudoxml:
		175		$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
		176		@echo
		177		@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

View Options

docs/source/api.rst

This file was added.

		1		.. This work is licensed under the Creative Commons Attribution 4.0
		2		International License. To view a copy of this license, visit
		3		http://creativecommons.org/licenses/by/4.0/.
		4
		5		================
		6		testCloud API
		7		================
		8
		9
		10		instance
		11		========
		12
		13		.. automodule:: testCloud.instance
		14		:members:
		15
		16		image
		17		=====
		18
		19		.. automodule:: testCloud.image
		20		:members:
		21
		22		util
		23		====
		24
		25		.. automodule:: testCloud.util
		26		:members:
		27
		28		cli
		29		====
		30
		31		.. automodule:: testCloud.cli
		32		:members:

View Options

docs/source/conf.py

This file was added.

		1		# -- coding: utf-8 --
		2		#
		3		# testCloud documentation build configuration file, created by
		4		# sphinx-quickstart on Wed May 20 14:59:21 2015.
		5		#
		6		# This file is execfile()d with the current directory set to its
		7		# containing dir.
		8		#
		9		# Note that not all possible configuration values are present in this
		10		# autogenerated file.
		11		#
		12		# All configuration values have a default; values that are commented out
		13		# serve to show the default.
		14
		15		import sys
		16		import os
		17
		18		# If extensions (or modules to document with autodoc) are in another directory,
		19		# add these directories to sys.path here. If the directory is relative to the
		20		# documentation root, use os.path.abspath to make it absolute, like shown here.
		21		sys.path.insert(0, os.path.abspath('../../'))
		22
		23		# -- General configuration ------------------------------------------------
		24
		25		# If your documentation needs a minimal Sphinx version, state it here.
		26		#needs_sphinx = '1.0'
		27
		28		# Add any Sphinx extension module names here, as strings. They can be
		29		# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
		30		# ones.
		31		extensions = [
		32		'sphinx.ext.autodoc',
		33		'sphinx.ext.todo',
		34		'sphinx.ext.viewcode',
		35		]
		36
		37		# Add any paths that contain templates here, relative to this directory.
		38		templates_path = ['_templates']
		39
		40		# The suffix of source filenames.
		41		source_suffix = '.rst'
		42
		43		# The encoding of source files.
		44		#source_encoding = 'utf-8-sig'
		45
		46		# The master toctree document.
		47		master_doc = 'index'
		48
		49		# General information about the project.
		50		project = u'testCloud'
		51		copyright = u'2015, testCloud devs'
		52
		53		# The version info for the project you're documenting, acts as replacement for
		54		# \|version\| and \|release\|, also used in various other places throughout the
		55		# built documents.
		56		#
		57		# The short X.Y version.
		58		version = '0.0.1'
		59		# The full version, including alpha/beta/rc tags.
		60		release = '0.0.1'
		61
		62		# The language for content autogenerated by Sphinx. Refer to documentation
		63		# for a list of supported languages.
		64		#language = None
		65
		66		# There are two options for replacing \|today\|: either, you set today to some
		67		# non-false value, then it is used:
		68		#today = ''
		69		# Else, today_fmt is used as the format for a strftime call.
		70		#today_fmt = '%B %d, %Y'
		71
		72		# List of patterns, relative to source directory, that match files and
		73		# directories to ignore when looking for source files.
		74		exclude_patterns = []
		75
		76		# The reST default role (used for this markup: `text`) to use for all
		77		# documents.
		78		#default_role = None
		79
		80		# If true, '()' will be appended to :func: etc. cross-reference text.
		81		#add_function_parentheses = True
		82
		83		# If true, the current module name will be prepended to all description
		84		# unit titles (such as .. function::).
		85		#add_module_names = True
		86
		87		# If true, sectionauthor and moduleauthor directives will be shown in the
		88		# output. They are ignored by default.
		89		#show_authors = False
		90
		91		# The name of the Pygments (syntax highlighting) style to use.
		92		pygments_style = 'sphinx'
		93
		94		# A list of ignored prefixes for module index sorting.
		95		#modindex_common_prefix = []
		96
		97		# If true, keep warnings as "system message" paragraphs in the built documents.
		98		#keep_warnings = False
		99
		100
		101		# -- Options for HTML output ----------------------------------------------
		102
		103		# The theme to use for HTML and HTML Help pages. See the documentation for
		104		# a list of builtin themes.
		105		html_theme = 'nature'
		106
		107		# Theme options are theme-specific and customize the look and feel of a theme
		108		# further. For a list of options available for each theme, see the
		109		# documentation.
		110		#html_theme_options = {}
		111
		112		# Add any paths that contain custom themes here, relative to this directory.
		113		#html_theme_path = []
		114
		115		# The name for this set of Sphinx documents. If None, it defaults to
		116		# "<project> v<release> documentation".
		117		#html_title = None
		118
		119		# A shorter title for the navigation bar. Default is the same as html_title.
		120		#html_short_title = None
		121
		122		# The name of an image file (relative to this directory) to place at the top
		123		# of the sidebar.
		124		#html_logo = None
		125
		126		# The name of an image file (within the static path) to use as favicon of the
		127		# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
		128		# pixels large.
		129		#html_favicon = None
		130
		131		# Add any paths that contain custom static files (such as style sheets) here,
		132		# relative to this directory. They are copied after the builtin static files,
		133		# so a file named "default.css" will overwrite the builtin "default.css".
		134		html_static_path = ['_static']
		135
		136		# Add any extra paths that contain custom files (such as robots.txt or
		137		# .htaccess) here, relative to this directory. These files are copied
		138		# directly to the root of the documentation.
		139		#html_extra_path = []
		140
		141		# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
		142		# using the given strftime format.
		143		#html_last_updated_fmt = '%b %d, %Y'
		144
		145		# If true, SmartyPants will be used to convert quotes and dashes to
		146		# typographically correct entities.
		147		#html_use_smartypants = True
		148
		149		# Custom sidebar templates, maps document names to template names.
		150		#html_sidebars = {}
		151
		152		# Additional templates that should be rendered to pages, maps page names to
		153		# template names.
		154		#html_additional_pages = {}
		155
		156		# If false, no module index is generated.
		157		#html_domain_indices = True
		158
		159		# If false, no index is generated.
		160		#html_use_index = True
		161
		162		# If true, the index is split into individual pages for each letter.
		163		#html_split_index = False
		164
		165		# If true, links to the reST sources are added to the pages.
		166		#html_show_sourcelink = True
		167
		168		# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
		169		#html_show_sphinx = True
		170
		171		# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
		172		#html_show_copyright = True
		173
		174		# If true, an OpenSearch description file will be output, and all pages will
		175		# contain a <link> tag referring to it. The value of this option must be the
		176		# base URL from which the finished HTML is served.
		177		#html_use_opensearch = ''
		178
		179		# This is the file name suffix for HTML files (e.g. ".xhtml").
		180		#html_file_suffix = None
		181
		182		# Output file base name for HTML help builder.
		183		htmlhelp_basename = 'testClouddoc'
		184
		185
		186		# -- Options for LaTeX output ---------------------------------------------
		187
		188		latex_elements = {
		189		# The paper size ('letterpaper' or 'a4paper').
		190		#'papersize': 'letterpaper',
		191
		192		# The font size ('10pt', '11pt' or '12pt').
		193		#'pointsize': '10pt',
		194
		195		# Additional stuff for the LaTeX preamble.
		196		#'preamble': '',
		197		}
		198
		199		# Grouping the document tree into LaTeX files. List of tuples
		200		# (source start file, target name, title,
		201		# author, documentclass [howto, manual, or own class]).
		202		latex_documents = [
		203		('index', 'testCloud.tex', u'testCloud Documentation',
		204		u'testCloud devs', 'manual'),
		205		]
		206
		207		# The name of an image file (relative to this directory) to place at the top of
		208		# the title page.
		209		#latex_logo = None
		210
		211		# For "manual" documents, if this is true, then toplevel headings are parts,
		212		# not chapters.
		213		#latex_use_parts = False
		214
		215		# If true, show page references after internal links.
		216		#latex_show_pagerefs = False
		217
		218		# If true, show URL addresses after external links.
		219		#latex_show_urls = False
		220
		221		# Documents to append as an appendix to all manuals.
		222		#latex_appendices = []
		223
		224		# If false, no module index is generated.
		225		#latex_domain_indices = True
		226
		227
		228		# -- Options for manual page output ---------------------------------------
		229
		230		# One entry per manual page. List of tuples
		231		# (source start file, name, description, authors, manual section).
		232		man_pages = [
		233		('index', 'testcloud', u'testCloud Documentation',
		234		[u'testCloud devs'], 1)
		235		]
		236
		237		# If true, show URL addresses after external links.
		238		#man_show_urls = False
		239
		240
		241		# -- Options for Texinfo output -------------------------------------------
		242
		243		# Grouping the document tree into Texinfo files. List of tuples
		244		# (source start file, target name, title, author,
		245		# dir menu entry, description, category)
		246		texinfo_documents = [
		247		('index', 'testCloud', u'testCloud Documentation',
		248		u'testCloud devs', 'testCloud', 'One line description of project.',
		249		'Miscellaneous'),
		250		]
		251
		252		# Documents to append as an appendix to all manuals.
		253		#texinfo_appendices = []
		254
		255		# If false, no module index is generated.
		256		#texinfo_domain_indices = True
		257
		258		# How to display URL addresses: 'footnote', 'no', or 'inline'.
		259		#texinfo_show_urls = 'footnote'
		260
		261		# If true, do not generate a @detailmenu in the "Top" node's menu.
		262		#texinfo_no_detailmenu = False

View Options

docs/source/indepth.rst

This file was added.

		1		.. This work is licensed under the Creative Commons Attribution 4.0
		2		International License. To view a copy of this license, visit
		3		http://creativecommons.org/licenses/by/4.0/.
		4
		5		===================
		6		testCloud, in Depth
		7		===================
		8
		9		The best way to understand exactly what testCloud is doing is to read through
		10		the code but the following is a more human-comprehension-friendly method of
		11		describing many of the details regarding how testCloud works.
		12
		13
		14		Instances and Images
		15		====================
		16
		17		Two of the more important higher-level concepts in testCloud are what we refer
		18		to as Instances and Images.
		19
		20		testcloud Image
		21		---------------
		22
		23		At this point, testCloud only supports qcow2 cloud images made from relatively
		24		recent Fedora releases. There are plans to support more distros and more image
		25		types in the future.
		26
		27		The image is representation of a cloud image, where it was downloaded from, how
		28		to download the image and where it lives on the local filesystem. At this time,
		29		images are assumed to already be downloaded if another image sharing the exact
		30		same filename already exists - not the most resilient method ever conceived but
		31		it does work in most cases.
		32
		33		testCloud Instance
		34		------------------
		35
		36		A reasonable description of a testCloud instance is that it is a cloud image
		37		backed virtual machine. This virtual machine can be created, stopped, started
		38		or destroyed using the CLI interface from testCloud.
		39
		40		testCloud instances make heavy use of `libvirt <http://libvirt.org/>`_ and
		41		virt-install, part of the `virt-manager <http://virt-manager.org/>`_ application.
		42
		43		General Process
		44		===============
		45
		46		Each instance has its own directory in the ``DATA_DIR`` and the tuple of
		47		(``INSTANCE_NAME``. ``IMAGE_FILENAME``) is considered to be unique. This method
		48		of delineating unique instances isn't perfect (should probably use image hash
		49		instead of filename) but it works well enough for now
		50
		51
		52		Directories and Files
		53		=====================
		54
		55		Globally, testCloud requires a few directories for storing images and instance
		56		metadata.
		57
		58		``/var/lib/testCloud/``
		59		testCloud stores its data in here
		60
		61		``/var/lib/testCloud/cache``
		62		default location for cached images
		63
		64		``/var/lib/testCloud/instances``
		65		every instance has a unique directory, stored in here
		66
		67
		68		Outside of the global directories, each instance has a directory (sharing the
		69		instance name) inside ``/var/lib/testCloud/instances/``.
		70
		71
		72		``/var/lib/testCloud/instances/<instancename>/``
		73		Directory to hold instance-specific data
		74
		75		``/var/lib/testCloud/instances/<instancename>/<instancename>-base.qcow2``
		76		copy-on-write image used as a backing store for the instance - this doesn't
		77		store the entire image - just the changes made from the base image the instance
		78		has been booted from
		79
		80		``/var/lib/testCloud/instances/<instancename>/<instancename>-seed.img``
		81		image holding cloud-init source data used on boot
		82
		83		``/var/lib/testCloud/instances/<instancename>/meta/``
		84		directory containing data from which the ``<instancename>-seed.img`` is built
		85
		86		``/var/lib/testCloud/instances/<instancename>/meta/meta-data``
		87		raw meta-data for cloud-init
		88
		89		``/var/lib/testCloud/instances/<instancename>/meta/user-data``
		90		raw user-data for cloud-init
		91
		92
		93		Booting Instances
		94		=================
		95
		96		The creation process for a testCloud instance roughly follows this process:
		97
		98		* download the referenced image, if it doesn't already exist in cache
		99
		100		* create an instance directory for the new instance, if an instance with the
		101		same name already exists, quit with an error
		102
		103		* create cloud-init metadata and the qcow2 backing store for the instance
		104
		105		* use ``virt-install`` to create a new virtual machine, using the backing store
		106		and the cloud-init ``seed.img`` as data stores.
		107
		108		Once the instance is booted, it can be stopped, started again or deleted.

View Options

docs/source/index.rst

This file was added.

		1		.. testCloud documentation master file, created by
		2		sphinx-quickstart on Wed May 20 14:59:21 2015.
		3
		4		.. This work is licensed under the Creative Commons Attribution 4.0
		5		International License. To view a copy of this license, visit
		6		http://creativecommons.org/licenses/by/4.0/.
		7
		8		==================================================
		9		testCloud - the best pretend cloud you'll ever use
		10		==================================================
		11
		12		testCloud is a relatively simple system which is capable of booting images
		13		designed for cloud systems on a local system with minimial configuration.
		14		testCloud is desiged to be (and remain) somewhat simple, trading fancy cloud
		15		system features for ease of use and sanity in development.
		16
		17
		18		Installing testCloud
		19		====================
		20
		21		The easiest way to install and use testCloud is to install the package from
		22		`the testCloud COPR <https://copr.fedoraproject.org/coprs/roshi/testCloud/>`_::
		23
		24		dnf enable roshi/testCloud
		25		dnf install testCloud
		26
		27
		28		Using testCloud
		29		===============
		30
		31		The main testCloud interface uses the terminal and the binary named
		32		``testcloud``. testCloud operations can be split into two major categories:
		33		image commands and instance commands.
		34
		35		Image Commands
		36		--------------
		37
		38		``testcloud image list``
		39		List all of the images currently cached by testCloud
		40
		41		``testcloud image destroy <image name>``
		42		Remove the image named ``<image name>`` from the local image cache. Make sure
		43		to replace ``<image name>`` with the name of an image which is currently
		44		cached.
		45
		46		Instance Commands
		47		-----------------
		48
		49		``testcloud instance list``
		50		List all of the instances currently running and spawned by testCloud. Adding
		51		the ``--all`` flag will list all instances spawned by testCloud whether the
		52		instance is currently running or not
		53
		54
		55		``testcloud instance create <instance name> -u <image url>``
		56		Create a new testCloud instance using the name ``<instance name>`` and the
		57		image stored at the url ``<image url>``. Currently supported image url types
		58		are ``http(s)://`` and ``file://``. Run ``testcloud instance create --help``
		59		for information on other options for image creation.
		60
		61
		62		``testcloud instance stop <instance name>``
		63		Stop the instance with name ``<instance name>``
		64
		65		``testcloud instance start <instance name>``
		66		Start the instance with name ``<instance name>``
		67
		68		``testcloud instance destroy <instance name>``
		69		Destroy the instance with name ``<instance name>``. This command will fail if
		70		the instance is not currently stopped
		71
		72
		73		Getting Help
		74		============
		75
		76		Self service methods for asking questions and filing tickets:
		77
		78		* `Source Repository <https://github.com/Rorosha/testCloud>`_
		79
		80		* `Currently Open Issues <https://phab.qadevel.cloud.fedoraproject.org/tag/testcloud/>`_
		81
		82		For other questions, the best places to ask are:
		83
		84		* `The #fedora-qa IRC channel on Freenode <http://webchat.freenode.net/?channels=#fedora-qa>`_
		85
		86		* `The qa-devel mailing list <https://admin.fedoraproject.org/mailman/listinfo/qa-devel>`_
		87
		88		Licenses
		89		========
		90
		91		The testCloud library is licensed as `GNU General Public Licence v2.0 or later
		92		<http://spdx.org/licenses/GPL-2.0+>`_.
		93
		94		The documentation for testCloud is licensed under a `Creative Commons
		95		Atribution-ShareAlike 4.0 International License <https://creativecommons.org/licenses/by-sa/4.0/>`_.
		96
		97
		98		Other Documentation
		99		===================
		100
		101		.. toctree::
		102		:maxdepth: 2
		103
		104		indepth
		105		api
		106
		107		==================
		108		Indices and tables
		109		==================
		110
		111		* :ref:`genindex`
		112		* :ref:`modindex`
		113		* :ref:`search`
		114

View Options

tox.ini

1	[flake8]	1	[flake8]
2	max-line-length = 99	2	max-line-length = 99
		3	exclude = conf/*,docs/source/conf.py

adding initial sphinx docs project. Fixes T429ClosedPublicActions

Details

Diff Detail

Revision Contents

Diff 1057

docs/LICENSE

docs/Makefile

docs/source/api.rst

docs/source/conf.py

docs/source/indepth.rst

docs/source/index.rst

tox.ini

adding initial sphinx docs project. Fixes T429
ClosedPublic
Actions