From 01b4af1673832297cbf41734c1ff34aeaa0cbf07 Mon Sep 17 00:00:00 2001
From: Andrea Dell'Amico <adellam@isti.cnr.it>
Date: Wed, 5 Dec 2018 19:01:06 +0100
Subject: [PATCH] Thredds role: add some customisations options, needed by the
 aquamaps service. See https://support.d4science.org/issues/12927

---
 thredds/defaults/main.yml              |   1 +
 thredds/files/customPalettes.tar.gz    | Bin 0 -> 2953 bytes
 thredds/tasks/main.yml                 |  17 +++-
 thredds/templates/threddsConfig.xml.j2 |   3 +
 thredds/templates/wmsConfig.xml.j2     | 105 +++++++++++++++++++++++++
 5 files changed, 125 insertions(+), 1 deletion(-)
 create mode 100644 thredds/files/customPalettes.tar.gz
 create mode 100644 thredds/templates/wmsConfig.xml.j2

diff --git a/thredds/defaults/main.yml b/thredds/defaults/main.yml
index 8a6d9485..f4a7e818 100644
--- a/thredds/defaults/main.yml
+++ b/thredds/defaults/main.yml
@@ -19,3 +19,4 @@ thredds_email: ''
 thredds_host_institution_name: 'ORG'
 thredds_host_institution_web: ''
 thredds_force_ssl_for_user_data: False
