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.11.0.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

kustomize_wrapper-0.11.0-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kustomize-wrapper-0.11.0.tar.gz
  • Upload date:
  • Size: 8.7 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.48.2 CPython/3.8.5

File hashes

Hashes for kustomize-wrapper-0.11.0.tar.gz
Algorithm Hash digest
SHA256 0e160025b0a39743f102ff9de09097d54a70e668e012cba6a21ae89e86cdebab
MD5 25d9ec6c72a48bb8e61382be65be3531
BLAKE2b-256 f56ef06a63e96317ae619a9d15944beb931f6c6aa24437019f34978f2da04baa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kustomize_wrapper-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 14.3 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.48.2 CPython/3.8.5

File hashes

Hashes for kustomize_wrapper-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 38135fa43383fa65575e749e5116d59deaa2d268e7c931fafb5ff237a8eb1475
MD5 689328ee99e2cd35cad167f6d95f8b5f
BLAKE2b-256 69ce01168e03df8474463c53e7b29505e31673a171a086f90a7ec365782f0089

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