• No results found

OBS Image Utils Documentation

N/A
N/A
Protected

Academic year: 2022

Share "OBS Image Utils Documentation"

Copied!
39
0
0

Loading.... (view fulltext now)

Full text

(1)

OBS Image Utils Documentation

Release 0.3.1

SUSE

Oct 18, 2021

(2)
(3)

1 Installation 3

1.1 openSUSE package. . . 3

1.2 PyPI . . . 3

1.3 Development . . . 3

1.4 Branch . . . 3

2 Requirements 5 3 Configuration 7 3.1 Options . . . 7

4 API 9 4.1 obs-img-utils . . . 9

4.1.1 download . . . 9

4.1.2 packages. . . 10

5 obs_img_utils package 13 5.1 Submodules . . . 13

5.1.1 obs_img_utils.api module. . . 13

5.1.2 obs_img_utils.cli module . . . 16

5.1.3 obs_img_utils.exceptions module. . . 16

5.1.4 obs_img_utils.utils module . . . 17

5.1.5 obs_img_utils.web_content module . . . 19

5.2 Module contents . . . 19

6 Overview 21

7 Contributing 23

8 Issues/Enhancements 25

9 License 27

Python Module Index 29

Index 31

(4)
(5)
(6)

2 CONTENTS

(7)

ONE

INSTALLATION

1.1 openSUSE package

Perform the following commands as root:

$ zypper ar http://download.opensuse.org/repositories/Cloud:/Tools/<distribution>

$ zypper refresh

$ zypper in obs-img-utils

1.2 PyPI

$ pip install obs-img-utils

1.3 Development

Install the latest development version from GitHub:

$ pip install git+https://github.com/SUSE-Enceladus/obs-img-utils.git

1.4 Branch

Install a specific branch from GitHub:

$ pip install git+https://github.com/SUSE-Enceladus/obs-img-utils.git@{branch/release}

SeePyPI docsfor more information on vcs support.

(8)

4 Chapter 1. Installation

(9)

TWO

REQUIREMENTS

• Click

• lxml

• PyYaml

• xmltodict

(10)

6 Chapter 2. Requirements

(11)

THREE

CONFIGURATION

OBS Image Utils uses a YAML configuration file. The expected path for the configuration file is ~/.con- fig/obs_img_utils/config.yaml.

This location can be configured with each command using the -C/–config option. For example:

obs-mg-utils --config ~/new/config.yaml job add ...

3.1 Options

The following options are currently available in the configuration file:

arch Architecture of image. Example x86_64

target_dir Directory for saving image and checksum. Example /home/{user}/images

download_url OBS download repository URL. Example https://provo-mirror.opensuse.org/repositories/Cloud:/Images:/Leap_15.0/images/

version_format Format of kiwi and obs version. Example {kiwi_version}-Build{obs_build}

conditions_wait_time Time in seconds to wait for conditions to pass. Example 300 log_level Python log level. See Pythondocsfor level values.

no_color If set to True removes ANSI color and styling from output.

(12)

8 Chapter 3. Configuration

(13)

FOUR

API

4.1 obs-img-utils

The command line interface provides obs image utilities.

This includes downloading images, checking packages in images and getting package version information.

obs-img-utils [OPTIONS] COMMAND [ARGS]...

Options --version

Show the version and exit.

--license

Show license information.

4.1.1 download

Download image from OBS repository specified by download-url.

obs-img-utils download [OPTIONS]

Options

--add-conditions

Invoke conditions process to specify conditions for image --conditions-wait-time <conditions_wait_time>

Time (in seconds) to wait for conditions to be met. Retry period is 150 seconds and default is 0 seconds for no wait.

--extension <extension>

Image file extension. Examples: [tar.gz, raw.xz]

--checksum-extension <checksum_extension>

Image checksum file extension. Example: sha256 --disallow-licenses

Invoke license REPL to specify any licenses that should not be in the image.

(14)

--disallow-packages

Invoke packages REPL to specify any packages which should not be in the image. This can use a wildcard (*) to match a naming pattern like “*-mini”.

-C, --config <config>

OBS Image utils config file to use. Default: ~/.config/obs_img_utils/config.yaml --no-color

Remove ANSI color and styling from output.

--debug

Display debug level logging to console.

--verbose

