File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/beacons/__pycache__/__init__.cpython-310.pyc
o
;j Q � @ sP d Z ddlZddlZddlZddlZddlZddlZe�e �Z
G dd� d�Z dS )zF
This package contains the loader modules for the salt streams system
� Nc @ s� e Zd ZdZd0dd�Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
d1dd�Zd1dd�Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� ZdS )2�BeaconzI
This class is used to evaluate and execute on the beacon system
Nc C s4 dd l }|| _|| _|j�||�| _|pt� | _d S )Nr )Z salt.loader�opts� functions�loader�beacons�dict� interval_map)�selfr r r �salt� r �I/opt/saltstack/salt/lib/python3.10/site-packages/salt/beacons/__init__.py�__init__ s
zBeacon.__init__c C s� | j d �|�}|du rdS d}t|t�r i }tt|j|�� nt|t�r'|}|du r-dS |}| �|d�r9|d }|� d�}|| jv rwz!t �
|�}t|t�rU|� d|i� t �
d|� | j| |� W dS tyv t j
d|dd � Y dS w dS )
z�
Close a single beacon module if it has a close function.
This releases resources like inotify file descriptors.
r N�
beacon_module�.close� _beacon_namezClosing beacon %szFailed to close beacon %sT)�exc_info)r �get�
isinstance�list�map�updater �_determine_beacon_configr �copy�deepcopy�append�log�debug� Exception)r �name�
beacon_config�current_beacon_config� beacon_name� close_str�configr r r �
_close_beacon s4
��zBeacon._close_beaconc C s* | � � }|D ] }|dkr
q| �|� qdS )aY
Close all beacon modules that have a close function.
This ensures resources like inotify file descriptors are properly
released when beacons are refreshed or the Beacon instance is replaced.
See: https://github.com/saltstack/salt/issues/66449
See: https://github.com/saltstack/salt/issues/58907
�enabledN)� _get_beaconsr$ )r r �modr r r �
close_beacons? s �zBeacon.close_beaconsc C sb g }t �|�}d|v r|d sdS |D �]�}|dkrqd}t|| t�r1i }tt|j|| �� n t|| t�r<|| }d|v r`|d sKt�d|� qt|| t�rX|| d= n| � || d� t�d|� d}| �
|d�rs|d }n|}|� d�}|| j v r�| j | || �\} }
| s�t� d||
� qnt�
d|� t|| t�s�t� d � q|| �d
|i� |� d �} | | j v �r�| �
|d �} | �
|d
�}
|
r�| �||d
�}| �||
�s�t�d|� q| �
|d��r1t�d|� | �||d�}d}tjj�| j�}|D ]
}t�d|d ��r d}q�|�r1|� d�}|| j v �r*t�d|� | j | || � nt�d|� q|| j | jd< d}z | j | || �}W n% t�� d � }t� d||� d� | jd |�}|�||i |d �� Y |�s�|D ]-}d� | jd |�}d |v �r�||� d �7 }d |v�r�| jd |d < |�|||d �� �qq| �r�| � |� qt�
d |� q|S )!a
Process the configured beacons
The config must be a list and looks like this in yaml
.. code_block:: yaml
beacons:
inotify:
- files:
- /etc/fstab: {}
- /var/cache/foo: {}
r% NzBeacon %s disabledzBeacon processing: %sr � .validatez0Beacon %s configuration invalid, not running.
%szCNo validate function found for %s, running basic beacon validation.z(Configuration for beacon must be a list.r �.beaconZrun_once�intervalz)Skipping beacon %s. Interval not reached.Zdisable_during_state_runz<Evaluting if beacon %s should be skipped due to a state run.Fzstate.*ZfunTr z)Closing beacon %s. State run in progress.z*Skipping beacon %s. State run in progress.Z
__grains__� z Unable to start %s beacon, %szsalt/beacon/{}/{}/�id)�tag�error�datar! r. )r. r0 r! zUnable to process beacon %s) r r r r r r r r �trace�_remove_list_itemr r r/ �warningr � _trim_config�_process_intervalr
�utils�minionZrunningr �re�match�info� __globals__�sysr �format�pop�disable_beacon)r r# Zgrains�ret�b_configr' r r! � validate_str�valid�vcommentZfun_strZrunoncer+ Z
is_runningZ running_jobsZjobr" r/ �rawr. r0 r r r �processN s�
���
�� ����
��
�
�zBeacon.processc C sB t || t�r| �|| |� |S t || t�r || �|� |S )zM
Take a beacon configuration and strip out the interval bits
)r r r2 r r> )r rA r' �keyr r r r4 � s �zBeacon._trim_configc C s d}t |t�r
|�|d�}|S )zJ
Process a beacon configuration to determine its interval
F)r r r )r r rG r+ r r r r � s
z Beacon._determine_beacon_configc C s� t �d||� | jd }|| jv r9t �d� | j| }t �d|� || |kr.d| j|< dS | j| d7 < dS t �d|� d| j|< dS ) zk
Process beacons with intervals
Return True if a beacon should be run on this loop
z(Processing interval %s for beacon mod %s�
loop_intervalzProcessing interval in mapzInterval counter: %sr, Tz"Interval process inserting mod: %sF)r r1 r r )r r' r+ rH Zcounterr r r r5 � s
�
zBeacon._process_intervalc s& � fdd�t |�D �}|sdS |d S )zn
Return the index of a labeled config item in the beacon config, -1 if the index is not found
c s g | ]
\}}� |v r|�qS r r )�.0�index�item��labelr r �
<listcomp> s z%Beacon._get_index.<locals>.<listcomp>���r )� enumerate)r r rM Zindexesr rL r �
_get_index s zBeacon._get_indexc C s | � ||�}||= dS )z:
Remove an item from a beacon config list
N)rQ )r r rM rJ r r r r2 s
zBeacon._remove_list_itemc C s~ t | jd | t�r|| jd | d< dS | �| jd | d�}|dkr1|| jd | | d< dS | jd | �d|i� dS )z@
Update whether an individual beacon is enabled
r r% r N)r r r rQ r )r r Z
enabled_valueZ
enabled_indexr r r �_update_enabled s zBeacon._update_enabledTc C sl i }|r | j �di ��di �}t|t�std��|�|� |r4| j �di �}t|t�s/td��|�|� |S )z3
Return the beacons data structure
Zpillarr z Beacons must be of type dict.)r r r r �
ValueErrorr )r � include_opts�include_pillarr Zpillar_beaconsZ opts_beaconsr r r r& ( s
zBeacon._get_beaconsc C s\ | j ||d�}tjjjd| jd��}|jd|d�dd� W d � dS 1 s'w Y dS ) a
List the beacon items
include_pillar: Whether to include beacons that are
configured in pillar, default is True.
include_opts: Whether to include beacons that are
configured in opts, default is True.
)rU rT r7 �r T��completer z)/salt/minion/minion_beacons_list_complete�r. N)r& r
r6 �event� get_eventr �
fire_event)r rU rT r �evtr r r � list_beacons9 s
��
��zBeacon.list_beaconsc C s^ dd� | j D �}tjjjd| jd��}|jd|d�dd� W d � dS 1 s(w Y dS )
z,
List the available beacons
c S s& g | ]}d |v rd� |�d d���qS )r* z{}� )r= �replace)rI Z_beaconr r r rN T s
�z1Beacon.list_available_beacons.<locals>.<listcomp>r7 rV TrW z3/salt/minion/minion_beacons_list_available_completerY N)r r
r6 rZ r[ r r\ )r Z_beaconsr] r r r �list_available_beaconsP s ��
��z Beacon.list_available_beaconsc s� t � fdd�|D ��}|� d�}|| jv r&d|v r |d= | j| |�\}}nd�|�}d}tjjjd| jd��}|jd||d �d
d � W d � dS 1 sNw Y dS )
z3
Return available beacon functions
c 3 s � | ] }|� d � �V qdS )r N)r )rI rK �r r r � <genexpr>g s � z)Beacon.validate_beacon.<locals>.<genexpr>r) r% zABeacon {} does not have a validate function, skipping validation.Tr7 rV )rX rD rC z./salt/minion/minion_beacon_validation_completerY N) �nextr r= r
r6 rZ r[ r r\ )r r � beacon_datar! rB rC rD r] r rb r �validate_beaconc s&
�
�
��zBeacon.validate_beaconc C s� i }|||< || j dd�v rd�|�}d}n || jd v r#d|� �}nd|� �}d}| jd �|� tjjjd| jd ��}|j||| jd d
�d d � W d
� dS 1 sVw Y dS )z#
Add a beacon item
F�rT zACannot update beacon item {}, because it is configured in pillar.r �#Updating settings for beacon item: zAdded new beacon item: Tr7 rV �rX �commentr z'/salt/minion/minion_beacon_add_completerY N) r& r= r r r
r6 rZ r[ r\ �r r re r0 rj rX r] r r r �
add_beacon� s0 �
��
�
�
zBeacon.add_beaconc C s� i }|||< || j dd�v rd|� d�}d}nd|� �}d}| jd �|� tjjjd| jd ��}|j||| jd d
�d d � W d
� dS 1 sJw Y dS )z&
Modify a beacon item
Frg zCannot modify beacon item � , it is configured in pillar.rh Tr r7 rV ri z*/salt/minion/minion_beacon_modify_completerY N)r& r r r
r6 rZ r[ r\ rk r r r �
modify_beacon� s(
��
� � zBeacon.modify_beaconc C s� || j dd�v rd|� d�}d}n || jd v r)| �|� | jd |= d|� �}nd|� d�}d }tjjjd
| jd ��}|j||| jd d �d
d� W d � d S 1 sUw Y d S )z&
Delete a beacon item
Frg zCannot delete beacon item rm r zDeleting beacon item: z Beacon item z not found.Tr7 rV ri z*/salt/minion/minion_beacon_delete_completerY N)r& r r$ r
r6 rZ r[ r\ �r r rj rX r] r r r �
delete_beacon� s*
��
�
�
zBeacon.delete_beaconc C sb d| j d d< tjjjd| j d��}|jd| j d d�dd� W d � dS 1 s*w Y dS )
�
Enable beacons
Tr r% r7 rV rW z,/salt/minion/minion_beacons_enabled_completerY N�r r
r6 rZ r[ r\ �r r] r r r �enable_beacons� � �
��zBeacon.enable_beaconsc C sb d| j d d< tjjjd| j d��}|jd| j d d�dd � W d
� dS 1 s*w Y dS ) rq Fr r% r7 rV TrW z-/salt/minion/minion_beacons_disabled_completerY Nrr rs r r r �disable_beacons� ru zBeacon.disable_beaconsc C s� || j dd�v rd|� d�}d}n
| �|d� d|� �}d}tjjjd| jd��}|j||| jd d
�d d � W d
� dS 1 sBw Y dS )z!
Enable a beacon
Frg zCannot enable beacon item rm TzEnabling beacon item r7 rV r ri z+/salt/minion/minion_beacon_enabled_completerY N)r& rR r
r6 rZ r[ r r\ ro r r r �
enable_beacon� s$
��
�
�
zBeacon.enable_beaconc C s� || j dd�v rd�|�}d}n
| �|d� d|� �}d}tjjjd| jd��}|j||| jd d �d
d � W d � dS 1 sAw Y dS )
z"
Disable a beacon
Frg z:Cannot disable beacon item {}, it is configured in pillar.zDisabling beacon item Tr7 rV r ri z,/salt/minion/minion_beacon_disabled_completerY N) r& r= rR r
r6 rZ r[ r r\ ro r r r r? s* ��
��
�
�
zBeacon.disable_beaconc C s` i | j d< tjjjd| j d��}|jdd| j d d�dd� W d � dS 1 s)w Y dS )
z/
Reset the beacons to defaults
r r7 rV TzBeacons have been resetri z)/salt/minion/minion_beacon_reset_completerY Nrr rs r r r �reset7 s
��
� � z Beacon.reset)N)TT)�__name__�
__module__� __qualname__�__doc__r
r$ r( rF r4 r r5 rQ r2 rR r& r^ ra rf rl rn rp rt rv rw r? rx r r r r r s2
"
# r ) r| r �loggingr8 r< Zsalt.utils.eventr
Zsalt.utils.minion� getLoggerry r r r r r r �<module> s