5e506bff2e
- If there are pre-install notes, prompt the user before proceeding. - Adds --yes and --no flags to bypass installation prompts non-interactively.
421 lines
11 KiB
Python
421 lines
11 KiB
Python
"""Install and manage DCOS software packages
|
|
|
|
Usage:
|
|
dcos package --config-schema
|
|
dcos package --info
|
|
dcos package describe [--app --options=<file> --cli] <package_name>
|
|
dcos package info
|
|
dcos package install [--cli | [--app --app-id=<app_id>]]
|
|
[--options=<file> --yes] <package_name>
|
|
dcos package list-installed [--endpoints --app-id=<app-id> <package_name>]
|
|
dcos package search [<query>]
|
|
dcos package sources
|
|
dcos package uninstall [--cli | [--app --app-id=<app-id> --all]]
|
|
<package_name>
|
|
dcos package update [--validate]
|
|
|
|
Options:
|
|
-h, --help Show this screen
|
|
--info Show a short description of this subcommand
|
|
--version Show version
|
|
--yes Assume "yes" is the answer to all prompts and run
|
|
non-interactively
|
|
--all Apply the operation to all matching packages
|
|
--app Apply the operation only to the package's application
|
|
--app-id=<app-id> The application id
|
|
--cli Apply the operation only to the package's CLI
|
|
--options=<file> Path to a JSON file containing package installation
|
|
options
|
|
--validate Validate package content when updating sources
|
|
|
|
Configuration:
|
|
[package]
|
|
# Path to the local package cache.
|
|
cache_dir = "/var/dcos/cache"
|
|
|
|
# List of package sources, in search order.
|
|
#
|
|
# Three protocols are supported:
|
|
# - Local file
|
|
# - HTTPS
|
|
# - Git
|
|
sources = [
|
|
"file:///Users/me/test-registry",
|
|
"https://my.org/registry",
|
|
"git://github.com/mesosphere/universe.git"
|
|
]
|
|
"""
|
|
import json
|
|
|
|
import dcoscli
|
|
import docopt
|
|
import pkg_resources
|
|
from dcos import cmds, emitting, marathon, options, package, subcommand, util
|
|
from dcos.errors import DCOSException
|
|
|
|
from six.moves import input as user_input
|
|
|
|
logger = util.get_logger(__name__)
|
|
|
|
emitter = emitting.FlatEmitter()
|
|
|
|
|
|
def main():
|
|
try:
|
|
return _main()
|
|
except DCOSException as e:
|
|
emitter.publish(e)
|
|
return 1
|
|
|
|
|
|
def _main():
|
|
util.configure_logger_from_environ()
|
|
|
|
args = docopt.docopt(
|
|
__doc__,
|
|
version='dcos-package version {}'.format(dcoscli.version))
|
|
|
|
return cmds.execute(_cmds(), args)
|
|
|
|
|
|
def _cmds():
|
|
"""
|
|
:returns: All of the supported commands
|
|
:rtype: dcos.cmds.Command
|
|
"""
|
|
|
|
return [
|
|
cmds.Command(
|
|
hierarchy=['package', 'sources'],
|
|
arg_keys=[],
|
|
function=_list_sources),
|
|
|
|
cmds.Command(
|
|
hierarchy=['package', 'update'],
|
|
arg_keys=['--validate'],
|
|
function=_update),
|
|
|
|
cmds.Command(
|
|
hierarchy=['package', 'describe'],
|
|
arg_keys=['<package_name>', '--cli', '--app', '--options'],
|
|
function=_describe),
|
|
|
|
cmds.Command(
|
|
hierarchy=['package', 'install'],
|
|
arg_keys=['<package_name>', '--options', '--app-id', '--cli',
|
|
'--app', '--yes'],
|
|
function=_install),
|
|
|
|
cmds.Command(
|
|
hierarchy=['package', 'list-installed'],
|
|
arg_keys=['--endpoints', '--app-id', '<package_name>'],
|
|
function=_list),
|
|
|
|
cmds.Command(
|
|
hierarchy=['package', 'search'],
|
|
arg_keys=['<query>'],
|
|
function=_search),
|
|
|
|
cmds.Command(
|
|
hierarchy=['package', 'uninstall'],
|
|
arg_keys=['<package_name>', '--all', '--app-id', '--cli', '--app'],
|
|
function=_uninstall),
|
|
|
|
cmds.Command(
|
|
hierarchy=['package'],
|
|
arg_keys=['--config-schema', '--info'],
|
|
function=_package),
|
|
]
|
|
|
|
|
|
def _package(config_schema, info):
|
|
"""
|
|
:param config_schema: Whether to output the config schema
|
|
:type config_schema: boolean
|
|
:param info: Whether to output a description of this subcommand
|
|
:type info: boolean
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
|
|
if config_schema:
|
|
schema = json.loads(
|
|
pkg_resources.resource_string(
|
|
'dcoscli',
|
|
'data/config-schema/package.json').decode('utf-8'))
|
|
emitter.publish(schema)
|
|
elif info:
|
|
_info()
|
|
else:
|
|
emitter.publish(options.make_generic_usage_message(__doc__))
|
|
return 1
|
|
|
|
return 0
|
|
|
|
|
|
def _info():
|
|
"""Print package cli information.
|
|
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
|
|
emitter.publish(__doc__.split('\n')[0])
|
|
return 0
|
|
|
|
|
|
def _list_sources():
|
|
"""List configured package sources.
|
|
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
|
|
config = util.get_config()
|
|
|
|
sources = package.list_sources(config)
|
|
|
|
for source in sources:
|
|
emitter.publish("{} {}".format(source.hash(), source.url))
|
|
|
|
return 0
|
|
|
|
|
|
def _update(validate):
|
|
"""Update local package definitions from sources.
|
|
|
|
:param validate: Whether to validate package content when updating sources.
|
|
:type validate: bool
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
|
|
config = util.get_config()
|
|
|
|
package.update_sources(config, validate)
|
|
|
|
return 0
|
|
|
|
|
|
def _describe(package_name, cli, app, options_path):
|
|
"""Describe the specified package.
|
|
|
|
:param package_name: The package to describe
|
|
:type package_name: str
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
|
|
config = util.get_config()
|
|
|
|
pkg = package.resolve_package(package_name, config)
|
|
|
|
if pkg is None:
|
|
raise DCOSException("Package [{}] not found".format(package_name))
|
|
|
|
# TODO(CD): Make package version to describe configurable
|
|
pkg_version = pkg.latest_version()
|
|
pkg_json = pkg.package_json(pkg_version)
|
|
version_map = pkg.software_versions()
|
|
versions = [version_map[pkg_ver] for pkg_ver in version_map]
|
|
|
|
del pkg_json['version']
|
|
pkg_json['versions'] = versions
|
|
|
|
if cli or app:
|
|
user_options = _user_options(options_path)
|
|
options = pkg.options(pkg_version, user_options)
|
|
|
|
if cli:
|
|
pkg_json['command'] = pkg.command_json(pkg_version, options)
|
|
if app:
|
|
pkg_json['app'] = pkg.marathon_json(pkg_version, options)
|
|
|
|
emitter.publish(pkg_json)
|
|
return 0
|
|
|
|
|
|
def _user_options(path):
|
|
if path is None:
|
|
return {}
|
|
else:
|
|
with open(path) as options_file:
|
|
return util.load_json(options_file)
|
|
|
|
|
|
def _confirm(prompt, yes):
|
|
"""
|
|
:param prompt: message to display to the terminal
|
|
:type prompt: str
|
|
:param yes: whether to assume that the user responded with yes
|
|
:type yes: bool
|
|
:returns: True if the user responded with yes; False otherwise
|
|
:rtype: bool
|
|
"""
|
|
|
|
if yes:
|
|
return True
|
|
else:
|
|
while True:
|
|
emitter.publish('{} [yes/no]'.format(prompt))
|
|
response = user_input().lower()
|
|
if response == 'yes' or response == 'y':
|
|
return True
|
|
elif response == 'no' or response == 'n':
|
|
return False
|
|
else:
|
|
emitter.publish(
|
|
"'{}' is not a valid response.".format(response))
|
|
|
|
|
|
def _install(package_name, options_path, app_id, cli, app, yes):
|
|
"""Install the specified package.
|
|
|
|
:param package_name: the package to install
|
|
:type package_name: str
|
|
:param options_path: path to file containing option values
|
|
:type options_path: str
|
|
:param app_id: app ID for installation of this package
|
|
:type app_id: str
|
|
:param cli: indicates if the cli should be installed
|
|
:type cli: bool
|
|
:param app: indicate if the application should be installed
|
|
:type app: bool
|
|
:param yes: automatically assume yes to all prompts
|
|
:type yes: bool
|
|
:returns: process status
|
|
:rtype: int
|
|
"""
|
|
|
|
if cli is False and app is False:
|
|
# Install both if neither flag is specified
|
|
cli = app = True
|
|
|
|
config = util.get_config()
|
|
|
|
pkg = package.resolve_package(package_name, config)
|
|
if pkg is None:
|
|
msg = "Package [{}] not found\n".format(package_name) + \
|
|
"You may need to run 'dcos package update' to update your " + \
|
|
"repositories"
|
|
raise DCOSException(msg)
|
|
|
|
# TODO(CD): Make package version to install configurable
|
|
pkg_version = pkg.latest_version()
|
|
|
|
pre_install_notes = pkg.package_json(pkg_version).get('preInstallNotes')
|
|
if pre_install_notes:
|
|
emitter.publish(pre_install_notes)
|
|
if not _confirm('Continue installing?', yes):
|
|
emitter.publish('Exiting installation.')
|
|
return 0
|
|
|
|
user_options = _user_options(options_path)
|
|
|
|
options = pkg.options(pkg_version, user_options)
|
|
|
|
if app:
|
|
# Install in Marathon
|
|
version_map = pkg.software_versions()
|
|
sw_version = version_map.get(pkg_version, '?')
|
|
|
|
message = 'Installing package [{}] version [{}]'.format(
|
|
pkg.name(), sw_version)
|
|
if app_id is not None:
|
|
message += ' with app id [{}]'.format(app_id)
|
|
|
|
emitter.publish(message)
|
|
|
|
init_client = marathon.create_client(config)
|
|
|
|
package.install_app(
|
|
pkg,
|
|
pkg_version,
|
|
init_client,
|
|
options,
|
|
app_id)
|
|
|
|
if cli and pkg.is_command_defined(pkg_version):
|
|
# Install subcommand
|
|
emitter.publish('Installing CLI subcommand for package [{}]'.format(
|
|
pkg.name()))
|
|
|
|
subcommand.install(pkg, pkg_version, options)
|
|
|
|
post_install_notes = pkg.package_json(pkg_version).get('postInstallNotes')
|
|
if post_install_notes:
|
|
emitter.publish(post_install_notes)
|
|
|
|
return 0
|
|
|
|
|
|
def _list(endpoints, app_id, package_name):
|
|
"""Show installed apps
|
|
|
|
:param endpoints: Whether to include a list of
|
|
endpoints as port-host pairs
|
|
:type endpoints: boolean
|
|
:param package_name: The package to show
|
|
:type package_name: str
|
|
:param app_id: App ID of app to show
|
|
:type app_id: str
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
|
|
config = util.get_config()
|
|
init_client = marathon.create_client(config)
|
|
installed = package.installed_packages(init_client, endpoints)
|
|
|
|
# only emit those packages that match the provided package_name or
|
|
# app_id
|
|
results = [
|
|
pkg.dict() for pkg in installed if not
|
|
((package_name and pkg.name() != package_name) or
|
|
(app_id and pkg.app and pkg.app['appId'] != app_id))
|
|
]
|
|
|
|
emitter.publish(results)
|
|
|
|
return 0
|
|
|
|
|
|
def _search(query):
|
|
"""Search for matching packages.
|
|
|
|
:param query: The search term
|
|
:type query: str
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
if not query:
|
|
query = ''
|
|
|
|
config = util.get_config()
|
|
results = package.search(query, config)
|
|
|
|
emitter.publish([r.as_dict() for r in results])
|
|
|
|
return 0
|
|
|
|
|
|
def _uninstall(package_name, remove_all, app_id, cli, app):
|
|
"""Uninstall the specified package.
|
|
|
|
:param package_name: The package to uninstall
|
|
:type package_name: str
|
|
:param remove_all: Whether to remove all instances of the named package
|
|
:type remove_all: boolean
|
|
:param app_id: App ID of the package instance to uninstall
|
|
:type app_id: str
|
|
:returns: Process status
|
|
:rtype: int
|
|
"""
|
|
|
|
err = package.uninstall(package_name, remove_all, app_id, cli, app)
|
|
if err is not None:
|
|
emitter.publish(err)
|
|
return 1
|
|
|
|
return 0
|