From d540ba3a23d97d748efc421d927d53c75fc336c0 Mon Sep 17 00:00:00 2001 From: Lars Karlitski Date: Tue, 18 Sep 2018 16:48:46 +0200 Subject: [PATCH] Rename composer-cli to composer --- Makefile | 2 +- docs/composer-cli.rst | 30 +++++++++---------- docs/lorax-composer.rst | 8 ++--- .../{composer-cli => composer} | 14 ++++----- lorax.spec | 4 +-- setup.py | 2 +- src/bin/{composer-cli => composer} | 4 +-- src/composer/__init__.py | 2 +- src/composer/cli/__init__.py | 6 ++-- src/composer/cli/blueprints.py | 2 +- src/composer/cli/cmdline.py | 4 +-- src/composer/cli/compose.py | 4 +-- src/composer/cli/modules.py | 2 +- src/composer/cli/projects.py | 2 +- src/composer/cli/sources.py | 2 +- src/composer/cli/status.py | 2 +- src/composer/cli/utilities.py | 2 +- src/composer/http_client.py | 2 +- 18 files changed, 47 insertions(+), 47 deletions(-) rename etc/bash_completion.d/{composer-cli => composer} (93%) rename src/bin/{composer-cli => composer} (98%) diff --git a/Makefile b/Makefile index 2dd0f552..113793cb 100644 --- a/Makefile +++ b/Makefile @@ -26,7 +26,7 @@ install: all install -m 644 docs/man/lorax.1 $(DESTDIR)/$(mandir)/man1 install -m 644 docs/man/livemedia-creator.1 $(DESTDIR)/$(mandir)/man1 mkdir -p $(DESTDIR)/etc/bash_completion.d - install -m 644 etc/bash_completion.d/composer-cli $(DESTDIR)/etc/bash_completion.d + install -m 644 etc/bash_completion.d/composer $(DESTDIR)/etc/bash_completion.d check: @echo "*** Running pylint ***" diff --git a/docs/composer-cli.rst b/docs/composer-cli.rst index 366e01ad..549dac15 100644 --- a/docs/composer-cli.rst +++ b/docs/composer-cli.rst @@ -1,54 +1,54 @@ -composer-cli -============ +composer +======== :Authors: Brian C. Lane -``composer-cli`` is used to interact with the ``lorax-composer`` API server, managing blueprints, exploring available packages, and building new images. +``composer`` is used to interact with the ``lorax-composer`` API server, managing blueprints, exploring available packages, and building new images. It requires `lorax-composer `_ to be installed on the local system, and the user running it needs to be a member of the ``weldr`` group. They do not need to be root, but all of the `security precautions `_ apply. -composer-cli cmdline arguments ------------------------------- +composer cmdline arguments +-------------------------- .. argparse:: :ref: composer.cli.cmdline.composer_cli_parser - :prog: composer-cli + :prog: composer Edit a Blueprint ---------------- -Start out by listing the available blueprints using ``composer-cli blueprints -list``, pick one and save it to the local directory by running ``composer-cli +Start out by listing the available blueprints using ``composer blueprints +list``, pick one and save it to the local directory by running ``composer blueprints save http-server``. If there are no blueprints available you can copy one of the examples `from the test suite `_. Edit the file (it will be saved with a .toml extension) and change the description, add a package or module to it. Send it back to the server by -running ``composer-cli blueprints push http-server.toml``. You can verify that it was -saved by viewing the changelog - ``composer-cli blueprints changes http-server``. +running ``composer blueprints push http-server.toml``. You can verify that it was +saved by viewing the changelog - ``composer blueprints changes http-server``. Build an image ---------------- -Build a ``qcow2`` disk image from this blueprint by running ``composer-cli +Build a ``qcow2`` disk image from this blueprint by running ``composer compose start http-server qcow2``. It will print a UUID that you can use to keep track of the build. You can also cancel the build if needed. -The available types of images is displayed by ``composer-cli compose types``. +The available types of images is displayed by ``composer compose types``. Currently this consists of: ext4-filesystem, live-iso, partitioned-disk, qcow2, tar Monitor the build status ------------------------ -Monitor it using ``composer-cli compose status``, which will show the status of +Monitor it using ``composer compose status``, which will show the status of all the builds on the system. You can view the end of the anaconda build logs -once it is in the ``RUNNING`` state using ``composer-cli compose log UUID`` +once it is in the ``RUNNING`` state using ``composer compose log UUID`` where UUID is the UUID returned by the start command. Once the build is in the ``FINISHED`` state you can download the image. @@ -56,7 +56,7 @@ Once the build is in the ``FINISHED`` state you can download the image. Download the image ------------------ -Downloading the final image is done with ``composer-cli compose image UUID`` and it will +Downloading the final image is done with ``composer compose image UUID`` and it will save the qcow2 image as ``UUID-disk.qcow2`` which you can then use to boot a VM like this:: qemu-kvm --name test-image -m 1024 -hda ./UUID-disk.qcow2 diff --git a/docs/lorax-composer.rst b/docs/lorax-composer.rst index 5ca18d8f..2c0dd45d 100644 --- a/docs/lorax-composer.rst +++ b/docs/lorax-composer.rst @@ -17,13 +17,13 @@ Installation ------------ The best way to install ``lorax-composer`` is to use ``sudo dnf install -lorax-composer composer-cli``, this will setup the weldr user and install the +lorax-composer composer``, this will setup the weldr user and install the systemd socket activation service. You will then need to enable it with ``sudo systemctl enable lorax-composer.socket && sudo systemctl start lorax-composer.socket``. This will leave the server off until the first request is made. Systemd will then launch the server and it will remain running until the system is rebooted. This will cause some delay in responding to the first -request from the UI or `composer-cli`. +request from the UI or `composer`. .. note:: @@ -102,7 +102,7 @@ Composing Images The `welder-web `_ GUI project can be used to construct blueprints and create composes using a web browser. -Or use the command line with `composer-cli `_. +Or use the command line with `composer `_. Blueprints ---------- @@ -334,7 +334,7 @@ system repo files with a configuration file pointing to the DVD. * Remove all the cached repo files from ``/var/lib/lorax/composer/repos/`` * Restart the ``lorax-composer.service`` -* Check the output of ``composer-cli status show`` for any output specific depsolve errors. +* Check the output of ``composer status show`` for any output specific depsolve errors. For example, the DVD usually does not include ``grub2-efi-*-cdboot-*`` so the live-iso image type will not be available. diff --git a/etc/bash_completion.d/composer-cli b/etc/bash_completion.d/composer similarity index 93% rename from etc/bash_completion.d/composer-cli rename to etc/bash_completion.d/composer index 59f8a2fc..f3493b70 100644 --- a/etc/bash_completion.d/composer-cli +++ b/etc/bash_completion.d/composer @@ -1,4 +1,4 @@ -# bash completion for composer-cli +# bash completion for composer __composer_cli_flags="-h --help -j --json -s --socket --log -a --api --test -V" @@ -16,19 +16,19 @@ __composer_socket_ok() { } __composer_blueprints() { - __composer_socket_ok && composer-cli blueprints list + __composer_socket_ok && composer blueprints list } __composer_sources() { - __composer_socket_ok && composer-cli sources list + __composer_socket_ok && composer sources list } __composer_compose_types() { - __composer_socket_ok && composer-cli compose types + __composer_socket_ok && composer compose types } __composer_composes() { - __composer_socket_ok && composer-cli compose list $@ | while read id rest; do echo $id; done + __composer_socket_ok && composer compose list $@ | while read id rest; do echo $id; done } __word_in_list() { @@ -39,7 +39,7 @@ __word_in_list() { return 1 } -_composer_cli() { +_composer() { local cur="${COMP_WORDS[COMP_CWORD]}" prev="${COMP_WORDS[COMP_CWORD-1]}" local w="" wi=0 cmd="__NONE__" subcmd="__NONE__" cmd_cword=0 @@ -140,4 +140,4 @@ _composer_cli() { fi } -complete -F _composer_cli composer-cli +complete -F _composer composer diff --git a/lorax.spec b/lorax.spec index f4ef13f7..c3160f42 100644 --- a/lorax.spec +++ b/lorax.spec @@ -225,9 +225,9 @@ getent passwd weldr >/dev/null 2>&1 || useradd -r -g weldr -d / -s /sbin/nologin %attr(0771, weldr, weldr) %{_sharedstatedir}/lorax/composer/blueprints/* %files -n composer-cli -%{_bindir}/composer-cli +%{_bindir}/composer %{python3_sitelib}/composer/* -%{_sysconfdir}/bash_completion.d/composer-cli +%{_sysconfdir}/bash_completion.d/composer %changelog * Fri Sep 07 2018 Brian C. Lane 29.15-1 diff --git a/setup.py b/setup.py index 266c54d5..4b56edc0 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ data_files.append(("/usr/sbin", ["src/sbin/lorax", "src/sbin/mkefiboot", "src/sbin/livemedia-creator", "src/sbin/lorax-composer"])) data_files.append(("/usr/bin", ["src/bin/image-minimizer", "src/bin/mk-s390-cdboot", - "src/bin/composer-cli"])) + "src/bin/composer"])) # get the version sys.path.insert(0, "src") diff --git a/src/bin/composer-cli b/src/bin/composer similarity index 98% rename from src/bin/composer-cli rename to src/bin/composer index 65f90f10..2b46e949 100755 --- a/src/bin/composer-cli +++ b/src/bin/composer @@ -1,6 +1,6 @@ #!/usr/bin/python3 # -# composer-cli +# composer # # Copyright (C) 2018 Red Hat, Inc. # @@ -18,7 +18,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") import os import sys diff --git a/src/composer/__init__.py b/src/composer/__init__.py index a97b168f..ce1e65a8 100644 --- a/src/composer/__init__.py +++ b/src/composer/__init__.py @@ -1,6 +1,6 @@ #!/usr/bin/python # -# composer-cli +# composer # # Copyright (C) 2018 Red Hat, Inc. # diff --git a/src/composer/cli/__init__.py b/src/composer/cli/__init__.py index 7e399252..f585128a 100644 --- a/src/composer/cli/__init__.py +++ b/src/composer/cli/__init__.py @@ -1,5 +1,5 @@ # -# composer-cli +# composer # # Copyright (C) 2018 Red Hat, Inc. # @@ -17,7 +17,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") from composer.cli.blueprints import blueprints_cmd from composer.cli.modules import modules_cmd @@ -44,7 +44,7 @@ def main(opts): """ # Making sure opts.args is not empty (thus, has a command and subcommand) - # is already handled in src/bin/composer-cli. + # is already handled in src/bin/composer. if opts.args[0] not in command_map: log.error("Unknown command %s", opts.args[0]) return 1 diff --git a/src/composer/cli/blueprints.py b/src/composer/cli/blueprints.py index bc8030b4..5ec34b7e 100644 --- a/src/composer/cli/blueprints.py +++ b/src/composer/cli/blueprints.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") import os diff --git a/src/composer/cli/cmdline.py b/src/composer/cli/cmdline.py index f827e824..aa48f7fd 100644 --- a/src/composer/cli/cmdline.py +++ b/src/composer/cli/cmdline.py @@ -24,7 +24,7 @@ from composer.cli.help import epilog VERSION = "{0}-{1}".format(os.path.basename(sys.argv[0]), vernum) def composer_cli_parser(): - """ Return the ArgumentParser for composer-cli""" + """ Return the ArgumentParser for composer""" parser = argparse.ArgumentParser(description="Lorax Composer commandline tool", epilog=epilog, @@ -36,7 +36,7 @@ def composer_cli_parser(): parser.add_argument("-s", "--socket", default="/run/weldr/api.socket", metavar="SOCKET", help="Path to the socket file to listen on") parser.add_argument("--log", dest="logfile", default=None, metavar="LOG", - help="Path to logfile (./composer-cli.log)") + help="Path to logfile (./composer.log)") parser.add_argument("-a", "--api", dest="api_version", default="0", metavar="APIVER", help="API Version to use") parser.add_argument("--test", dest="testmode", default=0, type=int, metavar="TESTMODE", diff --git a/src/composer/cli/compose.py b/src/composer/cli/compose.py index e8d87303..d6f370e6 100644 --- a/src/composer/cli/compose.py +++ b/src/composer/cli/compose.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") from datetime import datetime import sys @@ -186,7 +186,7 @@ def compose_types(socket_path, api_version, args, show_json=False, testmode=0): :param testmode: unused in this function :type testmode: int - Add additional details to types that are known to composer-cli. Raw JSON output does not + Add additional details to types that are known to composer. Raw JSON output does not include this extra information. """ api_route = client.api_url(api_version, "/compose/types") diff --git a/src/composer/cli/modules.py b/src/composer/cli/modules.py index 0a775738..122c69d5 100644 --- a/src/composer/cli/modules.py +++ b/src/composer/cli/modules.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") from composer import http_client as client from composer.cli.help import modules_help diff --git a/src/composer/cli/projects.py b/src/composer/cli/projects.py index f2a5b683..76ee2e87 100644 --- a/src/composer/cli/projects.py +++ b/src/composer/cli/projects.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") import textwrap diff --git a/src/composer/cli/sources.py b/src/composer/cli/sources.py index 79e02e62..a8807ae2 100644 --- a/src/composer/cli/sources.py +++ b/src/composer/cli/sources.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") import os diff --git a/src/composer/cli/status.py b/src/composer/cli/status.py index 09afee93..2f363032 100644 --- a/src/composer/cli/status.py +++ b/src/composer/cli/status.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") from composer import http_client as client from composer.cli.help import status_help diff --git a/src/composer/cli/utilities.py b/src/composer/cli/utilities.py index 199ed095..92e46f7b 100644 --- a/src/composer/cli/utilities.py +++ b/src/composer/cli/utilities.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") import json diff --git a/src/composer/http_client.py b/src/composer/http_client.py index f64642f7..7f305b12 100644 --- a/src/composer/http_client.py +++ b/src/composer/http_client.py @@ -15,7 +15,7 @@ # along with this program. If not, see . # import logging -log = logging.getLogger("composer-cli") +log = logging.getLogger("composer") import os import sys