Commit 46af7e15 authored by Truc Nguyen's avatar Truc Nguyen

rework license management tutorial + add reference to manage_licenses.yml.EXAMPLE

parent 58ef73fa
......@@ -189,6 +189,7 @@ Example scenario files are provided in the **scenarios** directory, including:
- **uswest_performance.yml.EXAMPLE** - a scenario for both stack and living application management with AWS provisioning
- **azure_northEurope.yml.EXAMPLE** - a scenario for both stack and living application management with Azure provisioning
- **build_and_deploy.yml.EXAMPLE** - a scenario for living application management only
- **manage_licenses.yml.EXAMPLE** - a scenario for license management only
Use these examples to customize your scenario and save it with a `.yml` file extension.
......
# 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
```
# How to manage Bonita licenses
This tutorial describes how to manage Bonita licenses from the command line using BCD.
This feature lets you generate licenses programmatically for your Bonita Studio or Bonita Server.
## Prerequisites
To use this feature, you need to prepare a [scenario file](scenarios) with the following required information:
* [All Licensing variables](https://documentation.bonitasoft.com/bcd/${varVersion}/scenarios#toc4)
* [The following Bonita variables](https://documentation.bonitasoft.com/bcd/${varVersion}/scenarios#toc3)
* bonita_edition
* bonita_version
::: info
An example scenario is provided with the **scenarios/manage_licenses.yml.EXAMPLE** file with required variables to manage
Bonita licenses with BCD.
:::
## Generating a new license
You can generate a new license providing a **Request Key**. Read more about Bonita licenses and how to generate a request key on this [documentation page](https://documentation.bonitasoft.com/bonita/${bonitaDocVersion}/licenses#toc2).
::: info
The request key has to be generated on the host where your Bonita Studio or Bonita Server will be running.
:::
Assuming your request key is `(CIVpYDRB8bhouXdWadLY1M9TVctwYUYu)`, here is an example usage of the `bcd license generate` command:
```bash
$ bcd -s scenarios/euwest1_performance.yml -y license generate -k '(CIVpYDRB8bhouXdWadLY1M9TVctwYUYu)' -o /path/to/output_directory
```
::: warning
The output directory (`/path/to/output_directory` in the above example) is related to your BCD Controller Docker container.
In order to persist the generated licenses after exiting the BCD Controller, you may use a bind-mounted output directory. Still, you may copy your generated licenses while the BCD controller is running.
:::
## Revoking a license
You can revoke a Bonita license providing the path to a license file.
::: info
Revoking a license will make your license inactive and it will delete the license file you have provided.
This operation releases a _slot_ to generate a new license as authorized by your Bonita subscription.
:::
Here is an example usage of the `bcd license revoke` command:
```bash
$ bcd -s scenarios/euwest1_performance.yml -y license revoke -p /path/to/bonita_license_file.lic
```
......@@ -18,6 +18,7 @@
* [Using initialization scripts](custom_init.md)
* [Configuring REST API authorization](how_to_configure_rest_api_authorization.md)
* [Enabling remote monitoring with JMX](how_to_enable_remote_monitoring_jmx.md)
* [Manage Bonita licenses](manage_bonita_licenses.md)
* [Manage Bonita Living Applications](_manage_living_application.md)
* [Build a Living App repository](livingapp_build.md)
* [Manage Living App configuration](livingapp_manage_configuration.md)
......@@ -25,5 +26,4 @@
* [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