Skip to content

mr-karan/kong-service-exporter

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

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.

About

Utility to create a export a service registry Markdown file from Kong's config

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published