+thredds_palettes_customisation: False
diff --git a/thredds/files/customPalettes.tar.gz b/thredds/files/customPalettes.tar.gz
new file mode 100644
index 0000000000000000000000000000000000000000..ef379e008a6a224938a5feeacda168b364f2c00a
GIT binary patch
literal 2953
zcmV;43wHD$iwFRSp7mP*1MON}Z(O$#&FdXN|AByB+J~$-{AN)UFi_ilNt(7lz*x&0
zTc|#qmF&PT`RzSt$dzQfj({eTP<RQ;JG_^7W=PJQIlQ~u&8wHE?>4Kq>(g)Ut9kEB
zN)De|v)=xkEmx;8)|jhS&CaVPE#EkQZyw!h?=G*_Te$LD^^BRg>(Bp_cIf`OdG#$r
zz##-SS63VH&byGa;LpuJlW|=h+ueQpo!k2K^}Xgk+g<seQv4+UeUAJ5e~@<Qei&)*
ze%xN1xhJP<tjEdLJ>Q(2ZB9?!A6|ZNo3r)Fsk=CL<?4<5{^I@S?B!<bg7@{0;#bW%
z=U3i2<$s6n{mBIs${}GyeZZwx>+QcCA!Y|HxHh{xjB$s@AJ*sdg60T4zqqS++n?T@
zT<*p}yE}Zn-E7V!_+*z5MI3l~a<*~v&QwTOK41bDKg&*~dH0LE*sjlCZ{%=78ZK@(
zuSBaifIFni<FdJpdyl<E_uAG!y<4BH-(KD)2r&Q4ujGFSW#)g-8Vl=x@nN6;577?Y
z6GXswh=6M#xXGdA@Xvk~UOYqdo|l)PftPvJuM+P3HQAlywDggoyzW=!#j~eR`gqD|
zsJnXw_Zpt7Q=@CijeCC?H!>AI_Nsh6?eg;KMJ)GA0q&~*HR-4PUp4RZ{~?+i+2>gy
zWptFutg{n3GkbQ((`uca+?=*DJ2g1%X?9u#IS8YpUR_W>JJ{TyQ=3MV^)R(5;v>YV
zO>=i4QJWST#4{X*kWr}C+R$l0mCj=$IvSwKSLZrZE5S?ADKM&?HVUSJ`M{0QL77K~
z!@{lugK%_o0%qCzu44vgC&GiWQxLP+njI_?R%djK&hE6OYW|H5r{H(m_;4?`I;Gy~
z#D1%zI|Z@rHf+r2x}!~Rb#lD!+_C@Q|KYw50C(koN#RreUxM!Q{~_9M<NqRGV)=v<
zWBWdR&ib+We5o*=oDxEINR!)t>2NR<{>m`{IzK-!Ohd?rX$aEYhX|_L$yvX2wxAyW
zg;U1VGVjBZ-@Qti=MH;#x@DgaeEc{+et)w0`BCeC<{Erb|3lfI{~x4XzwC2NhA7b$
zd<IFbvs?+uI|MI<#W<ucEXNR<G#7ZKN_P=sQbF*tY=x9X)um!Z9FH^OQWS-5J{bfI
zqi~!e>>a9WNC^C5ydicR#aR|n>O?^?JQ6HcL4{Tw90Ao-QKM0SB^Yspm?WTvppJwX
zg$0}t6Op~-GM<$id1q&o5Rrn#ih2lLSl=70g(jhq!x$$C<O6|hLC8`(x*<y>mEqVV
zoG^U|STTNZK#)iWsX--XBLyLNiNz=ZiBGItCx}fVr`?U(L|ba=mc-rQ*epq>n1u5(
zF$xu#h%Mrd;f|^#0+TnQWy?+i)`cG&<eMa0WU?foQF`Z#@DZC|7TOO3T}>y(`zXVb
zvAIk|9DtY@+zSOjaxt!?U|xKQ4-%ri38|qm!YY~k5&O}L6rw!#qh~=JXv#(z3u`~L
z^e7z1{pdjo#wkUWl8rNg$_cnv?=&c&N}zVynv~|65ktY|(kM7-^^OW!ma5KNOoCg9
zj5SJ)jt7nwq$Woe*HkKI#=BlBLl5pF&^aNan}`)1)VFrzh1MbsCLm;iao$SOU>ib|
zMkL4lr6m(oS~kH8BF!70W~f6z5;eyVt%6moWS7EuaZr}7gNrBWTud&cbmkJIAPCjy
zjj8wSBA@kwyupTpKMVGUWHUGE&2bYl^0bp;YG$H(SB<|433}r*$!brJR=U+kt6K^v
zP{OlP8S>R<qqCY>s)~_#1t_Q|7bgiu)^fMF)_?}}W*Rb#+O!IHUQ8c7AVMg2Es;P&
zW~^8$i{-nge%K{lrwt+nbC3%|tU!<iLjl-j&@z4q7i9F&LQCv;zy$(es9_h!6Pbuw
znFt~VDD)Yap&?l|fx|=2mSmVG<YKv}fDOi}z4ZWY;BQ`sT_OR;13Bz~Lp^{Fo(D`n
zutVdt8;FT<_yhD%gAX1TVAt@2dSI6T!g&EeG|u?~L6i`pmMFrtxAg&rs3p3cwjk?R
zPoN0l(bgF-qIQ&n4@xvnV_yIymX+KuAPM$t>?5E=)7)QRiCyEq15B{@BOZVz%DHl1
z0VirF9oPe&AcicgfG1=*^Z<B5D4+wLMIc*XdeWf6Xa$_m3n&4aAcz^&023YzBddcD
z)Zqf4M6IScAc+>s5&(%I4z9rpaRB3B1UN#_5Kc8YU<k4fNeBo*9wIG)Ambet0A#!k
z27VxWDL^@)#Q{B#;YfIZ2XY<|0PNs8b_eJHE)XXwOPFB?pu_46u0c7l1Cavk0L&0~
z03HNP>=4ica726pd;p?|S-=l&7W@Z*0LqAMKoAxyJOl{gSr}MRSSFjZ+!n)Pq#s~}
zM_*<Ka6}0t2wnh*#RB39NTS>mY&W2UWsmy-ECD(jU;|8m*#_f46FX|dEZ_wAZjhf@
zle-my%$jUv#F0tZi64)lCi_uJ04S&?R$zc9#=E08Ms3v{SINeUl_-D-1DS;jSc2MR
z<qS|_RTv=#B(ak`qAHOAj4}xvu}Vb|)^wCfpa?U>L|7w;Af|vJVUQWn72(SQ7G)ra
zl|5tz0K{GiAmGV23_n;ZgsI13Z+v4=0P+oj2NaTT5If)~`G%F#;K(;fI7lsEZAUm@
zEwn*HU~Rl+0ilv$pw9V;y>DP)hPAk(HxT0>J+KzjphB?5LS}#ou^4RvTm;J&7!<xa
zu$L#oS+StO6qdUXpM?-)H5roeH9!Oxf(SqomB{M=4}>jx0wd%ZD92)C1DPQPZ-`q7
zh6xV(v0K=D;hJX$-PkfLm>5{PFi%3df7|<r4F}#2m&fbV`}_sSoxlGWMfmpluco>`
z|2;%IbkBDY@X-%I{OzBAJhqejc5m(C_;`Kx;_dqKYIFK+^!I`ScjUj?!Qi9(4<+uu
z|9OxGp0l*JfD|8)dMu#k3pgM<xT<vlqd6cKSa57vP|?}Joz&6cu%Nh8M+cO0!6|5V
z3OZUA5QGDsZJ-*R7!G)dTzXqTnGSG9UV2%;Zz19{cwC0T4y`G}IEMEM_h2sc@hF%S
z^w5Ix3u!2dyhFPw@b7@fp2fbdPKm?f!U=$knKCG%Lf&Yjqsk6Vm!(HqvC&I~gXUdZ
zav%0Uf0xq6gh2F`%E@I6=Q?6I0vI|QCdK7|N~{eIN(ZE`@S<={xoWmZm~Uri4pXit
zoej1Rd?uS8jmEhQSS|Vl{*4*rrEn1%m#QwAe#1HNcykcTh%tU?ac*p>Saj|le5km`
zWi}rg_cqQBcQA+9DTTW*JJb>V=yd)YV)jeM@;!DO@7w>@e%x%go2$qD{y)ag_+Kdd
z-~T*FJ9PirY}}ixtG9nTI@$%p+2(Y0ez9J!USGUF`rF^Xd-}tZ=TDEGJ^9Dc>+SmO
zo0H?qqsbLtyu5gK{_1k|=IZS9%fAKmEBiir6|QfLF9KKg74@p{zsSq;%R0Mm|NAj~
ze%q$=ftwrr3e6OJboHzF<=*epjQ`#94*>4sfB)tCKcDyC|363rdx&5xo;(Rm<61_w
zr_6${X~@YBsuOh*yy_SHyOzO}j2|i}frdOg-e|+nRP$hXq-Y#O%9V^#3^_n1^&t}*
zVz?3GjhJr4Iz_URKFyFg`l-68u{v{-av&j{GS!er7JH7*44L$+>X7Mvf}D%#R}xYq
zP2MP;Q6_WQW@N*C8Pf)NMTd(Mh5;L8&V#3RqsXMF;BkJEMaagt=nWUh*tT)nWhVx1
zz>rA?i_tq!z&sxfgMxF+a99`HxWe^LOWw(#mVA~h9c-@7J#1kxTI>{vY%{+wuq|zJ
zQ>+`krH4C<*f}^8+b|e)*seEXz7gY%7_P;~&VhZ~w|(2Uud)3HCpu>D06G8wV84)y

literal 0
HcmV?d00001

diff --git a/thredds/tasks/main.yml b/thredds/tasks/main.yml
index e9cc52fb..a10a1a64 100644
--- a/thredds/tasks/main.yml
+++ b/thredds/tasks/main.yml
@@ -26,7 +26,7 @@
       template: src={{ item[1] }}.j2 dest={{ thredds_data_content_dir }}/thredds/{{ item[1] }} owner={{ item.0.user }} group={{ item.0.user }} mode=644
       with_nested: 
         - '{{ tomcat_m_instances }}'      
-        - ['threddsConfig.xml','catalog.xml']        
+        - [ 'threddsConfig.xml', 'catalog.xml', 'wmsConfig.xml' ]        
       notify: tomcat instances restart
       when: not thredds_skip_conf.stat.exists
       tags: [ 'thredds', 'tomcat', 'thredds_conf' ]
@@ -36,6 +36,21 @@
       register: thredds_skip_conf
       tags: [ 'thredds', 'tomcat', 'thredds_conf' ]
 
+    - name: Create the custom palettes directory
+      file: dest={{ thredds_data_content_dir }}/thredds/customPalettes state=directory  owner={{ item.user }} group={{ item.user }}
+      when: thredds_palettes_customisation
+      with_items: '{{ tomcat_m_instances }}'
+      tags: [ 'thredds', 'tomcat', 'thredds_custom_palettes' ]
+
+    - name: Install the custom palettes
+      unarchive: src=customPalettes.tar.gz  dest={{ thredds_data_content_dir }}/thredds/customPalettes/ remote_src=no  owner={{ item.user }} group={{ item.user }}
+      args:
+        creates: '{{ thredds_data_content_dir }}/thredds/customPalettes/occam.pal'
+      with_items: '{{ tomcat_m_instances }}'
+      notify: tomcat instances restart
+      when: thredds_palettes_customisation
+      tags: [ 'thredds', 'tomcat', 'thredds_custom_palettes' ]
+
     - name: Get the thredds war file
       maven_artifact: artifact_id={{ thredds_name }} version={{ thredds_version | default(omit) }} group_id={{ thredds_group_id }} extension={{ thredds_extension | default('war') }} repository_url={{ thredds_repository_url }} dest={{ thredds_download_directory }}/{{ thredds_file }}
 
diff --git a/thredds/templates/threddsConfig.xml.j2 b/thredds/templates/threddsConfig.xml.j2
index 2001d53a..5e282fec 100644
--- a/thredds/templates/threddsConfig.xml.j2
+++ b/thredds/templates/threddsConfig.xml.j2
@@ -200,6 +200,9 @@
     <allowRemote>false</allowRemote>
     <maxImageWidth>2048</maxImageWidth>
     <maxImageHeight>2048</maxImageHeight>
+    {% if thredds_palettes_customisation %}
+    <paletteLocationDir>customPalettes</paletteLocationDir>
+    {% endif %}
   </WMS>
   
 
diff --git a/thredds/templates/wmsConfig.xml.j2 b/thredds/templates/wmsConfig.xml.j2
new file mode 100644
index 00000000..5b94dfbf
--- /dev/null
+++ b/thredds/templates/wmsConfig.xml.j2
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Detailed configuration of the WMS service.  This config file can be used to
+set default styling parameters for each dataset/variable, and to enable or disable
+the GetFeatureInfo operation.
+
+See http://www.resc.reading.ac.uk/trac/myocean-tools/wiki/WmsDetailedConfiguration
+for more information.
+-->
+<!DOCTYPE wmsConfig [
+
+<!ELEMENT wmsConfig (global, overrides?)>
+
+<!ELEMENT global (defaults, standardNames?)>
+
+<!ELEMENT defaults (allowFeatureInfo, defaultColorScaleRange, defaultPaletteName, defaultNumColorBands, logScaling)>
+
+<!ELEMENT standardNames (standardName*)>
+
+<!ELEMENT standardName (defaultColorScaleRange?, defaultPaletteName?, defaultNumColorBands?, logScaling?)>
+<!ATTLIST standardName name CDATA #REQUIRED>
+<!ATTLIST standardName units CDATA #REQUIRED>
+
+<!ELEMENT overrides (datasetPath*)>
+
+<!ELEMENT datasetPath (pathDefaults?, variables?)>
+<!ATTLIST datasetPath pathSpec CDATA #REQUIRED>
+
+<!ELEMENT pathDefaults (allowFeatureInfo?, defaultColorScaleRange?, defaultPaletteName?, defaultNumColorBands?, logScaling?)>
+
+<!ELEMENT variables (variable*)>
+
+<!ELEMENT variable (defaultColorScaleRange?, defaultPaletteName?, defaultNumColorBands?, logScaling?)>
+<!ATTLIST variable id CDATA #REQUIRED>
+
+<!ELEMENT allowFeatureInfo (#PCDATA)>
+<!ELEMENT defaultColorScaleRange (#PCDATA)>
+<!ELEMENT defaultPaletteName (#PCDATA)>
+<!ELEMENT defaultNumColorBands (#PCDATA)>
+<!ELEMENT logScaling (#PCDATA)>
+]>
+<wmsConfig>
+
+    <global>
+        <!-- These settings apply to all datasets unless overridden below -->
+
+        <defaults>
+            <!-- The global defaults. All elements are mandatory -->
+            <allowFeatureInfo>true</allowFeatureInfo>
+            <defaultColorScaleRange>-50 50</defaultColorScaleRange>
+            <defaultPaletteName>rainbow</defaultPaletteName>
+            <defaultNumColorBands>20</defaultNumColorBands>
+            <logScaling>false</logScaling>
+        </defaults>
+
+        <standardNames>
+            <!-- Use this section to set defaults per standard name -->
+            <!-- Units must come from the UDUNITS vocabulary -->
+            <standardName name="sea_water_potential_temperature" units="K">
+                <defaultColorScaleRange>268 308</defaultColorScaleRange>
+            </standardName>
+            <standardName name="sea_water_temperature" units="K">
+                <defaultColorScaleRange>268 308</defaultColorScaleRange>
+            </standardName>
+            <standardName name="mass_concentration_of_chlorophyll_in_sea_water" units="kg m-3">
+                <logScaling>true</logScaling>
+            </standardName>
+            <!-- TODO: how about allowing "*fraction" to map to 0:1? -->
+            <!-- TODO: how about allowing multiple standard names to map to the same settings,
+                 either through a glob expression or through a list? -->
+        </standardNames>
+    </global>
+
+    <overrides>
+        
+        <datasetPath pathSpec="testAll/*eta_211.nc">
+            <!-- Will apply to all paths that match the path spec above -->
+            <pathDefaults>
+                <!-- These will apply to all variables in this path unless overridden below -->
+                <allowFeatureInfo>false</allowFeatureInfo>
+                <defaultPaletteName>occam</defaultPaletteName>
+            </pathDefaults>
+
+            <variables>
+                <!-- Configure variables individually according to their internal ID.
+                     This is the most specific setting and will override any others -->
+                <variable id="Z_sfc">
+                    <defaultColorScaleRange>10 20</defaultColorScaleRange>
+                </variable>
+            </variables>
+        </datasetPath>
+
+        {% if thredds_palettes_customisation %}
+        <datasetPath pathSpec="public/netcdf/AquaMaps*/*.nc">
+            <pathDefaults>
+                <defaultColorScaleRange>0 1</defaultColorScaleRange>
+                <defaultPaletteName>aquamaps</defaultPaletteName>
+                <defaultNumColorBands>5</defaultNumColorBands>
+            </pathDefaults>
+        </datasetPath>
+        {% endif %}
+        
+    </overrides>
+
+</wmsConfig>