Author: |
LasLabs |
License: |
AGPL-3 |
Branch: |
10.0 |
Repository: |
Develoman/odoo-connector-rancher |
Dependencies: |
component,
component_event,
connector,
infrastructure,
and
queue_job |
Languages: |
Python (1825, 2.3%),
XML (106, 0.1%),
YAML (76813, 97.4%),
and
reStructuredText (85, 0.1%) |
Other repositories: |
LasLabs/odoo-connector-rancher,
lasley/odoo-connector-rancher,
and
westlyou/odoo-connector-rancher |
<a class="reference external image-reference" href="https://www.gnu.org/licenses/agpl"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.svg">
</a>
<a name="rancher-connector"></a>
<h2>Rancher Connector</h2>
<p>This module allows for you to synchronize Odoo and Rancher.</p>
<p>This is a beta module, and we do not recommend that you use it in production.</p>
<table class="docutils">
<colgroup>
<col width="47%" />
<col width="18%" />
<col width="18%" />
<col width="18%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Object</th>
<th class="head">Import</th>
<th class="head">Export</th>
<th class="head">Delete</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>Environment</td>
<td>Yes</td>
<td>No</td>
<td>No</td>
</tr>
<tr><td>Host</td>
<td>Yes</td>
<td>No</td>
<td>No</td>
</tr>
<tr><td>Stack</td>
<td>Yes</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr><td>Service</td>
<td>Yes</td>
<td>No</td>
<td>No</td>
</tr>
<tr><td>Container</td>
<td>Yes</td>
<td>No</td>
<td>No</td>
</tr>
<tr><td>Catalog Templates</td>
<td>Yes</td>
<td>No</td>
<td>No</td>
</tr>
</tbody>
</table>
<a name="installation"></a>
<h3>Installation</h3>
<p>To install this module, you need to:</p>
<ol class="arabic simple">
<li>Install <code>gdapi-python</code> using your preferred Python package management method</li>
<li>Download <a class="reference external" href="https://github.com/OCA/connector/tree/10.0/">connector</a> and its
dependencies to your Odoo addons path.</li>
<li>Follow <a class="reference external" href="https://github.com/OCA/queue/tree/10.0/queue_job#installation">queue_job</a>
install instructions.</li>
<li>Install this module (<code>connector_rancher</code>).</li>
<li>Deploy a Docker/Rancher secret containing the <code>secret_key</code> that will be used
to access Rancher. You can also simply create a file somewhere containing the
key.</li>
</ol>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>To configure this module, you need to:</p>
<ol class="arabic simple">
<li>Go to Connectors => [Rancher] Backends</li>
<li>Create a new backend. The file path for the secret that was created in the
<code>Installation</code> section should go in <code>Secret Path</code>.</li>
<li>Restart Odoo. This is a required step for the asynchronous queue, and can be
done at any time after install. If you're missing data and haven't restarted,
this is the problem.</li>
</ol>
<a name="usage"></a>
<h3>Usage</h3>
<p>Rancher data can be seen in the <code>Infrastructure</code> application menus.</p>
<p>For the most part, everything is read-only.</p>
<a name="deploy-applications"></a>
<h4>Deploy Applications</h4>
<p>Rancher is still the recommended way of deploying applications, but it is still
possible to deploy them from Odoo as well. The primary purpose for this workflow
is to allow for a developer to create stacks based on actions within Odoo.</p>
<p>You can deploy an application stack using Rancher catalog entries by going to
the <code>Applications</code> Menu in the <code>Infrastructure</code> app. Find an application you
want to deploy, then use the <code>Deploy Application</code> link in the action menu to show
the deployment wizard:</p>
<img alt="Deploy Wizard" src="./static/description/deploy_wizard_traefik.png" />
<p>Fill the options out as you typically would in Rancher. The Docker and Rancher
compose files are also exposed on their respective tabs - should you feel the need
to edit those manually.</p>
<p>Click <code>Deploy</code> and your stack will provision in Rancher.</p>
<a name="known-issues"></a>
<h3>Known Issues</h3>
<ul class="simple">
<li>Data imports are quite dumb and should be optimized to reduce duplications.</li>
<li>Due to above dumbness, data imports aren't happening as often as they should.</li>
<li>Selection options should be represented in application deployer, instead of plain
text.</li>
<li>Once <a class="reference external" href="https://github.com/OCA/product-attribute/pull/309">OCA/product-attribute#309</a>
is merged, <code>product_uom_technology</code> should be removed from this repo.</li>
<li>Once <a class="reference external" href="https://github.com/OCA/server-tools/pull/1098">OCA/server-tools#1098</a>
is merged, <code>infrastructure</code> should be removed from this repo.</li>
</ul>
<a name="road-map"></a>
<h3>Road Map</h3>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/LasLabs/odoo-connector-rancher/issues">GitHub Issues</a>. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Dave Lasley <<a class="reference external" href="mailto:dave@laslabs.com">dave@laslabs.com</a>></li>
</ul>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://laslabs.com"><img alt="LasLabs Inc." src="https://laslabs.com/logo.png" /></a>
<p>This module is maintained by LasLabs Inc.</p>