Internal documentation only

This page has been marked as draft.

ITRS Analytics (Obcerv) - license generation

Preparation Copied

1. The ITRS account needs to have access to the Licence Tool.

• Please check that you are able to access: https://resources.itrsgroup.com/admin/config/itrs_licence_tool/licence_tool

2. Check with sales team that Sales Force / Omni records have been updated.

• An opportunity must be present in Sales Force / Omni to generate an ITRS Analytics license.

• The license generation tool looks for opportunities that have products with these conditions:

  • Product group is ITRS Obcerv
  • This needs to be a Primary Quote

• Please clarify with sales team when some organizations may be under multiple similar names (e.g. XYZ, XYZ - Group Account, XYZ Capital Markets, etc.).

3. Check with customer to obtain Instance ID used to install ITRS Analytics.

• From ITRS Analytics version 2.12.0+2 and above (REP-1099), this should be fully qualified domain names (FQDNs). This can be verified on the ITRS Analytics web console.

Replicated Portal (optional) Copied

It is useful to check if the user organization has been registered in the Replicated portal (Login link: https://iam.itrsgroup.com/auth/realms/itrsgroup/protocol/saml/clients/replicate). While this step is not necessary for license generation, this is needed to provide downloads of ITRS Analytics packages.

Procedure Copied

1. Navigate to this site: https://resources.itrsgroup.com/admin/config/itrs_licence_tool/licence_tool

2. Enter the Customer name and select from the available drop-down options.

3. Click the Show Opportunities button.

• It should populate a table with codes like OBCERV, OBCERV-APP-API-GATEWAY, OBCERV-STORAGE-MANAGEDENTITY, OBCERV-STORAGE-OSINSTANCE, OBCERV-APP-FIXMONITOR-SESSION, OBCERV-APP-SIGNAL-FORECASTER.

4. Currently there is no need to set the Licence Effective Date option.

5. Select an appropriate Licence Type (Trial / Production).

6. Input Instance ID name.

7. Select all the Obcerv related Entitlements check boxes.

8. Select Download License and provide the generated license file to the user.

• This is a license with all of the tokens good until the end date. All of this is audited and reported to the Sales Ops teams. If you generate a license from this opportunity for a client, it will be reported.

9. Depending on the Licence Type, the date will be displayed with the opportunity, The Start and End (in yellow box) is for Production licence. The POC Start /POC End is for Trial licence

Licence Installation Copied

• ITRS Analytics - Admin Settings (to upload license file)

Troubleshooting Copied

1. The license file is in JSON format which can be opened with text editors. It can be difficult to read though as the data is stored on a single line. You may use the “jq” command or appropriate tools to look at the contents. e.g.

cat licence_1751234567.json | jq

2. The license file is processed by the “licenced” pod as of this writing. From a support bundle, you may scroll through the log or search keywords for hints. e.g.

kubectl get pod -n kotsadm | grep licenced
kubectl logs licenced-7d59d59b96-tpfs5 -n kotsadm | grep instance_id

3. The licence “entitlements” reported on ITRS Analytics web console may not match exactly with codes in the license generator, since the licence tool includes additional logic. There is currently no official documentation on the mapping logic.

We have reverse engineered the process by creating dummy licenses to obtain below sample output.

Please check with products or development teams if customer reports the licence does not work as expected. (ITRS Analytics may add more apps in the future, the license generator may be updated to include more tokens although it is the same opportunity.)