Display logging info to console. (Default) --quiet

Disable console output.

--download-url <download_url>

URL for OBS download repository.

--target-dir <target_dir>

Directory to store downloaded images and checksums.

--image-name <image_name>

RequiredImage name to download from the download-url.

--arch <arch>

Architecture of the image.

Options x86_64 | aarch64 --profile <profile>

The multibuild profile name for the image.

4.1.2 packages

Package commands.

obs-img-utils packages [OPTIONS] COMMAND [ARGS]...

list

Return a list of packages for the given image name.

obs-img-utils packages list [OPTIONS]

10 Chapter 4. API

(15)

Options

--filter-licenses

Invoke license REPL to specify license filters --filter-packages

Invoke packages REPL to specify package name filters -C, --config <config>

OBS Image utils config file to use. Default: ~/.config/obs_img_utils/config.yaml --no-color

Remove ANSI color and styling from output.

--debug

Display debug level logging to console.

--verbose

Display logging info to console. (Default) --quiet

Disable console output.

--download-url <download_url>

URL for OBS download repository.

--target-dir <target_dir>

Directory to store downloaded images and checksums.

--image-name <image_name>

RequiredImage name to download from the download-url.

--arch <arch>

Architecture of the image.

Options x86_64 | aarch64 --profile <profile>

The multibuild profile name for the image.

show

Return information for the provided package name in the given image.

obs-img-utils packages show [OPTIONS]

Options

--package-name <package_name>

RequiredName of the package.

-C, --config <config>

OBS Image utils config file to use. Default: ~/.config/obs_img_utils/config.yaml --no-color

Remove ANSI color and styling from output.

--debug

Display debug level logging to console.

(16)

--verbose

Display logging info to console. (Default) --quiet

Disable console output.

--download-url <download_url>

URL for OBS download repository.

--target-dir <target_dir>

Directory to store downloaded images and checksums.

--image-name <image_name>

RequiredImage name to download from the download-url.

--arch <arch>

Architecture of the image.

Options x86_64 | aarch64 --profile <profile>

The multibuild profile name for the image.

12 Chapter 4. API

(17)

FIVE

OBS_IMG_UTILS PACKAGE

5.1 Submodules

5.1.1 obs_img_utils.api module

class obs_img_utils.api.OBSImageUtil(download_url, image_name, conditions=None, arch='x86_64', target_directory=None, profile=None, log_level=20,

conditions_wait_time=0, log_callback=None, report_callback=None, checksum_extension=None,

extension=None, filter_licenses=None, filter_packages=None, signature_extension=None)

Bases:object

Implements image downloader.

__dict__ = mappingproxy({'__module__': 'obs_img_utils.api', '__doc__': '\n Implements image downloader.\n ', '__init__': <function OBSImageUtil.__init__>, '_init_status': <function OBSImageUtil._init_status>, '_download_image': <function OBSImageUtil._download_image>, '_get_image_checksum': <function

OBSImageUtil._get_image_checksum>, '_get_build_number': <function

OBSImageUtil._get_build_number>, '_image_conditions_complied': <function OBSImageUtil._image_conditions_complied>, 'check_image_conditions': <function OBSImageUtil.check_image_conditions>, 'check_license_conditions': <function OBSImageUtil.check_license_conditions>, '_wait_on_image_conditions': <function OBSImageUtil._wait_on_image_conditions>, 'wait_for_new_image': <function

OBSImageUtil.wait_for_new_image>, 'get_image': <function OBSImageUtil.get_image>, '_download_metadata_file': <function OBSImageUtil._download_metadata_file>, '_get_image_version': <function OBSImageUtil._get_image_version>,

'get_image_packages_metadata': <function OBSImageUtil.get_image_packages_metadata>, 'parse_report_file': <function OBSImageUtil.parse_report_file>,

'parse_packages_file': <function OBSImageUtil.parse_packages_file>,

'_version_compare': <function OBSImageUtil._version_compare>, '_lookup_package':

<function OBSImageUtil._lookup_package>, 'check_invalid_packages': <function OBSImageUtil.check_invalid_packages>, '_check_version_and_build_condition':

<function OBSImageUtil._check_version_and_build_condition>, '__dict__': <attribute '__dict__' of 'OBSImageUtil' objects>, '__weakref__': <attribute '__weakref__' of 'OBSImageUtil' objects>, '__annotations__': {}})

