PingIntelligence

Deploying PingIntelligence policies

Deploying PingIntelligence policies in the Akana API Gateway is divided into three parts:

About this task

  • Adding an input script (config.js)

  • Adding a PingIntelligence policy and applying the policy to APIs

  • Adding the RetainerHeader policy and applying the policy to APIs

Downloading PingIntelligence policies

About this task

To download and extract the PingIntelligence policy:

Steps

  1. Download the PingIntelligence policy.

  2. Extract the policies by running the following command:

    # tar –zxvf  <file name>

    Example:

    # tar –zxvf pi-api-akana-policy-4.1.1.tar.gz

Adding an input script

About this task

To add an input script to the Akana API gateway:

Steps

  1. Sign on to Akana Policy Manager, navigate to Tenant, and click Scripts.

  2. Click Add Script.

  3. Enter Script Name and Script Description, and clickNext.

    A screenshot of the Specify Script Details page in Akana Policy Manager.
  4. Select JavaScript for Language from the list.

  5. Copy the contents of the config.js script provided by PingIntelligence and paste them into the Source.

    A screenshot of the Script Editor page in Akana Policy Manager.
  6. Paste the values of Service_QName, Interface_Name, and Operation_Name that were copied in Capturing ASE details.

    This needs to be done for both primary and secondary ASE nodes. The following table lists the variables in config.js that need to be populated.

    Variable Description

    ase_token

    Variable for the ASE sideband authentication token.

    primary_ase_service

    Service QName for primary ASE.

    primary_ase_interface

    Interface Name for primary ASE.

    primary_ase_request_operation

    Operation Name for posting Request Metadata in primary ASE.

    primary_ase_response_operation

    Operation Name for posting Response Metadata in primary ASE.

    secondry_ase_service

    Service QName for secondary ASE.

    secondary_ase_interface

    Interface Name for secondary ASE.

    secondary_ase_request_operation

    Operation Name for posting Request Metadata in secondary ASE.

    secondary_ase_response_operation

    Operation Name for posting Response Metadata in secondary ASE.

    Example:

    Below is a sample substitution snippet:

    var ase_token = "ASE-Token-123";
    /Primary ASE Configuration/
    var primary_ase_service = "{pi-as-ase-primary_0.0.0}svc_314492f1-ecdc-4184-93a0-57ee2258154b.smshargi.sandbox";
    var primary_ase_interface = "{pi-as-ase-primary_0.0.0}pi-as-ase-primary_PortType_0";
    var primary_ase_request_operation = "postRequestMetadata";
    var primary_ase_response_operation = "postResponseMetadata";
    /**/
    /Secondary ASE Configuration/
    var secondry_ase_service = "{pi-as-ase-primary_0.0.0}svc_314492f1-ecdc-4184-93a0-57ee2258154b.smshargi.sandbox";
    var secondary_ase_interface = "{pi-as-ase-primary_0.0.0}pi-as-ase-primary_PortType_0";
    var secondary_ase_request_operation = "postRequestMetadata";
    var secondary_ase_response_operation = "postResponseMetadata";
  7. Click Finish, and then click Close.

Adding a PingIntelligence policy

About this task

To add a PingIntelligence policy to the Akana API Gateway:

Steps

  1. Sign on to Akana Policy Manager, navigate to the Tenant, and click Operational Policies under Policies.

  2. Select Add Policy.

  3. For Type, select Private Operational Script Policy from the drop-down list, and click Next.

A screenshot of the Select Policy Creation Option page in Akana Policy Manager.
  1. Enter Policy Name and Description, click Finish, and then click Close.

A screenshot of the Specify Policy Details page in Akana Policy Manager.
  1. Navigate to Workbench.

  2. In the Private Operational Script Policy section, select the policy name and click Modify.

A screenshot of the Workbench tab in Akana Policy Manager.
  1. Click on Imports. Select the script added in Adding an input script and import it by clicking <<.

  2. Select JavaScript for Language from the list.

  3. Copy the contents of the pi_policy.js script and paste them into Expression under Source.

A screenshot of the Modify Script Policy page in Akana Policy Manager.
  1. Click Finish and then click Close.

  2. In the WorkFlow Actions, click Activate Policy to activate the PingIntelligence policy.

Applying the PingIntelligence policy to APIs

About this task

The PingIntelligence policy can be applied at tenant level, org level and at individual API level.

To add a policy at the API level:

Steps

  1. Sign on to Akana Portal.

  2. Click the API name.

  3. In the left navigation, click Implementations.

A screenshot of the Implementations page in Akana Policy Manager.
  1. Click the API Implementation Name icon.

    Possible values for API Implementation are Live, Sandbox, or Development.

  2. In the Policies section, click Edit.

A screenshot of the API Implementations page in Akana Policy Manager.
  1. Find the PingIntelligence policy in the Available Policies pane, and click Attach under the PingIntelligence policy.

  2. Click Save.

A screenshot of Edit Policies page in Akana Policy Manager.

Adding the RetainHeader policy

About this task

To add the RetainHeader policy to the Akana API Gateway:

Steps

  1. Sign on to Akana Policy Manager and click Tenant in the left navigation.

  2. Under Policies, click Operational Policies.

  3. Select Add Policy and choose Private Operational Script Policy from the Type drop-down list.

    A screenshot of the Select Policy Creation Option page in Akana Policy Manager.
  4. Click Next.

  5. Enter Policy Name and Description, click Finish, and then click Close.

A screenshot of the Specify Policy Details page in Akana Policy Manager.
  1. Navigate to the Workbench tab.

  2. In the Private Operational Script Policy section, select the policy name and click Modify.

A screenshot of the Workbench tab in Akana Policy Manager.
  1. For Script Language, select JavaScript from the drop-down list.

  2. Copy the contents of the retain-header-policy.js script and paste them into Expression.

  3. For Function, select Pre-policy Auditing from the drop-down list.

    A screenshot of the Modify Script Policy page in Akana Policy Manager.
  4. Click Finish and then click Close.

  5. Under the WorkFlow Actions, click Activate Policy to activate the RetainHeader policy.

Applying the RetainHeader policy to APIs

About this task

The RetainHeader policy can be applied at the tenant, org, and at individual API level.

To add a policy at the API level:

Steps

  1. Sign on to the Akana Portal.

  2. Click the API name.

  3. In the left navigation, click Implementations.

A screenshot of the Implementations page in the Akana Portal.
  1. Click the API Implementation Name icon.

    Possible values for API Implementation are Live, Sandbox, or Development.

  2. In the Policies section, click Edit.

A screenshot of the API Implementations Details page in Akana Policy Manager.
  1. Under Available Policies, find the RetainHeader policy, and click Attach under the RetainHeader policy.

  2. Click Save.

A screenshot of the Edit Policies page in Akana Policy Manager.