File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/dockercompose.cpython-310.pyc
Back
o ;j� � @ s� d Z ddlZddlZddlZddlZddlmZ ddlZddl Zddl m Z ddl m Z zddlZddlmZ ddlmZ dZW n eyK d ZY nw z dd lmZ dZW n eya d ZY nw d Zd Ze�e�Z d Z d Z dZ dd� Z dKdd�Z!dd� Z"dd� Z#dd� Z$dd� Z%dd � Z&d d � Z'd d � Z(d!d"� Z)d#d$� Z*d%d&� Z+d'd(� Z,d)d*� Z-d+d,� Z.dLd-d.�Z/dLd/d0�Z0dLd1d2�Z1dLd3d4�Z2dLd5d6�Z3dLd7d8�Z4dLd9d:�Z5dLd;d<�Z6dLd=d>�Z7d?d@� Z8dLdAdB�Z9dCdD� Z:dEdF� Z;dGdH� Z<dIdJ� Z=dS )MaQ Module to import docker-compose via saltstack .. versionadded:: 2016.3.0 :maintainer: Jean Praloran <jeanpralo@gmail.com> :maturity: new :depends: docker-compose>=1.5 :platform: all Introduction ------------ This module allows one to deal with docker-compose file in a directory. This is a first version only, the following commands are missing at the moment but will be built later on if the community is interested in this module: - run - logs - port - scale Installation Prerequisites -------------------------- This execution module requires at least version 1.4.0 of both docker-compose_ and Docker_. docker-compose can easily be installed using :py:func:`pip.install <salt.modules.pip.install>`: .. code-block:: bash salt myminion pip.install docker-compose>=1.5.0 .. _docker-compose: https://pypi.python.org/pypi/docker-compose .. _Docker: https://www.docker.com/ How to use this module? ----------------------- In order to use the module if you have no docker-compose file on the server you can issue the command create, it takes two arguments the path where the docker-compose.yml will be stored and the content of this latter: .. code-block:: text # salt-call -l debug dockercompose.create /tmp/toto ' database: image: mongo:3.0 command: mongod --smallfiles --quiet --logpath=/dev/null ' Then you can execute a list of method defined at the bottom with at least one argument (the path where the docker-compose.yml will be read) and an optional python list which corresponds to the services names: .. code-block:: bash # salt-call -l debug dockercompose.up /tmp/toto # salt-call -l debug dockercompose.restart /tmp/toto '[database]' # salt-call -l debug dockercompose.stop /tmp/toto # salt-call -l debug dockercompose.rm /tmp/toto Docker-compose method supported ------------------------------- - up - restart - stop - start - pause - unpause - kill - rm - ps - pull - build Functions --------- - docker-compose.yml management - :py:func:`dockercompose.create <salt.modules.dockercompose.create>` - :py:func:`dockercompose.get <salt.modules.dockercompose.get>` - Manage containers - :py:func:`dockercompose.restart <salt.modules.dockercompose.restart>` - :py:func:`dockercompose.stop <salt.modules.dockercompose.stop>` - :py:func:`dockercompose.pause <salt.modules.dockercompose.pause>` - :py:func:`dockercompose.unpause <salt.modules.dockercompose.unpause>` - :py:func:`dockercompose.start <salt.modules.dockercompose.start>` - :py:func:`dockercompose.kill <salt.modules.dockercompose.kill>` - :py:func:`dockercompose.rm <salt.modules.dockercompose.rm>` - :py:func:`dockercompose.up <salt.modules.dockercompose.up>` - Manage containers image: - :py:func:`dockercompose.pull <salt.modules.dockercompose.pull>` - :py:func:`dockercompose.build <salt.modules.dockercompose.build>` - Gather information about containers: - :py:func:`dockercompose.ps <salt.modules.dockercompose.ps>` - Manage service definitions: - :py:func:`dockercompose.service_create <salt.modules.dockercompose.ps>` - :py:func:`dockercompose.service_upsert <salt.modules.dockercompose.ps>` - :py:func:`dockercompose.service_remove <salt.modules.dockercompose.ps>` - :py:func:`dockercompose.service_set_tag <salt.modules.dockercompose.ps>` Detailed Function Documentation ------------------------------- � N)� attrgetter)�json)�yaml)� get_project)�ConvergenceStrategyTF)� OneOffFilter)� � r z([\d.]+)Z dockercompose)zdocker-compose.ymlzdocker-compose.yamlc C sH t r"t�tttj��} | r"tdd� | �d�� d�D ��}|t kr"t S dS )Nc s s � | ]}t |�V qd S �N)�int)�.0�x� r �N/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/dockercompose.py� <genexpr>� s � z __virtual__.<locals>.<genexpr>r �.)FzTThe dockercompose execution module not loaded: compose python library not available.) �HAS_DOCKERCOMPOSE�re�match� VERSION_RE�str�compose� __version__�tuple�group�split�MIN_DOCKERCOMPOSE�__virtualname__)r �versionr r r � __virtual__� s r c C s2 | |d�}|dur ||d< |durt r||d< |S )z� Standardizes all responses :param status: :param message: :param data: :param debug_msg: :return: )�status�messageN�return�debug)r# )r r! �dataZ debug_msg�resultr r r �__standardize_result� s r& c C s@ t j�| �r| S tD ]}t j�| |�}t j�|�r | S q dS )zG Determines the filepath to use :param path: :return: N)�os�path�isfile�DEFAULT_DC_FILENAMES�join)r( Z dc_filename� file_pathr r r �__get_docker_file_path� s ��r- c C s� t j�| �stdd| � d�dd�S z6tjj�| d��$}t j�| �}|di}|D ]}|| tjj � |�7 < q'W d � n1 sAw Y W n t yZ tdd| � �dd� Y S w tdd | � �|d�S ) za Read the compose file if it exists in the directory :param file_path: :return: F�Path � is not presentN�r� �Could not read TzReading content of ) r' r( r) r& �salt�utils�files�fopen�basename� stringutilsZ to_unicode�OSError)r, �fl� file_namer% �liner r r �__read_docker_compose_file� s" � � �� �r= c C sL t | �}|du rd| � �}dtd|dd�fS tj�|�s)dtdd|� d�dd�fS z tjj�|d�� }t � |�}W d � n1 sBw Y W n8 t y] dtdd|� �dd�f Y S t j y� } zd|� d |� �}dtd|dd�fW Y d}~S d}~ww |s�d |� �}dtd|dd�fS d |vr�i |d < |tj� |�d �}|dfS ) zU Read the compose file and load its' contents :param path: :return: N�&Could not find docker-compose file at Fr. r/ r0 r2 �Could not parse � zGot empty compose file at �services)�compose_contentr; )r- r& r' r( r) r3 r4 r5 r6 r �loadr9 � YAMLErrorr7 )r( r, �msgr: Zloaded�yerrr% r r r �__load_docker_compose� s: � �� � �� rG c C sb zt j|ddd�}t| ||�W S ty0 } zd|� d|� �}td|dd�W Y d}~S d}~ww )z] Dumps :param path: :param content: the not-yet dumped content :return: � F)�indentZdefault_flow_stylezCould not dump r@ N)r Z safe_dump�__write_docker_compose� TypeErrorr& )r( �content�already_existedZdumpedZt_errrE r r r �__dump_docker_compose� s ��rN c C s� | � � �d�r| }tj�| �}n | }tj�|td �}tj�|�du r(t�|� z$t j j � |d��}|� t j j�|�� W d � n1 sFw Y W n ty_ tdd|� �dd� Y S w t|�}t|t�rr|spt�|� |S |S )z� Write docker-compose to a path in order to use it with docker-compose ( config check ) :param path: docker_compose contains the docker-compose file :return: )z.ymlz.yamlr F�wNzCould not write )�lower�endswithr' r( �dirnamer+ r* �isdir�mkdirr3 r4 r5 r6 �writer8 Zto_strr9 r& � __load_project_from_file_path� isinstance�dict�remove)r( �docker_composerM r, Zdir_namer: �projectr r r rJ s* �� � rJ c C s0 t | �}|du rd| � �}td|dd�S t|�S )zP Load a docker-compose project from path :param path: :return: Nr> F)r- r& rV )r( r, rE r r r �__load_project- s r\ c C sR zt tj�| �tj�| �gd�}W |S ty( } z t|�W Y d}~S d}~ww )zU Load a docker-compose project from file path :param path: :return: )Z project_dirZ config_pathN)r r' r( rR r7 � Exception�__handle_except)r, r[ �instr r r rV ; s ����rV c C s� t | �\}}|r dd|fS t|t�r||dfS |�� �d�rKzt�|�}W nR tjyJ } zd|� d|� �}ddtd|dd�fW Y d}~S d}~ww zt � |�}W n% t j yw } zd|� d|� �}ddtd|dd�fW Y d}~S d}~ww ||dfS )a Will load the compose file located at path Then determines the format/contents of the sent definition err or results are only set if there were any :param path: :param definition: :return tuple(compose_result, loaded_definition, err): N�{r? r@ F) rG rW rX �strip� startswithr Z deserializeZDeserializationErrorr& r rC rD )r( � definition�compose_result�err�loaded_definitionZjerrrE rF r r r �__load_compose_definitionsL s* �� �� rg c C s0 t | |d |�}t|t�r|S td||d d�S )z� Utility function to dump the compose result to a file. :param path: :param compose_result: :param success_msg: the message to give upon success :return: rB TN)rN rW rX r& )r( rd Z success_msgrM �retr r r �__dump_compose_filek s � �ri c C s$ t ddt�� d d � d�| � d�S )zV Handle exception and return a standard result :param inst: :return: FzDocker-compose command r � z failedN)r& �inspect�stack)r_ r r r r^ ~ s �r^ c C sx i }| � | �|�tj�}|D ]+}|| \}}|dkr d||< q|dkr(d||< q|dkr1d||< q|dkr9d||< q|S ) zl Get action executed for each container :param project: :param service_names: :return: �createzCreating containerZrecreatezRe-creating container�startzStarting containerZnoopzContainer is up to date)�_get_convergence_plansZ get_servicesr �changed)r[ � service_namesrh ZplansZcont�action� containerr r r ro � s � �ro c C sl t | �}|du rtdd| � d�dd�S t|�}|d s |S t| �}t|t�r.d|d d< |S d|d d< |S ) a Get the content of the docker-compose file into a directory path Path where the docker-compose file is stored on the server CLI Example: .. code-block:: bash salt myminion dockercompose.get /path/where/docker-compose/stored NFr. r/ r r" ZvalidT)r- r& r= r\ rW rX )r( r, Z salt_resultr[ r r r �get� s �rt c C sB |rt | |dd�}t|t�r|S ntdddd�S tddd| id�S )aH Create and validate a docker-compose file into a directory path Path where the docker-compose file will be stored on the server docker_compose docker_compose file CLI Example: .. code-block:: bash salt myminion dockercompose.create /path/where/docker-compose/stored content F�rM zSCreating a docker-compose project failed, you must send a valid docker-compose fileNTz,Successfully created the docker-compose filezcompose.base_dir)rJ rW rX r& )r( rZ rh r r r rm � s" ���rm c C �` t | �}t|t�r |S z|�|� W n ty( } z t|�W Y d}~S d}~ww tdddd�S )a� Pull image for containers in the docker-compose file, service_names is a python list, if omitted pull all images path Path where the docker-compose file is stored on the server service_names If specified will pull only the image for the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.pull /path/where/docker-compose/stored salt myminion dockercompose.pull /path/where/docker-compose/stored '[janus]' NTz6Pulling containers images via docker-compose succeeded)r\ rW rX �pullr] r^ r& �r( rq r[ r_ r r r rw � � ���rw c C rv )a Build image for containers in the docker-compose file, service_names is a python list, if omitted build images for all containers. Please note that at the moment the module does not allow you to upload your Dockerfile, nor any other file you could need with your docker-compose.yml, you will have to make sure the files you need are actually in the directory specified in the `build` keyword path Path where the docker-compose file is stored on the server service_names If specified will pull only the image for the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.build /path/where/docker-compose/stored salt myminion dockercompose.build /path/where/docker-compose/stored '[janus]' NTz7Building containers images via docker-compose succeeded)r\ rW rX �buildr] r^ r& rx r r r rz s ���rz c C � t | �}i }i }t|t�r|S z3|�|� trA|�� D ]%}|du s,|�d�dd� |v r@|�� |�� ||�d�< d||�d�< qW n t yX } z t |�W Y d}~S d}~ww t dd||�S )a� Restart container(s) in the docker-compose file, service_names is a python list, if omitted restart all containers path Path where the docker-compose file is stored on the server service_names If specified will restart only the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.restart /path/where/docker-compose/stored salt myminion dockercompose.restart /path/where/docker-compose/stored '[janus]' N�Namer Z restartedTz(Restarting containers via docker-compose) r\ rW rX �restartr# � containersrt �inspect_if_not_inspectedrk r] r^ r& �r( rq r[ � debug_retr% rs r_ r r r r} ' s, ����r} c C �� t | �}i }i }t|t�r|S z5|�|� trC|jdd�D ]%}|du s.|�d�dd� |v rB|�� |�� ||�d�< d||�d�< q W n t yZ } z t |�W Y d}~S d}~ww t dd||�S )a� Stop running containers in the docker-compose file, service_names is a python list, if omitted stop all containers path Path where the docker-compose file is stored on the server service_names If specified will stop only the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.stop /path/where/docker-compose/stored salt myminion dockercompose.stop /path/where/docker-compose/stored '[janus]' T��stoppedNr| r r� z&Stopping containers via docker-compose) r\ rW rX �stopr# r~ rt r rk r] r^ r& r� r r r r� R �, ����r� c C r{ )a� Pause running containers in the docker-compose file, service_names is a python list, if omitted pause all containers path Path where the docker-compose file is stored on the server service_names If specified will pause only the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.pause /path/where/docker-compose/stored salt myminion dockercompose.pause /path/where/docker-compose/stored '[janus]' Nr| r ZpausedTz%Pausing containers via docker-compose) r\ rW rX �pauser# r~ rt r rk r] r^ r& r� r r r r� | �, ����r� c C r{ )a� Un-Pause containers in the docker-compose file, service_names is a python list, if omitted unpause all containers path Path where the docker-compose file is stored on the server service_names If specified will un-pause only the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.pause /path/where/docker-compose/stored salt myminion dockercompose.pause /path/where/docker-compose/stored '[janus]' Nr| r ZunpausedTz(Un-Pausing containers via docker-compose) r\ rW rX �unpauser# r~ rt r rk r] r^ r& r� r r r r� � r� r� c C r{ )a� Start containers in the docker-compose file, service_names is a python list, if omitted start all containers path Path where the docker-compose file is stored on the server service_names If specified will start only the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.start /path/where/docker-compose/stored salt myminion dockercompose.start /path/where/docker-compose/stored '[janus]' Nr| r �startedTz&Starting containers via docker-compose) r\ rW rX rn r# r~ rt r rk r] r^ r& r� r r r rn � r� rn c C r� )a� Kill containers in the docker-compose file, service_names is a python list, if omitted kill all containers path Path where the docker-compose file is stored on the server service_names If specified will kill only the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.kill /path/where/docker-compose/stored salt myminion dockercompose.kill /path/where/docker-compose/stored '[janus]' Tr� Nr| r Zkilledz%Killing containers via docker-compose) r\ rW rX �killr# r~ rt r rk r] r^ r& r� r r r r� � r� r� c C rv )a� Remove stopped containers in the docker-compose file, service_names is a python list, if omitted remove all stopped containers path Path where the docker-compose file is stored on the server service_names If specified will remove only the specified stopped services CLI Example: .. code-block:: bash salt myminion dockercompose.rm /path/where/docker-compose/stored salt myminion dockercompose.rm /path/where/docker-compose/stored '[janus]' NTz.Removing stopped containers via docker-compose)r\ rW rX Zremove_stoppedr] r^ r& rx r r r �rm$ ry r� c C s� t | �}i }t|t�r |S tr$t|jddd�|�dtj� td�d�}nt|jddd�|jddd� td�d�}|D ]#}|j }t |�dkrN|dd� � d �}|j |j ||j |jd �||j < q:tdd |d�S ) a List all running containers and report some information about them path Path where the docker-compose file is stored on the server CLI Example: .. code-block:: bash salt myminion dockercompose.ps /path/where/docker-compose/stored NTr� �name)�key)Zone_off� � z ...)�idr� �command�stateZportsz!Listing docker-compose containers)r\ rW rX �USE_FILTERCLASS�sortedr~ r Zonlyr Zhuman_readable_command�lenr� r� Zhuman_readable_stateZhuman_readable_portsr& )r( r[ r% r~ rs r� r r r �psC s8 �� �� �r� c C s� i }t | �}t|t�r |S z/t||�}|�|�}tr;|D ] }|du s-|�d�dd� |v r:|�� |�� ||�d�< q W n t yR } z t |�W Y d}~S d}~ww t dd||�S )a Create and start containers defined in the docker-compose.yml file located in path, service_names is a python list, if omitted create and start all containers path Path where the docker-compose file is stored on the server service_names If specified will create and start only the specified services CLI Example: .. code-block:: bash salt myminion dockercompose.up /path/where/docker-compose/stored salt myminion dockercompose.up /path/where/docker-compose/stored '[janus]' Nr| r Tz$Adding containers via docker-compose) r\ rW rX ro �upr# rt r rk r] r^ r& )r( rq r� r[ r% rh rs r_ r r r r� p s* ����r� c C sf t | |�\}}}|r |S |d d }||v r#d|� d�}td|dd�S |||< t| |d|� d�dd �S ) aN Create the definition of a docker-compose service This fails when the service already exists This does not pull or up the service This wil re-write your yaml file. Comments will be lost. Indentation is set to 2 spaces path Path where the docker-compose file is stored on the server service_name Name of the service to create definition Service definition as yaml or json string CLI Example: .. code-block:: bash salt myminion dockercompose.service_create /path/where/docker-compose/stored service_name definition rB rA �Service � already existsFNz createdTru �rg r& ri �r( � service_namerc rd rf re rA rE r r r �service_create� s � �r� c C sf t | |�\}}}|r |S |d d }||v r#d|� d�}td|dd�S |||< t| |d|� d�d d �S ) a) Create or update the definition of a docker-compose service This does not pull or up the service This wil re-write your yaml file. Comments will be lost. Indentation is set to 2 spaces path Path where the docker-compose file is stored on the server service_name Name of the service to create definition Service definition as yaml or json string CLI Example: .. code-block:: bash salt myminion dockercompose.service_upsert /path/where/docker-compose/stored service_name definition rB rA r� r� FNzService definition for z is setTru r� r� r r r �service_upsert� s � �r� c C s` t | �\}}|r |S |d d }||vr tdd|� d�dd�S ||= t| |d|� d| � �dd �S ) a� Remove the definition of a docker-compose service This does not rm the container This wil re-write your yaml file. Comments will be lost. Indentation is set to 2 spaces path Path where the docker-compose file is stored on the server service_name Name of the service to remove CLI Example: .. code-block:: bash salt myminion dockercompose.service_remove /path/where/docker-compose/stored service_name rB rA Fr� � did not existsNz is removed from Tru )rG r& ri )r( r� rd re rA r r r �service_remove� s ��r� c C s� t | �\}}|r |S |d d }||vr tdd|� d�dd�S d|| vr0tdd|� d�dd�S || d �d �d }|� d |� �|| d< t| |d|� d |� d �d d�S )a+ Change the tag of a docker-compose service This does not pull or up the service This wil re-write your yaml file. Comments will be lost. Indentation is set to 2 spaces path Path where the docker-compose file is stored on the server service_name Name of the service to remove tag Name of the tag (often used as version) that the service image should have CLI Example: .. code-block:: bash salt myminion dockercompose.service_create /path/where/docker-compose/stored service_name tag rB rA Fr� r� N�imagez% did not contain the variable "image"�:r z is set to tag "�"Tru )rG r& r ri )r( r� �tagrd re rA r� r r r �service_set_tag s. � ��r� )NNr )>�__doc__rk �loggingr' r �operatorr Zsalt.utils.filesr3 Zsalt.utils.stringutilsZsalt.serializersr Z salt.utilsr r Zcompose.cli.commandr Zcompose.servicer r � ImportErrorZcompose.projectr r� r r � getLogger�__name__�logr# r r* r r& r- r= rG rN rJ r\ rV rg ri r^ ro rt rm rw rz r} r� r� r� rn r� r� r� r� r� r� r� r� r r r r �<module> sx i � � $! $ # + * * * * * -*&% "
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings