Visualize your Kong Cluster with KongMap

KongMap

Kongmap is a free visualization tool which allows you to view and declaratively edit configurations of
your Kong API Gateway Clusters, including Routes, Services, and Plugins/Policies. The tool is
available for installation on Docker and Kubernetes only at this time.

Full documentation and install instructions available online here: https://github.com/yesinteractive/kong-map/

Features

Cluster View

Allows an admin to view a dynamic map of their Kong API Gateway clusters and visually see relationships between
Workspaces (for Kong Enterprise), Services, Routes (Endpoints), and Plugins (Policies). Cluster view can also
be used to see configuration of the proxy plane of your Kong for Kubernetes Ingress Controller. Clicking on any
entity displays details of the entity and related links. Plugins can be toggled from view.

Endpoint Analyzer

View details of an API Endpoint (Route). The analyzer shows the Service attached to the endpoint/route as well as provides
a breakdown of all plugins/policies in order of execution attached to the route/endpoint. For Kong Enterprise users,
all entities can be viewed directly via a link to Kong Manager.

Declarative Configuration Viewer/Editor

KongMap is deployed with a browser based implementation of Kong’s CLI tool, decK. Here you can view, edit, and export Kong declarative configurations for your open source
and Enterprise clusters via YAML. Configurations can easily be copied and pasted from one Kong cluster to another or between workspaces. Declarative
configuration editing can be disabled by KongMap configuration, or managed via RBAC permissions if using Kong Enterprise.

Compatibility

KongMap supports both Kong Open Source and Kong Enterprise Clusters greater than version 1.3 and supports both DB and Non-DB (dbless) Kong configurations.
KongMap also supports Kong for Kubernetes Ingress Controller versions greater than 0.5 (In Kong for Kubernetes,
the Ingress Controller’s proxy container must have its Admin API exposed in some fashion.)

Docker Installation

Full documentation and Install Instructions available online here: https://github.com/yesinteractive/kong-map/

7 Likes

Thats super neat, I was pondering awhile ago how maybe I could write a UI that would parse and help modify changes to a declarative config easily but use like a github style source repo for my yaml file and branch+pr model under the hood with a pipeline that would help deploy those changes out there to real-time nodes while having that nice git history and revision history in place. This applies it directly to a given Kong node via deck sounds like but gives me ideas :slight_smile: .


© 2019 Kong Inc.    Terms  •  Privacy  •  FAQ