__init__(download_url, image_name, conditions=None, arch='x86_64', target_directory=None,

profile=None, log_level=20, conditions_wait_time=0, log_callback=None, report_callback=None, checksum_extension=None, extension=None, filter_licenses=None, filter_packages=None,

signature_extension=None)

(18)

__module__ = 'obs_img_utils.api' __weakref__

list of weak references to the object (if defined)

_check_version_and_build_condition(condition, current_release, current_version, name) _download_image()

Download image and shasum to given file.

_download_metadata_file(ext='report') _get_build_number(name)

_get_image_checksum(name=None) _get_image_version()

_image_conditions_complied() _init_status()

_lookup_package(packages, condition)

_version_compare(current, expected, condition) _wait_on_image_conditions()

check_image_conditions() check_invalid_packages() check_license_conditions() get_image()

get_image_packages_metadata() parse_packages_file()

parse_report_file() wait_for_new_image()

class obs_img_utils.api.build_version(kiwi_version, obs_build) Bases:tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__module__ = 'obs_img_utils.api' static __new__(_cls, kiwi_version, obs_build)

Create new instance of build_version(kiwi_version, obs_build) __repr__()

Return a nicely formatted representation string __slots__ = ()

_asdict()

Return a new OrderedDict which maps field names to their values.

_field_defaults = {}

_fields = ('kiwi_version', 'obs_build') _fields_defaults = {}

14 Chapter 5. obs_img_utils package

(19)

classmethod _make(iterable)

Make a new build_version object from a sequence or iterable _replace(**kwds)

Return a new build_version object replacing specified fields with new values property kiwi_version

Alias for field number 0 property obs_build

Alias for field number 1

class obs_img_utils.api.package_type(name, version, release, arch, license, checksum) Bases:tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__module__ = 'obs_img_utils.api'

static __new__(_cls, name, version, release, arch, license, checksum)

Create new instance of package_type(name, version, release, arch, license, checksum) __repr__()

Return a nicely formatted representation string __slots__ = ()

_asdict()

Return a new OrderedDict which maps field names to their values.

_field_defaults = {}

_fields = ('name', 'version', 'release', 'arch', 'license', 'checksum') _fields_defaults = {}

classmethod _make(iterable)

Make a new package_type object from a sequence or iterable _replace(**kwds)

Return a new package_type object replacing specified fields with new values property arch

Alias for field number 3 property checksum

Alias for field number 5 property license

Alias for field number 4 property name

Alias for field number 0 property release

Alias for field number 2 property version

Alias for field number 1

(20)

5.1.2 obs_img_utils.cli module

obs_img_utils.cli.abort_if_false(ctx, param, value) obs_img_utils.cli.add_options(options)

obs_img_utils.cli.print_license(ctx, param, value)

5.1.3 obs_img_utils.exceptions module

exception obs_img_utils.exceptions.DownloadMetadataFileExceptionOBS(message) Bases:obs_img_utils.exceptions.OBSImageUtilsException

Exception raised if there is an issue downloading packages file.

__module__ = 'obs_img_utils.exceptions'

exception obs_img_utils.exceptions.OBSImageChecksumException(message) Bases:obs_img_utils.exceptions.OBSImageUtilsException

Exception raised if image checksum does not match.

__module__ = 'obs_img_utils.exceptions'

exception obs_img_utils.exceptions.OBSImageConditionsException(message) Bases:obs_img_utils.exceptions.OBSImageUtilsException

Exception raised if image metadata does not match conditions.

__module__ = 'obs_img_utils.exceptions'

exception obs_img_utils.exceptions.OBSImageDownloadException(message) Bases:obs_img_utils.exceptions.OBSImageUtilsException

Exception raised when unable to download image file.

__module__ = 'obs_img_utils.exceptions'

exception obs_img_utils.exceptions.OBSImageUtilsException(message) Bases:Exception

Base class to handle all known exceptions.

Specific exceptions are implemented as sub classes of OBSImageUtilsException.

Attributes * message Exception message text __init__(message)

__module__ = 'obs_img_utils.exceptions' __str__()

Return str(self).

__weakref__

list of weak references to the object (if defined)

exception obs_img_utils.exceptions.OBSImageVersionException(message) Bases:obs_img_utils.exceptions.OBSImageUtilsException

