From 58ef73fa43da5fba599b2b1e2db7b8ac32233ff9 Mon Sep 17 00:00:00 2001 From: Agustin Larreinegabe Date: Mon, 5 Nov 2018 12:33:28 +0100 Subject: [PATCH] Add documentation about license management --- md/bcd_cli.md | 60 ++++++++++++++++++++++++++++++++++++++++ md/license_management.md | 45 ++++++++++++++++++++++++++++++ md/taxonomy.md | 1 + 3 files changed, 106 insertions(+) create mode 100644 md/license_management.md diff --git a/md/bcd_cli.md b/md/bcd_cli.md index 2df9f5f..4e7f960 100644 --- a/md/bcd_cli.md +++ b/md/bcd_cli.md @@ -121,6 +121,66 @@ You can also see this information by running `bcd --help` and `bcd [SUBCOMMAND]

Show the version and exit.

+
+

license

+

Manage Bonita licenses

+
bcd license [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
+
+
+

Options

+
+
+-h, --help
+

Show this help message

+
+ +
+
generate
+

Request a license and get the license file

+
bcd license generate [OPTIONS]
+
+
+

Options

+
+
+-k, --request-key <request_key>
+

Request key to generate the license

+
+ +
+
+-o, --output-dir <output_dir>
+

Output directory path where the license file will be saved - Default to /tmp

+
+ +
+
+-h, --help
+

Show this help message

+
+ +
+
+
revoke
+

Revoke a license file

+
bcd license revoke [OPTIONS]
+
+
+

Options

+
+
+-p, --path <path>
+

Path to the license file to revoke

+
+ +
+
+-h, --help
+

Show this help message

+
+ +
+

livingapp

Manage Bonita Living Application

diff --git a/md/license_management.md b/md/license_management.md new file mode 100644 index 0000000..d24d4a1 --- /dev/null +++ b/md/license_management.md @@ -0,0 +1,45 @@ +# 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 +``` + + + diff --git a/md/taxonomy.md b/md/taxonomy.md index e8cf885..4379b3c 100644 --- a/md/taxonomy.md +++ b/md/taxonomy.md @@ -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) -- GitLab