SOAP-2-REST Knowledge Base Overview

This document serves as the main entry point and navigation guide for the SOAP-2-REST technical documentation. This knowledge base is the customer-facing documentation for the product, intended for operators, integration engineers, and platform teams responsible for running the platform.

The documentation is grounded in the shipping product, including the codebase and low-level design documents, and is versioned alongside product releases. The current release is v1.0 (General Availability).

All documentation pages describe the product as of their "last-updated" date. For changes made after a page's last update, consult the repository's git history.

Documentation Structure

The knowledge base is organized into the following sections, covering the entire lifecycle of installing, operating, and integrating with the platform.

Getting Started

• Introduction: An overview of the product and its underlying model.
• Core Concepts: A vocabulary of key terms such as Publish/Consume, mappings, and discovery.
• Quickstart: A guide to publishing a service from a starting point of zero.
• System Requirements: The necessary prerequisites for running the platform.

Releases & Versioning

• Release Index: A central list of all product releases.
• Versioning Policy: Details on how the product, schemas, and mappings are versioned.
• v1.0 GA Release Notes: Specific notes for the v1.0 General Availability release.
• Upgrade Guide: Instructions for upgrading the platform.
• Support Lifecycle & Deprecation Policy: Information on product support timelines and deprecation.

Installation

• Overview: An introduction to installation procedures.
• Docker Compose (standalone): Instructions for a standalone deployment.
• Kubernetes / OpenShift (Helm): Guide for deploying via Helm chart.
• GCP (Cloud Run + Cloud SQL): Instructions for deployment on Google Cloud Platform.
• Configuration Reference: A complete reference for all configuration options.

Onboarding a Service

• Overview: An introduction to the service onboarding process.
• Import a WSDL: How to import a WSDL file to begin the conversion process.
• Configure the Backend: Steps to configure the backend SOAP service.
• Generate & Review the OpenAPI: How to generate and review the corresponding OpenAPI specification.
• Publish & Version a Service: The process for publishing and versioning a newly created REST service.
• Consume Direction (SOAP Facade): How to configure the platform to present a SOAP facade to a backend.
• Zero-touch Autopilot: Information on the automated service onboarding feature.

Discovery & Connectors

• Traffic-driven Discovery: An overview of how the platform can discover services by observing traffic.
• Connectors Overview: An introduction to the available connectors.
• Connectors: Specific guides for F5 BIG-IP, IBM DataPower, generic load balancers, API gateways, and a generic HTTP receiver.
• Learned Examples: How the system uses discovered traffic to generate learned examples.

Conversion

• How Mapping Works: The core concepts behind SOAP-to-REST mapping.
• Conversion Options Reference: A reference guide to all available conversion settings.
• SOAP & XSD Support: Details on the supported SOAP and XSD standards and features.
• Field-level Overrides: How to apply specific overrides to individual fields during conversion.
• Validation Modes: Information on the different data validation modes available.

API Reference

• Overview: An introduction to the platform's APIs.
• Admin (Control-Plane) API: Reference for the administrative API.
• Runtime API: Reference for the data-plane API used by converted services.
• Error Codes: A comprehensive list of platform error codes.

Observability

• Overview: An introduction to monitoring and observability features.
• Dashboards & KPIs: Information on the provided dashboards and key performance indicators.
• Metrics & SLO Reports: Details on available metrics and Service-Level Objective (SLO) reporting.
• Logs & Tracing: Guidance on interpreting logs and distributed traces.
• Audit Trail: Information on the system's audit logging capabilities.

Security

• Overview: An introduction to the platform's security model.
• RBAC & Roles: Details on Role-Based Access Control and predefined roles.
• Authentication: How to configure authentication via IAP, OIDC, or SAML.
• Backend Credential Encryption: Information on how backend credentials are encrypted and stored.
• Network & Data Residency: Guidance on network configuration and data residency.
• Data Retention: Policies and configuration for data retention.

Licensing

• Overview: An introduction to the product's licensing.
• License Model: An explanation of how licensing is structured.
• Capacity Counting: How the platform measures usage against license capacity.
• Offline Grace & Degraded Mode: Behavior during license server connectivity loss.
• Egress Allow-list: Information on required network egress for licensing.

Operations

• Overview: An introduction to operational procedures.
• Deployment Runbook: A guide for standard deployment operations.
• Daily Operations: Checklists and procedures for day-to-day management.
• Troubleshooting: A guide to diagnosing and resolving common issues.
• Backup & Restore: Procedures for backing up and restoring the platform's state.

Support

• Getting Support: How to contact the support team.
• Support Tiers: An explanation of the available support levels.
• FAQ: A list of frequently asked questions.

Documentation Conventions

The documentation set follows several conventions to ensure clarity and consistency.

Versioning

This documentation is versioned and released with the product. When a feature or capability is specific to a release, the page will note it (e.g., Since v1.0). Every page includes a "created" and "last-updated" date at the bottom. The release notes are the canonical source for what changed in each version.

Naming and Formatting

• Error Codes: Platform error codes follow a standard format, such as S2R-RUN-0413, which includes a service prefix and a numeric code.
• Database Tables: All internal database tables are prefixed with s2r_.
• Placeholders: Customer-specific values like project IDs, hostnames, or group names are represented as placeholders in <angle-brackets>.
• Commands: All command examples assume a Unix shell unless otherwise specified.

---

All SOAP-to-REST docs