F5 WSDL Auto-Import Scheduler

Overview

The F5 WSDL Auto-Import Scheduler is an automated background service that periodically discovers and imports Web Services Definition Language (WSDL) files from registered F5 BIG-IP instances.

This component solves the problem of keeping API definitions synchronized with services exposed through F5 BIG-IP without requiring manual intervention. It operates by scanning the platform's database for F5 instances configured for auto-import, dispatching import tasks to a managed thread pool, and recording the outcome of each import attempt.

The scheduler is a self-contained process within the admin service. Its inputs are the F5 instance configurations stored in the database. Its outputs are updated WSDL probe statuses in the F5SyncStateRepository and success logs in the AuditRepository.

How it Works

The scheduler executes periodically, governed by a fixed-delay timer. Each execution cycle performs the following sequence of operations:

1. Prevent Concurrent Runs: The scheduler first checks if a previous cycle is still in progress. If so, the current execution is skipped to prevent overlap. This is managed by an internal running flag.
2. Identify Eligible Instances: It queries the database for all F5 instances across all tenants and filters them based on three criteria. An instance is eligible only if it:
   • Is marked as enabled.
   • Has autoWsdlImportEnabled set to true.
   • Has a non-empty managementUrl.
3. Dispatch Asynchronously: For each eligible instance, the scheduler dispatches an import task to the F5AutoImportDispatcher. This dispatcher manages a bounded executor thread pool, ensuring that the main scheduler thread is never blocked by network I/O or long-running import operations. The dispatcher also ensures that no more than one import task for the same F5 instance is in flight at any given time.
4. Execute Import Task: Each task, running on a separate thread, executes the runImport logic for a single F5 instance. This involves: a. Calling the F5WsdlAutoImportService to perform the WSDL import from the F5 management API. b. If the import is successful, it updates the instance's status by calling f5SyncStateRepository.markWsdlProbe with the results. c. A success event is recorded in the audit log via the AuditRepository with the event name f5.instance.wsdl-import.auto.
5. Handle Timeouts: Each import task is subject to a hard-coded 5-minute timeout (IMPORT_TIMEOUT). If an import operation against an F5 instance's management API does not complete within this window, the task is automatically terminated. This prevents a single unresponsive F5 instance from blocking the import executor indefinitely.
6. Handle Failures: If an exception occurs during the import process for an instance (e.g., a network error or an API failure), the exception is caught, and a warning is logged. The failure is isolated to that specific instance; the scheduler will continue processing other eligible instances and will retry the failed instance on its next scheduled run.

The following diagram illustrates the data flow for a single scheduled run.

sequenceDiagram
    participant Scheduler
    participant F5 Instance DB
    participant F5 Auto-Import Dispatcher
    participant F5 WSDL Import Service
    participant F5 Sync State DB
    participant Audit Log DB

    Scheduler->>Scheduler: runScheduled()
    Note over Scheduler: Check if enabled and not already running
    Scheduler->>F5 Instance DB: findAllAcrossTenants()
    F5 Instance DB-->>Scheduler: List of F5InstanceRecord
    Scheduler->>Scheduler: Filter for eligible instances
    loop For each eligible instance
        Scheduler->>F5 Auto-Import Dispatcher: dispatchImportAsync(instance)
        F5 Auto-Import Dispatcher->>F5 Auto-Import Dispatcher: dispatch(instance.id, runImport)
        Note over F5 Auto-Import Dispatcher: Submits task to executor; enforces timeout
    end
    
    par
        F5 Auto-Import Dispatcher-->>+F5 WSDL Import Service: (async) runImport() -> autoImportSuccessfulProbes()
        F5 WSDL Import Service-->>-F5 Auto-Import Dispatcher: Import result
        alt Import Successful
            F5 Auto-Import Dispatcher->>+F5 Sync State DB: markWsdlProbe()
            F5 Sync State DB-->>-F5 Auto-Import Dispatcher: 
            F5 Auto-Import Dispatcher->>+Audit Log DB: success()
            Audit Log DB-->>-F5 Auto-Import Dispatcher: 
        else Import Failed (Exception)
            F5 Auto-Import Dispatcher->>F5 Auto-Import Dispatcher: Log warning message
        end
    end

Configuration

The scheduler's behavior is controlled by application properties and per-instance database settings.

Application Properties

These properties are configured in the admin service's application settings and require a restart to apply.

Instance-Level Configuration

For an F5 instance to be included in an auto-import run, the following fields on its F5InstanceRecord in the database must be correctly set:

Troubleshooting

Import Failure for a Single Instance

If an import fails for a specific F5 instance, the service logs a warning message and continues to process other instances.

• Symptom: A log entry appears with the message: Scheduled F5 WSDL auto-import failed for <instance-name>: <error-message>.
• Cause: This can be caused by network connectivity issues to the F5 management API, invalid credentials, or API errors from the F5 device.
• Resolution: The failure is isolated to the specific instance. The scheduler will automatically retry the import on its next cycle. Check the F5 instance's configuration and its network accessibility from the platform.

Scheduler Skips an Instance

If you expect an instance to be processed but it is not, verify its configuration.

• Symptom: An F5 instance is never processed by the auto-import scheduler, and no errors are logged for it.
• Cause: The instance does not meet all three eligibility criteria: enabled must be true, autoWsdlImportEnabled must be true, and managementUrl must be populated.
• Resolution: Review and correct the F5InstanceRecord for the instance in the database to ensure it meets all criteria.

Scheduler Does Not Run

If the scheduler does not appear to be running at all.

• Symptom: No logs related to F5AutoImportScheduler appear after the initial startup message.
• Cause: The scheduler may be disabled globally.
• Resolution: Ensure the application property s2r.f5.auto-import.enabled is set to true.

Import Task Timeout

An individual import task is designed to time out to prevent system-wide stalls.

• Symptom: An import for a very large or slow F5 instance may fail without a specific error message in the log, other than the absence of a completion log.
• Cause: The import process for a single instance exceeded the hard-coded 5-minute timeout.
• Resolution: This is a protective mechanism. If an instance consistently times out, it may indicate a performance issue with the F5 device or its management API. The source does not specify a method for changing the timeout value.

API and CLI Reference

This component is an internal, time-based scheduler and does not expose any direct user-facing API endpoints or CLI commands. Its operation is entirely automatic and configured via application properties and database records.

All SOAP-to-REST docs