Back to Kustomize

Install Kustomize

site/content/en/docs/Getting started/installation.md

3.3.12.2 KB
Original Source

Binaries

Binaries at various versions for Linux, macOS and Windows are published on the releases page.

The following script detects your OS and downloads the appropriate kustomize binary to your current working directory.

bash
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"  | bash

Homebrew / MacPorts

For Homebrew users:

bash
brew install kustomize

For MacPorts users:

bash
sudo port install kustomize

Chocolatey

bash
choco install kustomize

For support on the chocolatey package and prior releases, see:

Docker Images

Starting with Kustomize v3.8.7, docker images are available to run Kustomize. The image artifacts are hosted on Google Container Registry (GCR).

See GCR page for available images.

The following commands are how to pull and run kustomize {{<example-semver-version>}} docker image.

bash
docker pull registry.k8s.io/kustomize/kustomize:{{< example-version >}}
docker run registry.k8s.io/kustomize/kustomize:{{< example-version >}} version

Go Source

Requires Go to be installed.

Install the kustomize CLI from source without cloning the repo

bash
go install sigs.k8s.io/kustomize/kustomize/{{< example-major-version >}}

Install the kustomize CLI from local source

bash
# Clone the repo
git clone [email protected]:kubernetes-sigs/kustomize.git
# Get into the repo root
cd kustomize

# Optionally checkout a particular tag if you don't want to build at head
git checkout kustomize/{{< example-version >}}

# Build the binary
(cd kustomize; go install .)

# Run it - this assumes your Go bin (generally GOBIN or GOPATH/bin) is on your PATH
# See the Go documentation for more details: https://go.dev/doc/code
kustomize version