MAINHACK

Viewing / Editing File: cl_packages_arg_parse.py

File is not writable. Editing disabled.
# -*- coding: utf-8 -*-

# Command line arguments parser for cloudlinux-packages utility

# cloudlinux-packages Utility to control lvectl packages
#
# Copyright © Cloud Linux GmbH & Cloud Linux Software, Inc 2010-2019 All Rights Reserved
#
# Licensed under CLOUD LINUX LICENSE AGREEMENT
# http://cloudlinux.com/docs/LICENSE.TXT

from __future__ import absolute_import
from docopt import docopt
from docopt import DocoptExit
from schema import Schema, And, Or, Use, SchemaError


def parse_cloudlinux_packages_opts(argv, _is_json_need=False):
    """
    Parse arguments for cloudlinux-packages command
    :param argv: sys.argv
    :param _is_json_need: sys.argv contains --json key
    :return cortege: (error_flag, s_message)
    """
    # program name
    prog_name = "cloudlinux-packages"
    docstring = """Utility to get/set any Cloudlinux package limits

Usage:
   {0} [get] [--json] [--provider <str> | --for-reseller <str>] [--package <str>] [--limits=<keys>] [--human-readable-numbers]
   {0} set [--json] (--provider <str> --package <str>) [--speed <str> --pmem <str> --vmem <str> --nproc <str> --maxEntryProcs <str> --io <str> --iops <str> --inodes <N,M> --mysql-cpu <int> --mysql-io <int>]
   {0} set [--json] (--for-reseller <str> --package <str>) [--speed <str> --pmem <str> --vmem <str> --nproc <str> --maxEntryProcs <str> --io <str> --iops <str> --inodes <N,M>]
   {0} (-h | --help)

Options:
    --json                              Return data in JSON format.
    --provider <str>                    Show data only for specific reseller.
    --for-reseller <str>                Show data only for specific reseller.
    --package <str>                     Show data only for specific package. Use only with --provider
                                        WARNING: package name must be unicode-escaped string
    --limits <keys>                     Available keys: speed, nproc, pmem, vmem, maxEntryProcs, io,
                                                        iops, inodes
    --human-readable-numbers            Return PMEM and VMEM limits in KBytes, MBytes or GBytes
    --speed <str>                       Limit CPU usage for LVE.
    --pmem <str>                        Limit physical memory usage for applications inside LVE.
    --vmem <str>                        Limit virtual memory for applications inside LVE.
    --nproc <str>                       Limit number of processes for LVE.
    --maxEntryProcs <str>               Limit number of entry processes for LVE.
    --io <str>                          Define io limits for LVE (KB/s).
    --iops <str>                        Limit io per second for LVE.
    --inodes <N,M>                      Set inode limits. N - soft, M - hard.
    --mysql-cpu <int>                   Set MySQL governor CPU limit (pct).
    --mysql-io <int>                    Set MySQL governor IO limit (read + write MB/s)
    -h, --help                          Show this help message and exit
""".format(prog_name)
    try:
        args = docopt(docstring, argv)
    except DocoptExit:
        s_error_string = 'ERROR: Invalid parameter passed'
        if not _is_json_need:
            s_error_string += "\n\n" + docstring
        return False, s_error_string
    # get mode by default
    if not args["get"] and not args["set"]:
        args["get"] = True
    if args['--for-reseller']:
        # --for-reseller option found, convert it to --provider
        args['--provider'] = args['--for-reseller']

    s = Schema({
        "get": bool,
        "set": bool,
        "--json": And(bool, lambda x: x, error="use --json option, other modes currently unsupported"),
        "--provider": Or(None, str),
        "--for-reseller": Or(None, str),
        "--package": Or(None, str),
        "--limits": Or(None, _limits_keys_validate, error="Invalid keys"),
        "--speed": Or(None, str),
        "--pmem": Or(None, str),
        "--vmem": Or(None, str),
        "--nproc": Or(None, str),
        "--maxEntryProcs": Or(None, str),
        "--io": Or(None, str),
        "--iops": Or(None, str),
        "--inodes": Or(None, str),
        "--help": bool,
        "--human-readable-numbers": bool,
        "--mysql-cpu": Or(None, And(Use(int), lambda x: x >= 0),
                          error="--mysql-cpu must be non-negative integer value"),
        "--mysql-io": Or(None, And(Use(int), lambda x: x >= 0),
                         error="--mysql-io must be non-negative integer value"),
    })

    try:
        args = s.validate(args)
        status = True
    except SchemaError as e:
        args = str(e)
        status = False
    return status, args


_AVAILABLE_KEYS_LIST = ["speed", "nproc", "pmem", "vmem", "maxEntryProcs", "io", "iops", "inodes",
                        "mysql-cpu", "mysql-io"]


def _limits_keys_validate(keys):
    """
    Validate limits keys
    """
    return len(set(keys.split(",")) - set(_AVAILABLE_KEYS_LIST)) == 0
Cancel / Back
[ MAINHACK ]

Viewing / Editing File: cl_packages_arg_parse.py

Server Info

System Features

User Info
