f1xska

<h1>Gendoc - Generic Docker Compose Stack apps (DCS)</h1>
<div class="level1">

<p>
gendoc is CatchMedia specific set of conventions and aliases to manage Docker Compose Stack applications (DCS).
</p>

<p>
See also: <a href="/doku.php?id=topic:dap" class="wikilink1" title="topic:dap" data-wiki-id="topic:dap">Docker Apps with Persistency</a> - DCS+keepalived+haproxy
</p>

<p>
We try to use gendoc/dcs instead of k8 because k8-based apps are notoriously harder to setup, manage and backup. The complexity price for HA and scalability just does not pay off for most applications we use.
</p>

</div>

<h2>Conventions</h2>
<div class="level2">
<ul>
<li class="level1"> aliases entity is installed</li>
<li class="level1"> DCS app has /opt/DCS_NAME/docker-compose.yml file</li>
<li class="level1"> The DCS might require dedicated IP using macvlan. If dedicated outbound source IP is needed, then    Firewall→NAT→Outbound tuning on FW might be necessary</li>
<li class="level1"> docker-compose.yml might have additional custom fields:<pre class="code">x-ska:
  start_on_boot: "no"
  on_demand_port: 25565

</pre><p> </p>
</li>
<li class="level1"> for DCS with persistency, /opt/DCS_NAME should be separate LVM volume, mounted on boot. Same for production-grade apps, to protect from disk full situations.</li>
<li class="level1"> systemd service gendoc starts DCS apps with start_on_boot=yes</li>
</ul>

</div>

<h2>Aliases</h2>
<div class="level2">

<p>
Aliases are actually scripts that sit in /opt/aliases/bin (should be in PATH). They must be run from the home directory of DCS - /opt/DCS_NAME, for example /opt/pamail
</p>
<ul>
<li class="level1"> <code>dcup</code> - start DCS app</li>
<li class="level1"> <code>dcdown</code> - stop DCS app</li>
<li class="level1"> <code>dclog</code> - see runtime log</li>
<li class="level1"> <code>dcch</code> - try to run bash or sh inside of the container (if container has shell in it). If you must get in as root, use this cmd (example for mysql_padb_a1): <code>docker exec -u 0 -it mysql_padb_a1 /bin/bash -l</code></li>
<li class="level1"> <code>dcii</code> - see information on the DCS</li>
<li class="level1"> <code>dcmy</code> - for mysql containers - connect to mysql server using mysql CLI</li>
<li class="level1"> <code>dcmyv</code> - for mysql containers - connect to mysql server using mysql CLI over Virtual IP</li>
<li class="level1"> <code>dcrc</code> - for redis containers - connect to redis server using redis CLI</li>
<li class="level1"> <code>docps</code> - See list of DCS running: docps</li>
</ul>

</div>

Enable Complex Tables Editor Height px Turn supplementary image paste support on

Edit summary: Minor changes