usage: livemedia-creator [-h]
- (--make-iso | --make-disk | --make-fsimage | --make-appliance | --make-ami | --make-tar | --make-tar-disk | --make-pxe-live | --make-ostree-live | --make-oci | --make-vagrant)
- [--iso ISO] [--iso-only] [--iso-name ISO_NAME]
- [--ks KS] [--image-only] [--no-virt] [--proxy PROXY]
- [--anaconda-arg ANACONDA_ARGS]
- [--armplatform ARMPLATFORM] [--location LOCATION]
- [--logfile LOGFILE]
- [--lorax-templates LORAX_TEMPLATES] [--tmp TMP]
- [--resultdir RESULT_DIR] [--macboot] [--nomacboot]
- [--extra-boot-args EXTRA_BOOT_ARGS]
- [--disk-image DISK_IMAGE] [--keep-image]
- [--fs-image FS_IMAGE] [--image-name IMAGE_NAME]
- [--tar-disk-name TAR_DISK_NAME] [--fs-label FS_LABEL]
- [--image-size-align IMAGE_SIZE_ALIGN]
- [--image-type IMAGE_TYPE] [--qemu-arg QEMU_ARGS]
- [--qcow2] [--qcow2-arg QEMU_ARGS]
- [--compression COMPRESSION]
- [--compress-arg COMPRESS_ARGS] [--app-name APP_NAME]
- [--app-template APP_TEMPLATE] [--app-file APP_FILE]
- [--ram MEMORY] [--vcpus VCPUS] [--vnc VNC]
- [--arch ARCH] [--kernel-args KERNEL_ARGS]
- [--ovmf-path OVMF_PATH] [--virt-uefi] [--no-kvm]
- [--with-rng WITH_RNG] [--dracut-conf DRACUT_CONF]
- [--dracut-arg DRACUT_ARGS]
- [--live-rootfs-size LIVE_ROOTFS_SIZE]
- [--live-rootfs-keep-size] [--oci-config OCI_CONFIG]
- [--oci-runtime OCI_RUNTIME]
- [--vagrant-metadata VAGRANT_METADATA]
- [--vagrantfile VAGRANTFILE] [--project PROJECT]
- [--releasever RELEASEVER] [--volid VOLID]
- [--squashfs-only] [--timeout TIMEOUT] [-V]
+usage: livemedia-creator [-h] (--make-iso | --make-disk | --make-fsimage | --make-appliance | --make-ami | --make-tar | --make-tar-disk | --make-pxe-live | --make-ostree-live | --make-oci | --make-vagrant) [--iso ISO] [--iso-only]
+ [--iso-name ISO_NAME] [--ks KS] [--image-only] [--no-virt] [--proxy PROXY] [--anaconda-arg ANACONDA_ARGS] [--armplatform ARMPLATFORM] [--location LOCATION] [--logfile LOGFILE] [--lorax-templates LORAX_TEMPLATES]
+ [--tmp TMP] [--resultdir RESULT_DIR] [--macboot] [--nomacboot] [--extra-boot-args EXTRA_BOOT_ARGS] [--disk-image DISK_IMAGE] [--keep-image] [--fs-image FS_IMAGE] [--image-name IMAGE_NAME]
+ [--tar-disk-name TAR_DISK_NAME] [--fs-label FS_LABEL] [--image-size-align IMAGE_SIZE_ALIGN] [--image-type IMAGE_TYPE] [--qemu-arg QEMU_ARGS] [--qcow2] [--qcow2-arg QEMU_ARGS] [--compression COMPRESSION]
+ [--compress-arg COMPRESS_ARGS] [--app-name APP_NAME] [--app-template APP_TEMPLATE] [--app-file APP_FILE] [--ram MEMORY] [--vcpus VCPUS] [--vnc VNC] [--arch ARCH] [--kernel-args KERNEL_ARGS]
+ [--ovmf-path OVMF_PATH] [--virt-uefi] [--no-kvm] [--with-rng WITH_RNG] [--dracut-conf DRACUT_CONF] [--dracut-arg DRACUT_ARGS] [--live-rootfs-size LIVE_ROOTFS_SIZE] [--live-rootfs-keep-size]
+ [--oci-config OCI_CONFIG] [--oci-runtime OCI_RUNTIME] [--vagrant-metadata VAGRANT_METADATA] [--vagrantfile VAGRANTFILE] [--project PROJECT] [--releasever RELEASEVER] [--volid VOLID] [--squashfs-only]
+ [--timeout TIMEOUT] [-V]
diff --git a/docs/html/lorax-composer.html b/docs/html/lorax-composer.html
index ba6e9a97..f712b1a4 100644
--- a/docs/html/lorax-composer.html
+++ b/docs/html/lorax-composer.html
@@ -8,7 +8,7 @@
-
lorax-composer — Lorax 33.2 documentation
+
lorax-composer — Lorax 34.0 documentation
@@ -21,10 +21,10 @@
-
-
-
-
+
+
+
+
@@ -60,7 +60,7 @@
- 33.2
+ 34.0
@@ -204,13 +204,21 @@
Brian C. Lane <bcl@redhat.com>
-
lorax-composer
is an API server that allows you to build disk images using
+
lorax-composer
is a WELDR 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.
+
+
Note
+
lorax-composer
is now deprecated. It is being replaced by the
+osbuild-composer
WELDR API server which implements more features (eg.
+ostree, image uploads, etc.) You can still use composer-cli
and
+cockpit-composer
with osbuild-composer
. See the documentation or
+the osbuild website for more information.
+
Important Things To Note
@@ -280,12 +288,7 @@ images using lorax-
lorax-composer cmdline arguments
Lorax Composer API Server
-usage: lorax-composer [-h] [--socket SOCKET] [--user USER] [--group GROUP]
- [--log LOG] [--mockfiles MOCKFILES]
- [--sharedir SHAREDIR] [-V] [-c CONFIG]
- [--releasever STRING] [--tmp TMP] [--proxy PROXY]
- [--no-system-repos]
- BLUEPRINTS
+usage: lorax-composer [-h] [--socket SOCKET] [--user USER] [--group GROUP] [--log LOG] [--mockfiles MOCKFILES] [--sharedir SHAREDIR] [-V] [-c CONFIG] [--releasever STRING] [--tmp TMP] [--proxy PROXY] [--no-system-repos] BLUEPRINTS
diff --git a/docs/html/lorax.html b/docs/html/lorax.html
index ecda8b47..3e20905f 100644
--- a/docs/html/lorax.html
+++ b/docs/html/lorax.html
@@ -8,7 +8,7 @@
-
Lorax — Lorax 33.2 documentation
+
Lorax — Lorax 34.0 documentation
@@ -21,10 +21,10 @@
-
-
-
-
+
+
+
+
@@ -60,7 +60,7 @@
- 33.2
+ 34.0
@@ -204,21 +204,10 @@ repositories.
lorax cmdline arguments
Create the Anaconda boot.iso
-
usage: lorax [-h] -p PRODUCT -v VERSION -r RELEASE [-s REPOSITORY]
- [--repo REPOSITORY] [-m REPOSITORY] [-t VARIANT] [-b URL]
- [--isfinal] [-c CONFIGFILE] [--proxy HOST] [-i PACKAGE]
- [-e PACKAGE] [--buildarch ARCH] [--volid VOLID] [--macboot]
- [--nomacboot] [--noupgrade] [--logfile LOGFILE] [--tmp TMP]
- [--cachedir CACHEDIR] [--workdir WORKDIR] [--force]
- [--add-template ADD_TEMPLATES]
- [--add-template-var ADD_TEMPLATE_VARS]
- [--add-arch-template ADD_ARCH_TEMPLATES]
- [--add-arch-template-var ADD_ARCH_TEMPLATE_VARS] [--noverify]
- [--sharedir SHAREDIR] [--enablerepo [repo]]
- [--disablerepo [repo]] [--rootfs-size ROOTFS_SIZE]
- [--noverifyssl] [--dnfplugin DNFPLUGINS] [--squashfs-only]
- [--skip-branding] [--dracut-conf DRACUT_CONF]
- [--dracut-arg DRACUT_ARGS] [-V]
+usage: lorax [-h] -p PRODUCT -v VERSION -r RELEASE [-s REPOSITORY] [--repo REPOSITORY] [-m REPOSITORY] [-t VARIANT] [-b URL] [--isfinal] [-c CONFIGFILE] [--proxy HOST] [-i PACKAGE] [-e PACKAGE] [--buildarch ARCH] [--volid VOLID]
+ [--macboot] [--nomacboot] [--noupgrade] [--logfile LOGFILE] [--tmp TMP] [--cachedir CACHEDIR] [--workdir WORKDIR] [--force] [--add-template ADD_TEMPLATES] [--add-template-var ADD_TEMPLATE_VARS]
+ [--add-arch-template ADD_ARCH_TEMPLATES] [--add-arch-template-var ADD_ARCH_TEMPLATE_VARS] [--noverify] [--sharedir SHAREDIR] [--enablerepo [repo]] [--disablerepo [repo]] [--rootfs-size ROOTFS_SIZE] [--noverifyssl]
+ [--dnfplugin DNFPLUGINS] [--squashfs-only] [--skip-branding] [--dracut-conf DRACUT_CONF] [--dracut-arg DRACUT_ARGS] [-V]
OUTPUTDIR
diff --git a/docs/html/mkksiso.html b/docs/html/mkksiso.html
index 7d52dd10..bc58a3e2 100644
--- a/docs/html/mkksiso.html
+++ b/docs/html/mkksiso.html
@@ -8,7 +8,7 @@
- mkksiso — Lorax 33.2 documentation
+ mkksiso — Lorax 34.0 documentation
@@ -21,10 +21,10 @@
-
-
-
-
+
+
+
+
@@ -60,7 +60,7 @@
- 33.2
+ 34.0
diff --git a/docs/html/modules.html b/docs/html/modules.html
index 5128fd04..624c8580 100644
--- a/docs/html/modules.html
+++ b/docs/html/modules.html
@@ -8,7 +8,7 @@
- src — Lorax 33.2 documentation
+ src — Lorax 34.0 documentation
@@ -21,10 +21,10 @@
-
-
-
-
+
+
+
+
@@ -60,7 +60,7 @@
- 33.2
+ 34.0
diff --git a/docs/html/objects.inv b/docs/html/objects.inv
index d4473a59..090ee93f 100644
Binary files a/docs/html/objects.inv and b/docs/html/objects.inv differ
diff --git a/docs/html/product-images.html b/docs/html/product-images.html
index 0372ff66..67f02433 100644
--- a/docs/html/product-images.html
+++ b/docs/html/product-images.html
@@ -8,7 +8,7 @@
- Product and Updates Images — Lorax 33.2 documentation
+ Product and Updates Images — Lorax 34.0 documentation
@@ -21,10 +21,10 @@
-
-
-
-
+
+
+
+
@@ -60,7 +60,7 @@
- 33.2
+ 34.0
diff --git a/docs/html/py-modindex.html b/docs/html/py-modindex.html
index 29819917..39aaccfc 100644
--- a/docs/html/py-modindex.html
+++ b/docs/html/py-modindex.html
@@ -8,7 +8,7 @@
- Python Module Index — Lorax 33.2 documentation
+ Python Module Index — Lorax 34.0 documentation
@@ -21,10 +21,10 @@
-
-
-
-
+
+
+
+
@@ -61,7 +61,7 @@
- 33.2
+ 34.0
diff --git a/docs/html/pylorax.api.html b/docs/html/pylorax.api.html
index 7c33bb80..2c47fefc 100644
--- a/docs/html/pylorax.api.html
+++ b/docs/html/pylorax.api.html
@@ -8,7 +8,7 @@
- pylorax.api package — Lorax 33.2 documentation
+ pylorax.api package — Lorax 34.0 documentation
@@ -21,10 +21,10 @@
-
-
-
-
+
+
+
+
@@ -59,7 +59,7 @@
- 33.2
+ 34.0
@@ -199,9 +199,9 @@
pylorax.api.bisect module
-
+
-
-
pylorax.api.bisect.
insort_left
(a, x, key=None, lo=0, hi=None)[source]
+pylorax.api.bisect.
insort_left
(a, x, key=None, lo=0, hi=None)[source]
Insert item x in list a, and keep it sorted assuming a is sorted.
- Parameters
@@ -229,15 +229,15 @@ was inserted.
pylorax.api.checkparams module
-
+
-
-
pylorax.api.checkparams.
checkparams
(tuples)[source]
+pylorax.api.checkparams.
checkparams
(tuples)[source]
pylorax.api.cmdline module
-
+
-
pylorax.api.cmdline.
lorax_composer_parser
()[source]
Return the ArgumentParser for lorax-composer
@@ -257,9 +257,9 @@ packages required by the output type, it should not have the trailing %end becau
package NEVRAs will be appended to it at build time.
compose_args should have a name matching the kickstart, and it should set the novirt_install
parameters needed to generate the desired output. Other types should be set to False.
-
+
-
-
pylorax.api.compose.
add_customizations
(f, recipe)[source]
+pylorax.api.compose.
add_customizations
(f, recipe)[source]
Add customizations to the kickstart file
- Parameters
@@ -277,9 +277,9 @@ parameters needed to generate the desired output. Other types should be set to F
-
+
-
-
pylorax.api.compose.
bootloader_append
(line, kernel_append)[source]
+pylorax.api.compose.
bootloader_append
(line, kernel_append)[source]
Insert the kernel_append string into the --append argument
- Parameters
@@ -293,9 +293,9 @@ parameters needed to generate the desired output. Other types should be set to F
is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
compose_args
(compose_type)[source]
+pylorax.api.compose.
compose_args
(compose_type)[source]
Returns the settings to pass to novirt_install for the compose type
- Parameters
@@ -307,18 +307,18 @@ These are the ones the define the type of output, it's filename, etc.
Other options will be filled in by make_compose()
-
+
-
-
pylorax.api.compose.
compose_types
(share_dir)[source]
+pylorax.api.compose.
compose_types
(share_dir)[source]
Returns a list of tuples of the supported output types, and their state
The output types come from the kickstart names in /usr/share/lorax/composer/*ks
If they are disabled on the current arch their state is False. If enabled, it is True.
eg. [("alibaba", False), ("ext4-filesystem", True), ...]
-
+
-
-
pylorax.api.compose.
customize_ks_template
(ks_template, recipe)[source]
+pylorax.api.compose.
customize_ks_template
(ks_template, recipe)[source]
Customize the kickstart template and return it
- Parameters
@@ -335,9 +335,9 @@ Add bootloader line if it is missing.
Add default timezone if needed. It does NOT replace an existing timezone entry
-
+
-
-
pylorax.api.compose.
firewall_cmd
(line, settings)[source]
+pylorax.api.compose.
firewall_cmd
(line, settings)[source]
Update the firewall line with the new ports and services
- Parameters
@@ -351,9 +351,9 @@ Add bootloader line if it is missing.
is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
get_default_services
(recipe)[source]
+pylorax.api.compose.
get_default_services
(recipe)[source]
Get the default string for services, based on recipe
:param recipe: The recipe
@@ -369,9 +369,9 @@ so return an empty string. Otherwise return "services" which will be u
the settings.
-
+
+pylorax.api.compose.
get_extra_pkgs
(dbo, share_dir, compose_type)[source]
Return extra packages needed for the output type
- Parameters
@@ -395,9 +395,9 @@ iso using the templates such as x86.tmpl
even though the results are applied differently.
-
+
-
-
pylorax.api.compose.
get_firewall_settings
(recipe)[source]
+pylorax.api.compose.
get_firewall_settings
(recipe)[source]
Return the customizations.firewall settings
- Parameters
@@ -412,9 +412,9 @@ even though the results are applied differently.
-
+
-
-
pylorax.api.compose.
get_kernel_append
(recipe)[source]
+pylorax.api.compose.
get_kernel_append
(recipe)[source]
Return the customizations.kernel append value
- Parameters
@@ -429,9 +429,9 @@ even though the results are applied differently.
-
+
-
-
pylorax.api.compose.
get_keyboard_layout
(recipe)[source]
+pylorax.api.compose.
get_keyboard_layout
(recipe)[source]
Return the customizations.locale.keyboard list
- Parameters
@@ -446,9 +446,9 @@ even though the results are applied differently.
-
+
-
-
pylorax.api.compose.
get_languages
(recipe)[source]
+pylorax.api.compose.
get_languages
(recipe)[source]
Return the customizations.locale.languages list
- Parameters
@@ -463,9 +463,9 @@ even though the results are applied differently.
-
+
-
-
pylorax.api.compose.
get_services
(recipe)[source]
+pylorax.api.compose.
get_services
(recipe)[source]
Return the customizations.services settings
- Parameters
@@ -480,9 +480,9 @@ even though the results are applied differently.
-
+
-
-
pylorax.api.compose.
get_timezone_settings
(recipe)[source]
+pylorax.api.compose.
get_timezone_settings
(recipe)[source]
Return the customizations.timezone dict
- Parameters
@@ -497,9 +497,9 @@ even though the results are applied differently.
-
+
-
-
pylorax.api.compose.
keyboard_cmd
(line, layout)[source]
+pylorax.api.compose.
keyboard_cmd
(line, layout)[source]
Update the keyboard line with the layout
- Parameters
@@ -513,9 +513,9 @@ even though the results are applied differently.
is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
lang_cmd
(line, languages)[source]
+pylorax.api.compose.
lang_cmd
(line, languages)[source]
Update the lang line with the languages
- Parameters
@@ -529,9 +529,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
move_compose_results
(cfg, results_dir)[source]
+pylorax.api.compose.
move_compose_results
(cfg, results_dir)[source]
Move the final image to the results_dir and cleanup the unneeded compose files
- Parameters
@@ -543,9 +543,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
repo_to_ks
(r, url='url')[source]
+pylorax.api.compose.
repo_to_ks
(r, url='url')[source]
Return a kickstart line with the correct args.
:param r: DNF repository information
:type r: dnf.Repo
@@ -556,9 +556,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
Set url to "baseurl" if it is a repo, leave it as "url" for the installation url.
-
+
-
-
pylorax.api.compose.
services_cmd
(line, settings)[source]
+pylorax.api.compose.
services_cmd
(line, settings)[source]
Update the services line with additional services to enable/disable
- Parameters
@@ -572,9 +572,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
start_build
(cfg, dnflock, gitlock, branch, recipe_name, compose_type, test_mode=0)[source]
+pylorax.api.compose.
start_build
(cfg, dnflock, gitlock, branch, recipe_name, compose_type, test_mode=0)[source]
Start the build
- Parameters
@@ -594,9 +594,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
test_templates
(dbo, share_dir)[source]
+pylorax.api.compose.
test_templates
(dbo, share_dir)[source]
Try depsolving each of the the templates and report any errors
- Parameters
@@ -612,9 +612,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
Return a list of templates and errors encountered or an empty list
-
+
-
-
pylorax.api.compose.
timezone_cmd
(line, settings)[source]
+pylorax.api.compose.
timezone_cmd
(line, settings)[source]
Update the timezone line with the settings
- Parameters
@@ -628,9 +628,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
is parsed correctly, and re-assembled for inclusion into the final kickstart
-
+
-
-
pylorax.api.compose.
write_ks_group
(f, group)[source]
+pylorax.api.compose.
write_ks_group
(f, group)[source]
Write kickstart group entry
- Parameters
@@ -643,9 +643,9 @@ is parsed correctly, and re-assembled for inclusion into the final kickstart
gid is optional
-
+
-
-
pylorax.api.compose.
write_ks_root
(f, user)[source]
+pylorax.api.compose.
write_ks_root
(f, user)[source]
Write kickstart root password and sshkey entry
- Parameters
@@ -667,9 +667,9 @@ If it contains password, use rootpw to set it
for root.
-
+
-
-
pylorax.api.compose.
write_ks_user
(f, user)[source]
+pylorax.api.compose.
write_ks_user
(f, user)[source]
Write kickstart user and sshkey entry
- Parameters
@@ -688,20 +688,20 @@ with whatever options are relevant.
pylorax.api.config module
-
+
-
-class
pylorax.api.config.
ComposerConfig
(defaults=None, dict_type=<class 'collections.OrderedDict'>, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=<object object>, converters=<object object>)[source]
+class pylorax.api.config.
ComposerConfig
(defaults=None, dict_type=<class 'dict'>, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=<object object>, converters=<object object>)[source]
Bases: configparser.ConfigParser
-
+
-
-
get_default
(section, option, default)[source]
+get_default
(section, option, default)[source]
-
+
-
-
pylorax.api.config.
configure
(conf_file='/etc/lorax/composer.conf', root_dir='/', test_config=False)[source]
+pylorax.api.config.
configure
(conf_file='/etc/lorax/composer.conf', root_dir='/', test_config=False)[source]
lorax-composer configuration
- Parameters
@@ -720,9 +720,9 @@ with whatever options are relevant.
-
+
-
-
pylorax.api.config.
make_dnf_dirs
(conf, uid, gid)[source]
+pylorax.api.config.
make_dnf_dirs
(conf, uid, gid)[source]
Make any missing dnf directories owned by user:group
- Parameters
@@ -741,9 +741,9 @@ with whatever options are relevant.
-
+
-
-
pylorax.api.config.
make_owned_dir
(p_dir, uid, gid)[source]
+pylorax.api.config.
make_owned_dir
(p_dir, uid, gid)[source]
Make a directory and its parents, setting owner and group
- Parameters
@@ -763,9 +763,9 @@ with whatever options are relevant.
Check to make sure it does not have o+rw permissions and that it is owned by uid:gid
-
+
-
-
pylorax.api.config.
make_queue_dirs
(conf, gid)[source]
+pylorax.api.config.
make_queue_dirs
(conf, gid)[source]
Make any missing queue directories
- Parameters
@@ -786,14 +786,14 @@ with whatever options are relevant.
pylorax.api.dnfbase module
-
+
-
-class
pylorax.api.dnfbase.
DNFLock
(conf, expire_secs=21600)[source]
+class pylorax.api.dnfbase.
DNFLock
(conf, expire_secs=21600)[source]
Bases: object
Hold the dnf.Base object and a Lock to control access to it.
self.dbo is a property that returns the dnf.Base object, but it may change
from one call to the next if the upstream repositories have changed.
-
+
-
property
lock
Check for repo updates (using expiration time) and return the lock
@@ -802,7 +802,7 @@ create a new one. This is the only way to force dnf to use the new
metadata.
-
+
-
property
lock_check
Force a check for repo updates and return the lock
@@ -811,9 +811,9 @@ metadata.
-
+
-
-
pylorax.api.dnfbase.
get_base_object
(conf)[source]
+pylorax.api.dnfbase.
get_base_object
(conf)[source]
Get the DNF object with settings from the config file
- Parameters
@@ -849,13 +849,13 @@ server.register_blueprint(v1, url_prefix="/api/v1/")
This will register all of v0's routes under /api/v0, and all but /blueprints/list under /api/v1,
and then register v1's version of /blueprints/list under /api/v1
-
+
-
-class
pylorax.api.flask_blueprint.
BlueprintSetupStateSkip
(blueprint, app, options, first_registration, skip_rules)[source]
+class pylorax.api.flask_blueprint.
BlueprintSetupStateSkip
(blueprint, app, options, first_registration, skip_rules)[source]
Bases: flask.blueprints.BlueprintSetupState
-
+
-
-
add_url_rule
(rule, endpoint=None, view_func=None, **options)[source]
+add_url_rule
(rule, endpoint=None, view_func=None, **options)[source]
A helper method to register a rule (and optionally a view function)
to the application. The endpoint is automatically prefixed with the
blueprint's name.
@@ -863,13 +863,13 @@ blueprint's name.
-
+
-
-class
pylorax.api.flask_blueprint.
BlueprintSkip
(*args, **kwargs)[source]
+class pylorax.api.flask_blueprint.
BlueprintSkip
(*args, **kwargs)[source]
Bases: flask.blueprints.Blueprint
-
+
-
-
make_setup_state
(app, options, first_registration=False)[source]
+make_setup_state
(app, options, first_registration=False)[source]
Creates an instance of BlueprintSetupState()
object that is later passed to the register callback functions.
Subclasses can override this to return a subclass of the setup state.
@@ -884,14 +884,14 @@ Subclasses can override this to return a subclass of the setup state.
This module contains functions for cloning a git repo, creating a tar archive of
the selected commit, branch, or tag, and packaging the files into an rpm that will
be installed by anaconda when creating the image.
-
+
-
-class
pylorax.api.gitrpm.
GitArchiveTarball
(gitRepo)[source]
+class pylorax.api.gitrpm.
GitArchiveTarball
(gitRepo)[source]
Bases: object
Create a git archive of the selected git repo and reference
-
+
-
-
write_file
(sourcesDir)[source]
+write_file
(sourcesDir)[source]
Create the tar archive
- Parameters
@@ -904,14 +904,14 @@ The result is in RPMNAME.tar.xz under the sourcesDir
-
+
-
-class
pylorax.api.gitrpm.
GitRpmBuild
(*args, **kwargs)[source]
-Bases: rpmfluff.SimpleRpmBuild
+class pylorax.api.gitrpm.
GitRpmBuild
(*args, **kwargs)[source]
+Bases: rpmfluff.rpmbuild.SimpleRpmBuild
Build an rpm containing files from a git repository
-
+
-
-
add_git_tarball
(gitRepo)[source]
+add_git_tarball
(gitRepo)[source]
Add a tar archive of a git repository to the rpm
- Parameters
@@ -924,24 +924,24 @@ and sets up the rpm to install the archive contents into the destination
path.
-
+
-
check
()[source]
-
+
-
clean
()[source]
Remove the base directory from inside the tmpdir
-
+
-
cleanup_tmpdir
()[source]
Remove the temporary directory and all of its contents
-
+
-
get_base_dir
()[source]
Place all the files under a temporary directory + rpmbuild/
@@ -949,9 +949,9 @@ path.
-
+
-
-
pylorax.api.gitrpm.
create_gitrpm_repo
(results_dir, recipe)[source]
+pylorax.api.gitrpm.
create_gitrpm_repo
(results_dir, recipe)[source]
Create a dnf repository with the rpms from the recipe
- Parameters
@@ -973,9 +973,9 @@ on the dnf repository so that Anaconda can use it, and returns the path to the
repository to the caller.
-
+
-
-
pylorax.api.gitrpm.
get_repo_description
(gitRepo)[source]
+pylorax.api.gitrpm.
get_repo_description
(gitRepo)[source]
Return a description including the git repo and reference
- Parameters
@@ -990,9 +990,9 @@ repository to the caller.
-
+
-
-
pylorax.api.gitrpm.
make_git_rpm
(gitRepo, dest)[source]
+pylorax.api.gitrpm.
make_git_rpm
(gitRepo, dest)[source]
Create an rpm from the specified git repo
- Parameters
@@ -1025,15 +1025,15 @@ directory. The gitRepo dict should have the following fields:
pylorax.api.projects module
-
+
-
exception
pylorax.api.projects.
ProjectsError
[source]
Bases: Exception
-
+
-
-
pylorax.api.projects.
api_changelog
(changelog)[source]
+pylorax.api.projects.
api_changelog
(changelog)[source]
Convert the changelog to a string
- Parameters
@@ -1049,9 +1049,9 @@ directory. The gitRepo dict should have the following fields:
This returns only the most recent changelog entry.
-
+
-
-
pylorax.api.projects.
api_time
(t)[source]
+pylorax.api.projects.
api_time
(t)[source]
Convert time since epoch to a string
- Parameters
@@ -1066,9 +1066,9 @@ directory. The gitRepo dict should have the following fields:
-
+
-
-
pylorax.api.projects.
delete_repo_source
(source_glob, source_id)[source]
+pylorax.api.projects.
delete_repo_source
(source_glob, source_id)[source]
Delete a source from a repo file
- Parameters
@@ -1090,9 +1090,9 @@ If it is the last one in the file, delete the file.
source_id isn't passed to it.
-
+
-
-
pylorax.api.projects.
dep_evra
(dep)[source]
+pylorax.api.projects.
dep_evra
(dep)[source]
Return the epoch:version-release.arch for the dep
- Parameters
@@ -1107,15 +1107,15 @@ source_id isn't passed to it.
-
+
-
-
pylorax.api.projects.
dep_nevra
(dep)[source]
+pylorax.api.projects.
dep_nevra
(dep)[source]
Return the name-epoch:version-release.arch
-
+
-
-
pylorax.api.projects.
dnf_repo_to_file_repo
(repo)[source]
+pylorax.api.projects.
dnf_repo_to_file_repo
(repo)[source]
Return a string representation of a DNF Repo object suitable for writing to a .repo file
- Parameters
@@ -1133,9 +1133,9 @@ it ouputs baseurl and gpgkey as python lists which DNF cannot read. So do this m
only the attributes we care about.
-
+
-
-
pylorax.api.projects.
estimate_size
(packages, block_size=6144)[source]
+pylorax.api.projects.
estimate_size
(packages, block_size=6144)[source]
Estimate the installed size of a package list
- Parameters
@@ -1156,9 +1156,9 @@ dnf doesn't provide access to. So use the file count and block size to estimate
a minimum size for each package.
-
+
-
-
pylorax.api.projects.
get_repo_sources
(source_glob)[source]
+pylorax.api.projects.
get_repo_sources
(source_glob)[source]
Return a list of sources from a directory of yum repositories
- Parameters
@@ -1173,9 +1173,9 @@ a minimum size for each package.
-
+
-
-
pylorax.api.projects.
get_source_ids
(source_path)[source]
+pylorax.api.projects.
get_source_ids
(source_path)[source]
Return a list of the source ids in a file
- Parameters
@@ -1190,9 +1190,9 @@ a minimum size for each package.
-
+
-
-
pylorax.api.projects.
modules_info
(dbo, module_names)[source]
+pylorax.api.projects.
modules_info
(dbo, module_names)[source]
Return details about a module, including dependencies
- Parameters
@@ -1210,9 +1210,9 @@ a minimum size for each package.
-
+
-
-
pylorax.api.projects.
modules_list
(dbo, module_names)[source]
+pylorax.api.projects.
modules_list
(dbo, module_names)[source]
Return a list of modules
- Parameters
@@ -1233,9 +1233,9 @@ a minimum size for each package.
and sets the type to "rpm"
-
+
-
-
pylorax.api.projects.
new_repo_source
(dbo, repoid, source, repo_dir)[source]
+pylorax.api.projects.
new_repo_source
(dbo, repoid, source, repo_dir)[source]
Add a new repo source from a Weldr source dict
- Parameters
@@ -1257,9 +1257,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
DNF variables will be substituted at load time, and on restart.
-
+
-
-
pylorax.api.projects.
pkg_to_build
(pkg)[source]
+pylorax.api.projects.
pkg_to_build
(pkg)[source]
Extract the build details from a hawkey.Package object
- Parameters
@@ -1276,9 +1276,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
Note that this only returns the build dict, it does not include the name, description, etc.
-
+
-
-
pylorax.api.projects.
pkg_to_dep
(pkg)[source]
+pylorax.api.projects.
pkg_to_dep
(pkg)[source]
Extract the info from a hawkey.Package object
- Parameters
@@ -1293,9 +1293,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
-
+
-
-
pylorax.api.projects.
pkg_to_project
(pkg)[source]
+pylorax.api.projects.
pkg_to_project
(pkg)[source]
Extract the details from a hawkey.Package object
- Parameters
@@ -1311,9 +1311,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
upstream_vcs is hard-coded to UPSTREAM_VCS
-
+
-
-
pylorax.api.projects.
pkg_to_project_info
(pkg)[source]
+pylorax.api.projects.
pkg_to_project_info
(pkg)[source]
Extract the details from a hawkey.Package object
- Parameters
@@ -1329,9 +1329,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
metadata entries are hard-coded to {}
-
+
-
-
pylorax.api.projects.
proj_to_module
(proj)[source]
+pylorax.api.projects.
proj_to_module
(proj)[source]
Extract the name from a project_info dict
- Parameters
@@ -1347,9 +1347,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
group_type is hard-coded to "rpm"
-
+
-
-
pylorax.api.projects.
projects_depsolve
(dbo, projects, groups)[source]
+pylorax.api.projects.
projects_depsolve
(dbo, projects, groups)[source]
Return the dependencies for a list of projects
- Parameters
@@ -1371,9 +1371,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
-
+
-
-
pylorax.api.projects.
projects_depsolve_with_size
(dbo, projects, groups, with_core=True)[source]
+pylorax.api.projects.
projects_depsolve_with_size
(dbo, projects, groups, with_core=True)[source]
Return the dependencies and installed size for a list of projects
- Parameters
@@ -1395,9 +1395,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
-
+
-
-
pylorax.api.projects.
projects_info
(dbo, project_names)[source]
+pylorax.api.projects.
projects_info
(dbo, project_names)[source]
Return details about specific projects
- Parameters
@@ -1416,9 +1416,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
If project_names is None it will return the full list of available packages
-
+
-
-
pylorax.api.projects.
projects_list
(dbo)[source]
+pylorax.api.projects.
projects_list
(dbo)[source]
Return a list of projects
- Parameters
@@ -1433,9 +1433,9 @@ The id parameter will the the 'name' field for API v0, and the 'id'
-
+
-
-
pylorax.api.projects.
repo_to_source
(repo, system_source, api=1)[source]
+pylorax.api.projects.
repo_to_source
(repo, system_source, api=1)[source]
Return a Weldr Source dict created from the DNF Repository
- Parameters
@@ -1473,9 +1473,9 @@ In v0 of the API na
id
has been added for the repo.id
-
+
-
-
pylorax.api.projects.
source_to_repo
(source, dnf_conf)[source]
+pylorax.api.projects.
source_to_repo
(source, dnf_conf)[source]
Return a dnf Repo object created from a source dict
- Parameters
@@ -1511,9 +1511,9 @@ In v0 of the API na
v0 of the API only used name
, v1 added the distinction between id
and name
.
-
+
-
-
pylorax.api.projects.
source_to_repodict
(source)[source]
+pylorax.api.projects.
source_to_repodict
(source)[source]
Return a tuple suitable for use with dnf.add_new_repo
- Parameters
@@ -1534,9 +1534,9 @@ with dnf.repos.add_new_repo
pylorax.api.queue module
Functions to monitor compose queue and run anaconda
-
+
-
-
pylorax.api.queue.
build_status
(cfg, status_filter=None, api=1)[source]
+pylorax.api.queue.
build_status
(cfg, status_filter=None, api=1)[source]
Return the details of finished or failed builds
- Parameters
@@ -1558,9 +1558,9 @@ system. It does not return the status of builds that have not been finished.
Use queue_status() for those.
-
+
-
-
pylorax.api.queue.
check_queues
(cfg)[source]
+pylorax.api.queue.
check_queues
(cfg)[source]
Check to make sure the new and run queue symlinks are correct
- Parameters
@@ -1571,9 +1571,9 @@ Use queue_status() for those.
set in STATUS have a symlink in queue/new/
-
+
-
-
pylorax.api.queue.
compose_detail
(cfg, results_dir, api=1)[source]
+pylorax.api.queue.
compose_detail
(cfg, results_dir, api=1)[source]
Return details about the build.
- Parameters
@@ -1613,9 +1613,9 @@ None in Python (or null in JSON). The following timestamps are included:
-
+
-
-
pylorax.api.queue.
get_compose_type
(results_dir)[source]
+pylorax.api.queue.
get_compose_type
(results_dir)[source]
Return the type of composition.
- Parameters
@@ -1633,9 +1633,9 @@ None in Python (or null in JSON). The following timestamps are included:
-
+
-
-
pylorax.api.queue.
get_image_name
(uuid_dir)[source]
+pylorax.api.queue.
get_image_name
(uuid_dir)[source]
Return the filename and full path of the build's image file
- Parameters
@@ -1653,9 +1653,9 @@ None in Python (or null in JSON). The following timestamps are included:
-
+
-
-
pylorax.api.queue.
make_compose
(cfg, results_dir)[source]
+pylorax.api.queue.
make_compose
(cfg, results_dir)[source]
Run anaconda with the final-kickstart.ks from results_dir
- Parameters
@@ -1679,9 +1679,9 @@ moved into logs/anaconda/ and their ownership will be set to the user from the c
object.
-
+
-
-
pylorax.api.queue.
monitor
(cfg)[source]
+pylorax.api.queue.
monitor
(cfg)[source]
Monitor the queue for new compose requests
- Parameters
@@ -1701,9 +1701,9 @@ will be created in the results directory.
from ./queue/run/ to ./queue/new/ and rerun them.
-
+
-
-
pylorax.api.queue.
queue_status
(cfg, api=1)[source]
+pylorax.api.queue.
queue_status
(cfg, api=1)[source]
Return details about what is in the queue.
- Parameters
@@ -1723,9 +1723,9 @@ from ./queue/run/ to ./queue/new/ and rerun them.
and "run" has the uuids that are being built (currently limited to 1 at a time).
-
+
-
-
pylorax.api.queue.
start_queue_monitor
(cfg, uid, gid)[source]
+pylorax.api.queue.
start_queue_monitor
(cfg, uid, gid)[source]
Start the queue monitor as a mp process
- Parameters
@@ -1741,9 +1741,9 @@ and "run" has the uuids that are being built (currently limited to 1 a
-
+
-
-
pylorax.api.queue.
uuid_add_upload
(cfg, uuid, upload_uuid)[source]
+pylorax.api.queue.
uuid_add_upload
(cfg, uuid, upload_uuid)[source]
Add an upload UUID to a build
- Parameters
@@ -1762,9 +1762,9 @@ and "run" has the uuids that are being built (currently limited to 1 a
-
+
-
-
pylorax.api.queue.
uuid_cancel
(cfg, uuid)[source]
+pylorax.api.queue.
uuid_cancel
(cfg, uuid)[source]
Cancel a build and delete its results
- Parameters
@@ -1783,9 +1783,9 @@ and "run" has the uuids that are being built (currently limited to 1 a
Only call this if the build status is WAITING or RUNNING
-
+
-
-
pylorax.api.queue.
uuid_delete
(cfg, uuid)[source]
+pylorax.api.queue.
uuid_delete
(cfg, uuid)[source]
Delete all of the results from a compose
- Parameters
@@ -1806,9 +1806,9 @@ and "run" has the uuids that are being built (currently limited to 1 a
-
+
-
-
pylorax.api.queue.
uuid_get_uploads
(cfg, uuid)[source]
+pylorax.api.queue.
uuid_get_uploads
(cfg, uuid)[source]
Return the list of uploads for a build uuid
- Parameters
@@ -1826,9 +1826,9 @@ and "run" has the uuids that are being built (currently limited to 1 a
-
+
-
-
pylorax.api.queue.
uuid_image
(cfg, uuid)[source]
+pylorax.api.queue.
uuid_image
(cfg, uuid)[source]
Return the filename and full path of the build's image file
- Parameters
@@ -1849,9 +1849,9 @@ and "run" has the uuids that are being built (currently limited to 1 a
-
+
-
-
pylorax.api.queue.
uuid_info
(cfg, uuid, api=1)[source]
+pylorax.api.queue.
uuid_info
(cfg, uuid, api=1)[source]
Return information about the composition
- Parameters
@@ -1882,9 +1882,9 @@ and "run" has the uuids that are being built (currently limited to 1 a
-
+
-
-
pylorax.api.queue.
uuid_log
(cfg, uuid, size=1024)[source]
+pylorax.api.queue.
uuid_log
(cfg, uuid, size=1024)[source]
Return size KiB from the end of the most currently relevant log for a
given compose
@@ -1911,9 +1911,9 @@ compose. It tries to return lines from the end of the log, it will attempt
to start on a line boundary, and it may return less than size kbytes.
-
+
-
-
pylorax.api.queue.
uuid_ready_upload
(cfg, uuid, upload_uuid)[source]
+pylorax.api.queue.
uuid_ready_upload
(cfg, uuid, upload_uuid)[source]
Set an upload to READY if the build is in FINISHED state
- Parameters
@@ -1935,9 +1935,9 @@ to start on a line boundary, and it may return less than size kbyte
-
+
-
-
pylorax.api.queue.
uuid_remove_upload
(cfg, upload_uuid)[source]
+pylorax.api.queue.
uuid_remove_upload
(cfg, upload_uuid)[source]
Remove an upload UUID from the build
- Parameters
@@ -1958,9 +1958,9 @@ to start on a line boundary, and it may return less than size kbyte
-
+
-
-
pylorax.api.queue.
uuid_schedule_upload
(cfg, uuid, provider_name, image_name, settings)[source]
+pylorax.api.queue.
uuid_schedule_upload
(cfg, uuid, provider_name, image_name, settings)[source]
Schedule an upload of an image
- Parameters
@@ -1984,9 +1984,9 @@ to start on a line boundary, and it may return less than size kbyte
-
+
-
-
pylorax.api.queue.
uuid_status
(cfg, uuid, api=1)[source]
+pylorax.api.queue.
uuid_status
(cfg, uuid, api=1)[source]
Return the details of a specific UUID compose
- Parameters
@@ -2006,9 +2006,9 @@ to start on a line boundary, and it may return less than size kbyte
Returns the same dict as compose_detail()
-
+
-
-
pylorax.api.queue.
uuid_tar
(cfg, uuid, metadata=False, image=False, logs=False)[source]
+pylorax.api.queue.
uuid_tar
(cfg, uuid, metadata=False, image=False, logs=False)[source]
Return a tar of the build data
- Parameters
@@ -2037,21 +2037,21 @@ the selected data to the caller by returning the Popen stdout from the tar proce
pylorax.api.recipes module
-
+
-
-class
pylorax.api.recipes.
CommitDetails
(commit, timestamp, message, revision=None)[source]
+class pylorax.api.recipes.
CommitDetails
(commit, timestamp, message, revision=None)[source]
Bases: pylorax.base.DataHolder
-
+
-
exception
pylorax.api.recipes.
CommitTimeValError
[source]
Bases: Exception
-
+
-
-
pylorax.api.recipes.
NewRecipeGit
(toml_dict)[source]
+pylorax.api.recipes.
NewRecipeGit
(toml_dict)[source]
Create a RecipeGit object from fields in a TOML dict
- Parameters
@@ -2087,17 +2087,17 @@ the selected data to the caller by returning the Popen stdout from the tar proce
Currently there is no support for authentication
-
+
-
-class
pylorax.api.recipes.
Recipe
(name, description, version, modules, packages, groups, customizations=None, gitrepos=None)[source]
+class pylorax.api.recipes.
Recipe
(name, description, version, modules, packages, groups, customizations=None, gitrepos=None)[source]
Bases: dict
A Recipe of package and modules
This is a subclass of dict that enforces the constructor arguments
and adds a .filename property to return the recipe's filename,
and a .toml() function to return the recipe as a TOML string.
-
+
-
-
bump_version
(old_version=None)[source]
+bump_version
(old_version=None)[source]
semver recipe version number bump
- Parameters
@@ -2120,16 +2120,16 @@ If the old and new versions are the same, bump the patch level
If they are different, check and return the new version
-
+
-
property
filename
Return the Recipe's filename
Replaces spaces in the name with '-' and appends .toml
-
+
-
-
freeze
(deps)[source]
+freeze
(deps)[source]
Return a new Recipe with full module and package NEVRA
- Parameters
@@ -2144,37 +2144,37 @@ If they are different, check and return the new version
-
+
-
property
group_names
Return the names of the groups. Groups do not have versions.
-
+
-
property
module_names
Return the names of the modules
-
+
-
property
module_nver
Return the names and version globs of the modules
-
+
-
property
package_names
Return the names of the packages
-
+
-
property
package_nver
Return the names and version globs of the packages
-
+
-
toml
()[source]
Return the Recipe in TOML format
@@ -2182,45 +2182,45 @@ If they are different, check and return the new version
-
+
-
exception
pylorax.api.recipes.
RecipeError
[source]
Bases: Exception
-
+
-
exception
pylorax.api.recipes.
RecipeFileError
[source]
Bases: Exception
-
+
-
-class
pylorax.api.recipes.
RecipeGit
(rpmname, rpmversion, rpmrelease, summary, repo, ref, destination)[source]
+class pylorax.api.recipes.
RecipeGit
(rpmname, rpmversion, rpmrelease, summary, repo, ref, destination)[source]
Bases: dict
-
+
-
-class
pylorax.api.recipes.
RecipeGroup
(name)[source]
+class pylorax.api.recipes.
RecipeGroup
(name)[source]
Bases: dict
-
+
-
-class
pylorax.api.recipes.
RecipeModule
(name, version)[source]
+class pylorax.api.recipes.
RecipeModule
(name, version)[source]
Bases: dict
-
+
-
-class
pylorax.api.recipes.
RecipePackage
(name, version)[source]
+class pylorax.api.recipes.
RecipePackage
(name, version)[source]
Bases: pylorax.api.recipes.RecipeModule
-
+
-
-
pylorax.api.recipes.
check_list_case
(expected_keys, recipe_keys, prefix='')[source]
+pylorax.api.recipes.
check_list_case
(expected_keys, recipe_keys, prefix='')[source]
Check the case of the recipe keys
- Parameters
@@ -2238,9 +2238,9 @@ If they are different, check and return the new version
-
+
-
-
pylorax.api.recipes.
check_recipe_dict
(recipe_dict)[source]
+pylorax.api.recipes.
check_recipe_dict
(recipe_dict)[source]
Check a dict before using it to create a new Recipe
- Parameters
@@ -2263,9 +2263,9 @@ are of the correct format, when included.
a string that can be presented to users.
-
+
-
-
pylorax.api.recipes.
check_required_list
(lst, fields)[source]
+pylorax.api.recipes.
check_required_list
(lst, fields)[source]
Check a list of dicts for required fields
- Parameters
@@ -2283,9 +2283,9 @@ a string that can be presented to users.
-
+
-
-
pylorax.api.recipes.
commit_recipe
(repo, branch, recipe)[source]
+pylorax.api.recipes.
commit_recipe
(repo, branch, recipe)[source]
Commit a recipe to a branch
- Parameters
@@ -2307,9 +2307,9 @@ a string that can be presented to users.
-
+
-
-
pylorax.api.recipes.
commit_recipe_directory
(repo, branch, directory)[source]
+pylorax.api.recipes.
commit_recipe_directory
(repo, branch, directory)[source]
Commit all *.toml files from a directory, if they aren't already in git.
- Parameters
@@ -2330,9 +2330,9 @@ a string that can be presented to users.
be tried.
-
+
-
-
pylorax.api.recipes.
commit_recipe_file
(repo, branch, filename)[source]
+pylorax.api.recipes.
commit_recipe_file
(repo, branch, filename)[source]
Commit a recipe file to a branch
- Parameters
@@ -2354,15 +2354,15 @@ be tried.
-
+
-
-
pylorax.api.recipes.
customizations_diff
(old_recipe, new_recipe)[source]
+pylorax.api.recipes.
customizations_diff
(old_recipe, new_recipe)[source]
Diff the customizations sections from two versions of a recipe
-
+
-
-
pylorax.api.recipes.
delete_file
(repo, branch, filename)[source]
+pylorax.api.recipes.
delete_file
(repo, branch, filename)[source]
Delete a file from a branch.
- Parameters
@@ -2384,9 +2384,9 @@ be tried.
-
+
-
-
pylorax.api.recipes.
delete_recipe
(repo, branch, recipe_name)[source]
+pylorax.api.recipes.
delete_recipe
(repo, branch, recipe_name)[source]
Delete a recipe from a branch.
- Parameters
@@ -2408,9 +2408,9 @@ be tried.
-
+
-
-
pylorax.api.recipes.
diff_lists
(title, field, old_items, new_items)[source]
+pylorax.api.recipes.
diff_lists
(title, field, old_items, new_items)[source]
Return the differences between two lists of dicts.
- Parameters
@@ -2430,9 +2430,9 @@ be tried.
-
+
-
-
pylorax.api.recipes.
find_commit_tag
(repo, branch, filename, commit_id)[source]
+pylorax.api.recipes.
find_commit_tag
(repo, branch, filename, commit_id)[source]
Find the tag that matches the commit_id
- Parameters
@@ -2455,9 +2455,9 @@ be a tag at all.
The tag will look like: 'refs/tags/<branch>/<filename>/r<revision>'
-
+
-
-
pylorax.api.recipes.
find_field_value
(field, value, lst)[source]
+pylorax.api.recipes.
find_field_value
(field, value, lst)[source]
Find a field matching value in the list of dicts.
- Parameters
@@ -2479,9 +2479,9 @@ be a tag at all.
find_field_value("name", "one", lst) will return the matching dict.
-
+
-
-
pylorax.api.recipes.
find_name
(name, lst)[source]
+pylorax.api.recipes.
find_name
(name, lst)[source]
Find the dict matching the name in a list and return it.
- Parameters
@@ -2500,9 +2500,9 @@ be a tag at all.
This is just a wrapper for find_field_value with field set to "name"
-
+
-
-
pylorax.api.recipes.
find_recipe_obj
(path, recipe, default=None)[source]
+pylorax.api.recipes.
find_recipe_obj
(path, recipe, default=None)[source]
Find a recipe object
- Parameters
@@ -2519,9 +2519,9 @@ return the default if it doesn't exist.
find_recipe_obj(["customizations", "hostname"], recipe, "")
-
+
-
-
pylorax.api.recipes.
get_commit_details
(commit, revision=None)[source]
+pylorax.api.recipes.
get_commit_details
(commit, revision=None)[source]
Return the details about a specific commit.
- Parameters
@@ -2542,9 +2542,9 @@ return the default if it doesn't exist.
-
+
-
-
pylorax.api.recipes.
get_revision_from_tag
(tag)[source]
+pylorax.api.recipes.
get_revision_from_tag
(tag)[source]
Return the revision number from a tag
- Parameters
@@ -2560,15 +2560,15 @@ return the default if it doesn't exist.
The revision is the part after the r in 'branch/filename/rXXX'
-
+
-
-
pylorax.api.recipes.
gfile
(path)[source]
+pylorax.api.recipes.
gfile
(path)[source]
Convert a string path to GFile for use with Git
-
+
-
-
pylorax.api.recipes.
head_commit
(repo, branch)[source]
+pylorax.api.recipes.
head_commit
(repo, branch)[source]
Get the branch's HEAD Commit Object
- Parameters
@@ -2589,9 +2589,9 @@ return the default if it doesn't exist.
-
+
-
-
pylorax.api.recipes.
is_commit_tag
(repo, commit_id, tag)[source]
+pylorax.api.recipes.
is_commit_tag
(repo, commit_id, tag)[source]
Check to see if a tag points to a specific commit.
- Parameters
@@ -2610,9 +2610,9 @@ return the default if it doesn't exist.
-
+
-
-
pylorax.api.recipes.
is_parent_diff
(repo, filename, tree, parent)[source]
+pylorax.api.recipes.
is_parent_diff
(repo, filename, tree, parent)[source]
Check to see if the commit is different from its parents
- Parameters
@@ -2632,9 +2632,9 @@ return the default if it doesn't exist.
-
+
-
-
pylorax.api.recipes.
list_branch_files
(repo, branch)[source]
+pylorax.api.recipes.
list_branch_files
(repo, branch)[source]
Return a sorted list of the files on the branch HEAD
- Parameters
@@ -2655,9 +2655,9 @@ return the default if it doesn't exist.
-
+
-
-
pylorax.api.recipes.
list_commit_files
(repo, commit)[source]
+pylorax.api.recipes.
list_commit_files
(repo, commit)[source]
Return a sorted list of the files on a commit
- Parameters
@@ -2678,9 +2678,9 @@ return the default if it doesn't exist.
-
+
-
-
pylorax.api.recipes.
list_commits
(repo, branch, filename, limit=0)[source]
+pylorax.api.recipes.
list_commits
(repo, branch, filename, limit=0)[source]
List the commit history of a file on a branch.
- Parameters
@@ -2703,9 +2703,9 @@ return the default if it doesn't exist.
-
+
-
-
pylorax.api.recipes.
open_or_create_repo
(path)[source]
+pylorax.api.recipes.
open_or_create_repo
(path)[source]
Open an existing repo, or create a new one
- Parameters
@@ -2726,9 +2726,9 @@ If a repo already exists it will be opened and returned instead of
creating a new one.
-
+
-
-
pylorax.api.recipes.
prepare_commit
(repo, branch, builder)[source]
+pylorax.api.recipes.
prepare_commit
(repo, branch, builder)[source]
Prepare for a commit
- Parameters
@@ -2750,9 +2750,9 @@ creating a new one.
-
+
-
-
pylorax.api.recipes.
read_commit
(repo, branch, filename, commit=None)[source]
+pylorax.api.recipes.
read_commit
(repo, branch, filename, commit=None)[source]
Return the contents of a file on a specific branch or commit.
- Parameters
@@ -2777,9 +2777,9 @@ creating a new one.
commit:filename
-
+
-
-
pylorax.api.recipes.
read_commit_spec
(repo, spec)[source]
+pylorax.api.recipes.
read_commit_spec
(repo, spec)[source]
Return the raw content of the blob specified by the spec
- Parameters
@@ -2801,9 +2801,9 @@ commit:filename
eg. To read the README file from master the spec is "master:README"
-
+
-
-
pylorax.api.recipes.
read_recipe_and_id
(repo, branch, recipe_name, commit=None)[source]
+pylorax.api.recipes.
read_recipe_and_id
(repo, branch, recipe_name, commit=None)[source]
Read a recipe commit and its id from git
- Parameters
@@ -2828,9 +2828,9 @@ commit:filename
commit:filename
-
+
-
-
pylorax.api.recipes.
read_recipe_commit
(repo, branch, recipe_name, commit=None)[source]
+pylorax.api.recipes.
read_recipe_commit
(repo, branch, recipe_name, commit=None)[source]
Read a recipe commit from git and return a Recipe object
- Parameters
@@ -2855,9 +2855,9 @@ commit:filename
commit:filename
-
+
-
-
pylorax.api.recipes.
recipe_diff
(old_recipe, new_recipe)[source]
+pylorax.api.recipes.
recipe_diff
(old_recipe, new_recipe)[source]
Diff two versions of a recipe
- Parameters
@@ -2875,16 +2875,16 @@ commit:filename
-
+
-
-
pylorax.api.recipes.
recipe_filename
(name)[source]
+pylorax.api.recipes.
recipe_filename
(name)[source]
Return the toml filename for a recipe
Replaces spaces with '-' and appends '.toml'
-
+
-
-
pylorax.api.recipes.
recipe_from_dict
(recipe_dict)[source]
+pylorax.api.recipes.
recipe_from_dict
(recipe_dict)[source]
Create a Recipe object from a plain dict.
- Parameters
@@ -2902,9 +2902,9 @@ commit:filename
-
+
-
-
pylorax.api.recipes.
recipe_from_file
(recipe_path)[source]
+pylorax.api.recipes.
recipe_from_file
(recipe_path)[source]
Return a recipe file as a Recipe object
- Parameters
@@ -2919,9 +2919,9 @@ commit:filename
-
+
-
-
pylorax.api.recipes.
recipe_from_toml
(recipe_str)[source]
+pylorax.api.recipes.
recipe_from_toml
(recipe_str)[source]
Create a Recipe object from a toml string.
- Parameters
@@ -2939,9 +2939,9 @@ commit:filename
-
+
-
-
pylorax.api.recipes.
repo_file_exists
(repo, branch, filename)[source]
+pylorax.api.recipes.
repo_file_exists
(repo, branch, filename)[source]
Return True if the filename exists on the branch
- Parameters
@@ -2960,9 +2960,9 @@ commit:filename
-
+
-
-
pylorax.api.recipes.
revert_file
(repo, branch, filename, commit)[source]
+pylorax.api.recipes.
revert_file
(repo, branch, filename, commit)[source]
Revert the contents of a file to that of a previous commit
- Parameters
@@ -2985,9 +2985,9 @@ commit:filename
-
+
-
-
pylorax.api.recipes.
revert_recipe
(repo, branch, recipe_name, commit)[source]
+pylorax.api.recipes.
revert_recipe
(repo, branch, recipe_name, commit)[source]
Revert the contents of a recipe to that of a previous commit
- Parameters
@@ -3010,9 +3010,9 @@ commit:filename
-
+
-
-
pylorax.api.recipes.
tag_file_commit
(repo, branch, filename)[source]
+pylorax.api.recipes.
tag_file_commit
(repo, branch, filename)[source]
Tag a file's most recent commit
- Parameters
@@ -3038,9 +3038,9 @@ Revisions start at 1 and increment for each new commit that is tagged.
If the commit has already been tagged it will return false.
-
+
-
-
pylorax.api.recipes.
tag_recipe_commit
(repo, branch, recipe_name)[source]
+pylorax.api.recipes.
tag_recipe_commit
(repo, branch, recipe_name)[source]
Tag a file's most recent commit
- Parameters
@@ -3063,9 +3063,9 @@ If the commit has already been tagged it will return false.
Uses tag_file_commit()
-
+
-
-
pylorax.api.recipes.
write_commit
(repo, branch, filename, message, content)[source]
+pylorax.api.recipes.
write_commit
(repo, branch, filename, message, content)[source]
Make a new commit to a repository's branch
- Parameters
@@ -3095,25 +3095,25 @@ If the commit has already been tagged it will return false.
pylorax.api.server module
-
+
-
-class
pylorax.api.server.
GitLock
(repo, lock, dir)
+class pylorax.api.server.
GitLock
(repo, lock, dir)
Bases: tuple
-
+
-
-property
dir
+dir
Alias for field number 2
-
+
-
-property
lock
+lock
Alias for field number 1
-
+
-
-property
repo
+repo
Alias for field number 0
@@ -3122,52 +3122,52 @@ If the commit has already been tagged it will return false.
pylorax.api.timestamp module
-
+
-
-
pylorax.api.timestamp.
timestamp_dict
(destdir)[source]
+pylorax.api.timestamp.
timestamp_dict
(destdir)[source]
-
+
-
-
pylorax.api.timestamp.
write_timestamp
(destdir, ty)[source]
+pylorax.api.timestamp.
write_timestamp
(destdir, ty)[source]
pylorax.api.toml module
-
+
-
-exception
pylorax.api.toml.
TomlError
(msg, doc, pos)[source]
+exception pylorax.api.toml.
TomlError
(msg, doc, pos)[source]
Bases: toml.decoder.TomlDecodeError
-
+
-
-
pylorax.api.toml.
dump
(o, file)[source]
+pylorax.api.toml.
dump
(o, file)[source]
-
+
-
-
pylorax.api.toml.
dumps
(o)[source]
+pylorax.api.toml.
dumps
(o)[source]
-
+
-
-
pylorax.api.toml.
load
(file)[source]
+pylorax.api.toml.
load
(file)[source]
-
+
-
-
pylorax.api.toml.
loads
(s)[source]
+pylorax.api.toml.
loads
(s)[source]
pylorax.api.utils module
API utility functions
-
+
-
-
pylorax.api.utils.
blueprint_exists
(api, branch, blueprint_name)[source]
+pylorax.api.utils.
blueprint_exists
(api, branch, blueprint_name)[source]
Return True if the blueprint exists
- Parameters
@@ -3180,9 +3180,9 @@ If the commit has already been tagged it will return false.
-
+
-
-
pylorax.api.utils.
take_limits
(iterable, offset, limit)[source]
+pylorax.api.utils.
take_limits
(iterable, offset, limit)[source]
Apply offset and limit to an iterable object
- Parameters
@@ -3230,9 +3230,9 @@ error response with it set to false and an error message included.
used then the API will use the master branch for blueprints. If you want to create
a new branch use the new or workspace routes with ?branch=<branch-name> to
store the new blueprint on the new branch.
-
+
-
-
pylorax.api.v0.
v0_blueprints_changes
(blueprint_names)[source]
+pylorax.api.v0.
v0_blueprints_changes
(blueprint_names)[source]
Return the changes to a blueprint or list of blueprints
/api/v0/blueprints/changes/<blueprint_names>[?offset=0&limit=20]
@@ -3295,9 +3295,9 @@ hash can be passed to /api/v0/blueprints/diff/ to retrieve the exac
-
+
-
-
pylorax.api.v0.
v0_blueprints_delete
(blueprint_name)[source]
+pylorax.api.v0.
v0_blueprints_delete
(blueprint_name)[source]
Delete a blueprint from git
DELETE /api/v0/blueprints/delete/<blueprint_name>
@@ -3310,9 +3310,9 @@ error response with it set to false and an error message included.
-
+
-
-
pylorax.api.v0.
v0_blueprints_delete_workspace
(blueprint_name)[source]
+pylorax.api.v0.
v0_blueprints_delete_workspace
(blueprint_name)[source]
Delete a blueprint from the workspace
DELETE /api/v0/blueprints/workspace/<blueprint_name>
@@ -3324,9 +3324,9 @@ error response with it set to false and an error message included.
-
+
-
-
pylorax.api.v0.
v0_blueprints_depsolve
(blueprint_names)[source]
+pylorax.api.v0.
v0_blueprints_depsolve
(blueprint_names)[source]
Return the dependencies for a blueprint
/api/v0/blueprints/depsolve/<blueprint_names>
@@ -3404,9 +3404,9 @@ and packages in modules, and any error will be in errors
-
+
-
-
pylorax.api.v0.
v0_blueprints_diff
(blueprint_name, from_commit, to_commit)[source]
+pylorax.api.v0.
v0_blueprints_diff
(blueprint_name, from_commit, to_commit)[source]
Return the differences between two commits of a blueprint
/api/v0/blueprints/diff/<blueprint_name>/<from_commit>/<to_commit>
@@ -3453,9 +3453,9 @@ The contents for these will be the old/new values for them.
-
+
-
-
pylorax.api.v0.
v0_blueprints_freeze
(blueprint_names)[source]
+pylorax.api.v0.
v0_blueprints_freeze
(blueprint_names)[source]
Return the blueprint with the exact modules and packages selected by depsolve
/api/v0/blueprints/freeze/<blueprint_names>
@@ -3499,9 +3499,9 @@ to the exact versions chosen by depsolving the blueprint.
-
+
-
-
pylorax.api.v0.
v0_blueprints_info
(blueprint_names)[source]
+pylorax.api.v0.
v0_blueprints_info
(blueprint_names)[source]
Return the contents of the blueprint, or a list of blueprints
/api/v0/blueprints/info/<blueprint_names>[?format=<json|toml>]
@@ -3565,7 +3565,7 @@ errors will both be returned.
-
+
-
pylorax.api.v0.
v0_blueprints_list
()[source]
List the available blueprints on a branch.
@@ -3587,7 +3587,7 @@ errors will both be returned.
-
+
-
pylorax.api.v0.
v0_blueprints_new
()[source]
Commit a new blueprint
@@ -3601,9 +3601,9 @@ error response with it set to false and an error message included.
-
+
-
-
pylorax.api.v0.
v0_blueprints_tag
(blueprint_name)[source]
+pylorax.api.v0.
v0_blueprints_tag
(blueprint_name)[source]
Tag a blueprint's latest blueprint commit as a 'revision'
POST /api/v0/blueprints/tag/<blueprint_name>
@@ -3616,9 +3616,9 @@ error response with it set to false and an error message included.