Exception raised when unable to parse image version.

__module__ = 'obs_img_utils.exceptions'

16 Chapter 5. obs_img_utils package

(21)

exception obs_img_utils.exceptions.PackageVersionExceptionOBS(message) Bases:obs_img_utils.exceptions.OBSImageUtilsException

Exception raised if package does not match version conditions.

__module__ = 'obs_img_utils.exceptions'

5.1.4 obs_img_utils.utils module

obs_img_utils.utils.click_progress_callback(block_num, read_size, total_size, done=False) Update the module level progress bar with image download progress.

If download has finished flush stdout with render_finish.

obs_img_utils.utils.conditions_repl(no_color) Query and accept input for condition options.

obs_img_utils.utils.echo_package(name, data, no_color) Echoes package info to terminal based on name.

obs_img_utils.utils.echo_packages(data, no_color) Echoes list of package info to terminal.

obs_img_utils.utils.echo_style(message, no_color, fg='green')

obs_img_utils.utils.filter_packages_by_licenses(packages_metadata, licenses) Returned a filtered dictionary of packages that matches the licenses.

obs_img_utils.utils.filter_packages_by_name(packages_metadata, package_name) Returned a filtered dictionary of packages that matches the package names.

obs_img_utils.utils.get_checksum_from_file(checksum_file) Get the checksum from OBS image.

Expects an inline signed file where checksum is on line 4.

obs_img_utils.utils.get_config(cli_context) Process OBS Image utils config.

Use ChainMap to build config values based on command line args, config and defaults.

obs_img_utils.utils.get_hash_from_image(image_file) Calculate hash of image read in from stream.

obs_img_utils.utils.get_logger(log_level) Return new console logger at provided log level.

obs_img_utils.utils.handle_errors(log_level, no_color) Context manager to handle exceptions and echo error msg.

class obs_img_utils.utils.img_downloader_config(arch, checksum_extension, conditions_wait_time, config, download_url, extension, image_name, log_level, no_color, profile, signature_extension, target_dir)

Bases:tuple __getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__module__ = 'obs_img_utils.utils'

(22)

static __new__(_cls, arch, checksum_extension, conditions_wait_time, config, download_url, extension, image_name, log_level, no_color, profile, signature_extension, target_dir)

Create new instance of img_downloader_config(arch, checksum_extension, conditions_wait_time, config, download_url, extension, image_name, log_level, no_color, profile, signature_extension, target_dir) __repr__()

Return a nicely formatted representation string __slots__ = ()

_asdict()

Return a new OrderedDict which maps field names to their values.

_field_defaults = {}

_fields = ('arch', 'checksum_extension', 'conditions_wait_time', 'config', 'download_url', 'extension', 'image_name', 'log_level', 'no_color', 'profile', 'signature_extension', 'target_dir')

_fields_defaults = {}

classmethod _make(iterable)

Make a new img_downloader_config object from a sequence or iterable _replace(**kwds)

Return a new img_downloader_config object replacing specified fields with new values property arch

Alias for field number 0 property checksum_extension

Alias for field number 1

property conditions_wait_time Alias for field number 2

property config

Alias for field number 3 property download_url

Alias for field number 4 property extension

Alias for field number 5 property image_name

Alias for field number 6 property log_level

Alias for field number 7 property no_color

Alias for field number 8 property profile

Alias for field number 9 property signature_extension

Alias for field number 10 property target_dir

Alias for field number 11

18 Chapter 5. obs_img_utils package

(23)

obs_img_utils.utils.license_repl() Query and accept input for license types.

obs_img_utils.utils.packages_repl()

Query and accept input for invalid package names.

obs_img_utils.utils.process_shared_options(context_obj, kwargs) Update context with values for shared options.

obs_img_utils.utils.retry(exceptions, tries=4, delay=3, backoff=2) Retry calling the decorated instance method using an exponential backoff.

obs_img_utils.utils.style_string(message, no_color, fg='yellow') Add color style to string if no_color is False.

5.1.5 obs_img_utils.web_content module

class obs_img_utils.web_content.WebContent(uri) Bases:object

Web Content Scanner and Download interface

