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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file kong-service-exporter-0.1.1.tar.gz.

File metadata

  • Download URL: kong-service-exporter-0.1.1.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.5

File hashes

Hashes for kong-service-exporter-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a8024e850aac99cbdb92d14991544905fc1e4f4f3acb7dbc24140141cb770798
MD5 59fdabfae62d2be6e6091578bcd25318
BLAKE2b-256 d14a032cedb1749a19c34ed6365fc5289bee4e5a70dbe4e3bcd3b03eaff85aab

See more details on using hashes here.

File details

Details for the file kong_service_exporter-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: kong_service_exporter-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.5

File hashes

Hashes for kong_service_exporter-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 206f0321c33d7d5869410a5cde20afd548b6e0c9938e56366e5698b78fb69bbb
MD5 03c4a87b53eeaadc097febedcba1f3de
BLAKE2b-256 46e534af07147849d9160b5f789c0ca74fdcc12302daedad093d6f7472de9111

See more details on using hashes here.

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