Skip to main content

Kubernetes architecture map generator for Structurizr and LikeC4.

Project description

kmap

kmap discovers Kubernetes workloads, builds a normalized architecture model, and renders documentation for Structurizr and LikeC4.

kmap is not a LikeC4-from-Structurizr converter. Kubernetes inspection and product configuration are the source inputs; Structurizr and LikeC4 are renderer outputs.

Install

pip install kmap

For development:

pip install -e '.[dev]'

Quick start

Copy one of the generic examples:

cp config/example.minimum.yaml config/my-product.yaml
kmap validate-config config/my-product.yaml
kmap run-all --config config/my-product.yaml --data-mode mocked --mock-seed demo --no-exec

By default, run kmap from the project root. Paths resolve under the current directory:

config/
Likec4/
Structurizr/
Inventory/
artifacts/buckets/
.tmp/

Tool-level defaults can be stored in kmap.yaml. Start from kmap.yaml.example.

Common commands

kmap validate-config config/example.minimum.yaml
kmap render-inventory
kmap validate-likec4 --root Likec4
kmap validate-structurizr --root Structurizr
kmap view example-product

The source checkout also keeps python kmap.py ... as a compatibility shim.

Documentation

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

korex_labs_kmap-1.1.1.tar.gz (196.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

korex_labs_kmap-1.1.1-py3-none-any.whl (271.1 kB view details)

Uploaded Python 3

File details

Details for the file korex_labs_kmap-1.1.1.tar.gz.

File metadata

  • Download URL: korex_labs_kmap-1.1.1.tar.gz
  • Upload date:
  • Size: 196.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for korex_labs_kmap-1.1.1.tar.gz
Algorithm Hash digest
SHA256 e609b347ae64bf57e6c8911207822ed5a3b086ee0c5523ea78e2f17632fffe7e
MD5 87efa8b90ace99b53957dde73e9c0831
BLAKE2b-256 5e0fd2304262ae8bb22e03948cbab6503292a47a2a83360bfae14f4ee3f069c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for korex_labs_kmap-1.1.1.tar.gz:

Publisher: ci.yml on korex-labs/kmap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file korex_labs_kmap-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: korex_labs_kmap-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 271.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for korex_labs_kmap-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d276809696d7720783a6edb6d841488f0175c8e776da76382221ebe0f5c9ec9d
MD5 bbc9a9d44d33763cc9c0b77e9e494ddd
BLAKE2b-256 2bad00dcd78e9ac6a754669a0cb32516660f16f39f54472616f2e83cb23231d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for korex_labs_kmap-1.1.1-py3-none-any.whl:

Publisher: ci.yml on korex-labs/kmap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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