Configure External Jarvis Service

CA Jarvis is an analytics platform that processes  data, providing real-time visibility and insights.
CA Jarvis is an analytics platform that processes 
API Developer Portal
 data, providing real-time visibility and insights.
 Jarvis is no longer pre-installed when running the 
API Developer Portal
 install script. Perform this step to set up an external Jarvis service, and (if applicable) to migrate your existing Jarvis data and configuration to the new service. For information on the latest Jarvis software and hardware requirements, consult Hardware and Software Requirements.
Jarvis must be run and installed on a different server to that of 
API Developer Portal
 Each Jarvis service can cater to multiple Portal tenants in different environments and/or time zones.
In this topic:
 
   
 
Set Up an External Jarvis Service
 
To set up an external Jarvis service:
 
  1. Download the external Jarvis package from CA Support.
  2. Extract the package:
    sudo tar zxvf jarvis.tar.gz
  3. Navigate into the Jarvis folder:
    cd jarvis
  4. Run 
    config.sh
     and enter your resolvable hostname. This hostname must be resolvable from the Portal host machine. 
     Editing the hosts file of the Portal machine is not a viable solution since the hosts file is not respected by Docker. The network should be set up such that the domain is resolvable.
    [[email protected]]# ./config.sh Jarvis configuration Jarvis domain (JARVIS_DOMAIN) [address.broadcom.net]: JARVIS_DOMAIN: address.broadcom.net Do you want to keep these settings? [Y/n]: Done.
  5. Run 
    jarvis.sh
    . This will create a self-signed certificate for the domain provided and start Jarvis services.
    ./jarvis.sh
  6. The 
    jarvis.crt
     file is generated in the 
    /certs
     directory.
  7. Copy the cert from the Jarvis instance to your Portal instance, which will be required when integrating Jarvis after installation.
Migrate Existing Jarvis Data to the New Service
If you
 
already have internal Jarvis data integrated into your existing Portal instance, perform this step before you upgrade to 
API Developer Portal
 4.3.1 or later.
Prerequisites
To ensure a successful migration:
  • Download the Jarvis migration tool from CA Support.
  • Run two instances: a source Portal instance (with integrated Jarvis data), and a target instance (with external Jarvis installed).
  • Install Java on the source Portal instance:
    yum install java
 Jarvis migration is only available in non-SSL source and destination environments.
 
To migrate your Jarvis data to the new service:
 
  1. On the source Portal instance, extract the migration tool:
    unzip migration-tools.zip
  2. Navigate to the folder containing the jar file:
    cd migration-tools
  3. Open up ports to access Portal API:
    1. On the source Portal instance:
      docker service update --publish-add "8080:8080" portal_apis
    2. On the target Jarvis instance:
      docker service update --publish-add "8080:8080" jarvis_apis
  4. Wait for portal_apis and jarvis_apis services to restart.
  5. On the source Portal instance, run the migration tool by specifying the migration source, target, and your product_id:
    java -jar migration-tools.jar --source http://<
    source
    >:8080 --target http://<
    target
    >:8080 --product ca_apim --pagesize=5000
     The default product_id is 
    ca_apim
    . If you have a PORTAL_TENANT_ID other than apim, your product_id is 
    ca_<PORTAL_TENANT_ID>
    .
  6. When the migration is complete, a migration summary page is displayed.
     
    For Example: 
     
    2019-02-14 09:03:04 ProcessID- [20330] INFO Main:75 - Starting Tool in Migration Mode. 2019-02-14 09:03:04 ProcessID- [20330] INFO Main:103 - 'from' is not given. Assuming migration from beginning. 2019-02-14 09:03:04 ProcessID- [20330] INFO Main:109 - 'to' is not given. Assuming migration until current time. 2019-02-14 09:03:04 ProcessID- [20330] INFO Main:127 - Source Jarvis API URL: http://10.175.245.187:8080 2019-02-14 09:03:04 ProcessID- [20330] INFO Main:128 - Target Jarvis API URL: http://10.175.245.246:8080 2019-02-14 09:03:04 ProcessID- [20330] INFO Main:129 - Product ID: ca_apim 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:220 - migrating 3 tenants 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:331 - migrating 5 doc types 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:505 - migrating 0 doc_views 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant system docType tenant: 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant system docType api: 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant system docType api_metrics: 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant d790dc77-fad8-11e6-9a60-0242ac11000f docType tenant: 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant d790dc77-fad8-11e6-9a60-0242ac11000f docType api: 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant d790dc77-fad8-11e6-9a60-0242ac11000f docType api_metrics: 564 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant apim docType tenant: 1 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant apim docType api: 2 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:678 - documents migrated for tenant apim docType api_metrics: 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:115 - Migration Summary: 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total tenants to migrate : 3 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total tenants migrated : 3 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total docTypes to migrate : 5 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total docTypes migrated : 5 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total docViews to migrate : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total docViews migrated : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant system and docType tenant_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant system and docType tenant_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant system and docType api_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant system and docType api_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant system and docType api_metrics_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant system and docType api_metrics_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant d790dc77-fad8-11e6-9a60-0242ac11000f and docType tenant_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant d790dc77-fad8-11e6-9a60-0242ac11000f and docType tenant_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant d790dc77-fad8-11e6-9a60-0242ac11000f and docType api_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant d790dc77-fad8-11e6-9a60-0242ac11000f and docType api_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant d790dc77-fad8-11e6-9a60-0242ac11000f and docType api_metrics_1.1 are: : 564 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant d790dc77-fad8-11e6-9a60-0242ac11000f and docType api_metrics_1.1 are: : 564 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant apim and docType tenant_1.1 are: : 1 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant apim and docType tenant_1.1 are: : 1 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant apim and docType api_1.1 are: : 2 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant apim and docType api_1.1 are: : 2 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents to migrate for tenant apim and docType api_metrics_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:117 - Total documents migrated for tenant apim and docType api_metrics_1.1 are: : 0 2019-02-14 09:03:05 ProcessID- [20330] INFO Migration:110 - Migration of product ca_apim from http://10.175.245.187:8080 to http://10.175.245.246:8080 is complete 2019-02-14 09:03:05 ProcessID- [20330] INFO Main:139 - Migration executed.
  7. Close the port on the target Jarvis instance:
    docker service update --publish-rm "8080:8080" jarvis_apis