> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/traceable/agent-docs/kong.md). # Kong API Gateway Integration This section provides comprehensive documentation for integrating Traceable with Kong API Gateway to secure and monitor your API traffic with enterprise-grade security and observability. ## Getting Started ### Prerequisites * Kong Gateway 2.4.0 or later (Enterprise or Open Source) * Network connectivity to Traceable Platform Agent (TPA) * Administrative access to Kong Admin API or Kong Manager * [Download the latest Kong Plugin](https://downloads.traceable.ai/) ### Supported Kong Versions | Kong Version | Enterprise | Open Source | | ------------ | ---------- | ----------- | | 3.0.x | ✅ | ✅ | | 2.8.x | ✅ | ✅ | | 2.7.x | ✅ | ✅ | | 2.6.x | ✅ | ✅ | | 2.5.x | ✅ | ✅ | | 2.4.x | ✅ | ✅ | ## Installation Methods ### 1. Docker Deployment For containerized Kong environments: * [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/docker/InstallationSteps.md) * [Configuration Reference](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/docker/Configuration.md) * [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/docker/Troubleshooting.md) ### 2. Kubernetes Deployment For Kong in Kubernetes: * [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/kubernetes/InstallationSteps.md) * [Configuration Reference](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/kubernetes/Configuration.md) * [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/kubernetes/Troubleshooting.md) ### 3. VM/Bare Metal Deployment For traditional server deployments: * [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/vm/InstallationSteps.md) * [Configuration Reference](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/vm/Configuration.md) * [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/vm/Troubleshooting.md) ### 4. Kong Konnect (SaaS) For Kong's managed service: * [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/konnect/InstallationSteps.md) * [Configuration Reference](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/konnect/Configuration.md) * [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/konnect/Troubleshooting.md) ### 5. Kong Ingress Controller For Kong Ingress Controller in Kubernetes: * [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/ingress-controller/InstallationSteps.md) ## Verification After installation, verify that: 1. The Traceable plugin is enabled in Kong 2. Traffic is being forwarded to the Traceable Platform Agent 3. API calls appear in the Traceable dashboard ```bash # Check if plugin is enabled curl -X GET http://localhost:8001/plugins/ # Verify plugin configuration for a specific service curl -X GET http://localhost:8001/services/{service_name}/plugins ``` ## Troubleshooting Troubleshooting guide is available [here](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/common/TroubleshootingCommon.md). ## Deployment Architectures Before installing, review the [Deployment Architectures](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/deployment-architectures/README.md) section for reference patterns on sync vs async mode, SSE capture, cloud metadata enrichment, fail-open/timeout behavior, and service naming. ## Quick Links * [Deployment Architectures](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/deployment-architectures/README.md) * [Sync vs Async Mode](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/deployment-architectures/sync-async-mode.md) * [SSE Capture](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/deployment-architectures/sse-capture.md) * [Cloud Metadata Enrichment](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/deployment-architectures/cloud-metadata.md) * [Fail-Open and Timeout Behavior](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/deployment-architectures/fail-open-timeouts.md) * [Service Naming and Content Filtering](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/deployment-architectures/service-naming-filtering.md) * [Install Options](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/README.md) * [Common](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/common/README.md) * [Docker](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/docker/README.md) * [Ingress Controller](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/ingress-controller/README.md) * [Konnect](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/konnect/README.md) * [Kubernetes](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/kubernetes/README.md) * [VM](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/kong/install-options/vm/README.md)