Packaging and deploying your app

Use the QRadar® GUI Application Framework to package your app as an archive (.zip file) and deploy it to your IBM® QRadar test environment.

Procedure

  1. Open a shell prompt and use the cd command to go to the bin sub folder of your SDK installation folder.
  2. Package your app by using the following command syntax:

    qradar_app_creator package -w <path_to_app_folder>/<app_name_folder> -p <app_name.zip>

    • To package an app on UNIX or Linux computers, type the following command:

      qradar_app_creator package -w <path_to_app_folder>/<app_name_folder> -p <app_name.zip>

    • To package an app on a Windows computer, type the following command:

      qradar_app_creator package -w <path_to_app_folder>\<app_name_folder> -p <app_name.zip>

  3. Upload your app (extension) to your QRadar Console by using the following command, and then press Enter.

    qradar_app_creator deploy -q <QRadar_console_IP> -u admin -p <app_name.zip>.

    Here is an example of the command:

    qradar_app_creator deploy -q 10.11.12.13 -u admin -p com.me.myapp.zip

    Note: Make sure that you record the application ID for your app from Application Creation Task state output that is returned when you issue the qradar_app_creator deploy command. You need it when you export you app as a QRadar extension.

    In the following example, the application ID is 1023.

    Application Creation Task state: {u'status': u'COMPLETED',
     u'application_id': u1023', u'error_messages': u'[]'} 

    If you're viewing your QRadar Console user interface in a browser, refresh your browser to see your app running.

What to do next

After you successfully test your app, you can use the QRadar Content Management Tool to export the app as an extension. You then use the QRadar Extensions Management tool on the Admin settings page to install your extension on your QRadar Console.