text
stringlengths
81
112k
Examine self.id and assign self.url (and self.branch, for git_pillar) def get_url(self): ''' Examine self.id and assign self.url (and self.branch, for git_pillar) ''' if self.role in ('git_pillar', 'winrepo'): # With winrepo and git_pillar, the remote is specified in the ...
Return the expected result of an os.walk on the linkdir, based on the mountpoint value. def linkdir_walk(self): ''' Return the expected result of an os.walk on the linkdir, based on the mountpoint value. ''' try: # Use cached linkdir_walk if we've already run...
Checkout the configured branch/tag. We catch an "Exception" class here instead of a specific exception class because the exceptions raised by GitPython when running these functions vary in different versions of GitPython. def checkout(self): ''' Checkout the configured branch/ta...
Initialize/attach to a remote using GitPython. Return a boolean which will let the calling function know whether or not a new repo was initialized by this function. def init_remote(self): ''' Initialize/attach to a remote using GitPython. Return a boolean which will let the call...
Get list of directories for the target environment using GitPython def dir_list(self, tgt_env): ''' Get list of directories for the target environment using GitPython ''' ret = set() tree = self.get_tree(tgt_env) if not tree: return ret if self.root(t...
Check the refs and return a list of the ones which can be used as salt environments. def envs(self): ''' Check the refs and return a list of the ones which can be used as salt environments. ''' ref_paths = [x.path for x in self.repo.refs] return self._get_envs_fr...
Fetch the repo. If the local copy was updated, return True. If the local copy was already up-to-date, return False. def _fetch(self): ''' Fetch the repo. If the local copy was updated, return True. If the local copy was already up-to-date, return False. ''' origin = self...
Get file list for the target environment using GitPython def file_list(self, tgt_env): ''' Get file list for the target environment using GitPython ''' files = set() symlinks = {} tree = self.get_tree(tgt_env) if not tree: # Not found, return empty ob...
Find the specified file in the specified environment def find_file(self, path, tgt_env): ''' Find the specified file in the specified environment ''' tree = self.get_tree(tgt_env) if not tree: # Branch/tag/SHA not found in repo return None, None, None ...
Return a git.Tree object matching a head ref fetched into refs/remotes/origin/ def get_tree_from_branch(self, ref): ''' Return a git.Tree object matching a head ref fetched into refs/remotes/origin/ ''' try: return git.RemoteReference( self.re...
Return a git.Tree object matching a tag ref fetched into refs/tags/ def get_tree_from_tag(self, ref): ''' Return a git.Tree object matching a tag ref fetched into refs/tags/ ''' try: return git.TagReference( self.repo, 'refs/tags/{0}'.format(r...
Return a git.Tree object matching a SHA def get_tree_from_sha(self, ref): ''' Return a git.Tree object matching a SHA ''' try: return self.repo.rev_parse(ref).tree except (gitdb.exc.ODBError, AttributeError): return None
Using the blob object, write the file to the destination path def write_file(self, blob, dest): ''' Using the blob object, write the file to the destination path ''' with salt.utils.files.fopen(dest, 'wb+') as fp_: blob.stream_data(fp_)
Checkout the configured branch/tag def checkout(self): ''' Checkout the configured branch/tag ''' tgt_ref = self.get_checkout_target() local_ref = 'refs/heads/' + tgt_ref remote_ref = 'refs/remotes/origin/' + tgt_ref tag_ref = 'refs/tags/' + tgt_ref try:...
Clean stale local refs so they don't appear as fileserver environments def clean_stale_refs(self, local_refs=None): # pylint: disable=arguments-differ ''' Clean stale local refs so they don't appear as fileserver environments ''' try: if pygit2.GIT_FETCH_PRUNE: ...
Initialize/attach to a remote using pygit2. Return a boolean which will let the calling function know whether or not a new repo was initialized by this function. def init_remote(self): ''' Initialize/attach to a remote using pygit2. Return a boolean which will let the calling fu...
Get a list of directories for the target environment using pygit2 def dir_list(self, tgt_env): ''' Get a list of directories for the target environment using pygit2 ''' def _traverse(tree, blobs, prefix): ''' Traverse through a pygit2 Tree object recursively, acc...
Fetch the repo. If the local copy was updated, return True. If the local copy was already up-to-date, return False. def _fetch(self): ''' Fetch the repo. If the local copy was updated, return True. If the local copy was already up-to-date, return False. ''' origin = self...
Get file list for the target environment using pygit2 def file_list(self, tgt_env): ''' Get file list for the target environment using pygit2 ''' def _traverse(tree, blobs, prefix): ''' Traverse through a pygit2 Tree object recursively, accumulating all ...
Find the specified file in the specified environment def find_file(self, path, tgt_env): ''' Find the specified file in the specified environment ''' tree = self.get_tree(tgt_env) if not tree: # Branch/tag/SHA not found in repo return None, None, None ...
Return a pygit2.Tree object matching a head ref fetched into refs/remotes/origin/ def get_tree_from_branch(self, ref): ''' Return a pygit2.Tree object matching a head ref fetched into refs/remotes/origin/ ''' try: return self.peel(self.repo.lookup_reference( ...
Return a pygit2.Tree object matching a SHA def get_tree_from_sha(self, ref): ''' Return a pygit2.Tree object matching a SHA ''' try: return self.repo.revparse_single(ref).tree except (KeyError, TypeError, ValueError, AttributeError): return None
Assign attributes for pygit2 callbacks def setup_callbacks(self): ''' Assign attributes for pygit2 callbacks ''' if PYGIT2_VERSION >= _LooseVersion('0.23.2'): self.remotecallbacks = pygit2.RemoteCallbacks( credentials=self.credentials) if not self...
Check the username and password/keypair info for validity. If valid, set a 'credentials' attribute consisting of the appropriate Pygit2 credentials object. Return False if a required auth param is not present. Return True if the required auth parameters are present (or auth is not config...
Using the blob object, write the file to the destination path def write_file(self, blob, dest): ''' Using the blob object, write the file to the destination path ''' with salt.utils.files.fopen(dest, 'wb+') as fp_: fp_.write(blob.data)
Initialize remotes def init_remotes(self, remotes, per_remote_overrides=(), per_remote_only=PER_REMOTE_ONLY, global_only=GLOBAL_ONLY): ''' Initialize remotes ''' # The global versions of the auth params (gitfs_user, # gitfs_password, etc...
Remove cache directories for remotes no longer configured def clear_old_remotes(self): ''' Remove cache directories for remotes no longer configured ''' try: cachedir_ls = os.listdir(self.cache_root) except OSError: cachedir_ls = [] # Remove activ...
Completely clear cache def clear_cache(self): ''' Completely clear cache ''' errors = [] for rdir in (self.cache_root, self.file_list_cachedir): if os.path.exists(rdir): try: shutil.rmtree(rdir) except OSError as ex...
Clear update.lk for all remotes def clear_lock(self, remote=None, lock_type='update'): ''' Clear update.lk for all remotes ''' cleared = [] errors = [] for repo in self.remotes: if remote: # Specific remote URL/pattern was passed, ensure that ...
Fetch all remotes and return a boolean to let the calling function know whether or not any remotes were updated in the process of fetching def fetch_remotes(self, remotes=None): ''' Fetch all remotes and return a boolean to let the calling function know whether or not any remotes were u...
Place an update.lk def lock(self, remote=None): ''' Place an update.lk ''' locked = [] errors = [] for repo in self.remotes: if remote: # Specific remote URL/pattern was passed, ensure that the URL # matches or else skip this o...
.. versionchanged:: 2018.3.0 The remotes argument was added. This being a list of remote URLs, it will only update matching remotes. This actually matches on repo.id Execute a git fetch on all of the repos and perform maintenance on the fileserver cache. def update(...
Returns a dictionary mapping remote IDs to their intervals, designed to be used for variable update intervals in salt.master.FileserverUpdate. A remote's ID is defined here as a tuple of the GitPython/Pygit2 object's "id" and "name" attributes, with None being assumed as the "name" valu...
Determine which provider to use def verify_provider(self): ''' Determine which provider to use ''' if 'verified_{0}_provider'.format(self.role) in self.opts: self.provider = self.opts['verified_{0}_provider'.format(self.role)] else: desired_provider = sel...
Check if GitPython is available and at a compatible version (>= 0.3.0) def verify_gitpython(self, quiet=False): ''' Check if GitPython is available and at a compatible version (>= 0.3.0) ''' def _recommend(): if PYGIT2_VERSION and 'pygit2' in self.git_providers: ...
Check if pygit2/libgit2 are available and at a compatible version. Pygit2 must be at least 0.20.3 and libgit2 must be at least 0.20.0. def verify_pygit2(self, quiet=False): ''' Check if pygit2/libgit2 are available and at a compatible version. Pygit2 must be at least 0.20.3 and libgit2 ...
Write the remote_map.txt def write_remote_map(self): ''' Write the remote_map.txt ''' remote_map = salt.utils.path.join(self.cache_root, 'remote_map.txt') try: with salt.utils.files.fopen(remote_map, 'w+') as fp_: timestamp = \ dat...
Common code for git_pillar/winrepo to handle locking and checking out of a repo. def do_checkout(self, repo): ''' Common code for git_pillar/winrepo to handle locking and checking out of a repo. ''' time_start = time.time() while time.time() - time_start <= 5: ...
Return a list of refs that can be used as environments def envs(self, ignore_cache=False): ''' Return a list of refs that can be used as environments ''' if not ignore_cache: cache_match = salt.fileserver.check_env_cache( self.opts, self.env_c...
Find the first file to match the path and ref, read the file out of git and send the path to the newly cached file def find_file(self, path, tgt_env='base', **kwargs): # pylint: disable=W0613 ''' Find the first file to match the path and ref, read the file out of git and send the path ...
Return a file hash, the hash type is set in the master config file def file_hash(self, load, fnd): ''' Return a file hash, the hash type is set in the master config file ''' if 'env' in load: # "env" is not supported; Use "saltenv". load.pop('env') if no...
Return a dict containing the file lists for files and dirs def _file_lists(self, load, form): ''' Return a dict containing the file lists for files and dirs ''' if 'env' in load: # "env" is not supported; Use "saltenv". load.pop('env') if not os.path.isd...
Return a dict of all symlinks based on a given path in the repo def symlink_list(self, load): ''' Return a dict of all symlinks based on a given path in the repo ''' if 'env' in load: # "env" is not supported; Use "saltenv". load.pop('env') if not salt.u...
Checkout the targeted branches/tags from the git_pillar remotes def checkout(self): ''' Checkout the targeted branches/tags from the git_pillar remotes ''' self.pillar_dirs = OrderedDict() self.pillar_linked_dirs = [] for repo in self.remotes: cachedir = self...
Ensure that the mountpoint is present in the correct location and points at the correct path def link_mountpoint(self, repo): ''' Ensure that the mountpoint is present in the correct location and points at the correct path ''' lcachelink = salt.utils.path.join(repo.linkd...
Checkout the targeted branches/tags from the winrepo remotes def checkout(self): ''' Checkout the targeted branches/tags from the winrepo remotes ''' self.winrepo_dirs = {} for repo in self.remotes: cachedir = self.do_checkout(repo) if cachedir is not Non...
Check if the minion is exposed, based on the whitelist and blacklist def _is_exposed(minion): ''' Check if the minion is exposed, based on the whitelist and blacklist ''' return salt.utils.stringutils.check_whitelist_blacklist( minion, whitelist=__opts__['minionfs_whitelist'], b...
Search the environment for the relative path def find_file(path, tgt_env='base', **kwargs): # pylint: disable=W0613 ''' Search the environment for the relative path ''' fnd = {'path': '', 'rel': ''} if os.path.isabs(path): return fnd if tgt_env not in envs(): return fnd if ...
When we are asked to update (regular interval) lets reap the cache def update(): ''' When we are asked to update (regular interval) lets reap the cache ''' try: salt.fileserver.reap_fileserver_cache_dir( os.path.join(__opts__['cachedir'], 'minionfs/hash'), find_file) ...
Return a file hash, the hash type is set in the master config file def file_hash(load, fnd): ''' Return a file hash, the hash type is set in the master config file ''' path = fnd['path'] ret = {} if 'env' in load: # "env" is not supported; Use "saltenv". load.pop('env') if...
Return a list of all files on the file server in a specified environment def file_list(load): ''' Return a list of all files on the file server in a specified environment ''' if 'env' in load: # "env" is not supported; Use "saltenv". load.pop('env') if load['saltenv'] not in envs()...
Function to standardize the subprocess call def _subprocess(cmd): ''' Function to standardize the subprocess call ''' log.debug('Running: "%s"', ' '.join(cmd)) try: proc = subprocess.Popen(cmd, stdout=subprocess.PIPE) ret = salt.utils.stringutils.to_unicode(proc.communicate()[0]).s...
Bounce Traffic Server on the local node. Bouncing Traffic Server shuts down and immediately restarts the Traffic Server node. drain This option modifies the restart behavior such that traffic_server is not shut down until the number of active client connections drops to the number given...
Restart the traffic_manager and traffic_server processes on the local node. drain This option modifies the restart behavior such that ``traffic_server`` is not shut down until the number of active client connections drops to the number given by the ``proxy.config.restart.active_clie...
Display the current values of all metrics whose names match the given regular expression. .. versionadded:: 2016.11.0 .. code-block:: bash salt '*' trafficserver.match_metric regex def match_metric(regex): ''' Display the current values of all metrics whose names match the given regu...
Display the current values of all configuration variables whose names match the given regular expression. .. versionadded:: 2016.11.0 .. code-block:: bash salt '*' trafficserver.match_config regex def match_config(regex): ''' Display the current values of all configuration variables whos...
Read Traffic Server configuration variable definitions. .. versionadded:: 2016.11.0 .. code-block:: bash salt '*' trafficserver.read_config proxy.config.http.keep_alive_post_out def read_config(*args): ''' Read Traffic Server configuration variable definitions. .. versionadded:: 2016.11...
Set the value of a Traffic Server configuration variable. variable Name of a Traffic Server configuration variable. value The new value to set. .. versionadded:: 2016.11.0 .. code-block:: bash salt '*' trafficserver.set_config proxy.config.http.keep_alive_post_out 0 def set...
Mark a cache storage device as offline. The storage is identified by a path which must match exactly a path specified in storage.config. This removes the storage from the cache and redirects requests that would have used this storage to other storage. This has exactly the same effect as a disk failure f...
Clear (acknowledge) an alarm event. The arguments are “all” for all current alarms, a specific alarm number (e.g. ‘‘1’‘), or an alarm string identifier (e.g. ‘’MGMT_ALARM_PROXY_CONFIG_ERROR’‘). .. code-block:: bash salt '*' trafficserver.clear_alarms [all | #event | name] def clear_alarms(alarm):...
Libcloud supported node states def node_state(id_): ''' Libcloud supported node states ''' states_int = { 0: 'RUNNING', 1: 'REBOOTING', 2: 'TERMINATED', 3: 'PENDING', 4: 'UNKNOWN', 5: 'STOPPED', 6: 'SUSPENDED', 7: 'ERROR', 8: 'PAUS...
Compare different libcloud versions def check_libcloud_version(reqver=LIBCLOUD_MINIMAL_VERSION, why=None): ''' Compare different libcloud versions ''' if not HAS_LIBCLOUD: return False if not isinstance(reqver, (list, tuple)): raise RuntimeError( '\'reqver\' needs to pa...
Return a libcloud node for the named VM def get_node(conn, name): ''' Return a libcloud node for the named VM ''' nodes = conn.list_nodes() for node in nodes: if node.name == name: __utils__['cloud.cache_node'](salt.utils.data.simple_types_filter(node.__dict__), __active_provide...
Return a dict of all available VM locations on the cloud provider with relevant data def avail_locations(conn=None, call=None): ''' Return a dict of all available VM locations on the cloud provider with relevant data ''' if call == 'action': raise SaltCloudSystemExit( 'The a...
Return a dict of all available VM images on the cloud provider with relevant data def avail_images(conn=None, call=None): ''' Return a dict of all available VM images on the cloud provider with relevant data ''' if call == 'action': raise SaltCloudSystemExit( 'The avail_imag...
Return a dict of all available VM images on the cloud provider with relevant data def avail_sizes(conn=None, call=None): ''' Return a dict of all available VM images on the cloud provider with relevant data ''' if call == 'action': raise SaltCloudSystemExit( 'The avail_sizes...
Return the location object to use def get_location(conn, vm_): ''' Return the location object to use ''' locations = conn.list_locations() vm_location = config.get_cloud_config_value('location', vm_, __opts__) if not six.PY3: vm_location = vm_location.encode( 'ascii', 'salt-...
Return the image object to use def get_image(conn, vm_): ''' Return the image object to use ''' images = conn.list_images() vm_image = config.get_cloud_config_value('image', vm_, __opts__) if not six.PY3: vm_image = vm_image.encode('ascii', 'salt-cloud-force-ascii') for img in ima...
Return the VM's size object def get_size(conn, vm_): ''' Return the VM's size object ''' sizes = conn.list_sizes() vm_size = config.get_cloud_config_value('size', vm_, __opts__) if not vm_size: return sizes[0] for size in sizes: if vm_size and str(vm_size) in (str(size.id),...
Delete a single VM def destroy(name, conn=None, call=None): ''' Delete a single VM ''' if call == 'function': raise SaltCloudSystemExit( 'The destroy action must be called with -d, --destroy, ' '-a or --action.' ) __utils__['cloud.fire_event']( 'even...
Reboot a single VM def reboot(name, conn=None): ''' Reboot a single VM ''' if not conn: conn = get_conn() # pylint: disable=E0602 node = get_node(conn, name) if node is None: log.error('Unable to find the VM %s', name) log.info('Rebooting VM: %s', name) ret = conn.reb...
Return a list of the VMs that are on the provider def list_nodes(conn=None, call=None): ''' Return a list of the VMs that are on the provider ''' if call == 'action': raise SaltCloudSystemExit( 'The list_nodes function must be called with -f or --function.' ) if not con...
Return a list of the VMs that are on the provider, with all fields def list_nodes_full(conn=None, call=None): ''' Return a list of the VMs that are on the provider, with all fields ''' if call == 'action': raise SaltCloudSystemExit( 'The list_nodes_full function must be called with ...
Return a list of the VMs that are on the provider, with select fields def list_nodes_select(conn=None, call=None): ''' Return a list of the VMs that are on the provider, with select fields ''' if not conn: conn = get_conn() # pylint: disable=E0602 return salt.utils.cloud.list_nodes_selec...
Find if the provided connection object has a specific method def conn_has_method(conn, method_name): ''' Find if the provided connection object has a specific method ''' if method_name in dir(conn): return True log.error('Method \'%s\' not yet supported!', method_name) return False
Checks if a database exists in InfluxDB. name Name of the database to check. CLI Example: .. code-block:: bash salt '*' influxdb.db_exists <name> def db_exists(name, **client_args): ''' Checks if a database exists in InfluxDB. name Name of the database to check. ...
Create a database. name Name of the database to create. CLI Example: .. code-block:: bash salt '*' influxdb.create_db <name> def create_db(name, **client_args): ''' Create a database. name Name of the database to create. CLI Example: .. code-block:: bash ...
Drop a database. name Name of the database to drop. CLI Example: .. code-block:: bash salt '*' influxdb.drop_db <name> def drop_db(name, **client_args): ''' Drop a database. name Name of the database to drop. CLI Example: .. code-block:: bash salt...
Get information about given user. name Name of the user for which to get information. CLI Example: .. code-block:: bash salt '*' influxdb.user_info <name> def user_info(name, **client_args): ''' Get information about given user. name Name of the user for which to ge...
Create a user. name Name of the user to create. passwd Password of the new user. admin : False Whether the user should have cluster administration privileges or not. CLI Example: .. code-block:: bash salt '*' influxdb.create_user <name> <password> ...
Change password of a user. name Name of the user for whom to set the password. passwd New password of the user. CLI Example: .. code-block:: bash salt '*' influxdb.set_user_password <name> <password> def set_user_password(name, passwd, **client_args): ''' Change pas...
Grant cluster administration privileges to a user. name Name of the user to whom admin privileges will be granted. CLI Example: .. code-block:: bash salt '*' influxdb.grant_admin_privileges <name> def grant_admin_privileges(name, **client_args): ''' Grant cluster administration ...
Revoke cluster administration privileges from a user. name Name of the user from whom admin privileges will be revoked. CLI Example: .. code-block:: bash salt '*' influxdb.revoke_admin_privileges <name> def revoke_admin_privileges(name, **client_args): ''' Revoke cluster adminis...
Remove a user. name Name of the user to remove CLI Example: .. code-block:: bash salt '*' influxdb.remove_user <name> def remove_user(name, **client_args): ''' Remove a user. name Name of the user to remove CLI Example: .. code-block:: bash salt '...
Get an existing retention policy. database Name of the database for which the retention policy was defined. name Name of the retention policy. CLI Example: .. code-block:: bash salt '*' influxdb.get_retention_policy metrics default def get_retention_policy(database,...
Check if retention policy with given name exists. database Name of the database for which the retention policy was defined. name Name of the retention policy to check. CLI Example: .. code-block:: bash salt '*' influxdb.retention_policy_exists metrics default def re...
Drop a retention policy. database Name of the database for which the retention policy will be dropped. name Name of the retention policy to drop. CLI Example: .. code-block:: bash salt '*' influxdb.drop_retention_policy mydb mypr def drop_retention_policy(database, name, **...
Create a retention policy. database Name of the database for which the retention policy will be created. name Name of the new retention policy. duration Duration of the new retention policy. Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported and mean 1 ...
List privileges from a user. name Name of the user from whom privileges will be listed. CLI Example: .. code-block:: bash salt '*' influxdb.list_privileges <name> def list_privileges(name, **client_args): ''' List privileges from a user. name Name of the user from w...
Grant a privilege on a database to a user. database Name of the database to grant the privilege on. privilege Privilege to grant. Can be one of 'read', 'write' or 'all'. username Name of the user to grant the privilege to. def grant_privilege(database, privilege, username, **clie...
Revoke a privilege on a database from a user. database Name of the database to grant the privilege on. privilege Privilege to grant. Can be one of 'read', 'write' or 'all'. username Name of the user to grant the privilege to. def revoke_privilege(database, privilege, username, **...
Check if continuous query with given name exists on the database. database Name of the database for which the continuous query was defined. name Name of the continuous query to check. CLI Example: .. code-block:: bash salt '*' influxdb.continuous_query_exists metrics...
Get an existing continuous query. database Name of the database for which the continuous query was defined. name Name of the continuous query to get. CLI Example: .. code-block:: bash salt '*' influxdb.get_continuous_query mydb cq_month def get_continuous_query(data...
Create a continuous query. database Name of the database for which the continuous query will be created on. name Name of the continuous query to create. query The continuous query string. resample_time : None Duration between continuous query resampling. ...
Drop a continuous query. database Name of the database for which the continuous query will be drop from. name Name of the continuous query to drop. CLI Example: .. code-block:: bash salt '*' influxdb.drop_continuous_query mydb my_cq def drop_continuous_query(databas...
Parses a ResultSet returned from InfluxDB into a dictionary of results, grouped by series names and optional JSON-encoded grouping tags. def _pull_query_results(resultset): ''' Parses a ResultSet returned from InfluxDB into a dictionary of results, grouped by series names and optional JSON-encoded grou...
Execute a query. database Name of the database to query on. query InfluxQL query string. def query(database, query, **client_args): ''' Execute a query. database Name of the database to query on. query InfluxQL query string. ''' client = _client(**cli...
Returns the recursive diff between dict values def _get_recursive_difference(self, type): '''Returns the recursive diff between dict values''' if type == 'intersect': return [recursive_diff(item['old'], item['new']) for item in self._intersect] elif type == 'added': retu...
Deletes an attribute from all of the intersect objects def remove_diff(self, diff_key=None, diff_list='intersect'): '''Deletes an attribute from all of the intersect objects''' if diff_list == 'intersect': for item in self._intersect: item['old'].pop(diff_key, None) ...
Returns a list of dictionaries with key value pairs. The values are the differences between the items identified by the key. def diffs(self): ''' Returns a list of dictionaries with key value pairs. The values are the differences between the items identified by the key. ''' ...