https://github.com/mr-karan/kong-service-exporter
Utility to create a export a service registry Markdown file from Kong's config
https://github.com/mr-karan/kong-service-exporter
kong
Last synced: 3 months ago
JSON representation
Utility to create a export a service registry Markdown file from Kong's config
- Host: GitHub
- URL: https://github.com/mr-karan/kong-service-exporter
- Owner: mr-karan
- License: mit
- Created: 2021-03-29T10:13:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-30T06:45:29.000Z (over 4 years ago)
- Last Synced: 2025-07-04T18:19:00.770Z (3 months ago)
- Topics: kong
- Language: Python
- Homepage:
- Size: 9.77 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.konghq.com/gateway-oss/2.3.x/db-less-and-declarative-config/), 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
```bash
$ 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](./kong_service_exporter/example/service_registry_sample.md) Markdown file from the [sample](./kong_service_exporter/example/config-sample.yml) config file.