Skip to main content

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

Project description

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.

Usage

usage: main.py [-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: out.md)

Quickstart

$ python3 main.py --config=config.yml --output=kong-service-registry.md

Sample File

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kong-service-exporter-0.1.1.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

kong_service_exporter-0.1.1-py3-none-any.whl (6.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page