Skip to content

Provide information and guidance for simple API Discovery via F5 Distributed Cloud.

Notifications You must be signed in to change notification settings

stockerts/f5xc-api-discovery

Repository files navigation

F5 Distributed Cloud - Simple API Discovery

Simple method for providing API Discovery via Distributed Cloud for APIs that are not proxied by Distributed Cloud.

This approach doesn't require an actual service response, only request traffic.

Table of Contents

  1. Flow
  2. Outcome
  3. Outcome Example
  4. Limitations
  5. Requirements
  6. Guide
  7. Custom Route Template
  8. Load Balancer Templates

Flow

Object Flow

Outcome

  • Path Discovery (Leaf Creation)

  • Request Sensitive Data Detection (PUT, POST)

Note - Sensitive Data Detection requires request format of JSON

Outcome Example

Path Discovery (Leaf Creation)

Path

Request Sensitive Data Detection (PUT, POST)

Detection

Limitations

  • No Response Sensitive Data Detection

  • No Authentication Detection

  • No Performance Statistics

Note - Limitation(s) are not a result of platform capability, but an outcome of not having a proper service response

Requirements

  • HTTP(S) Request Traffic

  • Distributed Cloud Tenant

    • Load Balancer

    • Route

    • API Discovery

Guide

Under Multi-Cloud App Connect > Manage > Virtual Host > Routes

Create a Custom Route, Configure under Routes

Custom Route

Add Route Match Condition

Route Match

Add Route Actions, Direct Response, Configure

Direct Response

Update Response Body (JSON Format)

Response Body

response body content

Expand Advanced Fields, Response Header to Add

Adv Response Header

Update Response Header

Header Config

Save and Exit


Under Multi-Cloud App Connect > Manage > Load Balancers > HTTP Load Balancers

Created a HTTP Load Balancer, specifying your desired configuration

  • Load Balancer Name
  • Domains
  • Load Balancer Type

Additional References @ F5 Tech Docs - HTTP Load Balacer

Add a Route, Configuration under Routes

Route

Attach Custom Route

Route

Enable API Discovery

Route Response List

Save and Exit

Custom Route Template

Custom Route Direct Response

custom_route_response

Load Balancer Templates

HTTP without Managed DNS

lb_template_http

HTTP with Managed DNS

lb_template_http_dns

HTTPS with Auto Certificate

lb_template_https_auto_cert

HTTPS with Custom Certificate (Multiple Certificate)

lb_template_https_multi_cert

About

Provide information and guidance for simple API Discovery via F5 Distributed Cloud.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published