[docs]defblueprints_freeze_show(socket_path,api_version,args,show_json=False):"""Show the frozen blueprint in TOML format
@@ -512,7 +500,7 @@
api_route=client.api_url(api_version,"/blueprints/tag/%s"%args[0])result=client.post_url(socket_path,api_route,"")
- returnhandle_api_result(result,show_json)
+ returnhandle_api_result(result,show_json)[0]
[docs]defblueprints_undo(socket_path,api_version,args,show_json=False):"""Undo changes to a blueprint
@@ -538,7 +526,7 @@
api_route=client.api_url(api_version,"/blueprints/undo/%s/%s"%(args[0],args[1]))result=client.post_url(socket_path,api_route,"")
- returnhandle_api_result(result,show_json)
+ returnhandle_api_result(result,show_json)[0]
[docs]defblueprints_workspace(socket_path,api_version,args,show_json=False):"""Push the blueprint TOML to the temporary workspace storage
@@ -563,14 +551,7 @@
blueprint_toml=open(blueprint,"r").read()result=client.post_url_toml(socket_path,api_route,blueprint_toml)
- ifshow_json:
- print(json.dumps(result,indent=4))
-
- forerrinresult.get("errors",[]):
- log.error(err)
-
- # Any errors results in returning a 1, but we continue with the rest first
- ifnotresult.get("status",False):
+ ifhandle_api_result(result,show_json)[0]:rval=1returnrval
[docs]defcompose_status(socket_path,api_version,args,show_json=False,testmode=0):"""Return the status of all known composes
@@ -131,7 +177,10 @@
"version":compose["version"],"compose_type":compose["compose_type"],"image_size":compose["image_size"],
- "status":compose["queue_status"]}
+ "status":compose["queue_status"],
+ "created":compose.get("job_created"),
+ "started":compose.get("job_started"),
+ "finished":compose.get("job_finished")}# Sort the status in a specific orderdefsort_status(a):
@@ -169,8 +218,10 @@
else:image_size=""
- print("%s%-8s%-15s%s%-16s%s"%(c["id"],c["status"],c["blueprint"],c["version"],c["compose_type"],
- image_size))
+ dt=datetime.fromtimestamp(c.get("finished")orc.get("started")orc.get("created"))
+
+ print("%s%-8s%s%-15s%s%-16s%s"%(c["id"],c["status"],dt.strftime("%c"),c["blueprint"],
+ c["version"],c["compose_type"],image_size))
[docs]defcompose_start(socket_path,api_version,args,show_json=False,testmode=0):"""Start a new compose using the selected blueprint and type
@@ -232,19 +283,12 @@
test_url=""api_route=client.api_url(api_version,"/compose"+test_url)result=client.post_url_json(socket_path,api_route,json.dumps(config))
-
- ifshow_json:
- print(json.dumps(result,indent=4))
- return0
-
- forerrinresult.get("errors",[]):
- log.error(err)
-
- ifresult["status"]==Falseorresult.get("errors",False):
- return1
+ (rc,exit_now)=handle_api_result(result,show_json)
+ ifexit_now:
+ returnrcprint("Compose %s added to the queue"%result["build_id"])
- return0
+ returnrc
[docs]defcompose_log(socket_path,api_version,args,show_json=False,testmode=0):"""Show the last part of the compose log
@@ -311,7 +355,7 @@
api_route=client.api_url(api_version,"/compose/cancel/%s"%args[0])result=client.delete_url_json(socket_path,api_route)
- returnhandle_api_result(result,show_json)
+ returnhandle_api_result(result,show_json)[0]
+#
+# Copyright (C) 2018 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+importlogging
+log=logging.getLogger("composer-cli")
+
+fromcomposerimporthttp_clientasclient
+fromcomposer.cli.helpimportstatus_help
+fromcomposer.cli.utilitiesimporthandle_api_result
+
+
@@ -110,17 +110,28 @@
:param result: JSON result from the http query :type result: dict
+ :rtype: tuple
+ :returns: (rc, should_exit_now)
+
+ Return the correct rc for the program (0 or 1), and whether or
+ not to continue processing the results. """ifshow_json:print(json.dumps(result,indent=4))
-
- forerrinresult.get("errors",[]):
- log.error(err)
-
- ifresult["status"]==True:
- return0else:
- return1
+ forerrinresult.get("errors",[]):
+ log.error(err["msg"])
+
+ # What's the rc? If status is present, use that
+ # If not, use length of errors
+ if"status"inresult:
+ rc=bool(notresult["status"])
+ else:
+ rc=bool(len(result.get("errors",[]))>0)
+
+ # Caller should return if showing json, or status was present and False
+ exit_now=show_jsonor("status"inresultandrc)
+ return(rc,exit_now)
[docs]defpackageNEVRA(pkg):"""Return the package info as a NEVRA
@@ -167,7 +178,7 @@
[docs]defappend_query(url,query):
+ """Add a query argument to a URL
+
+ The query should be of the form "param1=what¶m2=ever", i.e., no
+ leading '?'. The new query data will be appended to any existing
+ query string.
+
+ :param url: The original URL
+ :type url: str
+ :param query: The query to append
+ :type query: str
+ :returns: The new URL with the query argument included
+ :rtype: str
+ """
+
+ url_parts=urlparse(url)
+ ifurl_parts.query:
+ new_query=url_parts.query+"&"+query
+ else:
+ new_query=query
+ returnurlunparse([url_parts[0],url_parts[1],url_parts[2],
+ url_parts[3],new_query,url_parts[5]])
+
[docs]defget_url_raw(socket_path,url):"""Return the raw results of a GET request
@@ -101,7 +125,8 @@
ifr.status==400:err=json.loads(r.data.decode("utf-8"))if"status"inerranderr["status"]==False:
- raiseRuntimeError(", ".join(err["errors"]))
+ msgs=[e["msg"]foreinerr["errors"]]
+ raiseRuntimeError(", ".join(msgs))returnr.data.decode('utf-8')
[docs]defget_url_json_unlimited(socket_path,url):
+ """Return the JSON results of a GET request
+
+ For URLs that use offset/limit arguments, this command will
+ fetch all results for the given request.
+
+ :param socket_path: Path to the Unix socket to use for API communication
+ :type socket_path: str
+ :param url: URL to request
+ :type url: str
+ :returns: The json response from the server
+ :rtype: dict
+ """
+ http=UnixHTTPConnectionPool(socket_path)
+
+ # Start with limit=0 to just get the number of objects
+ total_url=append_query(url,"limit=0")
+ r_total=http.request("GET",total_url)
+ json_total=json.loads(r_total.data.decode('utf-8'))
+
+ # Add the "total" returned by limit=0 as the new limit
+ unlimited_url=append_query(url,"limit=%d"%json_total["total"])
+ r_unlimited=http.request("GET",unlimited_url)
+ returnjson.loads(r_unlimited.data.decode('utf-8'))
+
[docs]defdelete_url_json(socket_path,url):"""Send a DELETE request to the url and return JSON response
@@ -223,7 +273,8 @@
ifr.status==400:err=json.loads(r.data.decode("utf-8"))ifnoterr["status"]:
- raiseRuntimeError(", ".join(err["errors"]))
+ msgs=[e["msg"]foreinerr["errors"]]
+ raiseRuntimeError(", ".join(msgs))filename=get_filename(r.headers)ifos.path.exists(filename):
@@ -283,7 +334,7 @@
+#
+# Copyright (C) 2018 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+importlogging
+log=logging.getLogger("lorax-composer")
+
+fromflaskimportjsonify
+fromfunctoolsimportupdate_wrapper
+
+# A decorator for checking the parameters provided to the API route implementing
+# functions. The tuples parameter is a list of tuples. Each tuple is the string
+# name of a parameter ("blueprint_name", not blueprint_name), the value it's set
+# to by flask if the caller did not provide it, and a message to be returned to
+# the user.
+#
+# If the parameter is set to its default, the error message is returned. Otherwise,
+# the decorated function is called and its return value is returned.
+
[docs]deftest_templates(yb,share_dir):
+ """ Try depsolving each of the the templates and report any errors
+
+ :param yb: yum base object
+ :type yb: YumBase
+ :returns: List of template types and errors
+ :rtype: List of errors
+
+ Return a list of templates and errors encountered or an empty list
+ """
+ template_errors=[]
+ forcompose_typeincompose_types(share_dir):
+ # Read the kickstart template for this type
+ ks_template_path=joinpaths(share_dir,"composer",compose_type)+".ks"
+ ks_template=open(ks_template_path,"r").read()
+
+ # How much space will the packages in the default template take?
+ ks_version=makeVersion(RHEL7)
+ ks=KickstartParser(ks_version,errorsAreFatal=False,missingIncludeIsFatal=False)
+ ks.readKickstartFromString(ks_template+"\n%end\n")
+ pkgs=[(name,"*")fornameinks.handler.packages.packageList]
+ grps=[grp.nameforgrpinks.handler.packages.groupList]
+ try:
+ _=projects_depsolve(yb,pkgs,grps)
+ exceptProjectsErrorase:
+ template_errors.append("Error depsolving %s: %s"%(compose_type,str(e)))
+
+ returntemplate_errors
+
[docs]defrepo_to_ks(r,url="url"):""" Return a kickstart line with the correct args.
@@ -289,7 +319,7 @@
deps=[]try:withyumlock.lock:
- (installed_size,deps)=projects_depsolve_with_size(yumlock.yb,projects,with_core=False)
+ (installed_size,deps)=projects_depsolve_with_size(yumlock.yb,projects,recipe.group_names,with_core=False)exceptProjectsErrorase:log.error("start_build depsolve: %s",str(e))raiseRuntimeError("Problem depsolving %s: %s"%(recipe["name"],str(e)))
@@ -303,9 +333,10 @@
ks=KickstartParser(ks_version,errorsAreFatal=False,missingIncludeIsFatal=False)ks.readKickstartFromString(ks_template+"\n%end\n")pkgs=[(name,"*")fornameinks.handler.packages.packageList]
+ grps=[grp.nameforgrpinks.handler.packages.groupList]try:withyumlock.lock:
- (template_size,_)=projects_depsolve_with_size(yumlock.yb,pkgs,
+ (template_size,_)=projects_depsolve_with_size(yumlock.yb,pkgs,grps,with_core=notks.handler.packages.nocore)exceptProjectsErrorase:log.error("start_build depsolve: %s",str(e))
@@ -361,6 +392,10 @@
log.debug("repo composer-%s = %s",idx,ks_repo)f.write('repo --name="composer-%s" %s\n'%(idx,ks_repo))
+ # Setup the disk for booting
+ # TODO Add GPT and UEFI boot support
+ f.write('clearpart --all\n')
+
# Write the root partition and it's size in MB (rounded up)f.write('part / --fstype="ext4" --size=%d\n'%ceil(installed_size/1024**2))
@@ -407,6 +442,7 @@
iftest_mode>0:open(joinpaths(results_dir,"TEST"),"w").write("%s"%test_mode)
+ write_timestamp(results_dir,TS_CREATED)log.info("Adding %s (%s%s) to compose queue",build_id,recipe["name"],compose_type)os.symlink(results_dir,joinpaths(lib_dir,"queue/new/",build_id))
@@ -587,7 +623,7 @@
[docs]defprojects_depsolve(yb,projects,groups):"""Return the dependencies for a list of projects :param yb: yum base object :type yb: YumBase :param projects: The projects and version globs to find the dependencies for :type projects: List of tuples
+ :param groups: The groups to include in dependency solving
+ :type groups: List of str :returns: NEVRA's of the project and its dependencies :rtype: list of dicts :raises: ProjectsError if there was a problem installing something
@@ -256,10 +258,23 @@
try:# This resets the transactionyb.closeRpmDB()
+ install_errors=[]
+ fornameingroups:
+ yb.selectGroup(name,["mandatory","default"])
+
forname,versioninprojects:ifnotversion:version="*"
- yb.install(pattern="%s-%s"%(name,version))
+ pattern="%s-%s"%(name,version)
+ try:
+ yb.install(pattern=pattern)
+ exceptYumBaseErrorase:
+ install_errors.append((pattern,str(e)))
+
+ # Were there problems installing these packages?
+ ifinstall_errors:
+ raiseProjectsError("The following package(s) had problems: %s"%",".join(["%s (%s)"%(pattern,err)forpattern,errininstall_errors]))
+
(rc,msg)=yb.buildTransaction()ifrcnotin[0,1,2]:raiseProjectsError("There was a problem depsolving %s: %s"%(projects,msg))
@@ -291,13 +306,15 @@
installed_size+=p.po.installedsizereturninstalled_size
[docs]defprojects_depsolve_with_size(yb,projects,groups,with_core=True):"""Return the dependencies and installed size for a list of projects :param yb: yum base object :type yb: YumBase :param projects: The projects and version globs to find the dependencies for :type projects: List of tuples
+ :param groups: The groups to include in dependency solving
+ :type groups: List of str :returns: installed size and a list of NEVRA's of the project and its dependencies :rtype: tuple of (int, list of dicts) :raises: ProjectsError if there was a problem installing something
@@ -305,10 +322,23 @@
try:# This resets the transactionyb.closeRpmDB()
+ install_errors=[]
+ fornameingroups:
+ yb.selectGroup(name,["mandatory","default"])
+
forname,versioninprojects:ifnotversion:version="*"
- yb.install(pattern="%s-%s"%(name,version))
+ pattern="%s-%s"%(name,version)
+ try:
+ yb.install(pattern=pattern)
+ exceptYumBaseErrorase:
+ install_errors.append((pattern,str(e)))
+
+ # Were there problems installing these packages?
+ ifinstall_errors:
+ raiseProjectsError("The following package(s) had problems: %s"%",".join(["%s (%s)"%(pattern,err)forpattern,errininstall_errors]))
+
ifwith_core:yb.selectGroup("core",group_package_types=['mandatory','default','optional'])(rc,msg)=yb.buildTransaction()
@@ -368,7 +398,7 @@
modules=sorted(map(yaps_to_project,ybl.available),key=lambdap:p["name"].lower())# Add the dependency info to each oneformoduleinmodules:
- module["dependencies"]=projects_depsolve(yb,[(module["name"],"*")])
+ module["dependencies"]=projects_depsolve(yb,[(module["name"],"*")],[])returnmodules
@@ -83,6 +83,7 @@
frompylorax.api.composeimportmove_compose_resultsfrompylorax.api.recipesimportrecipe_from_file
+frompylorax.api.timestampimportTS_CREATED,TS_STARTED,TS_FINISHED,write_timestamp,timestamp_dictfrompylorax.baseimportDataHolderfrompylorax.creatorimportrun_creatorfrompylorax.sysutilsimportjoinpaths
@@ -159,6 +160,7 @@
make_compose(cfg,os.path.realpath(dst))log.info("Finished building %s, results are in %s",dst,os.path.realpath(dst))open(joinpaths(dst,"STATUS"),"w").write("FINISHED\n")
+ write_timestamp(dst,TS_FINISHED)exceptException:importtracebacklog.error("traceback: %s",traceback.format_exc())
@@ -166,6 +168,7 @@
# TODO - Write the error message to an ERROR-LOG file to include with the status# log.error("Error running compose: %s", e)open(joinpaths(dst,"STATUS"),"w").write("FAILED\n")
+ write_timestamp(dst,TS_FINISHED)os.unlink(dst)
@@ -243,6 +246,7 @@
log.debug("cfg = %s",install_cfg)try:test_path=joinpaths(results_dir,"TEST")
+ write_timestamp(results_dir,TS_STARTED)ifos.path.exists(test_path):# Pretend to run the composetime.sleep(5)
@@ -302,15 +306,21 @@
* id - The uuid of the comoposition * queue_status - The final status of the composition (FINISHED or FAILED)
- * timestamp - The time of the last status change * compose_type - The type of output generated (tar, iso, etc.) * blueprint - Blueprint name * version - Blueprint version * image_size - Size of the image, if finished. 0 otherwise.
+
+ Various timestamps are also included in the dict. These are all Unix UTC timestamps.
+ It is possible for these timestamps to not always exist, in which case they will be
+ None in Python (or null in JSON). The following timestamps are included:
+
+ * job_created - When the user submitted the compose
+ * job_started - Anaconda started running
+ * job_finished - Job entered FINISHED or FAILED state """build_id=os.path.basename(os.path.abspath(results_dir))status=open(joinpaths(results_dir,"STATUS")).read().strip()
- mtime=os.stat(joinpaths(results_dir,"STATUS")).st_mtimeblueprint=recipe_from_file(joinpaths(results_dir,"blueprint.toml"))compose_type=get_compose_type(results_dir)
@@ -321,9 +331,13 @@
else:image_size=0
+ times=timestamp_dict(results_dir)
+
return{"id":build_id,"queue_status":status,
- "timestamp":mtime,
+ "job_created":times.get(TS_CREATED),
+ "job_started":times.get(TS_STARTED),
+ "job_finished":times.get(TS_FINISHED),"compose_type":compose_type,"blueprint":blueprint["name"],"version":blueprint["version"],
@@ -491,7 +505,7 @@
:type cfg: ComposerConfig :param uuid: The UUID of the build :type uuid: str
- :returns: dictionary of information about the composition
+ :returns: dictionary of information about the composition or None :rtype: dict :raises: RuntimeError if there was a problem
@@ -507,7 +521,7 @@
"""uuid_dir=joinpaths(cfg.get("composer","lib_dir"),"results",uuid)ifnotos.path.exists(uuid_dir):
- raiseRuntimeError("%s is not a valid build_id"%uuid)
+ returnNone# Load the compose configurationcfg_path=joinpaths(uuid_dir,"config.toml")
@@ -696,7 +710,7 @@
@@ -100,21 +100,24 @@
and adds a .filename property to return the recipe's filename, and a .toml() function to return the recipe as a TOML string. """
- def__init__(self,name,description,version,modules,packages,customizations=None):
+ def__init__(self,name,description,version,modules,packages,groups,customizations=None):# Check that version is empty or semver compatibleifversion:semver.Version(version)
- # Make sure modules and packages are listed by their case-insensitive names
+ # Make sure modules, packages, and groups are listed by their case-insensitive namesifmodulesisnotNone:modules=sorted(modules,key=lambdam:m["name"].lower())ifpackagesisnotNone:packages=sorted(packages,key=lambdap:p["name"].lower())
+ ifgroupsisnotNone:
+ groups=sorted(groups,key=lambdag:g["name"].lower())dict.__init__(self,name=name,description=description,version=version,modules=modules,packages=packages,
+ groups=groups,customizations=customizations)# We don't want customizations=None to show up in the TOML so remove it
@@ -142,6 +145,11 @@
return[(m["name"],m["version"])forminself["modules"]or[]]
@property
+
[docs]defgroup_names(self):
+ """Return the names of the groups. Groups do not have versions."""
+ returnmap(lambdag:g["name"],self["groups"]or[])
+
[docs]defrecipe_from_file(recipe_path):"""Return a recipe file as a Recipe object
@@ -263,6 +279,10 @@
packages=[RecipePackage(p.get("name"),p.get("version"))forpinrecipe_dict["packages"]]else:packages=[]
+ ifrecipe_dict.get("groups"):
+ groups=[RecipeGroup(g.get("name"))forginrecipe_dict["groups"]]
+ else:
+ groups=[]name=recipe_dict["name"]description=recipe_dict["description"]version=recipe_dict.get("version",None)
@@ -270,7 +290,7 @@
exceptKeyErrorase:raiseRecipeError("There was a problem parsing the recipe: %s"%str(e))
- returnRecipe(name,description,version,modules,packages,customizations)
+ returnRecipe(name,description,version,modules,packages,groups,customizations)
[docs]defgfile(path):"""Convert a string path to GFile for use with Git"""
@@ -950,6 +970,7 @@
diffs.extend(diff_items("Module",old_recipe["modules"],new_recipe["modules"]))diffs.extend(diff_items("Package",old_recipe["packages"],new_recipe["packages"]))
+ diffs.extend(diff_items("Group",old_recipe["groups"],new_recipe["groups"]))returndiffs
@@ -118,14 +118,20 @@
"db_supported": true, "db_version": "0", "schema_version": "0",
- "backend": "lorax-composer"}
+ "backend": "lorax-composer",
+ "msgs": []}
+
+ The 'msgs' field can be a list of strings describing startup problems or status that
+ should be displayed to the user. eg. if the compose templates are not depsolving properly
+ the errors will be in 'msgs'. """returnjsonify(backend="lorax-composer",build=vernum,api="0",db_version="0",schema_version="0",
- db_supported=True)
+ db_supported=True,
+ msgs=server.config["TEMPLATE_ERRORS"])v0_api(server)
@@ -161,7 +167,7 @@
+#
+# Copyright (C) 2018 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+importpytomlastoml
+importtime
+
+frompylorax.sysutilsimportjoinpaths
+
+TS_CREATED="created"
+TS_STARTED="started"
+TS_FINISHED="finished"
+
+
[docs]defv0_api(api):# Note that Sphinx will not generate documentations for any of these.@api.route("/api/v0/blueprints/list")
@@ -1058,22 +1082,36 @@
defv0_blueprints_list():"""List the available blueprints on a branch."""branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:limit=int(request.args.get("limit","20"))offset=int(request.args.get("offset","0"))exceptValueErrorase:
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BAD_LIMIT_OR_OFFSET,"msg":str(e)}]),400withapi.config["GITLOCK"].lock:blueprints=take_limits(map(lambdaf:f[:-5],list_branch_files(api.config["GITLOCK"].repo,branch)),offset,limit)returnjsonify(blueprints=blueprints,limit=limit,offset=offset,total=len(blueprints))
+ @api.route("/api/v0/blueprints/info",defaults={'blueprint_names':""})@api.route("/api/v0/blueprints/info/<blueprint_names>")@crossdomain(origin="*")
+ @checkparams([("blueprint_names","","no blueprint names given")])defv0_blueprints_info(blueprint_names):"""Return the contents of the blueprint, or a list of blueprints"""
+ ifVALID_API_STRING.match(blueprint_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
out_fmt=request.args.get("format","json")
+ ifVALID_API_STRING.match(out_fmt)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in format argument"}]),400
+
blueprints=[]changes=[]errors=[]
@@ -1099,7 +1137,7 @@
ifnotws_blueprintandnotgit_blueprint:# Neither blueprint, return an error
- errors.append("%s: %s"%(blueprint_name,", ".join(exceptions)))
+ errors.append({"id":UNKNOWN_BLUEPRINT,"msg":"%s: %s"%(blueprint_name,", ".join(exceptions))})elifws_blueprintandnotgit_blueprint:# No git blueprint, return the workspace blueprintchanges.append({"name":blueprint_name,"changed":True})
@@ -1116,7 +1154,6 @@
# Sort all the results by case-insensitive blueprint namechanges=sorted(changes,key=lambdac:c["name"].lower())blueprints=sorted(blueprints,key=lambdar:r["name"].lower())
- errors=sorted(errors,key=lambdae:e.lower())ifout_fmt=="toml":# With TOML output we just want to dump the raw blueprint, skipping the rest.
@@ -1124,32 +1161,44 @@
else:returnjsonify(changes=changes,blueprints=blueprints,errors=errors)
+ @api.route("/api/v0/blueprints/changes",defaults={'blueprint_names':""})@api.route("/api/v0/blueprints/changes/<blueprint_names>")@crossdomain(origin="*")
+ @checkparams([("blueprint_names","","no blueprint names given")])defv0_blueprints_changes(blueprint_names):"""Return the changes to a blueprint or list of blueprints"""
+ ifVALID_API_STRING.match(blueprint_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:limit=int(request.args.get("limit","20"))offset=int(request.args.get("offset","0"))exceptValueErrorase:
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BAD_LIMIT_OR_OFFSET,"msg":str(e)}]),400blueprints=[]errors=[]forblueprint_namein[n.strip()forninblueprint_names.split(",")]:filename=recipe_filename(blueprint_name)
+
+ ifnotblueprint_exists(api,branch,blueprint_name):
+ errors.append({"id":UNKNOWN_BLUEPRINT,"msg":"Unknown blueprint name: %s"%blueprint_name})
+ continue
+
try:withapi.config["GITLOCK"].lock:commits=take_limits(list_commits(api.config["GITLOCK"].repo,branch,filename),offset,limit)exceptExceptionase:
- errors.append("%s: %s"%(blueprint_name,str(e)))
+ errors.append({"id":BLUEPRINTS_ERROR,"msg":"%s: %s"%(blueprint_name,str(e))})log.error("(v0_blueprints_changes) %s",str(e))else:blueprints.append({"name":blueprint_name,"changes":commits,"total":len(commits)})blueprints=sorted(blueprints,key=lambdar:r["name"].lower())
- errors=sorted(errors,key=lambdae:e.lower())returnjsonify(blueprints=blueprints,errors=errors,offset=offset,limit=limit)
@@ -1158,12 +1207,18 @@
defv0_blueprints_new():"""Commit a new blueprint"""branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:ifrequest.headers['Content-Type']=="text/x-toml":blueprint=recipe_from_toml(request.data)else:blueprint=recipe_from_dict(request.get_json(cache=False))
+ ifVALID_API_STRING.match(blueprint["name"])isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
withapi.config["GITLOCK"].lock:commit_recipe(api.config["GITLOCK"].repo,branch,blueprint)
@@ -1172,21 +1227,29 @@
workspace_write(api.config["GITLOCK"].repo,branch,blueprint)exceptExceptionase:log.error("(v0_blueprints_new) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BLUEPRINTS_ERROR,"msg":str(e)}]),400else:returnjsonify(status=True)
+ @api.route("/api/v0/blueprints/delete",defaults={'blueprint_name':""},methods=["DELETE"])@api.route("/api/v0/blueprints/delete/<blueprint_name>",methods=["DELETE"])@crossdomain(origin="*")
+ @checkparams([("blueprint_name","","no blueprint name given")])defv0_blueprints_delete(blueprint_name):"""Delete a blueprint from git"""
+ ifVALID_API_STRING.match(blueprint_name)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:withapi.config["GITLOCK"].lock:delete_recipe(api.config["GITLOCK"].repo,branch,blueprint_name)exceptExceptionase:log.error("(v0_blueprints_delete) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BLUEPRINTS_ERROR,"msg":str(e)}]),400else:returnjsonify(status=True)
@@ -1195,39 +1258,63 @@
defv0_blueprints_workspace():"""Write a blueprint to the workspace"""branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:ifrequest.headers['Content-Type']=="text/x-toml":blueprint=recipe_from_toml(request.data)else:blueprint=recipe_from_dict(request.get_json(cache=False))
+ ifVALID_API_STRING.match(blueprint["name"])isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
withapi.config["GITLOCK"].lock:workspace_write(api.config["GITLOCK"].repo,branch,blueprint)exceptExceptionase:log.error("(v0_blueprints_workspace) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BLUEPRINTS_ERROR,"msg":str(e)}]),400else:returnjsonify(status=True)
+ @api.route("/api/v0/blueprints/workspace",defaults={'blueprint_name':""},methods=["DELETE"])@api.route("/api/v0/blueprints/workspace/<blueprint_name>",methods=["DELETE"])@crossdomain(origin="*")
+ @checkparams([("blueprint_name","","no blueprint name given")])defv0_blueprints_delete_workspace(blueprint_name):"""Delete a blueprint from the workspace"""
+ ifVALID_API_STRING.match(blueprint_name)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:withapi.config["GITLOCK"].lock:workspace_delete(api.config["GITLOCK"].repo,branch,blueprint_name)exceptExceptionase:log.error("(v0_blueprints_delete_workspace) %s",str(e))
- returnjsonify(status=False,error=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BLUEPRINTS_ERROR,"msg":str(e)}]),400else:returnjsonify(status=True)
+ @api.route("/api/v0/blueprints/undo",defaults={'blueprint_name':"",'commit':""},methods=["POST"])
+ @api.route("/api/v0/blueprints/undo/<blueprint_name>",defaults={'commit':""},methods=["POST"])@api.route("/api/v0/blueprints/undo/<blueprint_name>/<commit>",methods=["POST"])@crossdomain(origin="*")
+ @checkparams([("blueprint_name","","no blueprint name given"),
+ ("commit","","no commit ID given")])defv0_blueprints_undo(blueprint_name,commit):"""Undo changes to a blueprint by reverting to a previous commit."""
+ ifVALID_API_STRING.match(blueprint_name)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:withapi.config["GITLOCK"].lock:revert_recipe(api.config["GITLOCK"].repo,branch,blueprint_name,commit)
@@ -1237,29 +1324,50 @@
workspace_write(api.config["GITLOCK"].repo,branch,blueprint)exceptExceptionase:log.error("(v0_blueprints_undo) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_COMMIT,"msg":str(e)}]),400else:returnjsonify(status=True)
+ @api.route("/api/v0/blueprints/tag",defaults={'blueprint_name':""},methods=["POST"])@api.route("/api/v0/blueprints/tag/<blueprint_name>",methods=["POST"])@crossdomain(origin="*")
+ @checkparams([("blueprint_name","","no blueprint name given")])defv0_blueprints_tag(blueprint_name):"""Tag a blueprint's latest blueprint commit as a 'revision'"""
+ ifVALID_API_STRING.match(blueprint_name)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:withapi.config["GITLOCK"].lock:tag_recipe_commit(api.config["GITLOCK"].repo,branch,blueprint_name)exceptExceptionase:log.error("(v0_blueprints_tag) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BLUEPRINTS_ERROR,"msg":str(e)}]),400else:returnjsonify(status=True)
+ @api.route("/api/v0/blueprints/diff",defaults={'blueprint_name':"",'from_commit':"",'to_commit':""})
+ @api.route("/api/v0/blueprints/diff/<blueprint_name>",defaults={'from_commit':"",'to_commit':""})
+ @api.route("/api/v0/blueprints/diff/<blueprint_name>/<from_commit>",defaults={'to_commit':""})@api.route("/api/v0/blueprints/diff/<blueprint_name>/<from_commit>/<to_commit>")@crossdomain(origin="*")
+ @checkparams([("blueprint_name","","no blueprint name given"),
+ ("from_commit","","no from commit ID given"),
+ ("to_commit","","no to commit ID given")])defv0_blueprints_diff(blueprint_name,from_commit,to_commit):"""Return the differences between two commits of a blueprint"""
+ forsin[blueprint_name,from_commit,to_commit]:
+ ifVALID_API_STRING.match(s)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
try:iffrom_commit=="NEWEST":withapi.config["GITLOCK"].lock:
@@ -1269,7 +1377,7 @@
old_blueprint=read_recipe_commit(api.config["GITLOCK"].repo,branch,blueprint_name,from_commit)exceptExceptionase:log.error("(v0_blueprints_diff) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_COMMIT,"msg":str(e)}]),400try:ifto_commit=="WORKSPACE":
@@ -1287,17 +1395,28 @@
new_blueprint=read_recipe_commit(api.config["GITLOCK"].repo,branch,blueprint_name,to_commit)exceptExceptionase:log.error("(v0_blueprints_diff) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_COMMIT,"msg":str(e)}]),400diff=recipe_diff(old_blueprint,new_blueprint)returnjsonify(diff=diff)
+ @api.route("/api/v0/blueprints/freeze",defaults={'blueprint_names':""})@api.route("/api/v0/blueprints/freeze/<blueprint_names>")@crossdomain(origin="*")
+ @checkparams([("blueprint_names","","no blueprint names given")])defv0_blueprints_freeze(blueprint_names):"""Return the blueprint with the exact modules and packages selected by depsolve"""
+ ifVALID_API_STRING.match(blueprint_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
out_fmt=request.args.get("format","json")
+ ifVALID_API_STRING.match(out_fmt)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in format argument"}]),400
+
blueprints=[]errors=[]forblueprint_namein[n.strip()forninsorted(blueprint_names.split(","),key=lambdan:n.lower())]:
@@ -1316,12 +1435,12 @@
withapi.config["GITLOCK"].lock:blueprint=read_recipe_commit(api.config["GITLOCK"].repo,branch,blueprint_name)exceptExceptionase:
- errors.append("%s: %s"%(blueprint_name,str(e)))
+ errors.append({"id":BLUEPRINTS_ERROR,"msg":"%s: %s"%(blueprint_name,str(e))})log.error("(v0_blueprints_freeze) %s",str(e))# No blueprint found, skip it.ifnotblueprint:
- errors.append("%s: blueprint_not_found"%(blueprint_name))
+ errors.append({"id":UNKNOWN_BLUEPRINT,"msg":"%s: blueprint_not_found"%blueprint_name})continue# Combine modules and packages and depsolve the list
@@ -1332,9 +1451,9 @@
deps=[]try:withapi.config["YUMLOCK"].lock:
- deps=projects_depsolve(api.config["YUMLOCK"].yb,projects)
+ deps=projects_depsolve(api.config["YUMLOCK"].yb,projects,blueprint.group_names)exceptProjectsErrorase:
- errors.append("%s: %s"%(blueprint_name,str(e)))
+ errors.append({"id":BLUEPRINTS_ERROR,"msg":"%s: %s"%(blueprint_name,str(e))})log.error("(v0_blueprints_freeze) %s",str(e))blueprints.append({"blueprint":blueprint.freeze(deps)})
@@ -1345,11 +1464,19 @@
else:returnjsonify(blueprints=blueprints,errors=errors)
+ @api.route("/api/v0/blueprints/depsolve",defaults={'blueprint_names':""})@api.route("/api/v0/blueprints/depsolve/<blueprint_names>")@crossdomain(origin="*")
+ @checkparams([("blueprint_names","","no blueprint names given")])defv0_blueprints_depsolve(blueprint_names):"""Return the dependencies for a blueprint"""
+ ifVALID_API_STRING.match(blueprint_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
branch=request.args.get("branch","master")
+ ifVALID_API_STRING.match(branch)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in branch argument"}]),400
+
blueprints=[]errors=[]forblueprint_namein[n.strip()forninsorted(blueprint_names.split(","),key=lambdan:n.lower())]:
@@ -1368,12 +1495,12 @@
withapi.config["GITLOCK"].lock:blueprint=read_recipe_commit(api.config["GITLOCK"].repo,branch,blueprint_name)exceptExceptionase:
- errors.append("%s: %s"%(blueprint_name,str(e)))
+ errors.append({"id":BLUEPRINTS_ERROR,"msg":"%s: %s"%(blueprint_name,str(e))})log.error("(v0_blueprints_depsolve) %s",str(e))# No blueprint found, skip it.ifnotblueprint:
- errors.append("%s: blueprint not found"%blueprint_name)
+ errors.append({"id":UNKNOWN_BLUEPRINT,"msg":"%s: blueprint not found"%blueprint_name})continue# Combine modules and packages and depsolve the list
@@ -1383,9 +1510,9 @@
deps=[]try:withapi.config["YUMLOCK"].lock:
- deps=projects_depsolve(api.config["YUMLOCK"].yb,projects)
+ deps=projects_depsolve(api.config["YUMLOCK"].yb,projects,blueprint.group_names)exceptProjectsErrorase:
- errors.append("%s: %s"%(blueprint_name,str(e)))
+ errors.append({"id":BLUEPRINTS_ERROR,"msg":"%s: %s"%(blueprint_name,str(e))})log.error("(v0_blueprints_depsolve) %s",str(e))# Get the NEVRA's of the modules and projects, add as "modules"
@@ -1407,41 +1534,61 @@
limit=int(request.args.get("limit","20"))offset=int(request.args.get("offset","0"))exceptValueErrorase:
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BAD_LIMIT_OR_OFFSET,"msg":str(e)}]),400try:withapi.config["YUMLOCK"].lock:available=projects_list(api.config["YUMLOCK"].yb)exceptProjectsErrorase:log.error("(v0_projects_list) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":PROJECTS_ERROR,"msg":str(e)}]),400projects=take_limits(available,offset,limit)returnjsonify(projects=projects,offset=offset,limit=limit,total=len(available))
+ @api.route("/api/v0/projects/info",defaults={'project_names':""})@api.route("/api/v0/projects/info/<project_names>")@crossdomain(origin="*")
+ @checkparams([("project_names","","no project names given")])defv0_projects_info(project_names):"""Return detailed information about the listed projects"""
+ ifVALID_API_STRING.match(project_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
try:withapi.config["YUMLOCK"].lock:projects=projects_info(api.config["YUMLOCK"].yb,project_names.split(","))exceptProjectsErrorase:log.error("(v0_projects_info) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":PROJECTS_ERROR,"msg":str(e)}]),400
+
+ ifnotprojects:
+ msg="one of the requested projects does not exist: %s"%project_names
+ log.error("(v0_projects_info) %s",msg)
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_PROJECT,"msg":msg}]),400returnjsonify(projects=projects)
+ @api.route("/api/v0/projects/depsolve",defaults={'project_names':""})@api.route("/api/v0/projects/depsolve/<project_names>")@crossdomain(origin="*")
+ @checkparams([("project_names","","no project names given")])defv0_projects_depsolve(project_names):"""Return detailed information about the listed projects"""
+ ifVALID_API_STRING.match(project_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
try:withapi.config["YUMLOCK"].lock:
- deps=projects_depsolve(api.config["YUMLOCK"].yb,[(n,"*")forninproject_names.split(",")])
+ deps=projects_depsolve(api.config["YUMLOCK"].yb,[(n,"*")forninproject_names.split(",")],[])exceptProjectsErrorase:log.error("(v0_projects_depsolve) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":PROJECTS_ERROR,"msg":str(e)}]),400
+
+ ifnotdeps:
+ msg="one of the requested projects does not exist: %s"%project_names
+ log.error("(v0_projects_depsolve) %s",msg)
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_PROJECT,"msg":msg}]),400returnjsonify(projects=deps)
@@ -1454,11 +1601,18 @@
sources=sorted([r.idforrinrepos])returnjsonify(sources=sources)
+ @api.route("/api/v0/projects/source/info",defaults={'source_names':""})@api.route("/api/v0/projects/source/info/<source_names>")@crossdomain(origin="*")
+ @checkparams([("source_names","","no source names given")])defv0_projects_source_info(source_names):"""Return detailed info about the list of sources"""
+ ifVALID_API_STRING.match(source_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
out_fmt=request.args.get("format","json")
+ ifVALID_API_STRING.match(out_fmt)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in format argument"}]),400# Return info on all of the sourcesifsource_names=="*":
@@ -1472,7 +1626,7 @@
withapi.config["YUMLOCK"].lock:repo=api.config["YUMLOCK"].yb.repos.repos.get(source,None)ifnotrepo:
- errors.append("%s is not a valid source"%source)
+ errors.append({"id":UNKNOWN_SOURCE,"msg":"%s is not a valid source"%source})continuesources[repo.id]=repo_to_source(repo,repo.idinsystem_sources)
@@ -1496,7 +1650,7 @@
system_sources=get_repo_sources("/etc/yum.repos.d/*.repo")ifsource["name"]insystem_sources:
- returnjsonify(status=False,errors=["%s is a system source, it cannot be deleted."%source["name"]]),400
+ returnjsonify(status=False,errors=[{"id":SYSTEM_SOURCE,"msg":"%s is a system source, it cannot be changed."%source["name"]}]),400try:# Delete it from yum (if it exists) and replace it with the new one
@@ -1544,17 +1698,22 @@
log.info("Updating repository metadata after adding %s failed",source["name"])update_metadata(yb)
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":PROJECTS_ERROR,"msg":str(e)}]),400returnjsonify(status=True)
+ @api.route("/api/v0/projects/source/delete",defaults={'source_name':""},methods=["DELETE"])@api.route("/api/v0/projects/source/delete/<source_name>",methods=["DELETE"])@crossdomain(origin="*")
+ @checkparams([("source_name","","no source name given")])defv0_projects_source_delete(source_name):"""Delete the named source and return a status response"""
+ ifVALID_API_STRING.match(source_name)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
system_sources=get_repo_sources("/etc/yum.repos.d/*.repo")ifsource_nameinsystem_sources:
- returnjsonify(status=False,errors=["%s is a system source, it cannot be deleted."%source_name]),400
+ returnjsonify(status=False,errors=[{"id":SYSTEM_SOURCE,"msg":"%s is a system source, it cannot be deleted."%source_name}]),400share_dir=api.config["COMPOSER_CFG"].get("composer","repo_dir")try:# Remove the file entry for the source
@@ -1574,7 +1733,7 @@
exceptProjectsErrorase:log.error("(v0_projects_source_delete) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_SOURCE,"msg":str(e)}]),400returnjsonify(status=True)
@@ -1583,11 +1742,14 @@
@crossdomain(origin="*")defv0_modules_list(module_names=None):"""List available modules, filtering by module_names"""
+ ifmodule_namesandVALID_API_STRING.match(module_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
try:limit=int(request.args.get("limit","20"))offset=int(request.args.get("offset","0"))exceptValueErrorase:
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":BAD_LIMIT_OR_OFFSET,"msg":str(e)}]),400ifmodule_names:module_names=module_names.split(",")
@@ -1597,21 +1759,35 @@
available=modules_list(api.config["YUMLOCK"].yb,module_names)exceptProjectsErrorase:log.error("(v0_modules_list) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":MODULES_ERROR,"msg":str(e)}]),400
+
+ ifmodule_namesandnotavailable:
+ msg="one of the requested modules does not exist: %s"%module_names
+ log.error("(v0_modules_list) %s",msg)
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_MODULE,"msg":msg}]),400modules=take_limits(available,offset,limit)returnjsonify(modules=modules,offset=offset,limit=limit,total=len(available))
+ @api.route("/api/v0/modules/info",defaults={'module_names':""})@api.route("/api/v0/modules/info/<module_names>")@crossdomain(origin="*")
+ @checkparams([("module_names","","no module names given")])defv0_modules_info(module_names):"""Return detailed information about the listed modules"""
+ ifVALID_API_STRING.match(module_names)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400try:withapi.config["YUMLOCK"].lock:modules=modules_info(api.config["YUMLOCK"].yb,module_names.split(","))exceptProjectsErrorase:log.error("(v0_modules_info) %s",str(e))
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":MODULES_ERROR,"msg":str(e)}]),400
+
+ ifnotmodules:
+ msg="one of the requested modules does not exist: %s"%module_names
+ log.error("(v0_modules_info) %s",msg)
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_MODULE,"msg":msg}]),400returnjsonify(modules=modules)
@@ -1636,10 +1812,10 @@
errors=[]ifnotcompose:
- returnjsonify(status=False,errors=["Missing POST body"]),400
+ returnjsonify(status=False,errors=[{"id":MISSING_POST,"msg":"Missing POST body"}]),400if"blueprint_name"notincompose:
- errors.append("No 'blueprint_name' in the JSON request")
+ errors.append({"id":UNKNOWN_BLUEPRINT,"msg":"No 'blueprint_name' in the JSON request"})else:blueprint_name=compose["blueprint_name"]
@@ -1649,10 +1825,13 @@
branch=compose["branch"]if"compose_type"notincompose:
- errors.append("No 'compose_type' in the JSON request")
+ errors.append({"id":BAD_COMPOSE_TYPE,"msg":"No 'compose_type' in the JSON request"})else:compose_type=compose["compose_type"]
+ ifVALID_API_STRING.match(blueprint_name)isNone:
+ errors.append({"id":INVALID_CHARS,"msg":"Invalid characters in API path"})
+
iferrors:returnjsonify(status=False,errors=errors),400
@@ -1660,7 +1839,10 @@
build_id=start_build(api.config["COMPOSER_CFG"],api.config["YUMLOCK"],api.config["GITLOCK"],branch,blueprint_name,compose_type,test_mode)exceptExceptionase:
- returnjsonify(status=False,errors=[str(e)]),400
+ if"Invalid compose type"instr(e):
+ returnjsonify(status=False,errors=[{"id":BAD_COMPOSE_TYPE,"msg":str(e)}]),400
+ else:
+ returnjsonify(status=False,errors=[{"id":BUILD_FAILED,"msg":str(e)}]),400returnjsonify(status=True,build_id=build_id)
@@ -1692,152 +1874,227 @@
"""Return the list of failed composes"""returnjsonify(failed=build_status(api.config["COMPOSER_CFG"],"FAILED"))
+ @api.route("/api/v0/compose/status",defaults={'uuids':""})@api.route("/api/v0/compose/status/<uuids>")@crossdomain(origin="*")
+ @checkparams([("uuids","","no UUIDs given")])defv0_compose_status(uuids):"""Return the status of the listed uuids"""
+ ifVALID_API_STRING.match(uuids)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
+ blueprint=request.args.get("blueprint",None)
+ status=request.args.get("status",None)
+ compose_type=request.args.get("type",None)
+
results=[]
- foruuidin[n.strip().lower()forninuuids.split(",")]:
- details=uuid_status(api.config["COMPOSER_CFG"],uuid)
- ifdetailsisnotNone:
- results.append(details)
+ errors=[]
- returnjsonify(uuids=results)
+ ifuuids.strip()=='*':
+ queue_status_dict=queue_status(api.config["COMPOSER_CFG"])
+ queue_new=queue_status_dict["new"]
+ queue_running=queue_status_dict["run"]
+ candidates=queue_new+queue_running+build_status(api.config["COMPOSER_CFG"])
+ else:
+ candidates=[]
+ foruuidin[n.strip().lower()forninuuids.split(",")]:
+ details=uuid_status(api.config["COMPOSER_CFG"],uuid)
+ ifdetailsisNone:
+ errors.append({"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid})
+ else:
+ candidates.append(details)
+ fordetailsincandidates:
+ ifblueprintisnotNoneanddetails['blueprint']!=blueprint:
+ continue
+
+ ifstatusisnotNoneanddetails['queue_status']!=status:
+ continue
+
+ ifcompose_typeisnotNoneanddetails['compose_type']!=compose_type:
+ continue
+
+ results.append(details)
+
+ returnjsonify(uuids=results,errors=errors)
+
+ @api.route("/api/v0/compose/cancel",defaults={'uuid':""},methods=["DELETE"])@api.route("/api/v0/compose/cancel/<uuid>",methods=["DELETE"])@crossdomain(origin="*")
+ @checkparams([("uuid","","no UUID given")])defv0_compose_cancel(uuid):"""Cancel a running compose and delete its results directory"""
+ ifVALID_API_STRING.match(uuid)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
status=uuid_status(api.config["COMPOSER_CFG"],uuid)ifstatusisNone:
- returnjsonify(status=False,errors=["%s is not a valid build uuid"%uuid]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid}]),400ifstatus["queue_status"]notin["WAITING","RUNNING"]:
- returnjsonify(status=False,errors=["Build %s is not in WAITING or RUNNING."%uuid])
+ returnjsonify(status=False,errors=[{"id":BUILD_IN_WRONG_STATE,"msg":"Build %s is not in WAITING or RUNNING."%uuid}])try:uuid_cancel(api.config["COMPOSER_CFG"],uuid)exceptExceptionase:
- returnjsonify(status=False,errors=["%s: %s"%(uuid,str(e))]),400
+ returnjsonify(status=False,errors=[{"id":COMPOSE_ERROR,"msg":"%s: %s"%(uuid,str(e))}]),400else:returnjsonify(status=True,uuid=uuid)
+ @api.route("/api/v0/compose/delete",defaults={'uuids':""},methods=["DELETE"])@api.route("/api/v0/compose/delete/<uuids>",methods=["DELETE"])@crossdomain(origin="*")
+ @checkparams([("uuids","","no UUIDs given")])defv0_compose_delete(uuids):"""Delete the compose results for the listed uuids"""
+ ifVALID_API_STRING.match(uuids)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
results=[]errors=[]foruuidin[n.strip().lower()forninuuids.split(",")]:status=uuid_status(api.config["COMPOSER_CFG"],uuid)ifstatusisNone:
- errors.append("%s is not a valid build uuid"%uuid)
+ errors.append({"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid})elifstatus["queue_status"]notin["FINISHED","FAILED"]:
- errors.append("Build %s is not in FINISHED or FAILED."%uuid)
+ errors.append({"id":BUILD_IN_WRONG_STATE,"msg":"Build %s is not in FINISHED or FAILED."%uuid})else:try:uuid_delete(api.config["COMPOSER_CFG"],uuid)exceptExceptionase:
- errors.append("%s: %s"%(uuid,str(e)))
+ errors.append({"id":COMPOSE_ERROR,"msg":"%s: %s"%(uuid,str(e))})else:results.append({"uuid":uuid,"status":True})returnjsonify(uuids=results,errors=errors)
+ @api.route("/api/v0/compose/info",defaults={'uuid':""})@api.route("/api/v0/compose/info/<uuid>")@crossdomain(origin="*")
+ @checkparams([("uuid","","no UUID given")])defv0_compose_info(uuid):"""Return detailed info about a compose"""
+ ifVALID_API_STRING.match(uuid)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
try:info=uuid_info(api.config["COMPOSER_CFG"],uuid)exceptExceptionase:
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":COMPOSE_ERROR,"msg":str(e)}]),400
- returnjsonify(**info)
+ ifinfoisNone:
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid}]),400
+ else:
+ returnjsonify(**info)
+ @api.route("/api/v0/compose/metadata",defaults={'uuid':""})@api.route("/api/v0/compose/metadata/<uuid>")@crossdomain(origin="*")
+ @checkparams([("uuid","","no UUID given")])defv0_compose_metadata(uuid):"""Return a tar of the metadata for the build"""
+ ifVALID_API_STRING.match(uuid)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
status=uuid_status(api.config["COMPOSER_CFG"],uuid)ifstatusisNone:
- returnjsonify(status=False,errors=["%s is not a valid build uuid"%uuid]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid}]),400ifstatus["queue_status"]notin["FINISHED","FAILED"]:
- returnjsonify(status=False,errors=["Build %s not in FINISHED or FAILED state."%uuid]),400
+ returnjsonify(status=False,errors=[{"id":BUILD_IN_WRONG_STATE,"msg":"Build %s not in FINISHED or FAILED state."%uuid}]),400else:returnResponse(uuid_tar(api.config["COMPOSER_CFG"],uuid,metadata=True,image=False,logs=False),mimetype="application/x-tar",headers=[("Content-Disposition","attachment; filename=%s-metadata.tar;"%uuid)],direct_passthrough=True)
+ @api.route("/api/v0/compose/results",defaults={'uuid':""})@api.route("/api/v0/compose/results/<uuid>")@crossdomain(origin="*")
+ @checkparams([("uuid","","no UUID given")])defv0_compose_results(uuid):"""Return a tar of the metadata and the results for the build"""
+ ifVALID_API_STRING.match(uuid)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
status=uuid_status(api.config["COMPOSER_CFG"],uuid)ifstatusisNone:
- returnjsonify(status=False,errors=["%s is not a valid build uuid"%uuid]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid}]),400elifstatus["queue_status"]notin["FINISHED","FAILED"]:
- returnjsonify(status=False,errors=["Build %s not in FINISHED or FAILED state."%uuid]),400
+ returnjsonify(status=False,errors=[{"id":BUILD_IN_WRONG_STATE,"msg":"Build %s not in FINISHED or FAILED state."%uuid}]),400else:returnResponse(uuid_tar(api.config["COMPOSER_CFG"],uuid,metadata=True,image=True,logs=True),mimetype="application/x-tar",headers=[("Content-Disposition","attachment; filename=%s.tar;"%uuid)],direct_passthrough=True)
+ @api.route("/api/v0/compose/logs",defaults={'uuid':""})@api.route("/api/v0/compose/logs/<uuid>")@crossdomain(origin="*")
+ @checkparams([("uuid","","no UUID given")])defv0_compose_logs(uuid):"""Return a tar of the metadata for the build"""
+ ifVALID_API_STRING.match(uuid)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
status=uuid_status(api.config["COMPOSER_CFG"],uuid)ifstatusisNone:
- returnjsonify(status=False,errors=["%s is not a valid build uuid"%uuid]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid}]),400elifstatus["queue_status"]notin["FINISHED","FAILED"]:
- returnjsonify(status=False,errors=["Build %s not in FINISHED or FAILED state."%uuid]),400
+ returnjsonify(status=False,errors=[{"id":BUILD_IN_WRONG_STATE,"msg":"Build %s not in FINISHED or FAILED state."%uuid}]),400else:returnResponse(uuid_tar(api.config["COMPOSER_CFG"],uuid,metadata=False,image=False,logs=True),mimetype="application/x-tar",headers=[("Content-Disposition","attachment; filename=%s-logs.tar;"%uuid)],direct_passthrough=True)
+ @api.route("/api/v0/compose/image",defaults={'uuid':""})@api.route("/api/v0/compose/image/<uuid>")@crossdomain(origin="*")
+ @checkparams([("uuid","","no UUID given")])defv0_compose_image(uuid):"""Return the output image for the build"""
+ ifVALID_API_STRING.match(uuid)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
status=uuid_status(api.config["COMPOSER_CFG"],uuid)ifstatusisNone:
- returnjsonify(status=False,errors=["%s is not a valid build uuid"%uuid]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid}]),400elifstatus["queue_status"]notin["FINISHED","FAILED"]:
- returnjsonify(status=False,errors=["Build %s not in FINISHED or FAILED state."%uuid]),400
+ returnjsonify(status=False,errors=[{"id":BUILD_IN_WRONG_STATE,"msg":"Build %s not in FINISHED or FAILED state."%uuid}]),400else:image_name,image_path=uuid_image(api.config["COMPOSER_CFG"],uuid)# Make sure it really existsifnotos.path.exists(image_path):
- returnjsonify(status=False,errors=["Build %s is missing image file %s"%(uuid,image_name)]),400
+ returnjsonify(status=False,errors=[{"id":BUILD_MISSING_FILE,"msg":"Build %s is missing image file %s"%(uuid,image_name)}]),400# Make the image name uniqueimage_name=uuid+"-"+image_name# XXX - Will mime type guessing work for all our output?returnsend_file(image_path,as_attachment=True,attachment_filename=image_name,add_etags=False)
+ @api.route("/api/v0/compose/log",defaults={'uuid':""})@api.route("/api/v0/compose/log/<uuid>")@crossdomain(origin="*")
+ @checkparams([("uuid","","no UUID given")])defv0_compose_log_tail(uuid):"""Return the end of the main anaconda.log, defaults to 1Mbytes"""
+ ifVALID_API_STRING.match(uuid)isNone:
+ returnjsonify(status=False,errors=[{"id":INVALID_CHARS,"msg":"Invalid characters in API path"}]),400
+
try:size=int(request.args.get("size","1024"))exceptValueErrorase:
- returnjsonify(status=False,errors=[str(e)]),400
+ returnjsonify(status=False,errors=[{"id":COMPOSE_ERROR,"msg":str(e)}]),400status=uuid_status(api.config["COMPOSER_CFG"],uuid)ifstatusisNone:
- returnjsonify(status=False,errors=["%s is not a valid build uuid"%uuid]),400
+ returnjsonify(status=False,errors=[{"id":UNKNOWN_UUID,"msg":"%s is not a valid build uuid"%uuid}]),400elifstatus["queue_status"]=="WAITING":
- returnjsonify(status=False,errors=["Build %s has not started yet. No logs to view"%uuid])
+ returnjsonify(status=False,errors=[{"id":BUILD_IN_WRONG_STATE,"msg":"Build %s has not started yet. No logs to view"%uuid}])try:returnResponse(uuid_log(api.config["COMPOSER_CFG"],uuid,size),direct_passthrough=True)exceptRuntimeErrorase:
- returnjsonify(status=False,errors=[str(e)]),400
diff --git a/lorax-composer/_sources/composer-cli.rst.txt b/lorax-composer/_sources/composer-cli.rst.txt
new file mode 100644
index 00000000..366e01ad
--- /dev/null
+++ b/lorax-composer/_sources/composer-cli.rst.txt
@@ -0,0 +1,62 @@
+composer-cli
+============
+
+:Authors:
+ Brian C. Lane
+
+``composer-cli`` is used to interact with the ``lorax-composer`` API server, managing blueprints, exploring available packages, and building new images.
+
+It requires `lorax-composer `_ to be installed on the
+local system, and the user running it needs to be a member of the ``weldr``
+group. They do not need to be root, but all of the `security precautions
+`_ apply.
+
+composer-cli cmdline arguments
+------------------------------
+
+.. argparse::
+ :ref: composer.cli.cmdline.composer_cli_parser
+ :prog: composer-cli
+
+Edit a Blueprint
+----------------
+
+Start out by listing the available blueprints using ``composer-cli blueprints
+list``, pick one and save it to the local directory by running ``composer-cli
+blueprints save http-server``. If there are no blueprints available you can
+copy one of the examples `from the test suite
+`_.
+
+Edit the file (it will be saved with a .toml extension) and change the
+description, add a package or module to it. Send it back to the server by
+running ``composer-cli blueprints push http-server.toml``. You can verify that it was
+saved by viewing the changelog - ``composer-cli blueprints changes http-server``.
+
+Build an image
+----------------
+
+Build a ``qcow2`` disk image from this blueprint by running ``composer-cli
+compose start http-server qcow2``. It will print a UUID that you can use to
+keep track of the build. You can also cancel the build if needed.
+
+The available types of images is displayed by ``composer-cli compose types``.
+Currently this consists of: ext4-filesystem, live-iso, partitioned-disk, qcow2,
+tar
+
+Monitor the build status
+------------------------
+
+Monitor it using ``composer-cli compose status``, which will show the status of
+all the builds on the system. You can view the end of the anaconda build logs
+once it is in the ``RUNNING`` state using ``composer-cli compose log UUID``
+where UUID is the UUID returned by the start command.
+
+Once the build is in the ``FINISHED`` state you can download the image.
+
+Download the image
+------------------
+
+Downloading the final image is done with ``composer-cli compose image UUID`` and it will
+save the qcow2 image as ``UUID-disk.qcow2`` which you can then use to boot a VM like this::
+
+ qemu-kvm --name test-image -m 1024 -hda ./UUID-disk.qcow2
diff --git a/lorax-composer/_sources/composer.cli.rst.txt b/lorax-composer/_sources/composer.cli.rst.txt
new file mode 100644
index 00000000..b71dcda4
--- /dev/null
+++ b/lorax-composer/_sources/composer.cli.rst.txt
@@ -0,0 +1,78 @@
+composer\.cli package
+=====================
+
+Submodules
+----------
+
+composer\.cli\.blueprints module
+--------------------------------
+
+.. automodule:: composer.cli.blueprints
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.cli\.compose module
+-----------------------------
+
+.. automodule:: composer.cli.compose
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.cli\.help module
+--------------------------
+
+.. automodule:: composer.cli.help
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.cli\.modules module
+-----------------------------
+
+.. automodule:: composer.cli.modules
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.cli\.projects module
+------------------------------
+
+.. automodule:: composer.cli.projects
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.cli\.sources module
+-----------------------------
+
+.. automodule:: composer.cli.sources
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.cli\.status module
+----------------------------
+
+.. automodule:: composer.cli.status
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.cli\.utilities module
+-------------------------------
+
+.. automodule:: composer.cli.utilities
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: composer.cli
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/lorax-composer/_sources/composer.cli.txt b/lorax-composer/_sources/composer.cli.txt
index ed753029..a93fedfa 100644
--- a/lorax-composer/_sources/composer.cli.txt
+++ b/lorax-composer/_sources/composer.cli.txt
@@ -57,6 +57,14 @@ cli Package
:undoc-members:
:show-inheritance:
+:mod:`status` Module
+--------------------
+
+.. automodule:: composer.cli.status
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
:mod:`utilities` Module
-----------------------
diff --git a/lorax-composer/_sources/composer.rst.txt b/lorax-composer/_sources/composer.rst.txt
new file mode 100644
index 00000000..f6658ce6
--- /dev/null
+++ b/lorax-composer/_sources/composer.rst.txt
@@ -0,0 +1,37 @@
+composer package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+
+ composer.cli
+
+Submodules
+----------
+
+composer\.http\_client module
+-----------------------------
+
+.. automodule:: composer.http_client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+composer\.unix\_socket module
+-----------------------------
+
+.. automodule:: composer.unix_socket
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: composer
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/lorax-composer/_sources/index.rst.txt b/lorax-composer/_sources/index.rst.txt
new file mode 100644
index 00000000..67f2b9ed
--- /dev/null
+++ b/lorax-composer/_sources/index.rst.txt
@@ -0,0 +1,29 @@
+.. Lorax documentation master file, created by
+ sphinx-quickstart on Wed Apr 8 13:46:00 2015.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Lorax's documentation!
+=================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 1
+
+ intro
+ lorax
+ livemedia-creator
+ lorax-composer
+ composer-cli
+ product-images
+ modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/lorax-composer/_sources/intro.rst.txt b/lorax-composer/_sources/intro.rst.txt
new file mode 100644
index 00000000..01857ee9
--- /dev/null
+++ b/lorax-composer/_sources/intro.rst.txt
@@ -0,0 +1,67 @@
+Introduction to Lorax
+=====================
+
+I am the Lorax. I speak for the trees [and images].
+
+Lorax is used to build the Anaconda Installer boot.iso, it consists of a
+library, pylorax, a set of templates, and the lorax script. Its operation
+is driven by a customized set of Mako templates that lists the packages
+to be installed, steps to execute to remove unneeded files, and creation
+of the iso for all of the supported architectures.
+
+
+
+
+
+
+Before Lorax
+============
+
+Tree building tools such as pungi and revisor rely on 'buildinstall' in
+anaconda/scripts/ to produce the boot images and other such control files
+in the final tree. The existing buildinstall scripts written in a mix of
+bash and Python are unmaintainable. Lorax is an attempt to replace them
+with something more flexible.
+
+
+EXISTING WORKFLOW:
+
+pungi and other tools call scripts/buildinstall, which in turn call other
+scripts to do the image building and data generation. Here's how it
+currently looks:
+
+ -> buildinstall
+ * process command line options
+ * write temporary yum.conf to point to correct repo
+ * find anaconda release RPM
+ * unpack RPM, pull in those versions of upd-instroot, mk-images,
+ maketreeinfo.py, makestamp.py, and buildinstall
+
+ -> call upd-instroot
+
+ -> call maketreeinfo.py
+
+ -> call mk-images (which figures out which mk-images.ARCH to call)
+
+ -> call makestamp.py
+
+ * clean up
+
+
+PROBLEMS:
+
+The existing workflow presents some problems with maintaining the scripts.
+First, almost all knowledge of what goes in to the stage 1 and stage 2
+images lives in upd-instroot. The mk-images* scripts copy things from the
+root created by upd-instroot in order to build the stage 1 image, though
+it's not completely clear from reading the scripts.
+
+
+NEW IDEAS:
+
+Create a new central driver with all information living in Python modules.
+Configuration files will provide the knowledge previously contained in the
+upd-instroot and mk-images* scripts.
+
+
+
diff --git a/lorax-composer/_sources/livemedia-creator.rst.txt b/lorax-composer/_sources/livemedia-creator.rst.txt
new file mode 100644
index 00000000..94d6a331
--- /dev/null
+++ b/lorax-composer/_sources/livemedia-creator.rst.txt
@@ -0,0 +1,391 @@
+livemedia-creator
+=================
+
+:Authors:
+ Brian C. Lane
+
+livemedia-creator uses `Anaconda `_,
+`kickstart `_ and `Lorax
+`_ to create bootable media that use the
+same install path as a normal system installation. It can be used to make live
+isos, bootable (partitioned) disk images, tarfiles, and filesystem images for
+use with virtualization and container solutions like libvirt, docker, and
+OpenStack.
+
+The general idea is to use virt-install with kickstart and an Anaconda boot.iso to
+install into a disk image and then use the disk image to create the bootable
+media.
+
+livemedia-creator --help will describe all of the options available. At the
+minimum you need:
+
+``--make-iso`` to create a final bootable .iso or one of the other ``--make-*`` options.
+
+``--iso`` to specify the Anaconda install media to use with virt-install.
+
+``--ks`` to select the kickstart file describing what to install.
+
+To use livemedia-creator with virtualization you will need to have virt-install installed.
+
+If you are going to be using Anaconda directly, with ``--no-virt`` mode, make sure
+you have the anaconda-tui package installed.
+
+Conventions used in this document:
+
+``lmc`` is an abbreviation for livemedia-creator.
+
+``builder`` is the system where livemedia-creator is being run
+
+``image`` is the disk image being created by running livemedia-creator
+
+
+livemedia-creator cmdline arguments
+-----------------------------------
+
+See the output from ``livemedia-creator --help`` for the commandline arguments.
+
+Quickstart
+----------
+
+Run this to create a bootable live iso::
+
+ sudo livemedia-creator --make-iso \
+ --iso=/extra/iso/boot.iso --ks=./docs/rhel7-livemedia.ks
+
+You can run it directly from the lorax git repo like this::
+
+ sudo PATH=./src/sbin/:$PATH PYTHONPATH=./src/ ./src/sbin/livemedia-creator \
+ --make-iso --iso=/extra/iso/boot.iso \
+ --ks=./docs/rhel7-livemedia.ks --lorax-templates=./share/
+
+You can observe the installation using vnc. The logs will show what port was
+chosen, or you can use a specific port by passing it. eg. ``--vnc vnc:127.0.0.1:5``
+
+This is usually a good idea when testing changes to the kickstart. lmc tries
+to monitor the logs for fatal errors, but may not catch everything.
+
+
+How ISO creation works
+----------------------
+
+There are 2 stages, the install stage which produces a disk or filesystem image
+as its output, and the boot media creation which uses the image as its input.
+Normally you would run both stages, but it is possible to stop after the
+install stage, by using ``--image-only``, or to skip the install stage and use
+a previously created disk image by passing ``--disk-image`` or ``--fs-image``
+
+When creating an iso virt-install boots using the passed Anaconda installer iso
+and installs the system based on the kickstart. The ``%post`` section of the
+kickstart is used to customize the installed system in the same way that
+current spin-kickstarts do.
+
+livemedia-creator monitors the install process for problems by watching the
+install logs. They are written to the current directory or to the base
+directory specified by the --logfile command. You can also monitor the install
+by using a vnc client. This is recommended when first modifying a kickstart,
+since there are still places where Anaconda may get stuck without the log
+monitor catching it.
+
+The output from this process is a partitioned disk image. kpartx can be used
+to mount and examine it when there is a problem with the install. It can also
+be booted using kvm.
+
+When creating an iso the disk image's / partition is copied into a formatted
+filesystem image which is then used as the input to lorax for creation of the
+final media.
+
+The final image is created by lorax, using the templates in /usr/share/lorax/live/
+or the live directory below the directory specified by ``--lorax-templates``. The
+templates are written using the Mako template system with some extra commands
+added by lorax.
+
+
+Kickstarts
+----------
+
+The docs/ directory includes several example kickstarts, one to create a live
+desktop iso using GNOME, and another to create a minimal disk image. When
+creating your own kickstarts you should start with the minimal example, it
+includes several needed packages that are not always included by dependencies.
+
+Or you can use existing spin kickstarts to create live media with a few
+changes. Here are the steps I used to convert the Fedora XFCE spin.
+
+1. Flatten the xfce kickstart using ksflatten
+2. Add zerombr so you don't get the disk init dialog
+3. Add clearpart --all
+4. Add swap partition
+5. bootloader target
+6. Add shutdown to the kickstart
+7. Add network --bootproto=dhcp --activate to activate the network
+ This works for F16 builds but for F15 and before you need to pass
+ something on the cmdline that activate the network, like sshd:
+
+ ``livemedia-creator --kernel-args="sshd"``
+
+8. Add a root password::
+
+ rootpw rootme
+ network --bootproto=dhcp --activate
+ zerombr
+ clearpart --all
+ bootloader --location=mbr
+ part swap --size=512
+ shutdown
+
+9. In the livesys script section of the %post remove the root password. This
+ really depends on how the spin wants to work. You could add the live user
+ that you create to the %wheel group so that sudo works if you wanted to.
+
+ ``passwd -d root > /dev/null``
+
+10. Remove /etc/fstab in %post, dracut handles mounting the rootfs
+
+ ``cat /dev/null > /dev/fstab``
+
+ Do this only for live iso's, the filesystem will be mounted read only if
+ there is no /etc/fstab
+
+11. Don't delete initramfs files from /boot in %post
+12. When creating live iso's you need to have, at least, these packages in the %package section::
+ dracut-config-generic
+ dracut-live
+ -dracut-config-rescue
+ grub-efi
+ memtest86+
+ syslinux
+
+One drawback to using virt-install is that it pulls the packages from the repo
+each time you run it. To speed things up you either need a local mirror of the
+packages, or you can use a caching proxy. When using a proxy you pass it to
+livemedia-creator like this:
+
+ ``--proxy=http://proxy.yourdomain.com:3128``
+
+You also need to use a specific mirror instead of mirrormanager so that the
+packages will get cached, so your kickstart url would look like:
+
+ ``url --url="http://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/x86_64/os/"``
+
+You can also add an update repo, but don't name it updates. Add --proxy to it
+as well.
+
+
+Anaconda image install (no-virt)
+--------------------------------
+
+You can create images without using virt-install by passing ``--no-virt`` on
+the cmdline. This will use Anaconda's directory install feature to handle the
+install. There are a couple of things to keep in mind when doing this:
+
+1. It will be most reliable when building images for the same release that the
+ host is running. Because Anaconda has expectations about the system it is
+ running under you may encounter strange bugs if you try to build newer or
+ older releases.
+
+2. Make sure selinux is set to permissive or disabled. It won't install
+ correctly with selinux set to enforcing yet.
+
+3. It may totally trash your host. So far I haven't had this happen, but the
+ possibility exists that a bug in Anaconda could result in it operating on
+ real devices. I recommend running it in a virt or on a system that you can
+ afford to lose all data from.
+
+The logs from anaconda will be placed in an ./anaconda/ directory in either
+the current directory or in the directory used for --logfile
+
+Example cmdline:
+
+``sudo livemedia-creator --make-iso --no-virt --ks=./rhel7-livemedia.ks``
+
+.. note::
+ Using no-virt to create a partitioned disk image (eg. --make-disk or
+ --make-vagrant) will only create disks usable on the host platform (BIOS
+ or UEFI). You can create BIOS partitioned disk images on UEFI by using
+ virt.
+
+
+AMI Images
+----------
+
+Amazon EC2 images can be created by using the --make-ami switch and an appropriate
+kickstart file. All of the work to customize the image is handled by the kickstart.
+The example currently included was modified from the cloud-kickstarts version so
+that it would work with livemedia-creator.
+
+Example cmdline:
+
+``sudo livemedia-creator --make-ami --iso=/path/to/boot.iso --ks=./docs/rhel7-livemedia-ec2.ks``
+
+This will produce an ami-root.img file in the working directory.
+
+At this time I have not tested the image with EC2. Feedback would be welcome.
+
+
+Appliance Creation
+------------------
+
+livemedia-creator can now replace appliance-tools by using the --make-appliance
+switch. This will create the partitioned disk image and an XML file that can be
+used with virt-image to setup a virtual system.
+
+The XML is generated using the Mako template from
+/usr/share/lorax/appliance/libvirt.xml You can use a different template by
+passing ``--app-template ``
+
+Documentation on the Mako template system can be found at the `Mako site
+`_
+
+The name of the final output XML is appliance.xml, this can be changed with
+``--app-file ``
+
+The following variables are passed to the template:
+
+ ``disks``
+ A list of disk_info about each disk.
+ Each entry has the following attributes:
+
+ ``name``
+ base name of the disk image file
+
+ ``format``
+ "raw"
+
+ ``checksum_type``
+ "sha256"
+
+ ``checksum``
+ sha256 checksum of the disk image
+
+ ``name``
+ Name of appliance, from --app-name argument
+
+ ``arch``
+ Architecture
+
+ ``memory``
+ Memory in KB (from ``--ram``)
+
+ ``vcpus``
+ from ``--vcpus``
+
+ ``networks``
+ list of networks from the kickstart or []
+
+ ``title``
+ from ``--title``
+
+ ``project``
+ from ``--project``
+
+ ``releasever``
+ from ``--releasever``
+
+The created image can be imported into libvirt using:
+
+ ``virt-image appliance.xml``
+
+You can also create qcow2 appliance images using ``--image-type=qcow2``, for example::
+
+ sudo livemedia-creator --make-appliance --iso=/path/to/boot.iso --ks=./docs/rhel7-minimal.ks \
+ --image-type=qcow2 --app-file=minimal-test.xml --image-name=minimal-test.img
+
+
+Filesystem Image Creation
+-------------------------
+
+livemedia-creator can be used to create un-partitined filesystem images using
+the ``--make-fsimage`` option. As of version 21.8 this works with both virt and
+no-virt modes of operation. Previously it was only available with no-virt.
+
+Kickstarts should have a single / partition with no extra mountpoints.
+
+ ``livemedia-creator --make-fsimage --iso=/path/to/boot.iso --ks=./docs/rhel7-minimal.ks``
+
+You can name the output image with ``--image-name`` and set a label on the filesystem with ``--fs-label``
+
+
+TAR File Creation
+-----------------
+
+The ``--make-tar`` command can be used to create a tar of the root filesystem. By
+default it is compressed using xz, but this can be changed using the
+``--compression`` and ``--compress-arg`` options. This option works with both virt and
+no-virt install methods.
+
+As with ``--make-fsimage`` the kickstart should be limited to a single / partition.
+
+For example::
+
+ livemedia-creator --make-tar --iso=/path/to/boot.iso --ks=./docs/rhel7-minimal.ks \
+ --image-name=rhel7-root.tar.xz
+
+
+Live Image for PXE Boot
+-----------------------
+
+The ``--make-pxe-live`` command will produce squashfs image containing live root
+filesystem that can be used for pxe boot. Directory with results will contain
+the live image, kernel image, initrd image and template of pxe configuration
+for the images.
+
+
+Atomic Live Image for PXE Boot
+------------------------------
+
+The ``--make-ostree-live`` command will produce the same result as ``--make-pxe-live``
+for installations of Atomic Host. Example kickstart for such an installation
+using Atomic installer iso with local repo included in the image can be found
+in docs/rhel-atomic-pxe-live.ks.
+
+The PXE images can also be created with ``--no-virt`` by using the example
+kickstart in docs/rhel-atomic-pxe-live-novirt.ks. This also works inside the
+mock environment.
+
+
+Debugging problems
+------------------
+
+Sometimes an installation will get stuck. When using virt-install the logs will
+be written to ./virt-install.log and most of the time any problems that happen
+will be near the end of the file. lmc tries to detect common errors and will
+cancel the installation when they happen. But not everything can be caught.
+When creating a new kickstart it is helpful to use vnc so that you can monitor
+the installation as it happens, and if it gets stuck without lmc detecting the
+problem you can switch to tty1 and examine the system directly.
+
+If it does get stuck the best way to cancel is to use kill -9 on the virt-install pid,
+lmc will detect that the process died and cleanup.
+
+If lmc didn't handle the cleanup for some reason you can do this:
+1. ``sudo umount /tmp/lmc-XXXX`` to unmount the iso from its mountpoint.
+2. ``sudo rm -rf /tmp/lmc-XXXX``
+3. ``sudo rm /var/tmp/lmc-disk-XXXXX`` to remove the disk image.
+
+Note that lmc uses the lmc- prefix for all of its temporary files and
+directories to make it easier to find and clean up leftovers.
+
+The logs from the virt-install run are stored in virt-install.log, logs from
+livemedia-creator are in livemedia.log and program.log
+
+You can add ``--image-only`` to skip the .iso creation and examine the resulting
+disk image. Or you can pass ``--keep-image`` to keep it around after the iso has
+been created.
+
+Cleaning up aborted ``--no-virt`` installs can sometimes be accomplished by
+running the ``anaconda-cleanup`` script. As of Fedora 18 anaconda is
+multi-threaded and it can sometimes become stuck and refuse to exit. When this
+happens you can usually clean up by first killing the anaconda process then
+running ``anaconda-cleanup``.
+
+
+Hacking
+-------
+
+Development on this will take place as part of the lorax project, and on the
+anaconda-devel-list mailing list, and `on github `_
+
+Feedback, enhancements and bugs are welcome. You can use `bugzilla
+`_ to
+report bugs against the lorax component.
+
diff --git a/lorax-composer/_sources/lorax-composer.rst.txt b/lorax-composer/_sources/lorax-composer.rst.txt
new file mode 100644
index 00000000..69dcc24e
--- /dev/null
+++ b/lorax-composer/_sources/lorax-composer.rst.txt
@@ -0,0 +1,312 @@
+lorax-composer
+==============
+
+:Authors:
+ Brian C. Lane
+
+``lorax-composer`` is an API server that allows you to build disk images using
+`Blueprints`_ to describe the package versions to be installed into the image.
+It is compatible with the Weldr project's bdcs-api REST protocol. More
+information on Weldr can be found `on the Weldr blog `_.
+
+Behind the scenes it uses `livemedia-creator `_ and
+`Anaconda `_ to handle the
+installation and configuration of the images.
+
+Important Things To Note
+------------------------
+
+* SELinux must be in Permissive mode. Anaconda requires SELinux be in permissive mode
+ for image creation to work correctly. You can either edit the setting in the
+ ``/etc/sysconfig/selinux`` file, or run ``setenforce 0`` before starting lorax-composer.
+
+* Some output types require packages from the RHEL 7 Optional repository. See the
+ `Red Hat Enterprise Linux 7 documentation `_
+ for information on how to enable it. Otherwise you will see image creation fail to
+ depsolve even if the blueprint itself is correct.
+
+Installation
+------------
+
+The best way to install ``lorax-composer`` is to use ``sudo dnf install
+lorax-composer composer-cli``, this will setup the weldr user and install the
+systemd socket activation service. You will then need to enable it with ``sudo
+systemctl enable lorax-composer.socket && sudo systemctl start
+lorax-composer.socket``. This will leave the server off until the first request
+is made. Systemd will then launch the server and it will remain running until
+the system is rebooted.
+
+Quickstart
+----------
+
+1. Create a ``weldr`` user and group by running ``useradd weldr``
+2. Remove any pre-existing socket directory with ``rm -rf /run/weldr/``
+ A new directory with correct permissions will be created the first time the server runs.
+3. Enable the socket activation with ``systemctl enable lorax-composer.socket
+ && sudo systemctl start lorax-composer.socket``.
+
+NOTE: You can also run it directly with ``lorax-composer /path/to/blueprints``. However,
+``lorax-composer`` does not react well to being started both on the command line and via
+socket activation at the same time. It is therefore recommended that you run it directly
+on the command line only for testing or development purposes. For real use or development
+of other projects that simply use the API, you should stick to socket activation only.
+
+The ``/path/to/blueprints/`` directory is where the blueprints' git repo will
+be created, and all the blueprints created with the ``/api/v0/blueprints/new``
+route will be stored. If there are blueprint ``.toml`` files in the top level
+of the directory they will be imported into the blueprint git storage when
+``lorax-composer`` starts.
+
+Logs
+----
+
+Logs are stored under ``/var/log/lorax-composer/`` and include all console
+messages as well as extra debugging info and API requests.
+
+Security
+--------
+
+Some security related issues that you should be aware of before running ``lorax-composer``:
+
+* One of the API server threads needs to retain root privileges in order to run Anaconda.
+* SELinux must be set to Permissive or disabled to allow ``livemedia-creator`` to run Anaconda.
+* Only allow authorized users access to the ``weldr`` group and socket.
+
+Since Anaconda kickstarts are used there is the possibility that a user could
+inject commands into a blueprint that would result in the kickstart executing
+arbitrary code on the host. Only authorized users should be allowed to build
+images using ``lorax-composer``.
+
+How it Works
+------------
+
+The server runs as root, and as ``weldr``. Communication with it is via a unix
+domain socket (``/run/weldr/api.socket`` by default). The directory and socket
+are owned by ``root:weldr`` so that any user in the ``weldr`` group can use the API
+to control ``lorax-composer``.
+
+At startup the server will check for the correct permissions and
+ownership of a pre-existing directory, or it will create a new one if it
+doesn't exist. The socket path and group owner's name can be changed from the
+cmdline by passing it the ``--socket`` and ``--group`` arguments.
+
+It will then drop root privileges for the API thread and run as the ``weldr``
+user. The queue and compose thread still runs as root because it needs to be
+able to mount/umount files and run Anaconda.
+
+Composing Images
+----------------
+
+The `welder-web `_ GUI project can be used to construct
+blueprints and create composes using a web browser.
+
+Or use the command line with `composer-cli `_.
+
+Blueprints
+----------
+
+Blueprints are simple text files in `TOML `_ format that describe
+which packages, and what versions, to install into the image. They can also define a limited set
+of customizations to make to the final image.
+
+Example blueprints can be found in the ``lorax-composer`` `test suite
+`_, with a simple one
+looking like this::
+
+ name = "base"
+ description = "A base system with bash"
+ version = "0.0.1"
+
+ [[packages]]
+ name = "bash"
+ version = "4.4.*"
+
+The ``name`` field is the name of the blueprint. It can contain spaces, but they will be converted to ``-``
+when it is written to disk. It should be short and descriptive.
+
+``description`` can be a longer description of the blueprint, it is only used for display purposes.
+
+``version`` is a `semver compatible `_ version number. If
+a new blueprint is uploaded with the same ``version`` the server will
+automatically bump the PATCH level of the ``version``. If the ``version``
+doesn't match it will be used as is. eg. Uploading a blueprint with ``version``
+set to ``0.1.0`` when the existing blueprint ``version`` is ``0.0.1`` will
+result in the new blueprint being stored as ``version 0.1.0``.
+
+[[packages]] and [[modules]]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These entries describe the package names and matching version glob to be installed into the image.
+
+The names must match the names exactly, and the versions can be an exact match
+or a filesystem-like glob of the version using ``*`` wildcards and ``?``
+character matching.
+
+NOTE: As of lorax-composer-29.2-1 the versions are not used for depsolving,
+that is planned for a future release. And currently there are no differences
+between ``packages`` and ``modules`` in ``lorax-composer``.
+
+[[groups]]
+~~~~~~~~~~
+
+These entries describe a group of packages to be installed into the image. Package groups are
+defined in the repository metadata. Each group has a descriptive name used primarily for display
+in user interfaces and an ID more commonly used in kickstart files. Here, the ID is the expected
+way of listing a group.
+
+Groups have three different ways of categorizing their packages: mandatory, default, and optional.
+For purposes of blueprints, mandatory and default packages will be installed. There is no mechanism
+for selecting optional packages.
+
+Customizations
+~~~~~~~~~~~~~~
+
+The ``[[customizations]]`` section can be used to configure the hostname of the final image. eg.::
+
+ [[customizations]]
+ hostname = "baseimage"
+
+
+[[customizations.sshkey]]
+*************************
+
+Set an existing user's ssh key in the final image::
+
+ [[customizations.sshkey]]
+ user = "root"
+ key = "PUBLIC SSH KEY"
+
+The key will be added to the user's authorized_keys file.
+
+
+[[customizations.user]]
+***********************
+
+Add a user to the image, and/or set their ssh key.
+All fields for this section are optional except for the ``name``, here is a complete example::
+
+ [[customizations.user]]
+ name = "admin"
+ description = "Administrator account"
+ password = "$6$CHO2$3rN8eviE2t50lmVyBYihTgVRHcaecmeCk31L..."
+ key = "PUBLIC SSH KEY"
+ home = "/srv/widget/"
+ shell = "/usr/bin/bash"
+ groups = ["widget", "users", "wheel"]
+ uid = 1200
+ gid = 1200
+
+If the password starts with ``$6$``, ``$5$``, or ``$2b$`` it will be stored as
+an encrypted password. Otherwise it will be treated as a plain text password.
+
+
+[[customizations.group]]
+************************
+
+Add a group to the image. ``name`` is required and ``gid`` is optional::
+
+ [[customizations.group]]
+ name = "widget"
+ gid = 1130
+
+
+Adding Output Types
+-------------------
+
+``livemedia-creator`` supports a large number of output types, and only some of
+these are currently available via ``lorax-composer``. To add a new output type to
+lorax-composer a kickstart file needs to be added to ``./share/composer/``. The
+name of the kickstart is what will be used by the ``/compose/types`` route, and the
+``compose_type`` field of the POST to start a compose. It also needs to have
+code added to the :py:func:`pylorax.api.compose.compose_args` function. The
+``_MAP`` entry in this function defines what lorax-composer will pass to
+:py:func:`pylorax.installer.novirt_install` when it runs the compose. When the
+compose is finished the output files need to be copied out of the build
+directory (``/var/lib/lorax/composer/results//compose/``),
+:py:func:`pylorax.api.compose.move_compose_results` handles this for each type.
+You should move them instead of copying to save space.
+
+If the new output type does not have support in livemedia-creator it should be
+added there first. This will make the output available to the widest number of
+users.
+
+Example: Add partitioned disk support
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Partitioned disk support is something that livemedia-creator already supports
+via the ``--make-disk`` cmdline argument. To add this to lorax-composer it
+needs 3 things:
+
+* A ``partitioned-disk.ks`` file in ``./share/composer/``
+* A new entry in the _MAP in :py:func:`pylorax.api.compose.compose_args`
+* Add a bit of code to :py:func:`pylorax.api.compose.move_compose_results` to move the disk image from
+ the compose directory to the results directory.
+
+The ``partitioned-disk.ks`` is pretty similar to the example minimal kickstart
+in ``./docs/rhel7-minimal.ks``. You should remove the ``url`` and ``repo``
+commands, they will be added by the compose process. Make sure the bootloader
+packages are included in the ``%packages`` section at the end of the kickstart,
+and you will want to leave off the ``%end`` so that the compose can append the
+list of packages from the blueprint.
+
+The new ``_MAP`` entry should be a copy of one of the existing entries, but with ``make_disk`` set
+to ``True``. Make sure that none of the other ``make_*`` options are ``True``. The ``image_name`` is
+what the name of the final image will be.
+
+``move_compose_results()`` can be as simple as moving the output file into
+the results directory, or it could do some post-processing on it. The end of
+the function should always clean up the ``./compose/`` directory, removing any
+unneeded extra files. This is especially true for the ``live-iso`` since it produces
+the contents of the iso as well as the boot.iso itself.
+
+Package Sources
+---------------
+
+By default lorax-composer uses the host's configured repositories. It copies
+the ``*.repo`` files from ``/etc/yum.repos.d/`` into
+``/var/lib/lorax/composer/repos.d/`` at startup, these are immutable system
+repositories and cannot be deleted or changed. If you want to add additional
+repos you can put them into ``/var/lib/lorax/composer/repos.d/`` or use the
+``/api/v0/projects/source/*`` API routes to create them.
+
+The new source can be added by doing a POST to the ``/api/v0/projects/source/new``
+route using JSON (with `Content-Type` header set to `application/json`) or TOML
+(with it set to `text/x-toml`). The format of the source looks like this (in
+TOML)::
+
+ name = "custom-source-1"
+ url = "https://url/path/to/repository/"
+ type = "yum-baseurl"
+ proxy = "https://proxy-url/"
+ check_ssl = true
+ check_gpg = true
+ gpgkey_urls = ["https://url/path/to/gpg-key"]
+
+The ``proxy`` and ``gpgkey_urls`` entries are optional. All of the others are required. The supported
+types for the urls are:
+
+* ``yum-baseurl`` is a URL to a yum repository.
+* ``yum-mirrorlist`` is a URL for a mirrorlist.
+* ``yum-metalink`` is a URL for a metalink.
+
+If ``check_ssl`` is true the https certificates must be valid. If they are self-signed you can either set
+this to false, or add your Certificate Authority to the host system.
+
+If ``check_gpg`` is true the GPG key must either be installed on the host system, or ``gpgkey_urls``
+should point to it.
+
+You can edit an existing source (other than system sources), by doing a POST to the ``new`` route
+with the new version of the source. It will overwrite the previous one.
+
+A list of existing sources is available from ``/api/v0/projects/source/list``, and detailed info
+on a source can be retrieved with the ``/api/v0/projects/source/info/`` route. By default
+it returns JSON but it can also return TOML if ``?format=toml`` is added to the request.
+
+Non-system sources can be deleted by doing a ``DELETE`` request to the
+``/api/v0/projects/source/delete/`` route.
+
+The documentation for the source API routes can be `found here `_
+
+The configured sources are used for all blueprint depsolve operations, and for composing images.
+When adding additional sources you must make sure that the packages in the source do not
+conflict with any other package sources, otherwise depsolving will fail.
diff --git a/lorax-composer/_sources/lorax-composer.txt b/lorax-composer/_sources/lorax-composer.txt
index 580338f4..749b816a 100644
--- a/lorax-composer/_sources/lorax-composer.txt
+++ b/lorax-composer/_sources/lorax-composer.txt
@@ -34,7 +34,13 @@ systemd socket activation service. You will then need to enable it with ``sudo
systemctl enable lorax-composer.socket && sudo systemctl start
lorax-composer.socket``. This will leave the server off until the first request
is made. Systemd will then launch the server and it will remain running until
-the system is rebooted.
+the system is rebooted. This will cause some delay in responding to the first
+request from the UI or `composer-cli`.
+
+.. note::
+
+ If you want lorax-composer to respond immediately to the first request you can
+ start and enable `lorax-composer.service` instead of `lorax-composer.socket`
Quickstart
----------
@@ -43,8 +49,13 @@ Quickstart
2. Remove any pre-existing socket directory with ``rm -rf /run/weldr/``
A new directory with correct permissions will be created the first time the server runs.
3. Enable the socket activation with ``systemctl enable lorax-composer.socket
- && sudo systemctl start lorax-composer.socket`` or run it directly with
- ``lorax-composer /path/to/blueprints/``
+ && sudo systemctl start lorax-composer.socket``.
+
+NOTE: You can also run it directly with ``lorax-composer /path/to/blueprints``. However,
+``lorax-composer`` does not react well to being started both on the command line and via
+socket activation at the same time. It is therefore recommended that you run it directly
+on the command line only for testing or development purposes. For real use or development
+of other projects that simply use the API, you should stick to socket activation only.
The ``/path/to/blueprints/`` directory is where the blueprints' git repo will
be created, and all the blueprints created with the ``/api/v0/blueprints/new``
@@ -141,6 +152,18 @@ NOTE: As of lorax-composer-29.2-1 the versions are not used for depsolving,
that is planned for a future release. And currently there are no differences
between ``packages`` and ``modules`` in ``lorax-composer``.
+[[groups]]
+~~~~~~~~~~
+
+These entries describe a group of packages to be installed into the image. Package groups are
+defined in the repository metadata. Each group has a descriptive name used primarily for display
+in user interfaces and an ID more commonly used in kickstart files. Here, the ID is the expected
+way of listing a group.
+
+Groups have three different ways of categorizing their packages: mandatory, default, and optional.
+For purposes of blueprints, mandatory and default packages will be installed. There is no mechanism
+for selecting optional packages.
+
Customizations
~~~~~~~~~~~~~~
diff --git a/lorax-composer/_sources/lorax.rst.txt b/lorax-composer/_sources/lorax.rst.txt
new file mode 100644
index 00000000..272970ae
--- /dev/null
+++ b/lorax-composer/_sources/lorax.rst.txt
@@ -0,0 +1,148 @@
+Lorax
+=====
+
+:Authors:
+ Brian C. Lane
+
+"I am the Lorax. I speak for the trees [and images]."
+
+The `lorax `_ tool is used to create the
+`Anaconda `_ installer boot.iso as
+well as the basic release tree, and .treeinfo metadata file. Its dependencies
+are fairly light-weight because it needs to be able to run in a mock chroot
+environment. It is best to run lorax from the same release as is being targeted
+because the templates may have release specific logic in them. eg. Use the
+rawhide version to build the boot.iso for rawhide, along with the rawhide
+repositories.
+
+
+lorax cmdline arguments
+-----------------------
+
+See the output from ``lorax --help`` for the commandline arguments.
+
+Quickstart
+----------
+
+Run this as root to create a boot.iso in ``./results/``::
+
+ yum install lorax
+ setenforce 0
+ lorax -p RHEL -v 7 -r 7 \
+ -s http://mirror.centos.org/centos-7/7/os/x86_64/ \
+ -s http://mirror.centos.org/centos-7/7/updates/x86_64/ \
+ ./results/
+ setenforce 1
+
+You can add your own repos with ``-s`` and packages with higher NVRs will
+override the ones in the distribution repositories.
+
+Under ``./results/`` will be the release tree files: .discinfo, .treeinfo, everything that
+goes onto the boot.iso, the pxeboot directory, and the boot.iso under ``./images/``.
+
+
+Running inside of mock
+----------------------
+
+If you are using lorax with mock v1.3.4 or later you will need to pass
+``--old-chroot`` to mock. Mock now defaults to using systemd-nspawn which cannot
+create the needed loop device nodes. Passing ``--old-chroot`` will use the old
+system where ``/dev/loop*`` is setup for you.
+
+
+How it works
+------------
+
+Lorax uses `yum `_ to install
+packages into a temporary directory, sets up configuration files, it then
+removes unneeded files to save space, and creates a squashfs filesystem of the
+files. The iso is then built using a generic initramfs and the kernel from the
+selected repositories.
+
+To drive these processes Lorax uses a custom template system, based on `Mako
+templates `_ with the addition of custom
+commands (documented in :class:`pylorax.ltmpl.LoraxTemplateRunner`). Mako
+supports ``%if/%endif`` blocks as well as free-form python code inside ``<%
+%>`` tags and variable substitution with ``${}``. The default templates are
+shipped with lorax in ``/usr/share/lorax/`` and use the
+``.tmpl`` extension.
+
+
+runtime-install.tmpl
+~~~~~~~~~~~~~~~~~~~~
+
+The ``runtime-install.tmpl`` template lists packages to be installed using the
+``installpkg`` command. This template is fairly simple, installing common packages and
+architecture specific packages. It must end with the ``run_pkg_transaction``
+command which tells dnf to download and install the packages.
+
+
+runtime-postinstall.tmpl
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``runtime-postinstall.tmpl`` template is where the system configuration
+happens. The installer environment is similar to a normal running system, but
+needs some special handling. Configuration files are setup, systemd is told to
+start the anaconda.target instead of a default system target, and a number of
+unneeded services are disabled, some of which can interfere with the
+installation. A number of template commands are used here:
+
+* :func:`append ` to add text to a file.
+* :func:`chmod ` changes the file's mode.
+* :func:`gconfset ` runs gconfset.
+* :func:`install ` to install a file into the installroot.
+* :func:`mkdir ` makes a new directory.
+* :func:`move ` to move a file into the installroot
+* :func:`replace ` does text substitution in a file
+* :func:`remove ` deletes a file
+* :func:`runcmd ` run arbitrary commands.
+* :func:`symlink ` creates a symlink
+* :func:`systemctl ` runs systemctl in the installroot
+
+
+runtime-cleanup.tmpl
+~~~~~~~~~~~~~~~~~~~~
+
+The ``runtime-cleanup.tmpl`` template is used to remove files that aren't strictly needed
+by the installation environment. In addition to the ``remove`` template command it uses:
+
+* :func:`removepkg `
+ remove all of a specific package's contents. A package may be pulled in as a dependency, but
+ not really used. eg. sound support.
+* :func:`removefrom `
+ Removes some files from a package. A file glob can be used, or the --allbut option to
+ remove everything except a select few.
+* :func:`removekmod `
+ Removes kernel modules
+
+
+The squashfs filesystem
+~~~~~~~~~~~~~~~~~~~~~~~
+
+After ``runtime-*.tmpl`` templates have finished their work lorax creates an
+empty ext4 filesystem, copies the remaining files to it, and makes a squashfs
+filesystem of it. This file is the / of the boot.iso's installer environment
+and is what is in the LiveOS/squashfs.img file on the iso.
+
+
+iso creation
+~~~~~~~~~~~~
+
+The iso creation is handled by another set of templates. The one used depends
+on the architecture that the iso is being created for. They are also stored in
+``/usr/share/lorax/`` and are named after the arch, like
+``x86.tmpl`` and ``aarch64.tmpl``. They handle creation of the tree, copying
+configuration template files, configuration variable substitution, treeinfo
+metadata (via the :func:`treeinfo `
+template command). Kernel and initrd are copied from the installroot to their
+final locations and then mkisofs is run to create the boot.iso
+
+
+Custom Templates
+----------------
+
+The default set of templates and configuration files are shipped in the
+``/usr/share/lorax/`` directory. You can make a copy of them and place them
+into another directory and then select the new template directory by passing
+``--sharedir`` to lorax.
+
diff --git a/lorax-composer/_sources/modules.rst.txt b/lorax-composer/_sources/modules.rst.txt
new file mode 100644
index 00000000..15b5f96f
--- /dev/null
+++ b/lorax-composer/_sources/modules.rst.txt
@@ -0,0 +1,8 @@
+src
+===
+
+.. toctree::
+ :maxdepth: 4
+
+ composer
+ pylorax
diff --git a/lorax-composer/_sources/product-images.rst.txt b/lorax-composer/_sources/product-images.rst.txt
new file mode 100644
index 00000000..9b75afd8
--- /dev/null
+++ b/lorax-composer/_sources/product-images.rst.txt
@@ -0,0 +1,27 @@
+Product and Updates Images
+==========================
+
+Lorax now supports creation of product.img and updates.img as part of the build
+process. This is implemented using the installimg template command which will
+take the contents of a directory and create a compressed archive from it. The
+directory must be created by one of the packages installed by
+runtime-install.tmpl or by passing ``--installpkgs `` to lorax at
+runtime. The x86, ppc, ppc64le and aarch64 templates all look for
+/usr/share/lorax/product/ and /usr/share/lorax/updates/ directories in the
+install chroot while creating the final install tree. If there are files in
+those directories lorax will create images/product.img and/or
+images/updates.img
+
+These archives are just like an anaconda updates image -- their contents are
+copied over the top of the filesystem at boot time so that you can drop in
+files to add to or replace anything on the filesystem.
+
+Anaconda has several places that it looks for updates, the one for product.img
+is in /run/install/product. So for example, to add an installclass to Anaconda
+you would put your custom class here:
+
+``/usr/share/lorax/product/run/install/product/pyanaconda/installclasses/custom.py``
+
+If the packages containing the product/updates files are not included as part
+of normal dependencies you can add specific packages with the ``--installpkgs``
+command or the installpkgs paramater of :class:`pylorax.treebuilder.RuntimeBuilder`
diff --git a/lorax-composer/_sources/pylorax.api.rst.txt b/lorax-composer/_sources/pylorax.api.rst.txt
new file mode 100644
index 00000000..dde69153
--- /dev/null
+++ b/lorax-composer/_sources/pylorax.api.rst.txt
@@ -0,0 +1,126 @@
+pylorax\.api package
+====================
+
+Submodules
+----------
+
+pylorax\.api\.checkparams module
+--------------------------------
+
+.. automodule:: pylorax.api.checkparams
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.compose module
+----------------------------
+
+.. automodule:: pylorax.api.compose
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.config module
+---------------------------
+
+.. automodule:: pylorax.api.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.crossdomain module
+--------------------------------
+
+.. automodule:: pylorax.api.crossdomain
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.errors module
+---------------------------
+
+.. automodule:: pylorax.api.errors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.projects module
+-----------------------------
+
+.. automodule:: pylorax.api.projects
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.queue module
+--------------------------
+
+.. automodule:: pylorax.api.queue
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.recipes module
+----------------------------
+
+.. automodule:: pylorax.api.recipes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.regexes module
+----------------------------
+
+.. automodule:: pylorax.api.regexes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.server module
+---------------------------
+
+.. automodule:: pylorax.api.server
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.timestamp module
+------------------------------
+
+.. automodule:: pylorax.api.timestamp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.v0 module
+-----------------------
+
+.. automodule:: pylorax.api.v0
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.workspace module
+------------------------------
+
+.. automodule:: pylorax.api.workspace
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.api\.yumbase module
+----------------------------
+
+.. automodule:: pylorax.api.yumbase
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pylorax.api
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/lorax-composer/_sources/pylorax.api.txt b/lorax-composer/_sources/pylorax.api.txt
index 87f5f4d1..a2093cdb 100644
--- a/lorax-composer/_sources/pylorax.api.txt
+++ b/lorax-composer/_sources/pylorax.api.txt
@@ -9,6 +9,14 @@ api Package
:undoc-members:
:show-inheritance:
+:mod:`checkparams` Module
+-------------------------
+
+.. automodule:: pylorax.api.checkparams
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
:mod:`compose` Module
---------------------
@@ -33,6 +41,14 @@ api Package
:undoc-members:
:show-inheritance:
+:mod:`errors` Module
+--------------------
+
+.. automodule:: pylorax.api.errors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
:mod:`projects` Module
----------------------
@@ -57,6 +73,14 @@ api Package
:undoc-members:
:show-inheritance:
+:mod:`regexes` Module
+---------------------
+
+.. automodule:: pylorax.api.regexes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
:mod:`server` Module
--------------------
@@ -65,6 +89,14 @@ api Package
:undoc-members:
:show-inheritance:
+:mod:`timestamp` Module
+-----------------------
+
+.. automodule:: pylorax.api.timestamp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
:mod:`v0` Module
----------------
diff --git a/lorax-composer/_sources/pylorax.rst.txt b/lorax-composer/_sources/pylorax.rst.txt
new file mode 100644
index 00000000..d5280598
--- /dev/null
+++ b/lorax-composer/_sources/pylorax.rst.txt
@@ -0,0 +1,141 @@
+pylorax package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+
+ pylorax.api
+
+Submodules
+----------
+
+pylorax\.base module
+--------------------
+
+.. automodule:: pylorax.base
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.buildstamp module
+--------------------------
+
+.. automodule:: pylorax.buildstamp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.creator module
+-----------------------
+
+.. automodule:: pylorax.creator
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.decorators module
+--------------------------
+
+.. automodule:: pylorax.decorators
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.discinfo module
+------------------------
+
+.. automodule:: pylorax.discinfo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.executils module
+-------------------------
+
+.. automodule:: pylorax.executils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.imgutils module
+------------------------
+
+.. automodule:: pylorax.imgutils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.installer module
+-------------------------
+
+.. automodule:: pylorax.installer
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.logmonitor module
+--------------------------
+
+.. automodule:: pylorax.logmonitor
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.ltmpl module
+---------------------
+
+.. automodule:: pylorax.ltmpl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.output module
+----------------------
+
+.. automodule:: pylorax.output
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.sysutils module
+------------------------
+
+.. automodule:: pylorax.sysutils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.treebuilder module
+---------------------------
+
+.. automodule:: pylorax.treebuilder
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.treeinfo module
+------------------------
+
+.. automodule:: pylorax.treeinfo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pylorax\.yumhelper module
+-------------------------
+
+.. automodule:: pylorax.yumhelper
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pylorax
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/lorax-composer/_static/classic.css b/lorax-composer/_static/classic.css
new file mode 100644
index 00000000..6cfbfb9c
--- /dev/null
+++ b/lorax-composer/_static/classic.css
@@ -0,0 +1,261 @@
+/*
+ * classic.css_t
+ * ~~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- classic theme.
+ *
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: sans-serif;
+ font-size: 100%;
+ background-color: #11303d;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+div.document {
+ background-color: #1c4e63;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 230px;
+}
+
+div.body {
+ background-color: #ffffff;
+ color: #000000;
+ padding: 0 20px 30px 20px;
+}
+
+div.footer {
+ color: #ffffff;
+ width: 100%;
+ padding: 9px 0 9px 0;
+ text-align: center;
+ font-size: 75%;
+}
+
+div.footer a {
+ color: #ffffff;
+ text-decoration: underline;
+}
+
+div.related {
+ background-color: #133f52;
+ line-height: 30px;
+ color: #ffffff;
+}
+
+div.related a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar {
+}
+
+div.sphinxsidebar h3 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.4em;
+ font-weight: normal;
+ margin: 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h3 a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar h4 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.3em;
+ font-weight: normal;
+ margin: 5px 0 0 0;
+ padding: 0;
+}
+
+div.sphinxsidebar p {
+ color: #ffffff;
+}
+
+div.sphinxsidebar p.topless {
+ margin: 5px 10px 10px 10px;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px;
+ padding: 0;
+ color: #ffffff;
+}
+
+div.sphinxsidebar a {
+ color: #98dbcc;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+
+
+/* -- hyperlink styles ------------------------------------------------------ */
+
+a {
+ color: #355f7c;
+ text-decoration: none;
+}
+
+a:visited {
+ color: #355f7c;
+ text-decoration: none;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+
+
+/* -- body styles ----------------------------------------------------------- */
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: 'Trebuchet MS', sans-serif;
+ background-color: #f2f2f2;
+ font-weight: normal;
+ color: #20435c;
+ border-bottom: 1px solid #ccc;
+ margin: 20px -20px 10px -20px;
+ padding: 3px 0 3px 10px;
+}
+
+div.body h1 { margin-top: 0; font-size: 200%; }
+div.body h2 { font-size: 160%; }
+div.body h3 { font-size: 140%; }
+div.body h4 { font-size: 120%; }
+div.body h5 { font-size: 110%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #c60f0f;
+ font-size: 0.8em;
+ padding: 0 4px 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ background-color: #c60f0f;
+ color: white;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ text-align: justify;
+ line-height: 130%;
+}
+
+div.admonition p.admonition-title + p {
+ display: inline;
+}
+
+div.admonition p {
+ margin-bottom: 5px;
+}
+
+div.admonition pre {
+ margin-bottom: 5px;
+}
+
+div.admonition ul, div.admonition ol {
+ margin-bottom: 5px;
+}
+
+div.note {
+ background-color: #eee;
+ border: 1px solid #ccc;
+}
+
+div.seealso {
+ background-color: #ffc;
+ border: 1px solid #ff6;
+}
+
+div.topic {
+ background-color: #eee;
+}
+
+div.warning {
+ background-color: #ffe4e4;
+ border: 1px solid #f66;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre {
+ padding: 5px;
+ background-color: #eeffcc;
+ color: #333333;
+ line-height: 120%;
+ border: 1px solid #ac9;
+ border-left: none;
+ border-right: none;
+}
+
+code {
+ background-color: #ecf0f3;
+ padding: 0 1px 0 1px;
+ font-size: 0.95em;
+}
+
+th {
+ background-color: #ede;
+}
+
+.warning code {
+ background: #efc2c2;
+}
+
+.note code {
+ background: #d6d6d6;
+}
+
+.viewcode-back {
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ background-color: #f4debf;
+ border-top: 1px solid #ac9;
+ border-bottom: 1px solid #ac9;
+}
+
+div.code-block-caption {
+ color: #efefef;
+ background-color: #1c4e63;
+}
\ No newline at end of file
diff --git a/lorax-composer/_static/jquery-3.1.0.js b/lorax-composer/_static/jquery-3.1.0.js
new file mode 100644
index 00000000..f2fc2747
--- /dev/null
+++ b/lorax-composer/_static/jquery-3.1.0.js
@@ -0,0 +1,10074 @@
+/*eslint-disable no-unused-vars*/
+/*!
+ * jQuery JavaScript Library v3.1.0
+ * https://jquery.com/
+ *
+ * Includes Sizzle.js
+ * https://sizzlejs.com/
+ *
+ * Copyright jQuery Foundation and other contributors
+ * Released under the MIT license
+ * https://jquery.org/license
+ *
+ * Date: 2016-07-07T21:44Z
+ */
+( function( global, factory ) {
+
+ "use strict";
+
+ if ( typeof module === "object" && typeof module.exports === "object" ) {
+
+ // For CommonJS and CommonJS-like environments where a proper `window`
+ // is present, execute the factory and get jQuery.
+ // For environments that do not have a `window` with a `document`
+ // (such as Node.js), expose a factory as module.exports.
+ // This accentuates the need for the creation of a real `window`.
+ // e.g. var jQuery = require("jquery")(window);
+ // See ticket #14549 for more info.
+ module.exports = global.document ?
+ factory( global, true ) :
+ function( w ) {
+ if ( !w.document ) {
+ throw new Error( "jQuery requires a window with a document" );
+ }
+ return factory( w );
+ };
+ } else {
+ factory( global );
+ }
+
+// Pass this if window is not defined yet
+} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
+
+// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
+// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
+// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
+// enough that all such attempts are guarded in a try block.
+"use strict";
+
+var arr = [];
+
+var document = window.document;
+
+var getProto = Object.getPrototypeOf;
+
+var slice = arr.slice;
+
+var concat = arr.concat;
+
+var push = arr.push;
+
+var indexOf = arr.indexOf;
+
+var class2type = {};
+
+var toString = class2type.toString;
+
+var hasOwn = class2type.hasOwnProperty;
+
+var fnToString = hasOwn.toString;
+
+var ObjectFunctionString = fnToString.call( Object );
+
+var support = {};
+
+
+
+ function DOMEval( code, doc ) {
+ doc = doc || document;
+
+ var script = doc.createElement( "script" );
+
+ script.text = code;
+ doc.head.appendChild( script ).parentNode.removeChild( script );
+ }
+/* global Symbol */
+// Defining this global in .eslintrc would create a danger of using the global
+// unguarded in another place, it seems safer to define global only for this module
+
+
+
+var
+ version = "3.1.0",
+
+ // Define a local copy of jQuery
+ jQuery = function( selector, context ) {
+
+ // The jQuery object is actually just the init constructor 'enhanced'
+ // Need init if jQuery is called (just allow error to be thrown if not included)
+ return new jQuery.fn.init( selector, context );
+ },
+
+ // Support: Android <=4.0 only
+ // Make sure we trim BOM and NBSP
+ rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,
+
+ // Matches dashed string for camelizing
+ rmsPrefix = /^-ms-/,
+ rdashAlpha = /-([a-z])/g,
+
+ // Used by jQuery.camelCase as callback to replace()
+ fcamelCase = function( all, letter ) {
+ return letter.toUpperCase();
+ };
+
+jQuery.fn = jQuery.prototype = {
+
+ // The current version of jQuery being used
+ jquery: version,
+
+ constructor: jQuery,
+
+ // The default length of a jQuery object is 0
+ length: 0,
+
+ toArray: function() {
+ return slice.call( this );
+ },
+
+ // Get the Nth element in the matched element set OR
+ // Get the whole matched element set as a clean array
+ get: function( num ) {
+ return num != null ?
+
+ // Return just the one element from the set
+ ( num < 0 ? this[ num + this.length ] : this[ num ] ) :
+
+ // Return all the elements in a clean array
+ slice.call( this );
+ },
+
+ // Take an array of elements and push it onto the stack
+ // (returning the new matched element set)
+ pushStack: function( elems ) {
+
+ // Build a new jQuery matched element set
+ var ret = jQuery.merge( this.constructor(), elems );
+
+ // Add the old object onto the stack (as a reference)
+ ret.prevObject = this;
+
+ // Return the newly-formed element set
+ return ret;
+ },
+
+ // Execute a callback for every element in the matched set.
+ each: function( callback ) {
+ return jQuery.each( this, callback );
+ },
+
+ map: function( callback ) {
+ return this.pushStack( jQuery.map( this, function( elem, i ) {
+ return callback.call( elem, i, elem );
+ } ) );
+ },
+
+ slice: function() {
+ return this.pushStack( slice.apply( this, arguments ) );
+ },
+
+ first: function() {
+ return this.eq( 0 );
+ },
+
+ last: function() {
+ return this.eq( -1 );
+ },
+
+ eq: function( i ) {
+ var len = this.length,
+ j = +i + ( i < 0 ? len : 0 );
+ return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );
+ },
+
+ end: function() {
+ return this.prevObject || this.constructor();
+ },
+
+ // For internal use only.
+ // Behaves like an Array's method, not like a jQuery method.
+ push: push,
+ sort: arr.sort,
+ splice: arr.splice
+};
+
+jQuery.extend = jQuery.fn.extend = function() {
+ var options, name, src, copy, copyIsArray, clone,
+ target = arguments[ 0 ] || {},
+ i = 1,
+ length = arguments.length,
+ deep = false;
+
+ // Handle a deep copy situation
+ if ( typeof target === "boolean" ) {
+ deep = target;
+
+ // Skip the boolean and the target
+ target = arguments[ i ] || {};
+ i++;
+ }
+
+ // Handle case when target is a string or something (possible in deep copy)
+ if ( typeof target !== "object" && !jQuery.isFunction( target ) ) {
+ target = {};
+ }
+
+ // Extend jQuery itself if only one argument is passed
+ if ( i === length ) {
+ target = this;
+ i--;
+ }
+
+ for ( ; i < length; i++ ) {
+
+ // Only deal with non-null/undefined values
+ if ( ( options = arguments[ i ] ) != null ) {
+
+ // Extend the base object
+ for ( name in options ) {
+ src = target[ name ];
+ copy = options[ name ];
+
+ // Prevent never-ending loop
+ if ( target === copy ) {
+ continue;
+ }
+
+ // Recurse if we're merging plain objects or arrays
+ if ( deep && copy && ( jQuery.isPlainObject( copy ) ||
+ ( copyIsArray = jQuery.isArray( copy ) ) ) ) {
+
+ if ( copyIsArray ) {
+ copyIsArray = false;
+ clone = src && jQuery.isArray( src ) ? src : [];
+
+ } else {
+ clone = src && jQuery.isPlainObject( src ) ? src : {};
+ }
+
+ // Never move original objects, clone them
+ target[ name ] = jQuery.extend( deep, clone, copy );
+
+ // Don't bring in undefined values
+ } else if ( copy !== undefined ) {
+ target[ name ] = copy;
+ }
+ }
+ }
+ }
+
+ // Return the modified object
+ return target;
+};
+
+jQuery.extend( {
+
+ // Unique for each copy of jQuery on the page
+ expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
+
+ // Assume jQuery is ready without the ready module
+ isReady: true,
+
+ error: function( msg ) {
+ throw new Error( msg );
+ },
+
+ noop: function() {},
+
+ isFunction: function( obj ) {
+ return jQuery.type( obj ) === "function";
+ },
+
+ isArray: Array.isArray,
+
+ isWindow: function( obj ) {
+ return obj != null && obj === obj.window;
+ },
+
+ isNumeric: function( obj ) {
+
+ // As of jQuery 3.0, isNumeric is limited to
+ // strings and numbers (primitives or objects)
+ // that can be coerced to finite numbers (gh-2662)
+ var type = jQuery.type( obj );
+ return ( type === "number" || type === "string" ) &&
+
+ // parseFloat NaNs numeric-cast false positives ("")
+ // ...but misinterprets leading-number strings, particularly hex literals ("0x...")
+ // subtraction forces infinities to NaN
+ !isNaN( obj - parseFloat( obj ) );
+ },
+
+ isPlainObject: function( obj ) {
+ var proto, Ctor;
+
+ // Detect obvious negatives
+ // Use toString instead of jQuery.type to catch host objects
+ if ( !obj || toString.call( obj ) !== "[object Object]" ) {
+ return false;
+ }
+
+ proto = getProto( obj );
+
+ // Objects with no prototype (e.g., `Object.create( null )`) are plain
+ if ( !proto ) {
+ return true;
+ }
+
+ // Objects with prototype are plain iff they were constructed by a global Object function
+ Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor;
+ return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString;
+ },
+
+ isEmptyObject: function( obj ) {
+
+ /* eslint-disable no-unused-vars */
+ // See https://github.com/eslint/eslint/issues/6125
+ var name;
+
+ for ( name in obj ) {
+ return false;
+ }
+ return true;
+ },
+
+ type: function( obj ) {
+ if ( obj == null ) {
+ return obj + "";
+ }
+
+ // Support: Android <=2.3 only (functionish RegExp)
+ return typeof obj === "object" || typeof obj === "function" ?
+ class2type[ toString.call( obj ) ] || "object" :
+ typeof obj;
+ },
+
+ // Evaluates a script in a global context
+ globalEval: function( code ) {
+ DOMEval( code );
+ },
+
+ // Convert dashed to camelCase; used by the css and data modules
+ // Support: IE <=9 - 11, Edge 12 - 13
+ // Microsoft forgot to hump their vendor prefix (#9572)
+ camelCase: function( string ) {
+ return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
+ },
+
+ nodeName: function( elem, name ) {
+ return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
+ },
+
+ each: function( obj, callback ) {
+ var length, i = 0;
+
+ if ( isArrayLike( obj ) ) {
+ length = obj.length;
+ for ( ; i < length; i++ ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( i in obj ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ }
+
+ return obj;
+ },
+
+ // Support: Android <=4.0 only
+ trim: function( text ) {
+ return text == null ?
+ "" :
+ ( text + "" ).replace( rtrim, "" );
+ },
+
+ // results is for internal usage only
+ makeArray: function( arr, results ) {
+ var ret = results || [];
+
+ if ( arr != null ) {
+ if ( isArrayLike( Object( arr ) ) ) {
+ jQuery.merge( ret,
+ typeof arr === "string" ?
+ [ arr ] : arr
+ );
+ } else {
+ push.call( ret, arr );
+ }
+ }
+
+ return ret;
+ },
+
+ inArray: function( elem, arr, i ) {
+ return arr == null ? -1 : indexOf.call( arr, elem, i );
+ },
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ merge: function( first, second ) {
+ var len = +second.length,
+ j = 0,
+ i = first.length;
+
+ for ( ; j < len; j++ ) {
+ first[ i++ ] = second[ j ];
+ }
+
+ first.length = i;
+
+ return first;
+ },
+
+ grep: function( elems, callback, invert ) {
+ var callbackInverse,
+ matches = [],
+ i = 0,
+ length = elems.length,
+ callbackExpect = !invert;
+
+ // Go through the array, only saving the items
+ // that pass the validator function
+ for ( ; i < length; i++ ) {
+ callbackInverse = !callback( elems[ i ], i );
+ if ( callbackInverse !== callbackExpect ) {
+ matches.push( elems[ i ] );
+ }
+ }
+
+ return matches;
+ },
+
+ // arg is for internal usage only
+ map: function( elems, callback, arg ) {
+ var length, value,
+ i = 0,
+ ret = [];
+
+ // Go through the array, translating each of the items to their new values
+ if ( isArrayLike( elems ) ) {
+ length = elems.length;
+ for ( ; i < length; i++ ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+
+ // Go through every key on the object,
+ } else {
+ for ( i in elems ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+ }
+
+ // Flatten any nested arrays
+ return concat.apply( [], ret );
+ },
+
+ // A global GUID counter for objects
+ guid: 1,
+
+ // Bind a function to a context, optionally partially applying any
+ // arguments.
+ proxy: function( fn, context ) {
+ var tmp, args, proxy;
+
+ if ( typeof context === "string" ) {
+ tmp = fn[ context ];
+ context = fn;
+ fn = tmp;
+ }
+
+ // Quick check to determine if target is callable, in the spec
+ // this throws a TypeError, but we will just return undefined.
+ if ( !jQuery.isFunction( fn ) ) {
+ return undefined;
+ }
+
+ // Simulated bind
+ args = slice.call( arguments, 2 );
+ proxy = function() {
+ return fn.apply( context || this, args.concat( slice.call( arguments ) ) );
+ };
+
+ // Set the guid of unique handler to the same of original handler, so it can be removed
+ proxy.guid = fn.guid = fn.guid || jQuery.guid++;
+
+ return proxy;
+ },
+
+ now: Date.now,
+
+ // jQuery.support is not used in Core but other projects attach their
+ // properties to it so it needs to exist.
+ support: support
+} );
+
+if ( typeof Symbol === "function" ) {
+ jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];
+}
+
+// Populate the class2type map
+jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ),
+function( i, name ) {
+ class2type[ "[object " + name + "]" ] = name.toLowerCase();
+} );
+
+function isArrayLike( obj ) {
+
+ // Support: real iOS 8.2 only (not reproducible in simulator)
+ // `in` check used to prevent JIT error (gh-2145)
+ // hasOwn isn't used here due to false negatives
+ // regarding Nodelist length in IE
+ var length = !!obj && "length" in obj && obj.length,
+ type = jQuery.type( obj );
+
+ if ( type === "function" || jQuery.isWindow( obj ) ) {
+ return false;
+ }
+
+ return type === "array" || length === 0 ||
+ typeof length === "number" && length > 0 && ( length - 1 ) in obj;
+}
+var Sizzle =
+/*!
+ * Sizzle CSS Selector Engine v2.3.0
+ * https://sizzlejs.com/
+ *
+ * Copyright jQuery Foundation and other contributors
+ * Released under the MIT license
+ * http://jquery.org/license
+ *
+ * Date: 2016-01-04
+ */
+(function( window ) {
+
+var i,
+ support,
+ Expr,
+ getText,
+ isXML,
+ tokenize,
+ compile,
+ select,
+ outermostContext,
+ sortInput,
+ hasDuplicate,
+
+ // Local document vars
+ setDocument,
+ document,
+ docElem,
+ documentIsHTML,
+ rbuggyQSA,
+ rbuggyMatches,
+ matches,
+ contains,
+
+ // Instance-specific data
+ expando = "sizzle" + 1 * new Date(),
+ preferredDoc = window.document,
+ dirruns = 0,
+ done = 0,
+ classCache = createCache(),
+ tokenCache = createCache(),
+ compilerCache = createCache(),
+ sortOrder = function( a, b ) {
+ if ( a === b ) {
+ hasDuplicate = true;
+ }
+ return 0;
+ },
+
+ // Instance methods
+ hasOwn = ({}).hasOwnProperty,
+ arr = [],
+ pop = arr.pop,
+ push_native = arr.push,
+ push = arr.push,
+ slice = arr.slice,
+ // Use a stripped-down indexOf as it's faster than native
+ // https://jsperf.com/thor-indexof-vs-for/5
+ indexOf = function( list, elem ) {
+ var i = 0,
+ len = list.length;
+ for ( ; i < len; i++ ) {
+ if ( list[i] === elem ) {
+ return i;
+ }
+ }
+ return -1;
+ },
+
+ booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",
+
+ // Regular expressions
+
+ // http://www.w3.org/TR/css3-selectors/#whitespace
+ whitespace = "[\\x20\\t\\r\\n\\f]",
+
+ // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier
+ identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+",
+
+ // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
+ attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace +
+ // Operator (capture 2)
+ "*([*^$|!~]?=)" + whitespace +
+ // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]"
+ "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace +
+ "*\\]",
+
+ pseudos = ":(" + identifier + ")(?:\\((" +
+ // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
+ // 1. quoted (capture 3; capture 4 or capture 5)
+ "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
+ // 2. simple (capture 6)
+ "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
+ // 3. anything else (capture 2)
+ ".*" +
+ ")\\)|)",
+
+ // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
+ rwhitespace = new RegExp( whitespace + "+", "g" ),
+ rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ),
+
+ rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
+ rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ),
+
+ rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ),
+
+ rpseudo = new RegExp( pseudos ),
+ ridentifier = new RegExp( "^" + identifier + "$" ),
+
+ matchExpr = {
+ "ID": new RegExp( "^#(" + identifier + ")" ),
+ "CLASS": new RegExp( "^\\.(" + identifier + ")" ),
+ "TAG": new RegExp( "^(" + identifier + "|[*])" ),
+ "ATTR": new RegExp( "^" + attributes ),
+ "PSEUDO": new RegExp( "^" + pseudos ),
+ "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace +
+ "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace +
+ "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
+ "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
+ // For use in libraries implementing .is()
+ // We use this for POS matching in `select`
+ "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" +
+ whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
+ },
+
+ rinputs = /^(?:input|select|textarea|button)$/i,
+ rheader = /^h\d$/i,
+
+ rnative = /^[^{]+\{\s*\[native \w/,
+
+ // Easily-parseable/retrievable ID or TAG or CLASS selectors
+ rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
+
+ rsibling = /[+~]/,
+
+ // CSS escapes
+ // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
+ runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ),
+ funescape = function( _, escaped, escapedWhitespace ) {
+ var high = "0x" + escaped - 0x10000;
+ // NaN means non-codepoint
+ // Support: Firefox<24
+ // Workaround erroneous numeric interpretation of +"0x"
+ return high !== high || escapedWhitespace ?
+ escaped :
+ high < 0 ?
+ // BMP codepoint
+ String.fromCharCode( high + 0x10000 ) :
+ // Supplemental Plane codepoint (surrogate pair)
+ String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
+ },
+
+ // CSS string/identifier serialization
+ // https://drafts.csswg.org/cssom/#common-serializing-idioms
+ rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\x80-\uFFFF\w-]/g,
+ fcssescape = function( ch, asCodePoint ) {
+ if ( asCodePoint ) {
+
+ // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER
+ if ( ch === "\0" ) {
+ return "\uFFFD";
+ }
+
+ // Control characters and (dependent upon position) numbers get escaped as code points
+ return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " ";
+ }
+
+ // Other potentially-special ASCII characters get backslash-escaped
+ return "\\" + ch;
+ },
+
+ // Used for iframes
+ // See setDocument()
+ // Removing the function wrapper causes a "Permission Denied"
+ // error in IE
+ unloadHandler = function() {
+ setDocument();
+ },
+
+ disabledAncestor = addCombinator(
+ function( elem ) {
+ return elem.disabled === true;
+ },
+ { dir: "parentNode", next: "legend" }
+ );
+
+// Optimize for push.apply( _, NodeList )
+try {
+ push.apply(
+ (arr = slice.call( preferredDoc.childNodes )),
+ preferredDoc.childNodes
+ );
+ // Support: Android<4.0
+ // Detect silently failing push.apply
+ arr[ preferredDoc.childNodes.length ].nodeType;
+} catch ( e ) {
+ push = { apply: arr.length ?
+
+ // Leverage slice if possible
+ function( target, els ) {
+ push_native.apply( target, slice.call(els) );
+ } :
+
+ // Support: IE<9
+ // Otherwise append directly
+ function( target, els ) {
+ var j = target.length,
+ i = 0;
+ // Can't trust NodeList.length
+ while ( (target[j++] = els[i++]) ) {}
+ target.length = j - 1;
+ }
+ };
+}
+
+function Sizzle( selector, context, results, seed ) {
+ var m, i, elem, nid, match, groups, newSelector,
+ newContext = context && context.ownerDocument,
+
+ // nodeType defaults to 9, since context defaults to document
+ nodeType = context ? context.nodeType : 9;
+
+ results = results || [];
+
+ // Return early from calls with invalid selector or context
+ if ( typeof selector !== "string" || !selector ||
+ nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {
+
+ return results;
+ }
+
+ // Try to shortcut find operations (as opposed to filters) in HTML documents
+ if ( !seed ) {
+
+ if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) {
+ setDocument( context );
+ }
+ context = context || document;
+
+ if ( documentIsHTML ) {
+
+ // If the selector is sufficiently simple, try using a "get*By*" DOM method
+ // (excepting DocumentFragment context, where the methods don't exist)
+ if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) {
+
+ // ID selector
+ if ( (m = match[1]) ) {
+
+ // Document context
+ if ( nodeType === 9 ) {
+ if ( (elem = context.getElementById( m )) ) {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( elem.id === m ) {
+ results.push( elem );
+ return results;
+ }
+ } else {
+ return results;
+ }
+
+ // Element context
+ } else {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( newContext && (elem = newContext.getElementById( m )) &&
+ contains( context, elem ) &&
+ elem.id === m ) {
+
+ results.push( elem );
+ return results;
+ }
+ }
+
+ // Type selector
+ } else if ( match[2] ) {
+ push.apply( results, context.getElementsByTagName( selector ) );
+ return results;
+
+ // Class selector
+ } else if ( (m = match[3]) && support.getElementsByClassName &&
+ context.getElementsByClassName ) {
+
+ push.apply( results, context.getElementsByClassName( m ) );
+ return results;
+ }
+ }
+
+ // Take advantage of querySelectorAll
+ if ( support.qsa &&
+ !compilerCache[ selector + " " ] &&
+ (!rbuggyQSA || !rbuggyQSA.test( selector )) ) {
+
+ if ( nodeType !== 1 ) {
+ newContext = context;
+ newSelector = selector;
+
+ // qSA looks outside Element context, which is not what we want
+ // Thanks to Andrew Dupont for this workaround technique
+ // Support: IE <=8
+ // Exclude object elements
+ } else if ( context.nodeName.toLowerCase() !== "object" ) {
+
+ // Capture the context ID, setting it first if necessary
+ if ( (nid = context.getAttribute( "id" )) ) {
+ nid = nid.replace( rcssescape, fcssescape );
+ } else {
+ context.setAttribute( "id", (nid = expando) );
+ }
+
+ // Prefix every selector in the list
+ groups = tokenize( selector );
+ i = groups.length;
+ while ( i-- ) {
+ groups[i] = "#" + nid + " " + toSelector( groups[i] );
+ }
+ newSelector = groups.join( "," );
+
+ // Expand context for sibling selectors
+ newContext = rsibling.test( selector ) && testContext( context.parentNode ) ||
+ context;
+ }
+
+ if ( newSelector ) {
+ try {
+ push.apply( results,
+ newContext.querySelectorAll( newSelector )
+ );
+ return results;
+ } catch ( qsaError ) {
+ } finally {
+ if ( nid === expando ) {
+ context.removeAttribute( "id" );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ // All others
+ return select( selector.replace( rtrim, "$1" ), context, results, seed );
+}
+
+/**
+ * Create key-value caches of limited size
+ * @returns {function(string, object)} Returns the Object data after storing it on itself with
+ * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
+ * deleting the oldest entry
+ */
+function createCache() {
+ var keys = [];
+
+ function cache( key, value ) {
+ // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
+ if ( keys.push( key + " " ) > Expr.cacheLength ) {
+ // Only keep the most recent entries
+ delete cache[ keys.shift() ];
+ }
+ return (cache[ key + " " ] = value);
+ }
+ return cache;
+}
+
+/**
+ * Mark a function for special use by Sizzle
+ * @param {Function} fn The function to mark
+ */
+function markFunction( fn ) {
+ fn[ expando ] = true;
+ return fn;
+}
+
+/**
+ * Support testing using an element
+ * @param {Function} fn Passed the created element and returns a boolean result
+ */
+function assert( fn ) {
+ var el = document.createElement("fieldset");
+
+ try {
+ return !!fn( el );
+ } catch (e) {
+ return false;
+ } finally {
+ // Remove from its parent by default
+ if ( el.parentNode ) {
+ el.parentNode.removeChild( el );
+ }
+ // release memory in IE
+ el = null;
+ }
+}
+
+/**
+ * Adds the same handler for all of the specified attrs
+ * @param {String} attrs Pipe-separated list of attributes
+ * @param {Function} handler The method that will be applied
+ */
+function addHandle( attrs, handler ) {
+ var arr = attrs.split("|"),
+ i = arr.length;
+
+ while ( i-- ) {
+ Expr.attrHandle[ arr[i] ] = handler;
+ }
+}
+
+/**
+ * Checks document order of two siblings
+ * @param {Element} a
+ * @param {Element} b
+ * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
+ */
+function siblingCheck( a, b ) {
+ var cur = b && a,
+ diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
+ a.sourceIndex - b.sourceIndex;
+
+ // Use IE sourceIndex if available on both nodes
+ if ( diff ) {
+ return diff;
+ }
+
+ // Check if b follows a
+ if ( cur ) {
+ while ( (cur = cur.nextSibling) ) {
+ if ( cur === b ) {
+ return -1;
+ }
+ }
+ }
+
+ return a ? 1 : -1;
+}
+
+/**
+ * Returns a function to use in pseudos for input types
+ * @param {String} type
+ */
+function createInputPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for buttons
+ * @param {String} type
+ */
+function createButtonPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return (name === "input" || name === "button") && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for :enabled/:disabled
+ * @param {Boolean} disabled true for :disabled; false for :enabled
+ */
+function createDisabledPseudo( disabled ) {
+ // Known :disabled false positives:
+ // IE: *[disabled]:not(button, input, select, textarea, optgroup, option, menuitem, fieldset)
+ // not IE: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable
+ return function( elem ) {
+
+ // Check form elements and option elements for explicit disabling
+ return "label" in elem && elem.disabled === disabled ||
+ "form" in elem && elem.disabled === disabled ||
+
+ // Check non-disabled form elements for fieldset[disabled] ancestors
+ "form" in elem && elem.disabled === false && (
+ // Support: IE6-11+
+ // Ancestry is covered for us
+ elem.isDisabled === disabled ||
+
+ // Otherwise, assume any non-