zeus
/
swarmlab-hybrid
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

docs

master
zeus 3 years ago
parent
7aeb04c755
commit
41a47514da
2 changed files with 792 additions and 2459 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 216
      docs/README.adoc.html
  2. 3035
      docs/README.adoc.pdf

216
docs/README.adoc.html
View File

@ -449,29 +449,21 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<div id="toc" class="toc2">
<div id="toctitle">Table of contents</div>
<ul class="sectlevel1">
<li><a href="#_install">1. Install</a>
<li><a href="#_startstop_agent">1. Start/Stop Agent</a>
<ul class="sectlevel2">
<li><a href="#_prerequisites_hardware">1.1. Prerequisites Hardware</a></li>
<li><a href="#_prerequisites_keys">1.2. Prerequisites Keys</a></li>
<li><a href="#_download_and_install">1.3. Download and install</a></li>
<li><a href="#_start_agent">1.1. Start Agent</a></li>
<li><a href="#_stop_agent">1.2. Stop Agent</a></li>
</ul>
</li>
<li><a href="#_startstop_agent">2. Start/Stop Agent</a>
<li><a href="#_config">2. Config</a></li>
<li><a href="#_deploy">3. Deploy</a>
<ul class="sectlevel2">
<li><a href="#_start_agent">2.1. Start Agent</a></li>
<li><a href="#_stop_agent">2.2. Stop Agent</a></li>
<li><a href="#_login">2.3. Login</a></li>
<li><a href="#_privatelocal">3.1. Private/Local</a></li>
<li><a href="#_hybrid">3.2. Hybrid</a></li>
</ul>
</li>
<li><a href="#_config">3. Config</a></li>
<li><a href="#_deploy">4. Deploy</a>
<ul class="sectlevel2">
<li><a href="#_local">4.1. Local</a></li>
<li><a href="#_hybrid">4.2. Hybrid</a></li>
</ul>
</li>
<li><a href="#_join">5. Join</a></li>
<li><a href="#_connect_to_container">6. Connect to Container</a></li>
<li><a href="#_join">4. Join</a></li>
<li><a href="#_connect_to_container">5. Connect to Container</a></li>
</ul>
</div>
</div>
@ -529,158 +521,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
</div>
<div class="sect1">
<h2 id="_install">1. Install</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_prerequisites_hardware">1.1. Prerequisites Hardware</h3>
<div class="ulist">
<ul>
<li>
<p>A Linux Server (Virtual or Physical)</p>
<div class="ulist">
<ul>
<li>
<p>You must have super user privileges (sudo)</p>
</li>
</ul>
</div>
</li>
<li>
<p>Docker Engine- Community version 18 or later is required.</p>
<div class="ulist">
<ul>
<li>
<p>Docker Engine is supported on x86_64 (or amd64), armhf, and arm64 architectures.</p>
</li>
</ul>
</div>
</li>
<li>
<p>RAM</p>
<div class="ulist">
<ul>
<li>
<p>Absolute minimum to run the daemon and some very light containers - 512MB</p>
</li>
<li>
<p>Minimum for “comfortable” usage – 2GB</p>
</li>
</ul>
</div>
</li>
<li>
<p>CPU</p>
<div class="ulist">
<ul>
<li>
<p>Minimum: 2; Recommended 4+.</p>
</li>
</ul>
</div>
</li>
<li>
<p>Disk Space</p>
<div class="ulist">
<ul>
<li>
<p>10 GB for internal requirements.</p>
</li>
<li>
<p>The amount of additional disk space required for load file staging, persistence, or backups depends on the size of the data to be loaded.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Docker uses a hypervisor with a VM, and the host server must support virtualization.
</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="title">Remember</div>
<div class="paragraph">
<p>Before you create and configure a hybrid deployment using the swarmlab-agent client, your Local Machines <strong>need to meet certain requirements.</strong></p>
</div>
<div class="paragraph">
<p>If you don&#8217;t meet those requirements, you won&#8217;t be able to complete the steps within the swarmlab-agent client</p>
</div>
<div class="paragraph">
<p>and you won&#8217;t be able to configure a hybrid deployment between your Local Enviroment and Swarmlab Online Enviroment.</p>
</div>
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_prerequisites_keys">1.2. Prerequisites Keys</h3>
<div class="ulist">
<ul>
<li>
<p>Create an Hybrid Swarmlab Key</p>
<div class="ulist">
<ul>
<li>
<p>Connect to <a href="https://api-client.swarmlab.io:8088/" class="bare">https://api-client.swarmlab.io:8088/</a> and click on the Dashboard&#8594;Profile Menou</p>
</li>
</ul>
</div>
</li>
<li>
<p>After creating Keys for your project, you will be informed with an email and it will also become visible in the Swarmlab-agent clients corresponding menu.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="_download_and_install">1.3. Download and install</h3>
<div class="ulist">
<ul>
<li>
<p>Download the swarmlab-agent client</p>
<div class="ulist">
<ul>
<li>
<p>git clone <a href="https://git.swarmlab.io:3000/zeus/swarmlab-hybrid.git" class="bare">https://git.swarmlab.io:3000/zeus/swarmlab-hybrid.git</a></p>
</li>
</ul>
</div>
</li>
<li>
<p>Run sudo ./install.sh</p>
<div class="ulist">
<ul>
<li>
<p>See also ./install directory</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_startstop_agent">2. Start/Stop Agent</h2>
<h2 id="_startstop_agent">1. Start/Stop Agent</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_start_agent">2.1. Start Agent</h3>
<h3 id="_start_agent">1.1. Start Agent</h3>
<div class="ulist">
<ul>
<li>
@ -697,7 +541,7 @@ Docker uses a hypervisor with a VM, and the host server must support virtualizat
</div>
</div>
<div class="sect2">
<h3 id="_stop_agent">2.2. Stop Agent</h3>
<h3 id="_stop_agent">1.2. Stop Agent</h3>
<div class="ulist">
<ul>
<li>
@ -713,28 +557,10 @@ Docker uses a hypervisor with a VM, and the host server must support virtualizat
</ul>
</div>
</div>
<div class="sect2">
<h3 id="_login">2.3. Login</h3>
<div class="paragraph">
<p>Connect to <a href="https://api-client.swarmlab.io:8088/" class="bare">https://api-client.swarmlab.io:8088/</a> and click on "Hybrid&#8594;OpenSwarmlab Hybrid" Menou</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
This is the way to have a fully functional Swarmlab Cloud. You HAVE to connect this way to be Authorized for the session.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_config">3. Config</h2>
<h2 id="_config">2. Config</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
@ -743,10 +569,10 @@ This is the way to have a fully functional Swarmlab Cloud. You HAVE to connect t
<div class="ulist">
<ul>
<li>
<p>add also a zone for your agent</p>
<p>click on "Load Settings" 1st</p>
</li>
<li>
<p>Connect to <a href="https://api-client.swarmlab.io:8088/" class="bare">https://api-client.swarmlab.io:8088/</a> and click on the Dashboard&#8594;Profile Menou</p>
<p>add also a zone for your agent</p>
</li>
</ul>
</div>
@ -756,10 +582,10 @@ This is the way to have a fully functional Swarmlab Cloud. You HAVE to connect t
</div>
</div>
<div class="sect1">
<h2 id="_deploy">4. Deploy</h2>
<h2 id="_deploy">3. Deploy</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_local">4.1. Local</h3>
<h3 id="_privatelocal">3.1. Private/Local</h3>
<div class="openblock float-group">
<div class="content">
<div class="videoblock left">
@ -793,7 +619,7 @@ This is the way to have a fully functional Swarmlab Cloud. You HAVE to connect t
</div>
</div>
<div class="sect2">
<h3 id="_hybrid">4.2. Hybrid</h3>
<h3 id="_hybrid">3.2. Hybrid</h3>
<div class="ulist">
<ul>
<li>
@ -833,7 +659,7 @@ This is the way to have a fully functional Swarmlab Cloud. You HAVE to connect t
</div>
</div>
<div class="sect1">
<h2 id="_join">5. Join</h2>
<h2 id="_join">4. Join</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
@ -851,7 +677,7 @@ This is the way to have a fully functional Swarmlab Cloud. You HAVE to connect t
</div>
</div>
<div class="sect1">
<h2 id="_connect_to_container">6. Connect to Container</h2>
<h2 id="_connect_to_container">5. Connect to Container</h2>
<div class="sectionbody">
<div class="videoblock">
<div class="title">.Connect to container (Host&#8594;container) 7:25 - 12:20</div>
@ -876,7 +702,7 @@ This is the way to have a fully functional Swarmlab Cloud. You HAVE to connect t
</div>
<div id="footer">
<div id="footer-text">
Last updated 2021-02-02 16:52:36 UTC
Last updated 2021-03-01 22:25:50 UTC
</div>
</div>
</body>

3035
docs/README.adoc.pdf
View File

File diff suppressed because it is too large
Write Preview
Loading…
Cancel
Save