iapp-migration.md

F5 iApp Migration

All v1 iApp templates have been deprecated and removed from F5 Azure ARM templates. This guide provides mappings between the f5.service_discovery and f5.cloud_logger iApp templates and example declarations that can be used with F5 Application Services 3 Extension and F5 Telemetry Services Extension.

Service Discovery iApp

tmsh list sys application service sd

sys application service sd.app/sd {
    device-group none
    inherited-devicegroup true
    inherited-traffic-group true
    template f5.service_discovery
    traffic-group traffic-group-1
    variables {
        basic__advanced {
            value no
        }
        basic__display_help {
            value hide
        }
        cloud__azure_bigip_in_environment {
            value yes
        }
        cloud__azure_client_id {
            value <service_principal_client_id>
        }
        cloud__azure_resource_group {
            value <resource_group_name>
        }
        cloud__azure_sp_secret {
            encrypted yes
            value <service_principal_secret>
        }
        cloud__azure_subscription_id {
            value <subscription_id>
        }
        cloud__azure_tenant_id {
            value <service_principal_tenant_id>
        }
        cloud__cloud_provider {
            value azure
        }
        monitor__frequency {
            value <monitor_frequency>
        }
        monitor__http_method {
            value <http_method>
        }
        monitor__http_version {
            value <http_version>
        }
        monitor__monitor {
            value "/#create_new#"
        }
        monitor__response { 
            value <monitor_response>
        }
        monitor__type {
            value <monitor_type>
        }
        monitor__uri {
            value <monitor_uri>
        }
        pool__interval {
            value <discovery_interval>
        }
        pool__member_conn_limit {
            value <connection_limit>
        }
        pool__member_port {
            value <member_port>
        }
        pool__pool_to_use {
            value "/#create_new#"
        }
        pool__public_private {
            value <ip_type>
        }
        pool__tag_key {
            value <tag_key>
        }
        pool__tag_value {
            value <tag_value>
        }
    }
}

Example AS3 declaration - Creates dynamically populated pool based on Azure resource tags

To send this declaration to AS3, use the POST method to the URI https:///mgmt/shared/appsvcs/declare and put the declaration in the body of the post. A Postman collection for AS3 can be found on the f5-appsvcs-extension releases page.

{
    "webPool": {
        "class": "Pool",
        "members": [
            {
                "servicePort": <member_port>,
                "addressDiscovery": "azure",
                "updateInterval": <discovery_interval>,
                "tagKey": "<tag_key>",
                "tagValue": "<tag_value>",
                "addressRealm": "<ip_type>",
                "resourceGroup": "<resource_group_name>",
                "subscriptionId": "<subscription_id>",
                "directoryId": "<service_principal_tenant_id>",
                "applicationId": "<service_principal_client_id>",
                "apiAccessKey": "<service_principal_secret>"
            }
        ],
        "monitors": [
            { "use": "httpMonitor" }
        ]
    },
    "httpMonitor": {
        "class": "Monitor",
        "label": "http monitor",
        "monitorType": "<monitor_type>",
        "send": "<http_method> <monitor_uri> <http_version>",
        "receive": "<monitor_response>",
        "interval": <monitor_frequency>,
        "connectionLimit": <connection_limit>
    }
}

Cloud Logger iApp

tmsh list sys application service logger

sys application service logger.app/logger {
    device-group none
    inherited-devicegroup true
    inherited-traffic-group true
    template f5.cloud_logger
    lists {
        logging_config__ltm_req_log_options {
            value { CLIENT_IP SERVER_IP HTTP_METHOD HTTP_URI VIRTUAL_NAME }
        }
    }
    template f5.cloud_logger.v1.0.0
    traffic-group traffic-group-1
    variables {
        analytics_config__analytics_solution {
            value azure_oms
        }
        analytics_config__log_type {
            value F5CustomLog
        }
        analytics_config__shared_key {
            encrypted yes
            value <shared_key>
        }
        analytics_config__workspace {
            value <workspace_id>
        }
        basic__advanced {
            value no
        }
        basic__help {
            value hide
        }
        internal_config__hostname {
            value custom
        }
        internal_config__mgmt_hostname {
            value <mgmt_hostname>
        }
        internal_config__mgmt_port {
            value <mgmt_port>
        }
        internal_config__port {
            value custom
        }
        logging_config__ltm_req_log_choice {
            value yes
        }
    }
}

Example TS declaration

To send this declaration to Telemetry Streaming, use the POST method to the URI https:///mgmt/telemetry/declare and put the declaration in the body of the post. A Postman collection for TS can be found on the f5-telemetry-streaming releases page.

{
    "class": "Telemetry",
    "My_System": {
        "class": "Telemetry_System",
        "host": "<mgmt_hostname>",
        "port": <mgmt_port>,
        "systemPoller": {
            "interval": 60
        }
    },
    "My_Listener": {
        "class": "Telemetry_Listener",
        "port": 6514
    },
    "My_Consumer": {
        "class": "Telemetry_Consumer",
        "type": "Azure_Log_Analytics",
        "workspaceId": "<workspace_id>",
        "passphrase": {
            "cipherText": "<shared_key>"
        },
        "useManagedIdentity": false,
        "region": "westus"
    }
}