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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kustomize-wrapper-0.14.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0

File hashes

Hashes for kustomize-wrapper-0.14.0.tar.gz
Algorithm Hash digest
SHA256 6acba2e411a64e251393d3daf331599aaa7fc69d4726c8e9609cdd9b61dfde3a
MD5 566f7b6cf83fad4abcb414ad1a444048
BLAKE2b-256 2286db406c13b15042f8c4720051ac3e272e71ad511d3d4f015375624a70325d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kustomize_wrapper-0.14.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.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0

File hashes

Hashes for kustomize_wrapper-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cbf43b316cd0db30c6439ae7721ca1bfcde5a30065c250d52bf0fe716fcbdf88
MD5 20c35d7a9661d8e4b477316c752499f0
BLAKE2b-256 2ed1863886362b82d11b7264a6c16f3dc2dc5ddf565876cc53628601037ea968

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