Table of Contents

• Getting Started
  • Helpful Background Information
  • Prerequisites
  • External Dependencies
  • Adapters
  • How to Install
  • Testing
• Using this Example Project
  • Provision Cloud Application
• Additional Information
  • Support

Getting Started

This section is helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

Workflows and processes often include logic that varies from business to business. Our Example Projects are more complex processes that include several of our modular components to build a more complete process.

While these can be utilized, you may find more value in using them as a starting point to build around.

Prerequisites

Itential Example Projects are built and tested on particular versions of IAP. In addition, Example Projects are often dependent on external systems and as such, these Example Projects will have dependencies on these other systems. This version of Alkira - REST - Example has been tested with:

• IAP 2023.2

External Dependencies

Adapters

"xmlArrayKeys": [
  "item"
]

How to Install

To install the Example Project:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Supported IAP Versions section in order to install the Example Project.
• Import the Example Project in Admin Essentials.

Testing

Cypress is generally used to test all Itential Example Projects. While Cypress is an opensource tool, at Itential we have internal libraries that have been built around Cypress to allow us to test with a deployed IAP.

When certifying our Example Projects for a release of IAP we run these tests against the particular version of IAP and create a release branch in GitLab. If you do not see the Example Project available in your version of IAP please contact Itential.

While Itential tests this Example Project and its capabilities, it is often the case the customer environments offer their own unique circumstances. Therefore, it is our recommendation that you deploy this Example Project into a development/testing environment in which you can test the Example Project.

Using this Example Project

Example Projects contain 1 or more workflows. Each of these workflows have different inputs and outputs.

Provision Cloud Application

Given values provided in form input, provisions VPC and EC2 with networking in AWS, provisions and configures Palo Alto Firewall service in Alkira Cloud Network as a Service as intermediate between on prem site and cloud application, and creates AWS VPC and Internet conntectors in Alkira Cloud Network as a Service.

Capabilities include:

• Provisions VPC and EC2 instance in AWS with networking
• Provisions and configures Palo Alto Firewall service in Alkira as intermediate between on prem location and cloud application
• Creates AWS VPC and Internet connectors in Alkira

Entry Point IAP Component

The primary IAP component to run Provision Cloud Application is listed below:

Inputs

The following table lists the inputs for Provision Cloud Application:

[
  {
    "sourceSubnetCidrMask": 32,
    "sourceIp": "199.27.253.134",
    "protocol": "TCP",
    "port": 80
  }
]

10.20.30.1/28

ami-041feb57c611358bd

t2.micro

key-name

170

customer

inet-zone

HASHING

DEFAULT

US-WEST-1

us-west-1

PROD-AWS

SMALL

username

password

[
  "PROD-AWS"
]

[
  "OnPrem"
]

[
  "INET-Connector"
]

[
  "PROD_AZURE"
]

1

1

false

true

alkira-credentials

IPSEC

2abfbad825a4233b8d1e243a07925a2c

a52685ac-1fb8-4a90-b891-18cf9b461237

2024-02-08T15:55:04.651Z

PAY_AS_YOU_GO

VM_SERIES_BUNDLE_1

SMALL

9.1.3

CORP

alkira

alkira

alkira

Outputs

There are no outputs for Provision Cloud Application.

Query Output

There are no query output examples for Provision Cloud Application.

Example Inputs and Outputs

Example 1

Input:

{
  "formData": {
    "aws": {
      "ingressRules": [
        {
          "sourceSubnetCidrMask": 24,
          "port": 80,
          "sourceIp": "10.0.0.0",
          "protocol": "TCP"
        },
        {
          "sourceSubnetCidrMask": 24,
          "port": 443,
          "sourceIp": "10.0.0.0",
          "protocol": "TCP"
        }
      ],
      "vpcSubnet": "192.168.84.0/24",
      "imageId": "ami-05014f9776cc26f27",
      "instanceType": "t2.micro",
      "keyName": "itential-california-key"
    },
    "alkira": {
      "tenantNetworkId": 170,
      "customerName": "CustomerName",
      "internetConnectorGroup": "inet-zone",
      "internetConnectorAlgorithm": "HASHING",
      "internetConnectorKeys": "DEFAULT",
      "cxpRegion": "US-WEST-1",
      "awsRegion": "us-west-1",
      "awsVpcConnectorGroup": "PROD-AWS",
      "awsVpcConnectorSize": "SMALL"
    },
    "paloAlto": {
      "username": "username",
      "maxInstanceCount": 1,
      "minInstanceCount": 1,
      "globalProtectEnabled": false,
      "panoramaEnabled": false,
      "prodAwsZone": [
        "OnPrem"
      ],
      "onPremZone": [
        "PROD-AWS"
      ],
      "inetZone": [
        "INET-Connector"
      ],
      "prodAzureZone": [
        "PROD_AZURE"
      ],
      "credentialId": "17afa9b7-12f9-a534-1549-1adba240a130",
      "tunnelProtocol": "IPSEC",
      "registrationPin": "2abab1d825a4433b8d17223a07827f1b",
      "registrationPinId": "ba1655da-2de8-5c30-ae78-b6cf1b5168ca",
      "expirationDate": "2024-02-09T22:20:27.493Z",
      "password": "password",
      "licenseType": "PAY_AS_YOU_GO",
      "bundle": "VM_SERIES_BUNDLE_1",
      "paloAltoFirewallServiceSize": "SMALL",
      "version": "9.1.3",
      "segment": "CORP"
    },
    "iap": {
      "awsEc2Adapter": "aws-ec2",
      "automationGatewayAdapter": "automation-gateway",
      "alkiraAdapter": "alkira"
    }
  }
} 

Output:

{} 

API Links

Additional Information

Support

Please use your Itential Customer Success account if you need support when using this Workflow Project.

Itential Documents:

Related Items:

Adapters