From 21b48f382c61a5b67092e950c99908ae2572ab86 Mon Sep 17 00:00:00 2001 From: Falk Werner Date: Sun, 14 Apr 2019 14:56:27 +0200 Subject: [PATCH] updates documentation --- README.md | 21 +++++++++++++++++++++ doc/filesystem.png | Bin 0 -> 5354 bytes doc/filesystem.uml | 16 ++++++++++++++++ 3 files changed, 37 insertions(+) create mode 100644 doc/filesystem.png create mode 100644 doc/filesystem.uml diff --git a/README.md b/README.md index b7d9803..6c2c236 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,27 @@ A reference implementation of such a daemon is provided within the examples. The Currently all requests are initiated by webfuse daemon and responded by filesystem provider. This may change in future, e.g. when authentication is supported. +### Filesystem represenation + +![filesystem](doc/filesystem.png) + +To handle multiple filesystems, that are registered by one or more providers, webfuse daemon maintains a directory structure as shown above. + +- **mount_point** is the entry point of the drectory structure + +- **fwupdate** is a name defined by the provider when filesystem was registered + *Note: the picture above shows two providers, where both registered a filesystem named "fwupdate"* + +- **<uuid>** is the filesystem id choosen by webfuse daemon to distinguish different filesystems + +- **default** is a symbolic link maintained by webfuse daemon to identify the default filesystem + + +This directoy structure allows to handle multiple filesystems registered by multiple providers. +It can be used as a kind of service registry, where each filesystem represents a service. +The named subdirectores distinguish differend service types. The symbolic link *default* can be used to identify the +default service and the listing of a named subdirectory can be used to list available services of a particular type. + ## Similar Projects ### Davfs2 diff --git a/doc/filesystem.png b/doc/filesystem.png new file mode 100644 index 0000000000000000000000000000000000000000..4b4106a5baa940e2e070fac600acdbbf8f44384c GIT binary patch literal 5354 zcmZWtc|6o_*S4=?8A~RblCh3tkTAArG?ub&m2I*{2s3usqcA0F3WMxxveVcK*%|v1 zij1AIgwp%f?|Gm1`Ml3Rv)jVCQKmd8ecq>vnF#iL*yaUXZY}z zWB<#>#@fbN%l>6H&zI=|{WCIN%|338`T4JGAdh#@a_>Sh5Mh)#8u-Gz#?X#g98SA8%ie8Ysv_xn-CeWr0eO9SNVO6zV&L70 zV7xAme36hK3rFHiT?Raa8pt;onoF)^{P9dRzMu1P^PuG6N5hA-mdr2>C$ z*UmkwLnqm>{GRSAUfmN#xTxNRsMufMCz zr+i)aa6$cHd{Ppw6YBHp$AD@jbgyh5hH12g(0$B>{c-JdiaM^StE;Q8ug}W5sHn)d zIU2_&w>e$AHLN39T38s$>gwuBkRBZ!m5`8d87tA!(J3x3=h20pm2v1TZ$4>o8NXcj z-mJv@;+&Z z5wF}DwB&K9vl0D($Im-6Mh;SqRI|@Gm;*okBl5 zuk5oq(|mHo%xh$5sD!f{DKNm{aGlRCr2MH4i!0+nn>TizeXcLpsa5fdE8fg%T8%x9+o0|4#C^wdt_WdFl?Tmm= z49~Ws;`+zqpKyv0e}0K^aB*x0z}{XLS<}3Kzwk(b97fCB@$7=+w3nBcd))$^UtqUb z{)3r11Nmm*XAV0jyCgk;;P3tSc;(z?62*)X@v*$JOfy0vBJKI##T~uBZ)PY5*iZx= z?Vi2jG$=Em1kOy}f|%vT}0mvx*PruT4%g`nWrB z=|a`s`9`rqkw6m0#>RX;`_cEy?!$mz?o`@oSy^QS<_;ggfNV&@;SFnLjr$wZ2S7=% zot0h$q8=Quhjg%gMt-^GjnFkf3Q*l;o8WIc{Pv2Qo12!F_95H&=%^)b)a1KS6n^5i z%v|7)TXV#q(Px(3-Q9x+X(T<>ptZ5m>>PaHpWg@kR;x41nZYMxciml8!vS6JB}Y?R z-oj#`Vv>^9RZc@Cx8GR>|K3|&UA6B?Ze{re>`ady6nW2aCydbY8FiKFo#TKhl4_cL z;@JtC^9o*0nlXoCTf1ZGBc26Jx~3#KcTXNCA4YjXNdpkO4Yb(wepLSv(BA zIaAMRCFDjt{MH&yUpze>e-g8a2CB?)3vF{isZO1F^7~+J+q&YA4q?;M`%Or z5YybeJl1pa4?n#SD*FBY;IsIpOE-0N6aiT^E4M10s&$*aV_^Z>aD46Y7)~vU>{v*# zegr7DmY&|$T(c^Tz5^t>rTo+4^O4L~8h(4DW&jJ*;^Per3_Qq#7bhV__`2oX!a~N& zSyfddzxYGk9NQnW0Gy6=`P9>Mml){RiN9RHuOB+PV}V1mhC2zG*eRtvg$k`^pOcBf ztKFN=~$%QRLwu^I~z6qIXPy3uBZB&i|!AQy1?BbbfvN})MG&B_U*}3Dci6iFa(aG zqx&)Gn5hnk*RtCVFRLB%t=tK7SCYq>z3HFGU3EwQ7cA8gP01syJ>V8#h2jV|M5eC|ze-RFn^ zMG>uoo~jM8$mX7&~W4+zu8YNb?}a=6q`!G0Z@bF2&OOWg1K|m2Q(?)7XYqnL-bZ zY*4%M!q_f0S0GxnUa~vmHWtJ&OZm8P2tD<^XlnfN!~McAig6r-I7n8Iz=11#&56lM6rk@aHyWP%KqipQX;r zp)XBHh7m<(9NTZwoWDrtRqM5^8$_$PUcg$xxiVg!8B5K3liG(J)!AZ5&Cn6AE=P_Q z&PVx5{0$zu&ABmt!Bx) zH6S;eRL#z3-SdyA$KeVEMB@4L!m9zbMPLWrl_8h%_sN-=>J z5A_HobR{c6i0nr>F70&0_4G=K#-%~K+oF#|4<5(Y%LTc zt)Wt{UIXMZRw+{vcQSOJKvrT`4DZv|ko*wX^qQf9QF_CK`qCJPPW~S2eBPFukY8?>Js9IBVWgGqA zK}Hu@atfm!x4e0^bJ8!Tk59R`i$tGYzg1!Sb!ek~!+-3yV=L|nUVH+BrpgcT@x9t| zV$I$<0<90Xp-<)w$%jqe|`Hx0way?=4{bDkmOwpO0m2(p@XhBPXz^vjs5i#&HQy z@KQQ2`9j)|R#i^%N~Rvqiz$=S9z=~k-1*2;Y((>xmuuVHRGbZThKsAq)>$=7H@Ri= zOxA4Z)5S%*g{mB*+qcDjR1Dgz%7=x}{dH9h!i5#w=z{1(K7H{uTX4TO+m^7dXqxk( zM$b}F+ZgvIuIs;C4Wpa&TTW-U-|M+b4>U_1Jv~+5ZGto9@#-x;fJ3+V^14qL73xx@ z?U}0hnhU7sJ$BoHDfe(W6PTtKLnx^enYrmxhe}FHL^6D-RGgii;c$4^%DBWtv08pZ z1FvcR3}d^Ij`EJWcEy>A*?Ts>0%@wLQxv?u-K-0qpWI$bu?`EzdHfKtJQa888Jn6iSK49ti(imx}NVNJpN&&QV9&TdTR!kCX7IY&%Jio;^bR z(eXwtFbVCikkEf};*Jlt=r!m=!!gBk6LNQC-=C4Rx}+NB!^Eyawl*}ZwC_1H3A72y z51Vbwk`a!~N_e;WrR3z~Gn1_2Wz(q4!wPe8I9ys4J@n%HaEQB z-&%b_61|d&bYedjnoBqDy@=4%7>))t7<1i79E{=E?KQO3hwKlHiZc95OA(+1-@oG@ z&wq4BT?XhRc;Qm7{tu&Hu_8ZrpEH0@TOo)Pi84VeCGfKpfHdHo@jvXtBbcbT&C{P_ zKVaD778zej@@)Ytu!Dk{)K{*@ccT^qZ}+EEOKM{VF3Hk8alK#}$J9>zI>q_oG6@W0 z9PV%0?bT0wNGyr?VL!`bKX3^NESmF@o!ZAK{jmRuR z1%>vf$S-p{2#EEZVgvSl=y=9+Y$$MSOtAT{jB%jRVFSlx zc$ii@Ce?S5W*A&Vr!is!#c*(s#gki+ZG!N(xiDkP;^!RB8iW~CZHpY(M9QXdtlZLI zg5veq$Ov$TaCCHJ?#(06#|pO@nzbT!bZ5w#nvB&PIgkqCg)BJJT8I&uG&1r=j?Ty? zRXakXJPgAT(zVJEIav+et>MB_F{ed26P{A8A=OQ|#whcFQ=k;D&?Z&8@fSvaZcqXR zN*~=u@m@lM%vkLtWn+mhc-n@XH~y_5t2Ti;waWAb4iTn|mVjoh?q%zF!r7AGbS2|Q zxqxZ1>Y3aJ+0@^DGk9f#?;_Pl*ZLTRvXcM)uYALp>#~HzXgVC41+2;Azzh}Jq|)%$ zU?YmgUvb`3m$(C(DAZz9u_Bg!6!%`rqTZkP0>e zlWHzJg{;g;V5;+XAVn~_`+Z4EO(UlA-o!@N;K{kJg`Q2ViKTlZ;Gzb&z0%M6TJh%O zq@+)h`IIkTzAQ@ruCZ79Hb?=13`p+6UDIGI&06aOa|?{bGyI}7TWR~5(?{M_pt~`N z&U$UQLAF6f>wb-KT8oCyuZngm!lEmy-Jl-EX1TFOUhcMLk0Q_9R_qA*7v@9k4V^_p z`RwJgEOB+LAep@$IvMgeIT4q1@((xs4~y`zFq`=|NJLi9Q{-|E|A+3z;bxzYAbz z)s_VS&<6X^@TzpfjS(Bse8y{Uu!7I=2a-1$;g{w`JH_v>nb#zDZ|?QZXcQOoc4*ja zDkpdhb(aeen793bW2k4p!g9f|Hq&%UV{^oJA*o^fYpk$`iXx>fTu`IL(Y?QvLK96wbunVsL<+*5q)M0*g8M zb?D%NwnjPycmI`UAJcTnZ-px*aZ}ZGDQ>|1OgNCbXO4>iiKA z#Ccz!0EP+qoGkE=eu^>Cn684q@@hR%vK@brJZ7 Za@|c+MQhBn1h~Vb(9+OFm8si={SRI2Miu}7 literal 0 HcmV?d00001 diff --git a/doc/filesystem.uml b/doc/filesystem.uml new file mode 100644 index 0000000..1b78837 --- /dev/null +++ b/doc/filesystem.uml @@ -0,0 +1,16 @@ +@startuml + +salt +{ +{T ++ mount_point +++ fwupdate ++++ default -> 7c029f81-6bdf-4d3c-82dc-26f748164012 ++++ 7c029f81-6bdf-4d3c-82dc-26f748164012 +++++ update.raucb ++++ f93de23b-4535-4a47-a287-a381b78a11b8 +++++ update.raucb +} +} + +@enduml \ No newline at end of file