__dict__ = mappingproxy({'__module__': 'obs_img_utils.web_content', '__doc__': '\n Web Content Scanner and Download interface\n ', '__init__': <function

WebContent.__init__>, 'fetch_index_list': <function WebContent.fetch_index_list>, 'fetch_to_dir': <function WebContent.fetch_to_dir>, '__dict__': <attribute '__dict__' of 'WebContent' objects>, '__weakref__': <attribute '__weakref__' of 'WebContent' objects>, '__annotations__': {}})

__init__(uri)

__module__ = 'obs_img_utils.web_content' __weakref__

list of weak references to the object (if defined) fetch_index_list(base_name)

fetch_to_dir(base_name, regex, target_dir, extensions, callback=None)

5.2 Module contents

(24)

20 Chapter 5. obs_img_utils package

(25)

SIX

OVERVIEW

OBS Image Utilsprovides an API and CLI utilities for images in OBS.

(26)

22 Chapter 6. Overview

(27)

SEVEN

CONTRIBUTING

Contributions to OBS Image Utils are welcome and encouraged. SeeCONTRIBUTINGfor info on getting started.

(28)

24 Chapter 7. Contributing

(29)

EIGHT

ISSUES/ENHANCEMENTS

Please submit issues and requests toGithub.

(30)

26 Chapter 8. Issues/Enhancements

(31)

NINE

LICENSE

Copyright (c) 2019 SUSE LLC. All rights reserved.

Distributed under the terms of GPL-3.0+ license, seeLICENSEfor details.

(32)

28 Chapter 9. License

(33)

o

obs_img_utils,19 obs_img_utils.api,13 obs_img_utils.cli,16

obs_img_utils.exceptions,16 obs_img_utils.utils,17 obs_img_utils.web_content,19

(34)

30 Python Module Index

(35)

Symbols

__dict__ (obs_img_utils.api.OBSImageUtil attribute), 13

__dict__ (obs_img_utils.web_content.WebContent at- tribute),19

__getnewargs__() (obs_img_utils.api.build_version method),14

__getnewargs__() (obs_img_utils.api.package_type method),15

__getnewargs__()(obs_img_utils.utils.img_downloader_config method),17

__init__()(obs_img_utils.api.OBSImageUtil method), 13

__init__()(obs_img_utils.exceptions.OBSImageUtilsException method),16

__init__() (obs_img_utils.web_content.WebContent method),19

__module__ (obs_img_utils.api.OBSImageUtil at- tribute),13

__module__(obs_img_utils.api.build_version attribute), 14

__module__(obs_img_utils.api.package_type attribute), 15

__module__(obs_img_utils.exceptions.DownloadMetadataFileExceptionOBS attribute),16

__module__(obs_img_utils.exceptions.OBSImageChecksumException attribute),16

__module__(obs_img_utils.exceptions.OBSImageConditionsException attribute),16

__module__(obs_img_utils.exceptions.OBSImageDownloadException attribute),16

__module__(obs_img_utils.exceptions.OBSImageUtilsException attribute),16

__module__(obs_img_utils.exceptions.OBSImageVersionException attribute),16

__module__(obs_img_utils.exceptions.PackageVersionExceptionOBS attribute),17

__module__(obs_img_utils.utils.img_downloader_config attribute),17

__module__ (obs_img_utils.web_content.WebContent attribute),19

method),14

__new__() (obs_img_utils.api.package_type static method),15

__new__() (obs_img_utils.utils.img_downloader_config static method),17

__repr__() (obs_img_utils.api.build_version method), 14

__repr__() (obs_img_utils.api.package_type method), 15

__repr__()(obs_img_utils.utils.img_downloader_config method),18

__slots__ (obs_img_utils.api.build_version attribute), 14

__slots__ (obs_img_utils.api.package_type attribute), 15

__slots__ (obs_img_utils.utils.img_downloader_config attribute),18

__str__()(obs_img_utils.exceptions.OBSImageUtilsException method),16

__weakref__ (obs_img_utils.api.OBSImageUtil at- tribute),14

__weakref__(obs_img_utils.exceptions.OBSImageUtilsException attribute),16

__weakref__ (obs_img_utils.web_content.WebContent attribute),19

_asdict()(obs_img_utils.api.build_version method),14 _asdict()(obs_img_utils.api.package_type method),15 _asdict() (obs_img_utils.utils.img_downloader_config

method),18

