Current File : //usr/lib/python2.7/site-packages/salt/modules/tomcat.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l m Z
d d l m Z d d l m Z m Z m Z m Z m Z d d l Z e
j e � Z i d d 6Z! i d d
g d 6d d
g d 6Z" d � Z# d � Z$ d � Z% d � Z& d � Z' d d d d � Z) d d d � Z* d d d � Z+ d d d � Z, d d d � Z- d d d � Z. d d d � Z/ d d d � Z0 d d d � Z1 d d d � Z2 d d d � Z3 d d d! � Z4 d" d d# d d e5 d$ � Z6 d% d& d d' � Z7 d( � Z8 d) � Z9 d d* � Z: e d+ k r�i Z; i Z< i d, d 6d- d 6Z= e% � Z> i i d, d 6d- d 6d. 6Z= e% � Z? e> e? k r�e j@ d/ � q�e jA d0 � n d S(1 u�
Support for Tomcat
This module uses the manager webapp to manage Apache tomcat webapps.
If the manager webapp is not configured some of the functions won't work.
:configuration:
- Java bin path should be in default path
- If ipv6 is enabled make sure you permit manager access to ipv6 interface
"0:0:0:0:0:0:0:1"
- If you are using tomcat.tar.gz it has to be installed or symlinked under
``/opt``, preferably using name tomcat
- "tomcat.signal start/stop" works but it does not use the startup scripts
The following grains/pillar should be set:
.. code-block:: yaml
tomcat-manager:
user: <username>
passwd: <password>
or the old format:
.. code-block:: yaml
tomcat-manager.user: <username>
tomcat-manager.passwd: <password>
Also configure a user in the conf/tomcat-users.xml file:
.. code-block:: xml
<?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
<role rolename="manager-script"/>
<user username="tomcat" password="tomcat" roles="manager-script"/>
</tomcat-users>
.. note::
- More information about tomcat manager:
http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html
- if you use only this module for deployments you've might want to strict
access to the manager only from localhost for more info:
http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html#Configuring_Manager_Application_Access
- Tested on:
JVM Vendor:
Sun Microsystems Inc.
JVM Version:
1.6.0_43-b01
OS Architecture:
amd64
OS Name:
Linux
OS Version:
2.6.32-358.el6.x86_64
Tomcat Version:
Apache Tomcat/7.0.37
i ( t absolute_importt unicode_literalst print_functionN( t string_types( t urlencode( t urlopent HTTPBasicAuthHandlert HTTPDigestAuthHandlert build_openert install_openeru reloadu reload_u tomcat-manager.useru tomcat-manager:useru useru tomcat-manager.passwdu tomcat-manager:passwdu passwdc C@ s# t � s t d � r d St d f S( uO
Only load tomcat if it is installed or if grains/pillar config exists
u dummyu tomcatu� Tomcat execution module not loaded: neither Tomcat installed locally nor tomcat-manager credentials set in grains/pillar/config.( t __catalina_homet _autht False( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt __virtual__m s c C@ sd d d g } xQ | D]I } t j | � } | r x+ | D] } t j j | d � r5 | Sq5 Wq q Wt S( u4
Tomcat paths differ depending on packaging
u /usr/share/tomcat*u /opt/tomcatu /bin( t globt ost patht isdirR ( t locationst locationt folderst
catalina_home( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyR
w s
c C@ s� i t d 6t d 6} xl | D]d } x[ t t t g D]J } xA t | D]5 } t j j j | | d � } | rB | | | <PqB qB Wq1 Wq W| d | d f S( uD
Get the username and password from opts, grains, or pillar
u useru passwdN(
R t __opts__t
__grains__t
__pillar__t __valid_configst saltt utilst datat traverse_dict_and_listt None( t rett itemt structt
config_keyt value( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt _get_credentials� s
c
C@ s� t � \ } } | t k s' | t k r+ t St � } | j d d d | d | d | � t � } | j d d d | d | d | � t | | � S( u�
returns a authentication handler.
Get user & password from grains, if are not set default to
modules.config.option
If user & pass are missing return False
t realmu Tomcat Manager Applicationt urit usert passwd( R$ R t _HTTPBasicAuthHandlert add_passwordt _HTTPDigestAuthHandlert
_build_opener( R& R' t passwordt basict digest( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyR � s
c C@ s^ t j j | � } t j j | � d } t j d | � } | rZ t | � d k rZ | d Sd S( uc
Extract the version from the war file name. There does not seem to be a
standard for encoding the version into the `war file name`_
.. _`war file name`: https://tomcat.apache.org/tomcat-6.0-doc/deployer-howto.html
Examples:
.. code-block:: bash
/path/salt-2015.8.6.war -> 2015.8.6
/path/V6R2013xD5.war -> None
i u -([\d.-]+)$i N( R R t basenamet splitextt ret findallt lenR ( t warR0 t war_packaget version( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt extract_war_version� s u http://localhost:8080/manageri� c C@ sx i t d 6g d 6} t | � } | t k rD t | d <d | d <| S| d d k ra | d 7} n | } | d j | � 7} | d j | � 7} | r� | d j t | � � 7} | d j t | � � 7} n t | � y& t | d | �j � j � | d <WnU t k
rOy& t | d | �j � j � | d <WqPt k
rKd
| d <qPXn X| d d j
d � stt | d <n | S(
u�
A private function used to issue the command to tomcat via the manager
webapp
cmd
the command to execute
url
The URL of the server manager webapp (example:
http://localhost:8080/manager)
opts
a dict of arguments
timeout
timeout for HTTP request
Return value is a dict in the from of::
{
res: [True|False]
msg: list of lines we got back from the manager
}
u resu msgu5 missing username and password settings (grain/pillar)i����u /u text/{0}u {0}u ?{0}t timeoutu Failed to create HTTP requesti u OK( t TrueR R t formatt
_urlencodet _install_openert _urlopent readt
splitlinest Exceptiont
startswith( t cmdt optst urlR9 R t autht url6( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt _wget� s6
&
&
c C@ sk yI i | d 6t | � | d d 6} d j t | | | d | �d � SWn t k
rf d j | � SXd S( uI
Simple command wrapper to commands that need only a path option
u pathu versionu
R9 u msgu% FAIL - No context exists for path {0}N( t lst joinRH RA R; ( RC t appRE R9 RD ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt _simple_cmd s '
c C@ s! t d i d d 6| d | �d S( u�
Find memory leaks in tomcat
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.leaks
u findleaksu trueu
statusLineR9 u msg( RH ( RE R9 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt leaks s c C@ s t d i | d | �d S( uE
Used to test if the tomcat manager is up
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.status
salt '*' tomcat.status http://localhost:8080/manager
u listR9 u res( RH ( RE R9 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt status0 s c C@ s� i } t d d | d | �} | d t k r2 i S| d j d � x� | d D]� } | j d � } i | d d 6| d
d 6| d d
6d d 6| | d <| d j d � } t | � d k rN | d | | d d <qN qN W| S( u2
list all the deployed webapps
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.ls
salt '*' tomcat.ls http://localhost:8080/manager
u listu R9 u resu msgi u :i u modei u sessionsi u fullnameu versionu ##( RH R t popt splitR4 ( RE R9 R R t linet tmpt sliced( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyRI D s c C@ s t d | | d | �S( ub
Stop the webapp
app
the webapp context path
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.stop /jenkins
salt '*' tomcat.stop /jenkins http://localhost:8080/manager
u stopR9 ( RL ( RK RE R9 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt stopi s c C@ s t d | | d | �S( u_
Start the webapp
app
the webapp context path
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.start /jenkins
salt '*' tomcat.start /jenkins http://localhost:8080/manager
u startR9 ( RL ( RK RE R9 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt start s c C@ s t d | | d | �S( uh
Reload the webapp
app
the webapp context path
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.reload /jenkins
salt '*' tomcat.reload /jenkins http://localhost:8080/manager
u reloadR9 ( RL ( RK RE R9 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt reload_� s c C@ s t d | | d | �S( u�
return the status of the webapp sessions
app
the webapp context path
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.sessions /jenkins
salt '*' tomcat.sessions /jenkins http://localhost:8080/manager
u sessionsR9 ( RL ( RK RE R9 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt sessions� s c C@ s? t | d | �} x& | D] } | | k r | | d Sq Wd S( u�
return the status of the webapp (stopped | running | missing)
app
the webapp context path
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.status_webapp /jenkins
salt '*' tomcat.status_webapp /jenkins http://localhost:8080/manager
R9 u modeu missing( RI ( RK RE R9 t webappst i( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt
status_webapp� s
c C@ s� t d i | d | �} | d t k r7 i | d d 6Si } | d j d � x? | d D]3 } | j d � } | d j � | | d j � <qY W| S( uD
return details about the server
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.serverinfo
salt '*' tomcat.serverinfo http://localhost:8080/manager
u
serverinfoR9 u resu msgu errori u :i ( RH R RO RP t strip( RE R9 R R RQ RR ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt
serverinfo� s "c C@ s t d | | d | �S( ul
Undeploy a webapp
app
the webapp context path
url : http://localhost:8080/manager
the URL of the server manager webapp
timeout : 180
timeout for HTTP request
CLI Examples:
.. code-block:: bash
salt '*' tomcat.undeploy /jenkins
salt '*' tomcat.undeploy /jenkins http://localhost:8080/manager
u undeployR9 ( RL ( RK RE R9 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt undeploy� s u nou basec C@ s� d j t j j | � � } | d k r^ t j j | � sF d j | � St j j | | � } n t j j t j � | � } t } t j j
| � s� t } t d | | | � }
|
s� d Sy t d |
d � Wq� t
k
r� q� Xn | } i d j | � d 6| d 6} | rI| t k r$t | � n | } t | t � rI| | d
<qIn | d k rbd | d
<n t d | | d | �} d j | d � }
| r�t d | � n |
S( uM
Deploy a WAR file
war
absolute path to WAR file (should be accessible by the user running
tomcat) or a path supported by the salt.modules.cp.get_file function
context
the context path to deploy
force : False
set True to deploy the webapp even one is deployed in the context
url : http://localhost:8080/manager
the URL of the server manager webapp
saltenv : base
the environment for WAR file in used by salt.modules.cp.get_url
function
timeout : 180
timeout for HTTP request
temp_war_location : None
use another location to temporarily copy to war file
by default the system's temp directory is used
version : ''
Specify the war version. If this argument is provided, it overrides
the version encoded in the war file name, if one is present.
Examples:
.. code-block:: bash
salt '*' tomcat.deploy_war salt://salt-2015.8.6.war version=2015.08.r6
.. versionadded:: 2015.8.6
CLI Examples:
cp module
.. code-block:: bash
salt '*' tomcat.deploy_war salt://application.war /api
salt '*' tomcat.deploy_war salt://application.war /api no
salt '*' tomcat.deploy_war salt://application.war /api yes http://localhost:8080/manager
minion local file system
.. code-block:: bash
salt '*' tomcat.deploy_war /tmp/application.war /api
salt '*' tomcat.deploy_war /tmp/application.war /api no
salt '*' tomcat.deploy_war /tmp/application.war /api yes http://localhost:8080/manager
u salt.{0}u Error - "{0}" is not a directoryu
cp.get_urlu# FAIL - could not cache the WAR fileu
file.set_modeu 0644u file:{0}u waru pathu versionu yesu trueu updateu deployR9 u
u msgu file.removeN( R; R R R0 R R RJ t tempfilet
gettempdirR t isfileR: t __salt__t KeyErrorR8 t
isinstancet
_string_typesRH ( R5 t contextt forceRE t saltenvR9 t temp_war_locationR7 t tfilet cachet cachedRD t deployedt res( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt
deploy_war s> ;
u u sha1c C@ su t t | � r t t | � p! d } | r_ | rO | j d j | | | � � q_ | j | � n | rq | j � pt t S( uk
This function replaces the $CATALINA_HOME/bin/digest.sh script
convert a clear-text password to the $CATALINA_BASE/conf/tomcat-users.xml
format
CLI Examples:
.. code-block:: bash
salt '*' tomcat.passwd secret
salt '*' tomcat.passwd secret tomcat sha1
salt '*' tomcat.passwd secret tomcat sha1 'Protected Realm'
u {0}:{1}:{2}N( t hasattrt hashlibt getattrR t updateR; t hexdigestR ( R( R' t algR% R/ ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyR( ~ s $ c C@ sg t � d } t d | � j � } x= | D]5 } | s< q* n d | k r* | j d � } | d Sq* Wd S( u�
Return server version from catalina.sh version
CLI Example:
.. code-block:: bash
salt '*' tomcat.version
u /bin/catalina.sh versionu cmd.runu Server versionu : i N( R
Ra R@ RP ( RC t outRQ t comps( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyR7 � s
c C@ s� t � d } i } t d | � j � } xP | D]H } | sB q0 n d | k r0 | j d � } | d j � | | d <q0 q0 W| S( u�
Return all server information from catalina.sh version
CLI Example:
.. code-block:: bash
salt '*' tomcat.fullversion
u /bin/catalina.sh versionu cmd.runu : i i ( R
Ra R@ RP t lstrip( RC R Ru RQ Rv ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt fullversion� s
c C@ s] i d d 6d d 6d d 6d d 6} | | k r2 d Sd j t � | | � } t d | � d S(
u�
Signals catalina to start, stop, securestart, forcestop.
CLI Example:
.. code-block:: bash
salt '*' tomcat.signal start
u stop -forceu forcestopu start -securityu securestartu startu stopNu {0}/bin/catalina.sh {1}u cmd.run( R; R
Ra ( t signalt
valid_signalsRC ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyRy � s
u __main__u foobaru barfoo1!u tomcat-manageru Config backwards compatibleu Config not backwards compatible(B t __doc__t
__future__R R R R R2 R Rp R^ t loggingt salt.ext.sixR Rd t salt.ext.six.moves.urllib.parseR R< t! salt.ext.six.moves.urllib.requestR R> R R) R R+ R R, R R= t salt.utils.dataR t getLoggert __name__t logt __func_alias__R R
R
R$ R R8 R RH RL RM RN RI RT RU RV RW RZ R\ R] R: Rn R( R7 Rx Ry R R R t old_format_credst new_format_credst infot ifno( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/tomcat.pyt <module>> s~ (
C% h
Mini Shell