%PDF-
%PDF-
Mini Shell
Mini Shell
# coding:utf-8
# 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, Use, Or, SchemaError
from .utils import VALUES_STR
ADMIN_ONLY_OPTIONS = ["--mysql-restrict", "--mysql-unrestrict-all", "--mysql-gov", "--mysql-io",
"--mysql-cpu", "--cagefs", "--inodes"]
def are_options_compatible_with_admins(argv):
"""
Checks options compatibility with admin options
:return: Cortege (flag, message)
flag: True/False - compatible/not compatible
message - comment if flag is False
"""
for_reseller_found = False
admin_option_name = None
for arg in argv:
if arg.startswith('--for-reseller'):
for_reseller_found = True
if not admin_option_name:
for admin_option in ADMIN_ONLY_OPTIONS:
if arg.startswith(admin_option):
admin_option_name = admin_option
if for_reseller_found and admin_option_name:
return False, "ERROR: option '%s' is not compatible with '--for-reseller'" % admin_option_name
return True, None
def parse_cloudlinux_limits_opts(argv, _is_json_need=False):
"""
Parse arguments for cloudlinux-limits 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-limits"
is_opt_compatible, message = are_options_compatible_with_admins(argv)
if not is_opt_compatible:
return False, message
docstring = """Utility to get/set any Cloudlinux limits
Usage:
{0} set [--json] (--lve-id <int> | --username <str>) (--unlimited) [--for-reseller <str>]
{0} set [--json] (--lve-id <int> | --username <str> | --reseller-name <str>) (--default <str>)
{0} set [--json] (--lve-id <int> | --username <str>) (--mysql-gov <ignored,watched> | --cagefs <enabled,disabled> | --mysql-restrict <restricted,unrestricted>)
{0} set [--json] (--mysql-unrestrict-all)
{0} set [--json] (--lve-id <int> | --username <str>) [--speed <str> --io <str> --nproc <str> --pmem <str> --vmem <str> --iops <str> --inodes <N,M> --maxEntryProcs <str> --mysql-cpu <int> --mysql-io <int> --save-all-parameters]
{0} set [--json] (--lve-id <int> | --username <str> | --reseller-name <str>) [--speed <str> --io <str> --nproc <str> --pmem <str> --vmem <str> --iops <str> --maxEntryProcs <str>] [--default <str>] [--for-reseller <str>]
{0} set [--json] (--reseller-name <str>) (--unlimited)
{0} [get] [--json] [--lve-id <int> | --username <str> | --reseller-name <str> | --domain <str>] [--limits=<keys>] [--human-readable-numbers] [--for-reseller <str>]
{0} disable-reseller-limits (--reseller-id <int> | --reseller-name <str>) [--json]
{0} enable-reseller-limits ((--reseller-id <int> | --reseller-name <str>) | --all) [--json]
{0} (-h | --help)
Options:
--json Return data in JSON format.
--lve-id <int> LVE id. will display record only for that LVE id.
--username <str> Execute command only for specific user.
--reseller-name <str> Execute command only for specific reseller.
--reseller-id <int> Execute command only for specific reseller.
--all Execute command for all resellers
--for-reseller <str> Use supplied reseller for get/set data.
--domain <str> Show data only for specific domain
--limits <keys> Available keys: speed,nproc,pmem,vmem,maxEntryProcs,io,
iops,mysql-gov,mysql-cpu,mysql-io,cagefs,inodes
--human-readable-numbers Return PMEM and VMEM limits in KBytes, MBytes or GBytes
--unlimited Set all limits to unlimited.
--default [limits] Reset limits to the Package defaults. List of comma-separated limits to reset them to default or "all"
--mysql-gov <ignored|watched> Monitor or ignore by MySQL governor.
--cagefs <enabled|disabled> Enable or disable CageFS for a user.
--mysql-restrict <[un]restricted> Set user restrict status with dbctl (restricted or unrestricted).
--mysql-unrestrict-all Unrestrict all restricted users with dbctl.
--speed <str> Limit CPU usage for LVE | LVP.
--pmem <str> Limit physical memory usage for applications inside LVE | LVP.
--vmem <str> Limit virtual memory for applications inside LVE.
--nproc <str> Limit number of processes for LVE | LVP.
--io <str> Define io limits for LVE | LVP (KB/s).
--iops <str> Limit io per second for LVE | LVP.
--maxEntryProcs <str> Limit number of entry processes for LVE | LVP.
--mysql-cpu <int> Set MySQL governor CPU limit (pct).
--mysql-io <int> Set MySQL governor IO limit (read + write MB/s)
--inodes <N,M> Set inode limits. N - soft, M - hard.
--save-all-parameters Save all parameters even if they match with defaults settings.
-h, --help Show this help message and exit
""".format(prog_name)
# add this parameters to docstring when need add read/write/cpu full edit mode
# this line for Usage block
# {0} set [--json] (--lve-id <int> | --username <str>) [--speed <int> --io <int> --nproc <int> --pmem <int> --vmem <int> --iops <int> --inodes <N,M> --maxEntryProcs <int> --mysql-cpu <int:int,int,int,int> --mysql-read <int:int,int,int,int> --mysql-write <int:int,int,int,int> --mysql-io <int:int,int,int,int> --save-all-parameters]
# this lines for Options block
# --mysql-cpu <int:int,int,int,int> Set MySQL governor CPU limit (pct).
# --mysql-io <int:int,int,int,int> Set MySQL governor IO limit (read + write KB/s)
# --mysql-read <int:int,int,int,int> Set MySQL governor read limit (KB/s)
# --mysql-write <int:int,int,int,int> Set MySQL governor write limit (KB/s)
try:
args = docopt(docstring, argv)
except DocoptExit:
s_error_string = 'ERROR: Invalid parameter passed or required parameter is missing'
if not _is_json_need:
s_error_string += "\n\n" + docstring
return False, s_error_string
# cloudlinux-limits set/get --json --reseller-name=reseller --for-reseller=reseller -- ERROR
if args['--reseller-name'] and args["--for-reseller"]:
return False, 'ERROR: --reseller-name and --for-reseller cannot be use together'
if (not args["get"] and not args["set"] and
not args["disable-reseller-limits"] and
not args["enable-reseller-limits"]):
args["get"] = True
# uncomment this for add full edit mode
# gov_int_list = And(Use(lambda x:x.split(",")), lambda x:len(x) == 4,
# Use(lambda x:map(int, x)))
s = Schema({
"set": bool,
"get": bool,
"disable-reseller-limits": bool,
"enable-reseller-limits": bool,
"--json": And(bool, lambda x: x, error="use --json option, other modes currently unsupported"),
"--human-readable-numbers": bool,
"--unlimited": bool,
"--default": Or(None, And(Use(lambda x: x.split(',')), _default_keys_validate), error="Invalid keys"),
"--save-all-parameters": bool,
"--lve-id": Or(None, And(Use(int), lambda x: int(x) >= 0),
And(Use(lambda x: str(x).lower()),
lambda x: x == "default"),
error="--lve-id must be non-negative integer value or 'default'"),
"--reseller-id": Or(None, And(Use(int), lambda x: int(x) >= 0),
error="--reseller-id must be non-negative integer value"),
"--reseller-name": Or(None, And(str, lambda x: not x.isdigit()), error="Invalid reseller name"),
"--all": bool,
"--for-reseller": Or(None, And(str, lambda x: not x.isdigit()), error="Invalid reseller name"),
"--username": Or(None, str),
"--domain": Or(None, str),
"--limits": Or(None, _limits_keys_validate, error="Invalid keys"),
"--mysql-gov": Or(None, lambda x: x in ["ignored", "watched"],
error='{}{}'.format(VALUES_STR, ": 'ignored', 'watched'")),
"--cagefs": Or(None, lambda x: x in ["enabled", "disabled"],
error='{}{}'.format(VALUES_STR, ": 'enabled', 'disabled'")),
"--mysql-restrict": Or(None, lambda x: x in ["restricted", "unrestricted"],
error='{}{}'.format(VALUES_STR, ": 'restricted', 'unrestricted'")),
"--mysql-unrestrict-all": bool,
"--speed": Or(None, str),
"--pmem": Or(None, str),
"--vmem": Or(None, str),
"--nproc": Or(None, str),
"--io": Or(None, str),
"--iops": Or(None, str),
"--maxEntryProcs": Or(None, str),
"--mysql-cpu": Or(None, And(Use(int), lambda x: x >= 0),
error="--mysql-cpu must be non-negative integer value"),
# uncomment this for add full edit mode
# "--mysql-io": Or(None, And(Use(int), lambda x:x >= 0), gov_int_list,
"--mysql-io": Or(None, And(Use(int), lambda x: x >= 0),
error="--mysql-io must be non-negative integer value"),
# uncomment this for add full edit mode
# "--mysql-read": Or(None, And(Use(int), lambda x:x >= 0), gov_int_list,
# error="--mysql-read must be non-negative integer value or 4 int numbers with comma"),
# "--mysql-write": Or(None, And(Use(int), lambda x:x >= 0), gov_int_list,
# error="--mysql-write must be non-negative integer value or 4 int numbers with comma"),
"--inodes": Or(None, str),
"--help": bool,
})
try:
args = s.validate(args)
status = True
except SchemaError as e:
args = str(e)
status = False
return status, args
AVAILABLE_LVE_KEYS = {"speed", "nproc", "pmem", "vmem", "maxEntryProcs", "io", "iops"}
AVAILABLE_LVP_KEYS = {"speed", "nproc", "pmem", "maxEntryProcs", "io", "iops"}
AVAILABLE_QUOTA_KEYS = {"inodes"}
AVAILABLE_MYSQL_KEYS = {"mysql-cpu", "mysql-io"}
AVAILABLE_KEYS = AVAILABLE_LVE_KEYS | AVAILABLE_QUOTA_KEYS | AVAILABLE_MYSQL_KEYS | AVAILABLE_LVP_KEYS
AVAILABLE_DEFAULTS = AVAILABLE_KEYS | {"all"}
AVAILABLE_LIMITS = AVAILABLE_KEYS | {"mysql-gov", "mysql-restrict", "cagefs"}
AVAILABLE_MYSQL_KEYS_ALL = AVAILABLE_MYSQL_KEYS | {"mysql-restrict", "mysql-unrestrict-all", "mysql-gov"}
def _default_keys_validate(keys):
"""
Validate limits keys for --default
"""
return len(set(keys) - AVAILABLE_DEFAULTS) == 0
def _limits_keys_validate(keys):
"""
Validate limits keys
"""
return len(set(keys.split(",")) - set(AVAILABLE_LIMITS)) == 0
Zerion Mini Shell 1.0