_check_version_and_build_condition()

(obs_img_utils.api.OBSImageUtil method), 14

_download_image() (obs_img_utils.api.OBSImageUtil method),14

_download_metadata_file()

(obs_img_utils.api.OBSImageUtil method), 14

_field_defaults (obs_img_utils.api.build_version at- tribute),14

_field_defaults (obs_img_utils.api.package_type at- tribute),15

(obs_img_utils.utils.img_downloader_config

(36)

attribute),18

_fields(obs_img_utils.api.build_version attribute),14 _fields(obs_img_utils.api.package_type attribute),15 _fields (obs_img_utils.utils.img_downloader_config

attribute),18

_fields_defaults (obs_img_utils.api.build_version attribute),14

_fields_defaults (obs_img_utils.api.package_type attribute),15

_fields_defaults(obs_img_utils.utils.img_downloader_config attribute),18

_get_build_number()

(obs_img_utils.api.OBSImageUtil method), 14

_get_image_checksum()

(obs_img_utils.api.OBSImageUtil method), 14

_get_image_version()

(obs_img_utils.api.OBSImageUtil method), 14

_image_conditions_complied()

(obs_img_utils.api.OBSImageUtil method), 14

_init_status() (obs_img_utils.api.OBSImageUtil method),14

_lookup_package() (obs_img_utils.api.OBSImageUtil method),14

_make()(obs_img_utils.api.build_version class method), 14

_make()(obs_img_utils.api.package_type class method), 15

_make() (obs_img_utils.utils.img_downloader_config class method),18

_replace() (obs_img_utils.api.build_version method), 15

_replace() (obs_img_utils.api.package_type method), 15

_replace()(obs_img_utils.utils.img_downloader_config method),18

_version_compare()(obs_img_utils.api.OBSImageUtil method),14

_wait_on_image_conditions()

(obs_img_utils.api.OBSImageUtil method), 14

-C

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,11

--add-conditions

obs-img-utils-download command line option,9

--arch <arch>

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,12

--checksum-extension <checksum_extension>

obs-img-utils-download command line option,9

--conditions-wait-time

<conditions_wait_time>

obs-img-utils-download command line option,9

--config <config>

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,11

--debug

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,11

--disallow-licenses

obs-img-utils-download command line option,9

--disallow-packages

obs-img-utils-download command line option,9

--download-url <download_url>

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,12

--extension <extension>

obs-img-utils-download command line option,9

--filter-licenses

obs-img-utils-packages-list command line option,11

--filter-packages

obs-img-utils-packages-list command line option,11

--image-name <image_name>

obs-img-utils-download command line option,10

obs-img-utils-packages-list command

32 Index

(37)

line option,11

obs-img-utils-packages-show command line option,12

--license

obs-img-utils command line option,9 --no-color

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,11

--package-name <package_name>

obs-img-utils-packages-show command line option,11

--profile <profile>

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,12

--quiet

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,12

--target-dir <target_dir>

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,12

--verbose

obs-img-utils-download command line option,10

obs-img-utils-packages-list command line option,11

obs-img-utils-packages-show command line option,11

--version

obs-img-utils command line option,9

A

abort_if_false()(in module obs_img_utils.cli),16 add_options()(in module obs_img_utils.cli),16 arch(obs_img_utils.api.package_type property),15 arch (obs_img_utils.utils.img_downloader_config prop-

erty),18

B

build_version(class in obs_img_utils.api),14

C

check_image_conditions()

(obs_img_utils.api.OBSImageUtil method), 14

check_invalid_packages()

(obs_img_utils.api.OBSImageUtil method), 14

check_license_conditions()

(obs_img_utils.api.OBSImageUtil method), 14

checksum(obs_img_utils.api.package_type property),15

checksum_extension(obs_img_utils.utils.img_downloader_config property),18

click_progress_callback() (in module obs_img_utils.utils),17

conditions_repl()(in module obs_img_utils.utils),17 conditions_wait_time

(obs_img_utils.utils.img_downloader_config property),18

config (obs_img_utils.utils.img_downloader_config property),18

D

download_url(obs_img_utils.utils.img_downloader_config property),18

DownloadMetadataFileExceptionOBS,16

E

