desc
stringlengths
3
26.7k
decl
stringlengths
11
7.89k
bodies
stringlengths
8
553k
'role_ref property setter'
@role_ref.setter def role_ref(self, data):
self._role_ref = data
'group_names property'
@property def group_names(self):
if (self._group_names is None): self._group_names = self.get_group_names() return self._group_names
'group_names property setter'
@group_names.setter def group_names(self, data):
self._group_names = data
'user_names property'
@property def user_names(self):
if (self._user_names is None): self._user_names = self.get_user_names() return self._user_names
'user_names property setter'
@user_names.setter def user_names(self, data):
self._user_names = data
'return groupNames'
def get_group_names(self):
return (self.get(RoleBinding.group_names_path) or [])
'return usernames'
def get_user_names(self):
return (self.get(RoleBinding.user_names_path) or [])
'return role_ref'
def get_role_ref(self):
return (self.get(RoleBinding.role_ref_path) or {})
'return subjects'
def get_subjects(self):
return (self.get(RoleBinding.subjects_path) or [])
'add a subject'
def add_subject(self, inc_subject):
if self.subjects: self.subjects.append(inc_subject) else: self.put(RoleBinding.subjects_path, [inc_subject]) return True
'add a role_ref'
def add_role_ref(self, inc_role_ref):
if (not self.role_ref): self.put(RoleBinding.role_ref_path, {'name': inc_role_ref}) return True return False
'add a group_names'
def add_group_names(self, inc_group_names):
if self.group_names: self.group_names.append(inc_group_names) else: self.put(RoleBinding.group_names_path, [inc_group_names]) return True
'add a username'
def add_user_name(self, inc_user_name):
if self.user_names: self.user_names.append(inc_user_name) else: self.put(RoleBinding.user_names_path, [inc_user_name]) return True
'remove a subject'
def remove_subject(self, inc_subject):
try: self.subjects.remove(inc_subject) except ValueError as _: return False return True
'remove a role_ref'
def remove_role_ref(self, inc_role_ref):
if (self.role_ref and (self.role_ref['name'] == inc_role_ref)): del self.role_ref['name'] return True return False
'remove a groupname'
def remove_group_name(self, inc_group_name):
try: self.group_names.remove(inc_group_name) except ValueError as _: return False return True
'remove a username'
def remove_user_name(self, inc_user_name):
try: self.user_names.remove(inc_user_name) except ValueError as _: return False return True
'update a subject'
def update_subject(self, inc_subject):
try: index = self.subjects.index(inc_subject) except ValueError as _: return self.add_subject(inc_subject) self.subjects[index] = inc_subject return True
'update a groupname'
def update_group_name(self, inc_group_name):
try: index = self.group_names.index(inc_group_name) except ValueError as _: return self.add_group_names(inc_group_name) self.group_names[index] = inc_group_name return True
'update a username'
def update_user_name(self, inc_user_name):
try: index = self.user_names.index(inc_user_name) except ValueError as _: return self.add_user_name(inc_user_name) self.user_names[index] = inc_user_name return True
'update a role_ref'
def update_role_ref(self, inc_role_ref):
self.role_ref['name'] = inc_role_ref return True
'find a subject'
def find_subject(self, inc_subject):
index = None try: index = self.subjects.index(inc_subject) except ValueError as _: return index return index
'find a group_name'
def find_group_name(self, inc_group_name):
index = None try: index = self.group_names.index(inc_group_name) except ValueError as _: return index return index
'find a user_name'
def find_user_name(self, inc_user_name):
index = None try: index = self.user_names.index(inc_user_name) except ValueError as _: return index return index
'find a user_name'
def find_role_ref(self, inc_role_ref):
if (self.role_ref and (self.role_ref['name'] == inc_role_ref['name'])): return self.role_ref return None
'constructor for handling scc options'
def __init__(self, sname, kubeconfig, options=None, fs_group='MustRunAs', default_add_capabilities=None, groups=None, priority=None, required_drop_capabilities=None, run_as_user='MustRunAsRange', se_linux_context='MustRunAs', supplemental_groups='RunAsAny', users=None, annotations=None):
self.kubeconfig = kubeconfig self.name = sname self.options = options self.fs_group = fs_group self.default_add_capabilities = default_add_capabilities self.groups = groups self.priority = priority self.required_drop_capabilities = required_drop_capabilities self.run_as_user = run_as...
'assign the correct properties for a scc dict'
def create_dict(self):
if self.options: for (key, value) in self.options.items(): self.data[key] = value else: self.data['allowHostDirVolumePlugin'] = False self.data['allowHostIPC'] = False self.data['allowHostNetwork'] = False self.data['allowHostPID'] = False self.data['a...
'SecurityContextConstraints constructor'
def __init__(self, content):
super(SecurityContextConstraints, self).__init__(content=content) self._users = None self._groups = None
'users property getter'
@property def users(self):
if (self._users is None): self._users = self.get_users() return self._users
'groups property getter'
@property def groups(self):
if (self._groups is None): self._groups = self.get_groups() return self._groups
'users property setter'
@users.setter def users(self, data):
self._users = data
'groups property setter'
@groups.setter def groups(self, data):
self._groups = data
'get scc users'
def get_users(self):
return (self.get(SecurityContextConstraints.users_path) or [])
'get scc groups'
def get_groups(self):
return (self.get(SecurityContextConstraints.groups_path) or [])
'add a user'
def add_user(self, inc_user):
if self.users: self.users.append(inc_user) else: self.put(SecurityContextConstraints.users_path, [inc_user]) return True
'add a group'
def add_group(self, inc_group):
if self.groups: self.groups.append(inc_group) else: self.put(SecurityContextConstraints.groups_path, [inc_group]) return True
'remove a user'
def remove_user(self, inc_user):
try: self.users.remove(inc_user) except ValueError as _: return False return True
'remove a group'
def remove_group(self, inc_group):
try: self.groups.remove(inc_group) except ValueError as _: return False return True
'update a user'
def update_user(self, inc_user):
try: index = self.users.index(inc_user) except ValueError as _: return self.add_user(inc_user) self.users[index] = inc_user return True
'update a group'
def update_group(self, inc_group):
try: index = self.groups.index(inc_group) except ValueError as _: return self.add_group(inc_group) self.groups[index] = inc_group return True
'find a user'
def find_user(self, inc_user):
index = None try: index = self.users.index(inc_user) except ValueError as _: return index return index
'find a group'
def find_group(self, inc_group):
index = None try: index = self.groups.index(inc_group) except ValueError as _: return index return index
'return the kind we are working with'
def get_kind(self):
if (self.config_options['resource_kind']['value'] == 'role'): return 'rolebinding' elif (self.config_options['resource_kind']['value'] == 'cluster-role'): return 'clusterrolebinding' elif (self.config_options['resource_kind']['value'] == 'scc'): return 'scc' return None
'Constructor for PolicyUser'
def __init__(self, config, verbose=False):
super(PolicyUser, self).__init__(config.namespace, config.kubeconfig, verbose) self.config = config self.verbose = verbose self._rolebinding = None self._scc = None self._cluster_role_bindings = None self._role_bindings = None
'role_binding property'
@property def role_binding(self):
return self._rolebinding
'setter for role_binding property'
@role_binding.setter def role_binding(self, binding):
self._rolebinding = binding
'security_context_constraint property'
@property def security_context_constraint(self):
return self._scc
'setter for security_context_constraint property'
@security_context_constraint.setter def security_context_constraint(self, scc):
self._scc = scc
'fetch the desired kind This is only used for scc objects. The {cluster}rolebindings happen in exists.'
def get(self):
resource_name = self.config.config_options['name']['value'] if (resource_name == 'cluster-reader'): resource_name += 's' return self._get(self.config.kind, resource_name)
'return whether role_binding exists'
def exists_role_binding(self):
bindings = None if (self.config.config_options['resource_kind']['value'] == 'cluster-role'): bindings = self.clusterrolebindings else: bindings = self.rolebindings if (bindings is None): return False for binding in bindings: if ((binding['roleRef']['name'] == self.con...
'return whether scc exists'
def exists_scc(self):
results = self.get() if (results['returncode'] == 0): self.security_context_constraint = SecurityContextConstraints(results['results'][0]) if (self.security_context_constraint.find_user(self.config.config_options['user']['value']) != None): return True return False return...
'does the object exist?'
def exists(self):
if (self.config.config_options['resource_kind']['value'] == 'cluster-role'): return self.exists_role_binding() elif (self.config.config_options['resource_kind']['value'] == 'role'): return self.exists_role_binding() elif (self.config.config_options['resource_kind']['value'] == 'scc'): ...
'perform action on resource'
def perform(self):
cmd = ['policy', self.config.config_options['action']['value'], self.config.config_options['name']['value'], self.config.config_options['user']['value']] return self.openshift_cmd(cmd, oadm=True)
'run the idempotent ansible code'
@staticmethod def run_ansible(params, check_mode):
state = params['state'] action = None if (state == 'present'): action = (('add-' + params['resource_kind']) + '-to-user') else: action = (('remove-' + params['resource_kind']) + '-from-user') nconfig = PolicyUserConfig(params['namespace'], params['kubeconfig'], {'action': {'value': a...
'getter method for separator'
@property def separator(self):
return self._separator
'setter method for separator'
@separator.setter def separator(self, inc_sep):
self._separator = inc_sep
'getter method for yaml_dict'
@property def yaml_dict(self):
return self.__yaml_dict
'setter method for yaml_dict'
@yaml_dict.setter def yaml_dict(self, value):
self.__yaml_dict = value
'parse the key allowing the appropriate separator'
@staticmethod def parse_key(key, sep='.'):
common_separators = list((Yedit.com_sep - set([sep]))) return re.findall(Yedit.re_key.format(''.join(common_separators)), key)
'validate the incoming key'
@staticmethod def valid_key(key, sep='.'):
common_separators = list((Yedit.com_sep - set([sep]))) if (not re.match(Yedit.re_valid_key.format(''.join(common_separators)), key)): return False return True
'remove data at location key'
@staticmethod def remove_entry(data, key, sep='.'):
if ((key == '') and isinstance(data, dict)): data.clear() return True elif ((key == '') and isinstance(data, list)): del data[:] return True if ((not (key and Yedit.valid_key(key, sep))) and isinstance(data, (list, dict))): return None key_indexes = Yedit.parse_ke...
'Get an item from a dictionary with key notation a.b.c d = {\'a\': {\'b\': \'c\'}}} key = a#b return c'
@staticmethod def add_entry(data, key, item=None, sep='.'):
if (key == ''): pass elif ((not (key and Yedit.valid_key(key, sep))) and isinstance(data, (list, dict))): return None key_indexes = Yedit.parse_key(key, sep) for (arr_ind, dict_key) in key_indexes[:(-1)]: if dict_key: if (isinstance(data, dict) and (dict_key in data) ...
'Get an item from a dictionary with key notation a.b.c d = {\'a\': {\'b\': \'c\'}}} key = a.b return c'
@staticmethod def get_entry(data, key, sep='.'):
if (key == ''): pass elif ((not (key and Yedit.valid_key(key, sep))) and isinstance(data, (list, dict))): return None key_indexes = Yedit.parse_key(key, sep) for (arr_ind, dict_key) in key_indexes: if (dict_key and isinstance(data, dict)): data = data.get(dict_key) ...
'Actually write the file contents to disk. This helps with mocking.'
@staticmethod def _write(filename, contents):
tmp_filename = (filename + '.yedit') with open(tmp_filename, 'w') as yfd: yfd.write(contents) os.rename(tmp_filename, filename)
'write to file'
def write(self):
if (not self.filename): raise YeditException('Please specify a filename.') if (self.backup and self.file_exists()): shutil.copy(self.filename, (self.filename + '.orig')) try: self.yaml_dict.fa.set_block_style() except AttributeError: pass try: Yedit._...
'read from file'
def read(self):
if ((self.filename is None) or (not self.file_exists())): return None contents = None with open(self.filename) as yfd: contents = yfd.read() return contents
'return whether file exists'
def file_exists(self):
if os.path.exists(self.filename): return True return False
'return yaml file'
def load(self, content_type='yaml'):
contents = self.read() if ((not contents) and (not self.content)): return None if self.content: if isinstance(self.content, dict): self.yaml_dict = self.content return self.yaml_dict elif isinstance(self.content, str): contents = self.content t...
'get a specified key'
def get(self, key):
try: entry = Yedit.get_entry(self.yaml_dict, key, self.separator) except KeyError: entry = None return entry
'remove a key, value pair from a dict or an item for a list'
def pop(self, path, key_or_item):
try: entry = Yedit.get_entry(self.yaml_dict, path, self.separator) except KeyError: entry = None if (entry is None): return (False, self.yaml_dict) if isinstance(entry, dict): if (key_or_item in entry): entry.pop(key_or_item) return (True, self.yam...
'remove path from a dict'
def delete(self, path):
try: entry = Yedit.get_entry(self.yaml_dict, path, self.separator) except KeyError: entry = None if (entry is None): return (False, self.yaml_dict) result = Yedit.remove_entry(self.yaml_dict, path, self.separator) if (not result): return (False, self.yaml_dict) re...
'check if value exists at path'
def exists(self, path, value):
try: entry = Yedit.get_entry(self.yaml_dict, path, self.separator) except KeyError: entry = None if isinstance(entry, list): if (value in entry): return True return False elif isinstance(entry, dict): if isinstance(value, dict): rval = Fals...
'append value to a list'
def append(self, path, value):
try: entry = Yedit.get_entry(self.yaml_dict, path, self.separator) except KeyError: entry = None if (entry is None): self.put(path, []) entry = Yedit.get_entry(self.yaml_dict, path, self.separator) if (not isinstance(entry, list)): return (False, self.yaml_dict) ...
'put path, value into a dict'
def update(self, path, value, index=None, curr_value=None):
try: entry = Yedit.get_entry(self.yaml_dict, path, self.separator) except KeyError: entry = None if isinstance(entry, dict): if (not isinstance(value, dict)): raise YeditException(('Cannot replace key, value entry in dict with non-dict type. ...
'put path, value into a dict'
def put(self, path, value):
try: entry = Yedit.get_entry(self.yaml_dict, path, self.separator) except KeyError: entry = None if (entry == value): return (False, self.yaml_dict) try: tmp_copy = yaml.load(yaml.round_trip_dump(self.yaml_dict, default_flow_style=False), yaml.RoundTripLoader) except ...
'create a yaml file'
def create(self, path, value):
if (not self.file_exists()): try: tmp_copy = yaml.load(yaml.round_trip_dump(self.yaml_dict, default_flow_style=False), yaml.RoundTripLoader) except AttributeError: tmp_copy = copy.deepcopy(self.yaml_dict) try: tmp_copy.fa.set_block_style() except A...
'return the current value'
@staticmethod def get_curr_value(invalue, val_type):
if (invalue is None): return None curr_value = invalue if (val_type == 'yaml'): curr_value = yaml.load(invalue) elif (val_type == 'json'): curr_value = json.loads(invalue) return curr_value
'determine value type passed'
@staticmethod def parse_value(inc_value, vtype=''):
true_bools = ['y', 'Y', 'yes', 'Yes', 'YES', 'true', 'True', 'TRUE', 'on', 'On', 'ON'] false_bools = ['n', 'N', 'no', 'No', 'NO', 'false', 'False', 'FALSE', 'off', 'Off', 'OFF'] if (isinstance(inc_value, str) and ('bool' in vtype)): if ((inc_value not in true_bools) and (inc_value not in false_bools...
'run through a list of edits and process them one-by-one'
@staticmethod def process_edits(edits, yamlfile):
results = [] for edit in edits: value = Yedit.parse_value(edit['value'], edit.get('value_type', '')) if (edit.get('action') == 'update'): curr_value = Yedit.get_curr_value(Yedit.parse_value(edit.get('curr_value')), edit.get('curr_value_format')) rval = yamlfile.update(edi...
'perform the idempotent crud operations'
@staticmethod def run_ansible(params):
yamlfile = Yedit(filename=params['src'], backup=params['backup'], separator=params['separator']) state = params['state'] if params['src']: rval = yamlfile.load() if ((yamlfile.yaml_dict is None) and (state != 'present')): return {'failed': True, 'msg': ('Error opening file ...
'Constructor for OpenshiftCLI'
def __init__(self, namespace, kubeconfig='/etc/origin/master/admin.kubeconfig', verbose=False, all_namespaces=False):
self.namespace = namespace self.verbose = verbose self.kubeconfig = Utils.create_tmpfile_copy(kubeconfig) self.all_namespaces = all_namespaces self.oc_binary = locate_oc_binary()
'replace the current object with the content'
def _replace_content(self, resource, rname, content, force=False, sep='.'):
res = self._get(resource, rname) if (not res['results']): return res fname = Utils.create_tmpfile((rname + '-')) yed = Yedit(fname, res['results'][0], separator=sep) changes = [] for (key, value) in content.items(): changes.append(yed.put(key, value)) if any([change[0] for ch...
'replace the current object with oc replace'
def _replace(self, fname, force=False):
yed = Yedit(fname) results = yed.delete('metadata.resourceVersion') if results[0]: yed.write() cmd = ['replace', '-f', fname] if force: cmd.append('--force') return self.openshift_cmd(cmd)
'create a temporary file and then call oc create on it'
def _create_from_content(self, rname, content):
fname = Utils.create_tmpfile((rname + '-')) yed = Yedit(fname, content=content) yed.write() atexit.register(Utils.cleanup, [fname]) return self._create(fname)
'call oc create on a filename'
def _create(self, fname):
return self.openshift_cmd(['create', '-f', fname])
'call oc delete on a resource'
def _delete(self, resource, name=None, selector=None):
cmd = ['delete', resource] if (selector is not None): cmd.append('--selector={}'.format(selector)) elif (name is not None): cmd.append(name) else: raise OpenShiftCLIError('Either name or selector is required when calling delete.') return self.openshift...
'process a template template_name: the name of the template to process create: whether to send to oc create after processing params: the parameters for the template template_data: the incoming template\'s data; instead of a file'
def _process(self, template_name, create=False, params=None, template_data=None):
cmd = ['process'] if template_data: cmd.extend(['-f', '-']) else: cmd.append(template_name) if params: param_str = ['{}={}'.format(key, str(value).replace("'", '"')) for (key, value) in params.items()] cmd.append('-v') cmd.extend(param_str) results = self.open...
'return a resource by name'
def _get(self, resource, name=None, selector=None):
cmd = ['get', resource] if (selector is not None): cmd.append('--selector={}'.format(selector)) elif (name is not None): cmd.append(name) cmd.extend(['-o', 'json']) rval = self.openshift_cmd(cmd, output=True) if ('items' in rval): rval['results'] = rval['items'] elif ...
'perform oadm manage-node scheduable'
def _schedulable(self, node=None, selector=None, schedulable=True):
cmd = ['manage-node'] if node: cmd.extend(node) else: cmd.append('--selector={}'.format(selector)) cmd.append('--schedulable={}'.format(schedulable)) return self.openshift_cmd(cmd, oadm=True, output=True, output_type='raw')
'perform oadm list pods node: the node in which to list pods selector: the label selector filter if provided pod_selector: the pod selector filter if provided'
def _list_pods(self, node=None, selector=None, pod_selector=None):
cmd = ['manage-node'] if node: cmd.extend(node) else: cmd.append('--selector={}'.format(selector)) if pod_selector: cmd.append('--pod-selector={}'.format(pod_selector)) cmd.extend(['--list-pods', '-o', 'json']) return self.openshift_cmd(cmd, oadm=True, output=True, output...
'perform oadm manage-node evacuate'
def _evacuate(self, node=None, selector=None, pod_selector=None, dry_run=False, grace_period=None, force=False):
cmd = ['manage-node'] if node: cmd.extend(node) else: cmd.append('--selector={}'.format(selector)) if dry_run: cmd.append('--dry-run') if pod_selector: cmd.append('--pod-selector={}'.format(pod_selector)) if grace_period: cmd.append('--grace-period={}'.for...
'return the openshift version'
def _version(self):
return self.openshift_cmd(['version'], output=True, output_type='raw')
'perform image import'
def _import_image(self, url=None, name=None, tag=None):
cmd = ['import-image'] image = '{0}'.format(name) if tag: image += ':{0}'.format(tag) cmd.append(image) if url: cmd.append('--from={0}/{1}'.format(url, image)) cmd.append('-n{0}'.format(self.namespace)) cmd.append('--confirm') return self.openshift_cmd(cmd)
'Actually executes the command. This makes mocking easier.'
def _run(self, cmds, input_data):
curr_env = os.environ.copy() curr_env.update({'KUBECONFIG': self.kubeconfig}) proc = subprocess.Popen(cmds, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=curr_env) (stdout, stderr) = proc.communicate(input_data) return (proc.returncode, stdout.decode('utf-8'), stderr.dec...
'Base command for oc'
def openshift_cmd(self, cmd, oadm=False, output=False, output_type='json', input_data=None):
cmds = [self.oc_binary] if oadm: cmds.append('adm') cmds.extend(cmd) if self.all_namespaces: cmds.extend(['--all-namespaces']) elif ((self.namespace is not None) and (self.namespace.lower() not in ['none', 'emtpy'])): cmds.extend(['-n', self.namespace]) if self.verbose: ...
'Actually write the file contents to disk. This helps with mocking.'
@staticmethod def _write(filename, contents):
with open(filename, 'w') as sfd: sfd.write(contents)
'create a file in tmp with name and contents'
@staticmethod def create_tmp_file_from_contents(rname, data, ftype='yaml'):
tmp = Utils.create_tmpfile(prefix=rname) if (ftype == 'yaml'): if hasattr(yaml, 'RoundTripDumper'): Utils._write(tmp, yaml.dump(data, Dumper=yaml.RoundTripDumper)) else: Utils._write(tmp, yaml.safe_dump(data, default_flow_style=False)) elif (ftype == 'json'): ...
'create a temporary copy of a file'
@staticmethod def create_tmpfile_copy(inc_file):
tmpfile = Utils.create_tmpfile('lib_openshift-') Utils._write(tmpfile, open(inc_file).read()) atexit.register(Utils.cleanup, [tmpfile]) return tmpfile
'Generates and returns a temporary file name'
@staticmethod def create_tmpfile(prefix='tmp'):
with tempfile.NamedTemporaryFile(prefix=prefix, delete=False) as tmp: return tmp.name
'Turn an array of dict: filename, content into a files array'
@staticmethod def create_tmp_files_from_contents(content, content_type=None):
if (not isinstance(content, list)): content = [content] files = [] for item in content: path = Utils.create_tmp_file_from_contents((item['path'] + '-'), item['data'], ftype=content_type) files.append({'name': os.path.basename(item['path']), 'path': path}) return files