| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.5"/> |
| <title>Apache Mesos: src/slave/containerizer/mesos/provisioner/backends/bind.hpp Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_80f0d4a0945c74dfa611dba2ec326a39.html">slave</a></li><li class="navelem"><a class="el" href="dir_fbb1f3397356a940a2dbc4baf07ee5bb.html">containerizer</a></li><li class="navelem"><a class="el" href="dir_06602996fd31a3e264808d1450975cb2.html">mesos</a></li><li class="navelem"><a class="el" href="dir_f319675d4a0209ee44e08f6c8dad3e25.html">provisioner</a></li><li class="navelem"><a class="el" href="dir_d77c8f8e469340eab433d8e642b86d28.html">backends</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">bind.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="bind_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __PROVISIONER_BACKENDS_BIND_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __PROVISIONER_BACKENDS_BIND_HPP__</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="backend_8hpp.html">slave/containerizer/mesos/provisioner/backend.hpp</a>"</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>mesos {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>internal {</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>slave {</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Forward declaration.</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>BindBackendProcess;</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// This is a specialized backend that may be useful for deployments</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// using large (multi-GB) single-layer images *and* where more recent</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// kernel features such as overlayfs are not available (overlayfs-based</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// backend tracked by MESOS-2971). For small images (10's to 100's of MB)</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// the copy backend may be sufficient. NOTE:</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// 1) BindBackend supports only a single layer. Multi-layer images will</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// fail to provision and the container will fail to launch!</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// 2) The filesystem is read-only because all containers using this</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// image share the source. Select writable areas can be achieved by</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// mounting read-write volumes to places like /tmp, /var/tmp,</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// /home, etc. using the ContainerInfo. These can be relative to</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// the executor work directory.</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// N.B. Since the filesystem is read-only:</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// i. The '--sandbox_directory' must already exist within the</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// filesystem because the filesystem isolator is unable to</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// create it!</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// ii. The 'tmpfs' moint point '/tmp' must already exist within</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// the filesystem, because 'pivot_root' needs a mount point</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// for the old root.</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// 3) It's fast because the bind mount requires (nearly) zero IO.</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html">BindBackend</a> : <span class="keyword">public</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1Backend.html">Backend</a></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> {</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">virtual</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#a8882f2786d4113cd1ec713e1f9da89b4">~BindBackend</a>();</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// BindBackend doesn't use any flag.</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">static</span> <a class="code" href="classTry.html">Try<process::Owned<Backend></a>> <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#adbdd753e01959bc93d459580e5dd25c8">create</a>(<span class="keyword">const</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1Flags.html">Flags</a>&);</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">process::Future<Nothing></a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#a2dd8bcf080e7dfcf4e2787b4f32a7476">provision</a>(</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> std::vector<std::string>& layers,</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">const</span> std::string& rootfs,</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> std::string& backendDir);</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">process::Future<bool></a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#a0bdbea56c92f73b5dd8e477d9f08ceaa">destroy</a>(</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> std::string& rootfs,</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> std::string& backendDir);</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">explicit</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html">BindBackend</a>(<a class="code" href="classprocess_1_1Owned.html">process::Owned<BindBackendProcess></a> process);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html">BindBackend</a>(<span class="keyword">const</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html">BindBackend</a>&); <span class="comment">// Not copyable.</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html">BindBackend</a>& operator=(<span class="keyword">const</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1BindBackend.html">BindBackend</a>&); <span class="comment">// Not assignable.</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classprocess_1_1Owned.html">process::Owned<BindBackendProcess></a> process;</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> };</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> } <span class="comment">// namespace slave {</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> } <span class="comment">// namespace internal {</span></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// namespace mesos {</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif // __PROVISIONER_BACKENDS_BIND_HPP__</span></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1BindBackend_html_a2dd8bcf080e7dfcf4e2787b4f32a7476"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#a2dd8bcf080e7dfcf4e2787b4f32a7476">mesos::internal::slave::BindBackend::provision</a></div><div class="ttdeci">virtual process::Future< Nothing > provision(const std::vector< std::string > &layers, const std::string &rootfs, const std::string &backendDir)</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1BindBackend_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1BindBackend.html">mesos::internal::slave::BindBackend</a></div><div class="ttdef"><b>Definition:</b> bind.hpp:50</div></div> |
| <div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> try.hpp:34</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1Flags_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1Flags.html">mesos::internal::slave::Flags</a></div><div class="ttdef"><b>Definition:</b> flags.hpp:38</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1Backend_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1Backend.html">mesos::internal::slave::Backend</a></div><div class="ttdef"><b>Definition:</b> backend.hpp:36</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1BindBackend_html_a8882f2786d4113cd1ec713e1f9da89b4"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#a8882f2786d4113cd1ec713e1f9da89b4">mesos::internal::slave::BindBackend::~BindBackend</a></div><div class="ttdeci">virtual ~BindBackend()</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1BindBackend_html_a0bdbea56c92f73b5dd8e477d9f08ceaa"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#a0bdbea56c92f73b5dd8e477d9f08ceaa">mesos::internal::slave::BindBackend::destroy</a></div><div class="ttdeci">virtual process::Future< bool > destroy(const std::string &rootfs, const std::string &backendDir)</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1BindBackend_html_adbdd753e01959bc93d459580e5dd25c8"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1BindBackend.html#adbdd753e01959bc93d459580e5dd25c8">mesos::internal::slave::BindBackend::create</a></div><div class="ttdeci">static Try< process::Owned< Backend > > create(const Flags &)</div></div> |
| <div class="ttc" id="backend_8hpp_html"><div class="ttname"><a href="backend_8hpp.html">backend.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Owned_html"><div class="ttname"><a href="classprocess_1_1Owned.html">process::Owned< BindBackendProcess ></a></div></div> |
| <div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future< Nothing ></a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