echo_package()(in module obs_img_utils.utils),17 echo_packages()(in module obs_img_utils.utils),17 echo_style()(in module obs_img_utils.utils),17 extension (obs_img_utils.utils.img_downloader_config

property),18

F

fetch_index_list()(obs_img_utils.web_content.WebContent method),19

fetch_to_dir()(obs_img_utils.web_content.WebContent method),19

filter_packages_by_licenses() (in module obs_img_utils.utils),17

filter_packages_by_name() (in module obs_img_utils.utils),17

G

get_checksum_from_file() (in module obs_img_utils.utils),17

get_config()(in module obs_img_utils.utils),17

get_hash_from_image() (in module

(38)

get_image() (obs_img_utils.api.OBSImageUtil method),14

get_image_packages_metadata()

(obs_img_utils.api.OBSImageUtil method), 14

get_logger()(in module obs_img_utils.utils),17

H

handle_errors()(in module obs_img_utils.utils),17

I

image_name(obs_img_utils.utils.img_downloader_config property),18

img_downloader_config(class in obs_img_utils.utils), 17

K

kiwi_version (obs_img_utils.api.build_version prop- erty),15

L

license(obs_img_utils.api.package_type property),15 license_repl()(in module obs_img_utils.utils),18 log_level(obs_img_utils.utils.img_downloader_config

property),18

M

module

obs_img_utils,19 obs_img_utils.api,13 obs_img_utils.cli,16

obs_img_utils.exceptions,16 obs_img_utils.utils,17 obs_img_utils.web_content,19

N

name(obs_img_utils.api.package_type property),15 no_color (obs_img_utils.utils.img_downloader_config

property),18

O

obs_build (obs_img_utils.api.build_version property), 15

obs_img_utils module,19 obs_img_utils.api

module,13 obs_img_utils.cli

module,16

obs_img_utils.exceptions module,16

obs_img_utils.utils module,17

obs_img_utils.web_content module,19

obs-img-utils command line option --license,9

--version,9

obs-img-utils-download command line option -C,10

--add-conditions,9 --arch <arch>,10 --checksum-extension

<checksum_extension>,9 --conditions-wait-time

<conditions_wait_time>,9 --config <config>,10

--debug,10

--disallow-licenses,9 --disallow-packages,9

--download-url <download_url>,10 --extension <extension>,9

--image-name <image_name>,10 --no-color,10

--profile <profile>,10 --quiet,10

--target-dir <target_dir>,10 --verbose,10

obs-img-utils-packages-list command line option

-C,11

--arch <arch>,11 --config <config>,11 --debug,11

--download-url <download_url>,11 --filter-licenses,11

--filter-packages,11

--image-name <image_name>,11 --no-color,11

--profile <profile>,11 --quiet,11

--target-dir <target_dir>,11 --verbose,11

obs-img-utils-packages-show command line option

-C,11

--arch <arch>,12 --config <config>,11 --debug,11

--download-url <download_url>,12 --image-name <image_name>,12 --no-color,11

--package-name <package_name>,11 --profile <profile>,12

--quiet,12

--target-dir <target_dir>,12 --verbose,11

34 Index

(39)

OBSImageChecksumException,16 OBSImageConditionsException,16 OBSImageDownloadException,16

OBSImageUtil(class in obs_img_utils.api),13 OBSImageUtilsException,16

OBSImageVersionException,16

P

package_type(class in obs_img_utils.api),15 packages_repl()(in module obs_img_utils.utils),19 PackageVersionExceptionOBS,16

parse_packages_file()

(obs_img_utils.api.OBSImageUtil method), 14

parse_report_file()

(obs_img_utils.api.OBSImageUtil method), 14

print_license()(in module obs_img_utils.cli),16 process_shared_options() (in module

obs_img_utils.utils),19

profile (obs_img_utils.utils.img_downloader_config property),18

R

release(obs_img_utils.api.package_type property),15 retry()(in module obs_img_utils.utils),19

S

signature_extension

(obs_img_utils.utils.img_downloader_config property),18

style_string()(in module obs_img_utils.utils),19

T

target_dir(obs_img_utils.utils.img_downloader_config property),18

V

version(obs_img_utils.api.package_type property),15

W

wait_for_new_image()

(obs_img_utils.api.OBSImageUtil method), 14

WebContent(class in obs_img_utils.web_content),19

References

Related documents