Commit 58ef73fa authored by Agustin Larreinegabe's avatar Agustin Larreinegabe Committed by Truc Nguyen

Add documentation about license management

parent 15b88dfb
......@@ -121,6 +121,66 @@ You can also see this information by running `bcd --help` and `bcd [SUBCOMMAND]
<dd><p>Show the version and exit.</p>
</dd></dl>
<div class="section" id="bcd-license">
<h4>license</h4>
<p>Manage Bonita licenses</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre>bcd license <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND1 <span class="o">[</span>ARGS<span class="o">]</span>... <span class="o">[</span>COMMAND2 <span class="o">[</span>ARGS<span class="o">]</span>...<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="option">
<dt id="cmdoption-bcd-license-h">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code></dt>
<dd><p>Show this help message</p>
</dd></dl>
<div class="section" id="bcd-license-generate">
<h5>generate</h5>
<p>Request a license and get the license file</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre>bcd license generate <span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="option">
<dt id="cmdoption-bcd-license-generate-k">
<code class="descname">-k</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--request-key</code><code class="descclassname"> &lt;request_key&gt;</code></dt>
<dd><p>Request key to generate the license</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-bcd-license-generate-o">
<code class="descname">-o</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--output-dir</code><code class="descclassname"> &lt;output_dir&gt;</code></dt>
<dd><p>Output directory path where the license file will be saved - Default to <cite>/tmp</cite></p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-bcd-license-generate-h">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code></dt>
<dd><p>Show this help message</p>
</dd></dl>
</div>
<div class="section" id="bcd-license-revoke">
<h5>revoke</h5>
<p>Revoke a license file</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre>bcd license revoke <span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="option">
<dt id="cmdoption-bcd-license-revoke-p">
<code class="descname">-p</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--path</code><code class="descclassname"> &lt;path&gt;</code></dt>
<dd><p>Path to the license file to revoke</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-bcd-license-revoke-h">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code></dt>
<dd><p>Show this help message</p>
</dd></dl>
</div></div>
<div class="section" id="bcd-livingapp">
<h4>livingapp</h4>
<p>Manage Bonita Living Application</p>
......
# How to manage Bonita license
This tutorial describes how to manage Bonita License from the command line using BCD.
## Prerequisite
To use this feature, you will need a [scenario](scenarios) and describe at least this information:
* [All Licensing variables](scenarios#toc4) and
* [These Bonita variables](scenarios#toc3)
* bonita_edition
* bonita_version
* lic_type
### Generate
You can generate a new license, to do that you will need to generate a __Request Key__ on your Bonita host (you can read
more about in Bonita [License](https://documentation.bonitasoft.com/bonita/${bonitaDocVersion}/licenses#toc2)).
Here is an example:
**Warning**: This example uses _fake_ Request Key... :-)
```bash
bcd -y -s scenarios/euwest1_performance.yml license generate -k 'SEFWRSBGVU4gV0lUSCBCQ0Q=' -o /path/to/license
```
::: warning
Be careful that the output directory is a mounted volume because you can lose your license file when you quit your BCD
container
:::
### Revoke
You can revoke your Bonita license, to do that you just have to describe the path of your license.
Here is an example:
```bash
bcd -y -s scenarios/euwest1_performance.yml license revoke -p /path/to/license/my_bonita_license_performance.lic
```
......@@ -25,4 +25,5 @@
* [Build and deploy (Best Practices)](livingapp_build_and_deploy.md)
* [Use BCD with sensitive data encrypted](how_to_use_bcd_with_data_encrypted.md)
* [Integrate BCD with Jenkins](jenkins_example.md)
* [Bonita License management](license_management.md)
* [Troubleshooting guide](troubleshooting_guide.md)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment