Kong Service Registry Exporter

This is a small utility to export a Markdown file containing the list of services and other useful information from Kong's config.

If you're using Kong with Declarative Configuration, you'd know the config file can easily grow in 1000s of lines with 40-50 services. This utility aims to extract some of the useful information in a Markdown file and display as a table.

Install

pip install kong-service-exporter

Tested on Python 3.8.5

Usage

$ kong-service-exporter --help
usage: kong-service-exporter [-h] [--config CONFIG] [--output OUTPUT]

Generate Service Registry (markdown) using Kong config

optional arguments:
  -h, --help       show this help message and exit
  --config CONFIG  Path to Kong config file (YAML). (default: config-sample.yml)
  --output OUTPUT  Path to store the generated markdown file. (default: service_registry.md)

Quickstart

$ kong-service-exporter --config=config.yml --output=kong-service-registry.md

Sample File

You can see the generated Markdown file from the sample config file.