show <blueprint,…> Display the blueprint in TOML format. -changes <blueprint,…> Display the changes for each blueprint. -diff <blueprint-name> Display the differences between 2 versions of a blueprint.
---<from-commit> Commit hash or NEWEST -<to-commit> Commit hash, NEWEST, or WORKSPACE
save <blueprint,…> Save the blueprint to a file, <blueprint-name>.toml -delete <blueprint> Delete a blueprint from the server -depsolve <blueprint,…> Display the packages needed to install the blueprint. -push <blueprint> Push a blueprint TOML file to the server. -freeze <blueprint,…> Display the frozen blueprint’s modules and packages. -freeze show <blueprint,…> Display the frozen blueprint in TOML format. -freeze save <blueprint,…> Save the frozen blueprint to a file, <blueprint-name>.frozen.toml. -tag <blueprint> Tag the most recent blueprint commit as a release. -undo <blueprint> <commit> Undo changes to a blueprint by reverting to the selected commit. -workspace <blueprint> Push the blueprint TOML to the temporary workspace storage.
-modules list List the available modules. -projects list List the available projects. -projects info <project,…> Show details about the listed projects.
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
- VERSION:'28.10',
+ VERSION:'28.13',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -377,9 +413,7 @@ save the qcow2 image as
jQuery(function () {
-
- SphinxRtdTheme.Navigation.enableSticky();
-
+ SphinxRtdTheme.Navigation.enable(true);
});
diff --git a/docs/html/genindex.html b/docs/html/genindex.html
index 4b9aa2df..8b6690a3 100644
--- a/docs/html/genindex.html
+++ b/docs/html/genindex.html
@@ -9,7 +9,7 @@
- Index — Lorax 28.10 documentation
+ Index — Lorax 28.13 documentation
@@ -58,7 +58,7 @@
- 28.10
+ 28.13
@@ -308,6 +308,8 @@
delete_file() (in module pylorax.api.recipes)
delete_recipe() (in module pylorax.api.recipes)
+
+ delete_repo_source() (in module pylorax.api.projects)
dep_evra() (in module pylorax.api.projects)
@@ -326,6 +328,8 @@
dm_detach() (in module pylorax.imgutils)
DMDev (class in pylorax.imgutils)
+
+ dnf_repo_to_file_repo() (in module pylorax.api.projects)
do_grafts() (in module pylorax.imgutils)
@@ -393,8 +397,6 @@
G
- get_image_name() (in module pylorax.api.queue)
- get_iso_label() (pylorax.mount.IsoMountpoint method)
- get_loop_name() (in module pylorax.imgutils)
+
+ - get_repo_sources() (in module pylorax.api.projects)
- get_revision_from_tag() (in module pylorax.api.recipes)
+
+ - get_source_ids() (in module pylorax.api.projects)
- gfile() (in module pylorax.api.recipes)
@@ -604,6 +610,8 @@
- mktar() (in module pylorax.imgutils)
- module_names (pylorax.api.recipes.Recipe attribute)
+
+ - module_nver (pylorax.api.recipes.Recipe attribute)
- modules_info() (in module pylorax.api.projects)
@@ -648,6 +656,8 @@
+ - pylorax.api.compose (module)
+
- pylorax.api.config (module)
- pylorax.api.crossdomain (module)
@@ -811,10 +821,10 @@
- removefrom() (pylorax.ltmpl.LoraxTemplateRunner method)
-
- removepkg() (pylorax.ltmpl.LoraxTemplateRunner method)
- replace() (in module pylorax.sysutils)
@@ -826,6 +836,8 @@
- repo (pylorax.api.server.GitLock attribute)
- repo_to_ks() (in module pylorax.api.compose)
+
+ - repo_to_source() (in module pylorax.api.projects)
- reset() (pylorax.creator.FakeDNF method)
@@ -875,12 +887,14 @@
- singleton() (in module pylorax.decorators)
- - split_and_expand() (in module pylorax.ltmpl)
+
- source_to_repo() (in module pylorax.api.projects)
- - squashfs_args() (in module pylorax.creator)
+
- split_and_expand() (in module pylorax.ltmpl)
+ - squashfs_args() (in module pylorax.creator)
+
- start() (pylorax.dnfhelper.LoraxDownloadCallback method)
- start_build() (in module pylorax.api.compose)
@@ -1040,7 +1054,7 @@
diff --git a/docs/html/index.html b/docs/html/index.html
index 771ed9d9..ea41d573 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -8,7 +8,7 @@
-
Welcome to Lorax’s documentation! — Lorax 28.10 documentation
+ Welcome to Lorax’s documentation! — Lorax 28.13 documentation
@@ -58,7 +58,7 @@
- 28.10
+ 28.13
@@ -227,7 +227,7 @@
diff --git a/docs/html/intro.html b/docs/html/intro.html
index 68daae92..8d2e54f8 100644
--- a/docs/html/intro.html
+++ b/docs/html/intro.html
@@ -8,7 +8,7 @@
- Introduction to Lorax — Lorax 28.10 documentation
+ Introduction to Lorax — Lorax 28.13 documentation
@@ -59,7 +59,7 @@
- 28.10
+ 28.13
@@ -250,7 +250,7 @@ upd-instroot and mk-images* scripts.
diff --git a/docs/html/livemedia-creator.html b/docs/html/livemedia-creator.html
index aa28940a..d77286e0 100644
--- a/docs/html/livemedia-creator.html
+++ b/docs/html/livemedia-creator.html
@@ -8,7 +8,7 @@
- livemedia-creator — Lorax 28.10 documentation
+ livemedia-creator — Lorax 28.13 documentation
@@ -59,7 +59,7 @@
- 28.10
+ 28.13
@@ -1148,7 +1148,7 @@ report bugs against the lorax component.
diff --git a/docs/html/lorax-composer.html b/docs/html/lorax-composer.html
index c5536881..62ea439c 100644
--- a/docs/html/lorax-composer.html
+++ b/docs/html/lorax-composer.html
@@ -8,7 +8,7 @@
- lorax-composer — Lorax 28.10 documentation
+ lorax-composer — Lorax 28.13 documentation
@@ -59,7 +59,7 @@
- 28.10
+ 28.13
@@ -114,6 +114,7 @@
- Example: Add partitioned disk support
+- Package Sources
- composer-cli
@@ -469,6 +470,50 @@ unneeded extra files. This is especially true for the
+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/<source-name> 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/<source-name> 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.
+
@@ -513,7 +558,7 @@ the contents of the iso as well as the boot.iso itself.
diff --git a/docs/html/lorax.html b/docs/html/lorax.html
index f5179bb1..1076b97e 100644
--- a/docs/html/lorax.html
+++ b/docs/html/lorax.html
@@ -8,7 +8,7 @@
- Lorax — Lorax 28.10 documentation
+ Lorax — Lorax 28.13 documentation
@@ -59,7 +59,7 @@
- 28.10
+ 28.13
@@ -458,7 +458,6 @@ installation. A number of template commands are used here:
append to add text to a file.chmod changes the file’s mode.gconfset runs gconfset.install to install a file into the installroot.mkdir makes a new directory.move to move a file into the installroot
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
- VERSION:'28.10',
+ VERSION:'28.13',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -577,9 +576,7 @@ should) select the specific template directory by passing
jQuery(function () {
-
- SphinxRtdTheme.Navigation.enableSticky();
-
+ SphinxRtdTheme.Navigation.enable(true);
});
diff --git a/docs/html/modules.html b/docs/html/modules.html
index 36123fe2..ea282810 100644
--- a/docs/html/modules.html
+++ b/docs/html/modules.html
@@ -8,7 +8,7 @@
- pylorax — Lorax 28.10 documentation
+ pylorax — Lorax 28.13 documentation
@@ -59,7 +59,7 @@
- 28.10
+ 28.13
@@ -250,7 +250,7 @@
diff --git a/docs/html/objects.inv b/docs/html/objects.inv
index 2d2fc3d0..938631e3 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 22536bec..57d66c80 100644
--- a/docs/html/product-images.html
+++ b/docs/html/product-images.html
@@ -8,7 +8,7 @@
- Product and Updates Images — Lorax 28.10 documentation
+ Product and Updates Images — Lorax 28.13 documentation
@@ -59,7 +59,7 @@
- 28.10
+ 28.13
@@ -222,7 +222,7 @@ command or the installpkgs paramater of
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
- VERSION:'28.10',
+ VERSION:'28.13',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
@@ -243,9 +243,7 @@ command or the installpkgs paramater of
jQuery(function () {
-
- SphinxRtdTheme.Navigation.enableSticky();
-
+ SphinxRtdTheme.Navigation.enable(true);
});
diff --git a/docs/html/py-modindex.html b/docs/html/py-modindex.html
index b49c8e23..2db224cb 100644
--- a/docs/html/py-modindex.html
+++ b/docs/html/py-modindex.html
@@ -8,7 +8,7 @@
- Python Module Index — Lorax 28.10 documentation
+ Python Module Index — Lorax 28.13 documentation
@@ -60,7 +60,7 @@
- 28.10
+ 28.13
@@ -345,7 +345,7 @@
diff --git a/docs/html/pylorax.api.html b/docs/html/pylorax.api.html
index c5b2124e..ce471bb2 100644
--- a/docs/html/pylorax.api.html
+++ b/docs/html/pylorax.api.html
@@ -8,7 +8,7 @@
- pylorax.api package — Lorax 28.10 documentation
+ pylorax.api package — Lorax 28.13 documentation
@@ -58,7 +58,7 @@
- 28.10
+ 28.13
@@ -490,6 +490,28 @@ with whatever options are relevant.
+
+-
+
pylorax.api.projects.delete_repo_source(source_glob, source_name)[source]¶
+Delete a source from a repo file
+
+Parameters: source_glob (str) – A glob of the repo sources to search
+Returns: None
+Raises: ProjectsError if there was a problem
+
+A repo file may have multiple sources in it, delete only the selected source.
+If it is the last one in the file, delete the file.
+WARNING: This will delete ANY source, the caller needs to ensure that a system
+source_name isn’t passed to it.
+
+
-
pylorax.api.projects.dep_evra(dep)[source]¶
@@ -514,6 +536,27 @@ with whatever options are relevant.
Return the name-epoch:version-release.arch
+
+-
+
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: repo (dnf.RepoDict) – DNF Repository
+Returns: A string
+Return type: str
+
+The DNF Repo.dump() function does not produce a string that can be used as a dnf .repo file,
+it ouputs baseurl and gpgkey as python lists which DNF cannot read. So do this manually with
+only the attributes we care about.
+
+
-
pylorax.api.projects.estimate_size(packages, block_size=6144)[source]¶
@@ -541,6 +584,42 @@ dnf doesn’t provide access to. So use the file count and block size to estimat
a minimum size for each package.
+
+-
+
pylorax.api.projects.get_repo_sources(source_glob)[source]¶
+Return a list of sources from a directory of yum repositories
+
+Parameters: source_glob (str) – A glob to use to match the source files, including full path
+Returns: A list of the source ids in all of the matching files
+Return type: list of str
+
+
+
+
+-
+
pylorax.api.projects.get_source_ids(source_path)[source]¶
+Return a list of the source ids in a file
+
+Parameters: source_path (str) – Full path and filename of the source (yum repo) file
+Returns: A list of source id strings
+Return type: list of str
+
+
+
-
pylorax.api.projects.modules_info(dbo, module_names)[source]¶
@@ -669,7 +748,7 @@ and sets the type to “rpm”
-
-
pylorax.api.projects.projects_depsolve(dbo, project_names)[source]¶
+pylorax.api.projects.projects_depsolve(dbo, projects)[source]¶
Return the dependencies for a list of projects
Parameters:
- dbo (dnf.Base) – dnf base object
-- project_names (List of Strings) – The projects to find the dependencies for
+- projects (List of Strings) – The projects to find the dependencies for
Returns: NEVRA’s of the project and its dependencies
Return type: list of dicts
+Return type: list of dicts
+Raises: ProjectsError if there was a problem installing something
-
-
pylorax.api.projects.projects_depsolve_with_size(dbo, project_names, with_core=True)[source]¶
+pylorax.api.projects.projects_depsolve_with_size(dbo, projects, with_core=True)[source]¶
Return the dependencies and installed size for a list of projects
Returns: installed size and a list of NEVRA’s of the project and its dependencies
Return type: tuple of (int, list of dicts)
+Return type: tuple of (int, list of dicts)
+Raises: ProjectsError if there was a problem installing something
+
+-
+
pylorax.api.projects.repo_to_source(repo, system_source)[source]¶
+Return a Weldr Source dict created from the DNF Repository
+
+Parameters:
+- repo (dnf.RepoDict) – DNF Repository
+- system_source (bool) – True if this source is an immutable system source
+
+Returns: A dict with Weldr Source fields filled in
+Return type:
+
+
+Example:
+{
+ "check_gpg": true,
+ "check_ssl": true,
+ "gpgkey_url": [
+ "file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"
+ ],
+ "name": "fedora",
+ "proxy": "http://proxy.brianlane.com:8123",
+ "system": true
+ "type": "yum-metalink",
+ "url": "https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"
+}
+
+
+
+
+
+-
+
pylorax.api.projects.source_to_repo(source, dnf_conf)[source]¶
+Return a dnf Repo object created from a source dict
+
+Parameters: source (dict) – A Weldr source dict
+Returns: A dnf Repo object
+Return type: dnf.Repo
+
+Example:
+{
+ "check_gpg": True,
+ "check_ssl": True,
+ "gpgkey_urls": [
+ "file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"
+ ],
+ "name": "fedora",
+ "proxy": "http://proxy.brianlane.com:8123",
+ "system": True
+ "type": "yum-metalink",
+ "url": "https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"
+}
+
+
+
+
pylorax.api.queue module¶
@@ -1237,12 +1394,24 @@ If they are different, check and return the new version
Return the names of the modules
+-
+
module_nver¶
+Return the names and version globs of the modules
+
+
-
package_names¶
Return the names of the packages
+
+-
+
package_nver¶
+Return the names and version globs of the packages
+
+
+
+/api/v0/projects/source/list¶
+
+Return the list of repositories used for depsolving and installing packages.
+Example:
+{
+ "sources": [
+ "fedora",
+ "fedora-cisco-openh264",
+ "fedora-updates-testing",
+ "fedora-updates"
+ ]
+}
+
+
+
+
+
+/api/v0/projects/source/info/<source-names>¶
+
+Return information about the comma-separated list of source names. Or all of the
+sources if ‘*’ is passed. Note that general globbing is not supported, only ‘*’.
+immutable system sources will have the “system” field set to true. User added sources
+will have it set to false. System sources cannot be changed or deleted.
+Example:
+{
+ "errors": [],
+ "sources": {
+ "fedora": {
+ "check_gpg": true,
+ "check_ssl": true,
+ "gpgkey_urls": [
+ "file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"
+ ],
+ "name": "fedora",
+ "proxy": "http://proxy.brianlane.com:8123",
+ "system": true,
+ "type": "yum-metalink",
+ "url": "https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"
+ }
+ }
+}
+
+
+
+
+
+POST /api/v0/projects/source/new¶
+
+Add (or change) a source for use when depsolving blueprints and composing images.
+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
+of the new version of the source. It will overwrite the previous one.
+Example:
+{
+ "name": "custom-source-1",
+ "url": "https://url/path/to/repository/",
+ "type": "yum-baseurl",
+ "check_ssl": true,
+ "check_gpg": true,
+ "gpgkey_urls": [
+ "https://url/path/to/gpg-key"
+ ]
+}
+
+
+
+
+
+DELETE /api/v0/projects/source/delete/<source-name>¶
+
+Delete a user added source. This will fail if a system source is passed to
+it.
+The response will be a status response with status set to true, or an
+error response with it set to false and an error message included.
+
+
/api/v0/modules/list[?offset=0&limit=20]¶
@@ -3213,7 +3469,7 @@ a line boundry.
diff --git a/docs/html/pylorax.html b/docs/html/pylorax.html
index b46c44f0..471056d3 100644
--- a/docs/html/pylorax.html
+++ b/docs/html/pylorax.html
@@ -8,7 +8,7 @@
- pylorax package — Lorax 28.10 documentation
+ pylorax package — Lorax 28.13 documentation
@@ -59,7 +59,7 @@
- 28.10
+ 28.13
@@ -224,6 +224,10 @@
- /api/v0/projects/list[?offset=0&limit=20]
- /api/v0/projects/info/<project_names>
- /api/v0/projects/depsolve/<project_names>
+- /api/v0/projects/source/list
+- /api/v0/projects/source/info/<source-names>
+- POST /api/v0/projects/source/new
+- DELETE /api/v0/projects/source/delete/<source-name>
- /api/v0/modules/list[?offset=0&limit=20]
- /api/v0/modules/list/<module_names>[?offset=0&limit=20]
- /api/v0/modules/info/<module_names>
@@ -1417,7 +1421,7 @@ with the rest of the line as arguments
Parsing and execution are separate passes - so you can’t use the result
of a command in an %if statement (or any other control statements)!
Commands that run external programs (systemctl, gconfset) currently use
+
Commands that run external programs (e.g. systemctl) currently use
the host’s copy of that program, which may cause problems if there’s a
big enough difference between the host and the image you’re modifying.
--
-
gconfset(path, keytype, value, outfile=None)[source]¶
-
-- gconfset PATH KEYTYPE VALUE [OUTFILE]
-Set the given gconf PATH, with type KEYTYPE, to the given value.
-OUTFILE defaults to /etc/gconf/gconf.xml.defaults if not given.
-Example:
-
-gconfset /apps/metacity/general/num_workspaces int 1
-
-
-
-
hardlink(src, dest)[source]¶
@@ -2270,7 +2260,7 @@ lowest numbered directory entry is returned.
diff --git a/docs/html/search.html b/docs/html/search.html
index 56259cd7..f12aa271 100644
--- a/docs/html/search.html
+++ b/docs/html/search.html
@@ -8,7 +8,7 @@
- Search — Lorax 28.10 documentation
+ Search — Lorax 28.13 documentation
@@ -57,7 +57,7 @@
- 28.10
+ 28.13
@@ -198,7 +198,7 @@