Skip to main content

A wrapper for Kustomize and related tooling.

Project description

Kustomize Wrapper latest-version

checks-status tests-status kustomize kubeval python-support license

A Python wrapper for the Kubernetes Kustomize tool and related tooling.

  • More readable, more concise one-liners
  • Easy linting (with integrated kubeval)
  • Integrates into your Python tooling (e.g. use it with tox)
  • Automatic download of external Go binaries
  • Cross-platform (installs matching Go binaries on Linux, macOS, Windows)

Installation

python3 -m pip install kustomize-wrapper

Why should I use this tool?

Forget about several kustomize calls, piping your calls into kubeval or kubectl apply commands. Using Kustomize is now even more pleasant!

Instead of:

lint:
  script:
  - kustomize build deployment/overlays/development | kubeval --strict
  - kustomize build deployment/overlays/integration | kubeval --strict
  - kustomize build deployment/overlays/production | kubeval --strict

You can now write:

lint:
  script:
  - kustomize lint deployment/overlays/*

Instead of:

production:
  script:
  - cd deployment/base
  - kustomize edit set image IMAGE="foobar/application:${CI_COMMIT_SHA}"
  - cd ../..
  - kustomize build deployment/overlays/production | kubectl apply -f -

You can now write:

production:
  script:
  - kustomize apply deployment/overlays/production --edit deployment/base \
        set image IMAGE="foobar/application:${CI_COMMIT_SHA}"

Usage

kustomize --help

Philosophy:

  • Build automatically
  • Kustomize commands become CLI options
  • Kubeval options become CLI options of lint command

Python tox

Add kustomize-wrapper to your tox.ini, then Tox takes care of downloading:

[testenv:kubernetes]
description = Validate Kubernetes manifests
deps = kustomize-wrapper
commands =
    kustomize lint {posargs:--ignore-missing-schemas --fail-fast \
        deployment/application/overlays/development \
        deployment/application/overlays/integration \
        deployment/application/overlays/production \
    }

Allows you to override arguments: (Use -- in case you add command line options)

tox -e kubernetes -- --fail-fast deployment/application/base

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

kustomize-wrapper-0.13.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

kustomize_wrapper-0.13.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file kustomize-wrapper-0.13.0.tar.gz.

File metadata

  • Download URL: kustomize-wrapper-0.13.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for kustomize-wrapper-0.13.0.tar.gz
Algorithm Hash digest
SHA256 c505fd98b383dbcc83d447f6e75d881dbd3fa171c90b302de7d19110cfd49626
MD5 1be1da424f73c470c4a3ce9564c99188
BLAKE2b-256 675198d6403e121d164a28d9f2ccceac50713eb23e59b0eaa3e4b16ea983b831

See more details on using hashes here.

File details

Details for the file kustomize_wrapper-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: kustomize_wrapper-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for kustomize_wrapper-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9dd7b197fd69370247854246daf4fd1bb176275b204518fd1a77631749f3091f
MD5 b5eb411e0210cfa9af46f466814ac2ae
BLAKE2b-256 ab53c3405bba1de7be527eb3b76bcb437311f6ce9b3ba9d431ea4d529f60d495

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