Kubectl and Kustomize Documentation

https://kubectl.docs.kubernetes.io
Admin
Comprehensive guides and API references for Kubectl (Kubernetes CLI) and Kustomize (YAML...
Tokens:77,822
Snippets:1,152
Trust Score:9.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Kustomize

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/containerized_krm_functions

This command downloads and installs the Kustomize binary. It's a prerequisite for the guided example.

```bash
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"  | bash
mkdir -p $DEMO/bin
mv kustomize $DEMO/bin

```

--------------------------------

### Install Dependencies and Serve Site Locally

Source: https://kubectl.docs.kubernetes.io/contributing/docs

Install necessary Node.js dependencies, PostCSS CLI, and Autoprefixer, then start the local Hugo development server.

```bash
cd site/
npm install
npm install -g postcss-cli
npm install autoprefixer
npm audit fix
hugo server

```

--------------------------------

### Install Kustomize Plugin API

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/go_plugins

Installs the Kustomize plugin API using go get. Ensure GOPATH and GO111MODULE are set appropriately.

```bash
GOPATH=${whatever} GO111MODULE=on go get sigs.k8s.io/kustomize/api
```

--------------------------------

### Install Kustomize CLI (Go 1.17+)

Source: https://kubectl.docs.kubernetes.io/installation/kustomize/source

Use this command to install the Kustomize CLI from source for Go versions 1.17 and higher. Ensure Go is installed and configured.

```bash
GOBIN=$(pwd)/ GO111MODULE=on go install sigs.k8s.io/kustomize/kustomize/v5@latest

```

--------------------------------

### Install Kustomize CLI (Go < 1.17)

Source: https://kubectl.docs.kubernetes.io/installation/kustomize/source

Use this command to install the Kustomize CLI from source for Go versions prior to 1.17. Ensure Go is installed and configured.

```bash
GOBIN=$(pwd)/ GO111MODULE=on go get sigs.k8s.io/kustomize/kustomize/v5

```

--------------------------------

### Example Output with --show-kind

Source: https://kubectl.docs.kubernetes.io/references/kubectl/get/options/show_kind

This is an example of the output when the --show-kind flag is used with 'kubectl get deployments'. The 'NAME' column now displays 'deployment.extensions/nginx' instead of just 'nginx'.

```text
NAME                          DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
deployment.extensions/nginx   1         1         1            1           8m

```

--------------------------------

### Install Kustomize

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/exec_plugins

Downloads and installs the Kustomize executable into the temporary working directory.

```bash
curl -s "https://raw.githubusercontent.com/\kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"  | bash
mkdir -p $DEMO/bin
mv kustomize $DEMO/bin
```

--------------------------------

### Install kubeval

Source: https://kubectl.docs.kubernetes.io/contributing/kustomize/mac

Installs the kubeval tool using go get. Ensure Go is installed and in your PATH.

```bash
go get github.com/instrumenta/kubeval

```

--------------------------------

### Install Kustomize CLI from Local Source

Source: https://kubectl.docs.kubernetes.io/installation/kustomize/source

Build and install the Kustomize CLI from a local clone of the repository. This method requires Git and Go (1.13+) to be installed. It involves cloning the repo, checking out a specific tag if desired, and then building the binary.

```bash
# Need go 1.13 or higher
unset GOPATH
# see https://golang.org/doc/go1.13#modules
unset GO111MODULES

# clone the repo
git clone git@github.com: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/v5.0.0

# build the binary -- this installs the binary to your go bin path
make kustomize

# run it
~/go/bin/kustomize version

```

--------------------------------

### Download and Install Kustomize Binary

Source: https://kubectl.docs.kubernetes.io/installation/kustomize/binaries

This script detects your OS and downloads the appropriate Kustomize binary to your current working directory. It is useful for a quick setup on any supported platform.

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

```

--------------------------------

### Example Deployment Creation

Source: https://kubectl.docs.kubernetes.io/references/kubectl/create/deployment

This example demonstrates creating a Deployment named 'my-deployment' using the 'nginx' image. After execution, you can verify the deployment and its associated pods.

```bash
kubectl create deployment my-deployment --image=nginx
```

--------------------------------

### Print kustomize Version in YAML format

Source: https://kubectl.docs.kubernetes.io/references/kustomize/cmd/version

This example shows how to use the -o yaml flag to get detailed version information formatted as YAML.

```bash
kustomize version -o yaml
```

--------------------------------

### Install Kustomize

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/go_plugins

Installs Kustomize version v3.0.0 using Go. This method compiles Kustomize from source, not using pre-compiled binaries.

```bash
GOPATH=$tmpGoPath go install sigs.k8s.io/kustomize/kustomize
```

--------------------------------

### Create Directory and Navigate

Source: https://kubectl.docs.kubernetes.io/guides/example/inline_patch

Sets up the necessary directory structure for the Kustomize patch example.

```bash
$ cd $DEMO_HOME
$ mkdir patch
$ cd patch
```

--------------------------------

### Install Sops

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/go_plugins

Install the sops command-line tool using 'go install'. Ensure GOPATH is set correctly.

```bash
GOPATH=$tmpGoPath go install go.mozilla.org/sops/cmd/sops

```

--------------------------------

### Example Deployment

Source: https://kubectl.docs.kubernetes.io/guides/config_management/components

A basic Kubernetes Deployment for a web application.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: example
spec:
  template:
    spec:
      containers:
      - name: example
        image: example:1.0

```

--------------------------------

### Example Deployment Resource

Source: https://kubectl.docs.kubernetes.io/guides/config_management/namespaces_names

A standard Kubernetes Deployment resource used as an example.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
  labels:
    app: nginx
spec:
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx

```

--------------------------------

### Print kustomize Version in JSON format

Source: https://kubectl.docs.kubernetes.io/references/kustomize/cmd/version

This example shows how to use the -o json flag to get detailed version information formatted as JSON.

```bash
kustomize version -o json
```

--------------------------------

### Install Kustomize using Homebrew

Source: https://kubectl.docs.kubernetes.io/installation/kustomize/homebrew

Use this command to install Kustomize if you are a Homebrew user on macOS.

```bash
brew install kustomize
```

--------------------------------

### Example: Localizing a remote kustomization

Source: https://kubectl.docs.kubernetes.io/references/kustomize/cmd/localize

This example demonstrates running the `kustomize localize` command with a remote URL and shows the resulting directory structure and kustomization files.

```bash
$ kustomize localize "https://github.com/kubernetes-sigs/kustomize//api/krusty/testdata/localize/remote?submodules=0&ref=kustomize/v5.0.0&timeout=300"
```

```yaml
# example/localized-remote-kustomize-v5.0.0/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
labels:
  purpose: remoteReference
kind: Kustomization
resources:
- localized-files/github.com/kubernetes-sigs/kustomize/kustomize/v5.0.0/api/krusty/testdata/localize/simple
- hpa.yaml

```

```yaml
# example/localized-remote-kustomize-v5.0.0/localized-files/github.com/kubernetes-sigs/kustomize/kustomize/v5.0.0/api/krusty/testdata/localize/simple/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namePrefix: localize-
resources:
- deployment.yaml
- service.yaml

```

--------------------------------

### Start proxy and connect to an internal Service

Source: https://kubectl.docs.kubernetes.io/references/kubectl/proxy

Starts the kubectl proxy and demonstrates how to access an internal 'nginx' Service by constructing the correct proxy URL.

```bash
kubectl proxy

Starting to serve on 127.0.0.1:8001

```

```bash
curl http://127.0.0.1:8001/api/v1/namespaces/default/services/nginx/proxy/

```

--------------------------------

### Start a proxy server

Source: https://kubectl.docs.kubernetes.io/guides/container_debugging/proxying_traffic_to_services

Starts a proxy server that forwards local connections to Services running in the cluster. This is the initial step to enable proxying.

```bash
kubectl proxy

Starting to serve on 127.0.0.1:8001

```

--------------------------------

### Scale a statefulset

Source: https://kubectl.docs.kubernetes.io/references/kubectl/scale

This example shows how to scale a statefulset named 'web' to 3 replicas.

```bash
# Scale statefulset named 'web' to 3.
kubectl scale --replicas=3 statefulset/web
```

--------------------------------

### Install golangci-lint

Source: https://kubectl.docs.kubernetes.io/contributing/kustomize/windows

Installs the golangci-lint tool, a fast linters runner, using the Go package manager.

```powershell
go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
```

--------------------------------

### Example Output with Labels

Source: https://kubectl.docs.kubernetes.io/references/kubectl/get/options/show_labels

This is an example of the output you can expect when using the --show-labels flag, showing the 'LABELS' column.

```text
NAME      DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE       LABELS
nginx     1         1         1            1           7m        app=nginx

```

--------------------------------

### Example Deployment Resource Configuration

Source: https://kubectl.docs.kubernetes.io/guides/introduction/resources_controllers

This is an example of a Deployment resource configuration in YAML format. It defines the desired state for a set of Nginx pods.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
  labels:
    app: nginx
spec:
  replicas: 3
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.15.4

```

--------------------------------

### Test kubectl Installation

Source: https://kubectl.docs.kubernetes.io/installation/kubectl/binaries

Verify the kubectl installation by checking the client version.

```bash
kubectl version --client

```

--------------------------------

### Install kubectl using Homebrew (Option 1)

Source: https://kubectl.docs.kubernetes.io/installation/kubectl/homebrew

Use this command to install kubectl if you are a Homebrew user. This is the recommended method for Homebrew users.

```bash
brew install kubectl
```

--------------------------------

### Install Kubectl using Chocolatey

Source: https://kubectl.docs.kubernetes.io/installation/kubectl/chocolatey

Use this command to install the Kubernetes CLI on Windows if you are a Chocolatey user.

```bash
choco install kubernetes-cli
```

--------------------------------

### Install a Kubectl Plugin

Source: https://kubectl.docs.kubernetes.io/guides/extending_kubectl/discovering_plugins

Use this command to install a specific kubectl plugin, such as 'access-matrix'. Ensure the plugin name is correct.

```bash
kubectl krew install access-matrix

```

--------------------------------

### Example Output of kubectl describe deployments

Source: https://kubectl.docs.kubernetes.io/guides/resource_printing/describe

This is an example of the detailed output you can expect when describing a deployment. It includes information on replicas, strategy, pod template, conditions, and events.

```yaml
Name:                   nginx
Namespace:              default
CreationTimestamp:      Thu, 15 Nov 2018 10:58:03 -0800
Labels:                 app=nginx
Annotations:            deployment.kubernetes.io/revision=1
Selector:               app=nginx
Replicas:               1 desired | 1 updated | 1 total | 1 available | 0 unavailable
StrategyType:           RollingUpdate
MinReadySeconds:        0
RollingUpdateStrategy:  25% max unavailable, 25% max surge
Pod Template:
  Labels:  app=nginx
  Containers:
   nginx:
    Image:        nginx
    Port:         <none>
    Host Port:    <none>
    Environment:  <none>
    Mounts:       <none>
  Volumes:        <none>
Conditions:
  Type           Status  Reason
  ----           ------  ------
  Progressing    True    NewReplicaSetAvailable
  Available      True    MinimumReplicasAvailable
OldReplicaSets:  <none>
NewReplicaSet:   nginx-78f5d695bd (1/1 replicas created)
Events:          <none>
```

--------------------------------

### Scale a replicaset

Source: https://kubectl.docs.kubernetes.io/references/kubectl/scale

This example shows how to scale a replicaset named 'foo' to 3 replicas.

```bash
# Scale a replicaset named 'foo' to 3.
kubectl scale --replicas=3 rs/foo
```

--------------------------------

### File Layout Example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization

Demonstrates a file structure for managing reusable transformer configurations and application-specific overlays.

```yaml
app1/
  kustomization.yaml
    | resources:
    | - ../base/resources
    | transformers:
    | - ../transformers1
    | patches:
    | - patch1.yaml
  patch1.yaml
    | {a patch for resources}

app2/
  kustomization.yaml
    | resources:
    | - ../base/resources
    | transformers:
    | - ../transformers2
    | patches:
    | - patch2.yaml
  patch2.yaml
    | {some other patch for the resources}

transformers1/
  kustomization.yaml
    | resources:
    | - ../base/transformers
  transformerPatch1.yaml
    | {a patch for the base transformer configs}

transformers2/
  kustomization.yaml
    | resources:
    | - ../base/transformers
  transformerPatch1.yaml
    | {some other patch for the base transformer configs}

base/
  transformers/
    kustomization.yaml
       | resources:
       | - transformerConfig1.yaml
       | - transformerConfig2.yaml
    transformerConfig1.yaml
    transformerConfig2.yaml
  resources/
    kustomization.yaml
       | resources:
       | - deployment.yaml
       | - configMap.yaml
    deployment.yaml
    configMap.yaml
```

--------------------------------

### Example Container Output

Source: https://kubectl.docs.kubernetes.io/guides/container_debugging/container_logs

This snippet shows an example of the output you might see when retrieving container logs.

```text
hello
hello
```

--------------------------------

### Build Target Example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/glossary

Demonstrates how to specify a target for the 'kustomize build' command. The target must be a path or URL to a kustomization.

```bash
kustomize build $target
```

--------------------------------

### List Installed Kubectl Plugins

Source: https://kubectl.docs.kubernetes.io/guides/extending_kubectl/plugin_mechanism

Use this command to display all available kubectl plugins installed on your system.

```bash
kubectl plugin list

```

--------------------------------

### Example Deployment Resource Config

Source: https://kubectl.docs.kubernetes.io/references/architecture/field_merge_semantics

This is the initial Resource Config for a deployment that will be applied to the cluster.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.7.9

```

--------------------------------

### Example Deployment YAML

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/namespace

A sample Kubernetes Deployment resource definition.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: the-deployment
  namespace: the-namespace
spec:
  replicas: 5
  template:
    containers:
      - name: the-container
        image: registry/container:latest

```

--------------------------------

### Install GNU tools with Homebrew

Source: https://kubectl.docs.kubernetes.io/contributing/kustomize/mac

Installs coreutils, wget, and gnu-sed using Homebrew. These tools are often needed for various build and development tasks.

```bash
brew install coreutils wget gnu-sed tree

```

--------------------------------

### Example: Create TLS Secret

Source: https://kubectl.docs.kubernetes.io/references/kubectl/create/secret

This example demonstrates creating a TLS secret named 'my-secret' using specified certificate and key file paths.

```bash
kubectl create secret tls my-secret --cert=tls.cert --ket=tls.key
```

--------------------------------

### Install Kustomize using Chocolatey

Source: https://kubectl.docs.kubernetes.io/installation/kustomize/chocolatey

Use this command to install the Kustomize package on Windows. For support, refer to the Choco Package and Package Source links.

```bash
choco install kustomize

```

--------------------------------

### Install Kustomize using MacPorts

Source: https://kubectl.docs.kubernetes.io/installation/kustomize/homebrew

Use this command to install Kustomize if you are a MacPorts user on macOS. This command requires administrator privileges.

```bash
sudo port install kustomize
```

--------------------------------

### Online configuration file

Source: https://kubectl.docs.kubernetes.io/references/kubectl/diff

This is an example of the online configuration file as it exists in the cluster.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-dev
  labels:
    app: nginx
spec:
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:latest

```

--------------------------------

### Origin annotation example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/buildmetadata

An example of the `config.kubernetes.io/origin` annotation content. It includes fields like `path`, `ref`, `repo`, `configuredIn`, and `configuredBy`.

```yaml
config.kubernetes.io/origin: |
  path: path.yaml 
  ref: v0.0.0 
  repo: http://github.com/examplerepo 
  configuredIn: path/to/generatorconfig 
  configuredBy: 
    kind: Generator
    apiVersion: builtin 
    name: foo
    namespace: default  

```

--------------------------------

### Example: Update Deployment Replicas

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/replicas

This example demonstrates how to update the replica count of a Deployment from 5 to 10 using a kustomization file. The `resources` field includes the original deployment manifest.

```yaml
# deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: the-deployment
spec:
  replicas: 5
  template:
    containers:
      - name: the-container
        image: registry/container:latest

```

```yaml
# kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

replicas:
- name: the-deployment
  count: 10

resources:
- deployment.yaml

```

```yaml
# deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: the-deployment
spec:
  replicas: 10
  template:
    containers:
      - name: the-container
        image: registry/container:latest

```

--------------------------------

### Install kubectl using Homebrew (Option 2)

Source: https://kubectl.docs.kubernetes.io/installation/kubectl/homebrew

An alternative command for Homebrew users to install kubectl. Both 'kubectl' and 'kubernetes-cli' typically refer to the same package.

```bash
brew install kubernetes-cli
```

--------------------------------

### Deployment Resource with Labels

Source: https://kubectl.docs.kubernetes.io/guides/config_management/labels_annotations

An example Deployment resource with its own set of labels.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
  labels:
    app: nginx
    bar: baz
spec:
  selector:
    matchLabels:
      app: nginx
      bar: baz
  template:
    metadata:
      labels:
        app: nginx
        bar: baz
    spec:
      containers:
      - name: nginx
        image: nginx

```

--------------------------------

### Kustomization Configuration

Source: https://kubectl.docs.kubernetes.io/references/kubectl/apply

Example kustomization.yaml file defining resources, namespace, and labels for Kustomize.

```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

# list of Resource Config to be Applied
resources:
- deployment.yaml

# namespace to deploy all Resources to
namespace: default

# labels added to all Resources
labels:
  app: example
  env: test

```

--------------------------------

### Example: Create Docker Registry Secret

Source: https://kubectl.docs.kubernetes.io/references/kubectl/create/secret

This example demonstrates creating a secret named 'my-secret' for a Docker registry with provided credentials and a literal token.

```bash
kubectl create secret docker-registry my-secret --docker-username=kubectluser --docker-password=somepassword --docker-email=kubectl@kubectl.com --from-literal=token=GGH132YYu8asbbAA
```

--------------------------------

### Kustomization file with commonAnnotations and resources

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/commonannotations

This example shows a kustomization.yaml file that includes common annotations and references a deployment resource.

```yaml
# kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

commonAnnotations:
  oncallPager: 800-555-1212

resources:
- deploy.yaml


```

--------------------------------

### Create Demo Directory

Source: https://kubectl.docs.kubernetes.io/guides/config_management/components

Sets up a temporary directory for demonstrating Kustomize components.

```bash
DEMO_HOME=$(mktemp -d)

```

--------------------------------

### Example Deployment Configuration

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/images

This YAML defines a Kubernetes Deployment with several containers, each specifying an image.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: the-deployment
spec:
  template:
    spec:
      containers:
      - name: mypostgresdb
        image: postgres:8
      - name: nginxapp
        image: nginx:1.7.9
      - name: myapp
        image: my-demo-app:latest
      - name: alpine-app
        image: alpine:3.7

```

--------------------------------

### List Merge Example: Resource (Live)

Source: https://kubectl.docs.kubernetes.io/references/architecture/field_merge_semantics

Shows the 'args' field in the live 'Resource' configuration.

```yaml
# Resource (Live)
args: ["a", "b", "d"]
```

--------------------------------

### Off-the-Shelf Kustomize Configuration Example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/glossary

Shows a typical structure for a Kustomize project published for others to use, including a kustomization.yaml and resource files.

```yaml
github.com/username/someapp/
  kustomization.yaml
  deployment.yaml
  configmap.yaml
  README.md

```

--------------------------------

### Example: Create Generic Secret from File

Source: https://kubectl.docs.kubernetes.io/references/kubectl/create/secret

This example shows how to create a generic secret named 'my-secret' using the content of a local file named 'simplesecret.txt'.

```bash
kubectl create secret generic my-secret --from-file=simplesecret.txt
```

--------------------------------

### Run Make to Verify Installation

Source: https://kubectl.docs.kubernetes.io/contributing/kustomize/mac

Executes the 'make' command to run all tests required for qualifying a pull request. This verifies that all development tools are correctly installed and configured.

```bash
make

```

--------------------------------

### Example Deployment YAML

Source: https://kubectl.docs.kubernetes.io/guides/config_management/container_images

This YAML defines a Kubernetes Deployment with multiple containers, each specifying an image with a name and tag. This serves as a base example for demonstrating image management.

```yaml
# deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: the-deployment
spec:
  template:
    spec:
      containers:
      - name: mypostgresdb
        image: postgres:8
      - name: nginxapp
        image: nginx:1.7.9
      - name: myapp
        image: my-demo-app:latest
      - name: alpine-app
        image: alpine:3.7


```

--------------------------------

### Wide Output Example

Source: https://kubectl.docs.kubernetes.io/references/kubectl/get/options/wide

This is an example of the output you might see when using 'kubectl get -o wide'. It includes default columns plus extra information like containers, images, and selectors.

```text
NAME      DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE       CONTAINERS   IMAGES    SELECTOR
nginx     1         1         1            1           26s       nginx        nginx     app=nginx

```

--------------------------------

### Applying Staging and Production Overlays with Kustomize

Source: https://kubectl.docs.kubernetes.io/references/kustomize/glossary

Demonstrates how to build and apply Kustomize configurations for staging and production environments using kubectl.

```bash
kustomize build someapp/overlays/staging |
    kubectl apply -f -

kustomize build someapp/overlays/production |
    kubectl apply -f -

```

--------------------------------

### Verify Deployment and Pods

Source: https://kubectl.docs.kubernetes.io/references/kubectl/create/deployment

After creating a deployment, use 'kubectl get deployments' to check its status and 'kubectl get pods' to verify that the pods are running as expected.

```bash
kubectl get deployments

NAME            READY   UP-TO-DATE   AVAILABLE   AGE
my-deployment   1/1     1            1           35s

kubectl get pods

NAME                             READY   STATUS    RESTARTS   AGE
my-deployment-7d6dd5c955-pr4jt   1/1     Running   0          15s
```

--------------------------------

### Get Resources from Directory

Source: https://kubectl.docs.kubernetes.io/guides/resource_printing/queries_and_options

Fetches all resources defined in a directory containing resource configuration files.

```bash
kubectl get -f configs/
```

--------------------------------

### Directory Structure

Source: https://kubectl.docs.kubernetes.io/guides/example/multi_base

Illustrates the file and directory structure created for the Kustomize multibase example.

```text
.
├── kustomization.yaml
├── base
│   ├── kustomization.yaml
│   └── pod.yaml
├── dev
│   └── kustomization.yaml
├── production
│   └── kustomization.yaml
└── staging
    └── kustomization.yaml
```

--------------------------------

### Example Kustomize Labels

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/labels

Demonstrates how labels are applied to Kubernetes resources like Services and StatefulSets using Kustomize.

```yaml
apiVersion: v1
kind: Service
metadata:
  labels:
    app: bingo
    owner: alice
    someName: someValue
  name: example
---
apiVersion: apps/v1
kind: StatefulSet
metadata:
  labels:
    app: bingo
    owner: alice
    someName: someValue
  name: example
spec:
  volumeClaimTemplates:
  - metadata:
      labels:
        app: bingo
        owner: alice
        someName: someValue

```

--------------------------------

### Example Logs from a Single Container Pod

Source: https://kubectl.docs.kubernetes.io/references/kubectl/logs

This displays the output logs from a pod with a single container.

```text
hello
hello

```

--------------------------------

### Display golangci-lint Help

Source: https://kubectl.docs.kubernetes.io/contributing/kustomize/windows

Shows the help information for the golangci-lint command, confirming its installation and basic usage.

```powershell
C:\...> golangci-lint --help
Smart, fast linters runner. Run it in cloud for every GitHub pull request on https://golangci.com
...
```

--------------------------------

### Install kubectl using MacPorts

Source: https://kubectl.docs.kubernetes.io/installation/kubectl/homebrew

Commands for MacPorts users to install kubectl. This involves updating the ports tree first, then installing the kubectl package.

```bash
sudo port selfupdate
sudo port install kubectl
```

--------------------------------

### Kustomization File with Resources

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/resource

Example of a Kustomization file specifying local files, local directories, and remote URLs as resources.

```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
# Local files
- myNamespace.yaml
- deployment.yaml
- sub-dir/some-deployment.yaml

# Local directories
- ../../commonbase

# Remote URLs
- https://github.com/kubernetes-sigs/kustomize//examples/multibases/?timeout=120&ref=v3.3.1

# Legacy hashicorp/go-getter format
- github.com/kubernets-sigs/kustomize/examples/helloWorld?ref=test-branch

```

--------------------------------

### Display mdrip Help

Source: https://kubectl.docs.kubernetes.io/contributing/kustomize/windows

Displays the usage instructions for the mdrip command, verifying its installation and command-line arguments.

```powershell
C:\...> mdrip --help
Usage:  C:\_go\bin\mdrip.exe {fileName}...
...
```

--------------------------------

### Get Deployments as YAML

Source: https://kubectl.docs.kubernetes.io/references/kubectl/get/raw

Prints the raw resource formatting it as YAML. This is useful for inspecting the full configuration of a deployment.

```bash
kubectl get deployments -o yaml
```

```yaml
apiVersion: v1
items:
- apiVersion: extensions/v1beta1
  kind: Deployment
  metadata:
    annotations:
      deployment.kubernetes.io/revision: "1"
    creationTimestamp: 2018-11-15T18:58:03Z
    generation: 1
    labels:
      app: nginx
    name: nginx
    namespace: default
    resourceVersion: "1672574"
    selfLink: /apis/extensions/v1beta1/namespaces/default/deployments/nginx
    uid: 6131547f-e908-11e8-9ff6-42010a8a00d1
  spec:
    progressDeadlineSeconds: 600
    replicas: 1
    revisionHistoryLimit: 10
    selector:
      matchLabels:
        app: nginx
    strategy:
      rollingUpdate:
        maxSurge: 25%
        maxUnavailable: 25%
      type: RollingUpdate
    template:
      metadata:
        creationTimestamp: null
        labels:
          app: nginx
      spec:
        containers:
        - image: nginx
          imagePullPolicy: Always
          name: nginx
          resources: {}
          terminationMessagePath: /dev/termination-log
          terminationMessagePolicy: File
        dnsPolicy: ClusterFirst
        restartPolicy: Always
        schedulerName: default-scheduler
        securityContext: {}
        terminationGracePeriodSeconds: 30
  status:
    availableReplicas: 1
    conditions:
    - lastTransitionTime: 2018-11-15T18:58:10Z
      lastUpdateTime: 2018-11-15T18:58:10Z
      message: Deployment has minimum availability.
      reason: MinimumReplicasAvailable
      status: "True"
      type: Available
    - lastTransitionTime: 2018-11-15T18:58:03Z
      lastUpdateTime: 2018-11-15T18:58:10Z
      message: ReplicaSet "nginx-78f5d695bd" has successfully progressed.
      reason: NewReplicaSetAvailable
      status: "True"
      type: Progressing
    observedGeneration: 1
    readyReplicas: 1
    replicas: 1
    updatedReplicas: 1
kind: List
metadata:
  resourceVersion: ""
  selfLink: ""

```

--------------------------------

### Create Kustomization Directory

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/exec_plugins

Sets up the main directory for the Kustomize application configuration.

```bash
MYAPP=$DEMO/myapp
mkdir -p $MYAPP
```

--------------------------------

### Create Overlay Directories

Source: https://kubectl.docs.kubernetes.io/guides/config_management/bespoke

Sets up staging and production overlay directories. These directories will contain environment-specific patches and Kustomization files.

```bash
mkdir -p ~/ldap/overlays/staging
mkdir -p ~/ldap/overlays/production

```

--------------------------------

### List Merge Example: Resource Config (Local)

Source: https://kubectl.docs.kubernetes.io/references/architecture/field_merge_semantics

Shows the 'args' field in the local 'Resource Config'.

```yaml
# Resource Config (Local)
args: ["a", "c"]
```

--------------------------------

### Example Deployment resource

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/commonlabels

A sample Deployment resource file that would be processed by Kustomize. Labels defined in commonLabels will be added to this resource.

```yaml
# deploy.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: example


```

--------------------------------

### Remote kustomization.yaml example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/buildmetadata

The Kustomization file content from a remote repository used in the example. It defines a `ConfigMapGenerator`.

```yaml
configMapGenerator:
- name: my-java-server-env-vars
  literals:
  - JAVA_HOME=/opt/java/jdk
  - JAVA_TOOL_OPTIONS=-agentlib:hprof

```

--------------------------------

### Install mdrip

Source: https://kubectl.docs.kubernetes.io/contributing/kustomize/windows

Installs the mdrip tool, used for processing markdown files, via the Go package manager.

```powershell
go get -u github.com/monopole/mdrip
```

--------------------------------

### Complex Example Patch YAML with Vars

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/vars

Patch file in a complex example using vars for service names.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: wordpress
spec:
  template:
    spec:
      initContainers:
      - name: init-command
        image: debian
        command: ["/bin/sh"]
        args: ["-c", "echo $(WORDPRESS_SERVICE); echo $(MYSQL_SERVICE)"]
      containers:
      - name: wordpress
        env:
        - name: WORDPRESS_DB_HOST
          value: $(MYSQL_SERVICE)
        - name: WORDPRESS_DB_PASSWORD
          valueFrom:
            secretKeyRef:
              name: mysql-pass
              key: password


```

--------------------------------

### Initialize Go Module for Plugin

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/containerized_krm_functions

Navigate to the plugin's source directory and initialize a Go module. This is necessary for managing dependencies.

```bash
cd $GOPATH/src/kustomize-plugin-demo

```

--------------------------------

### Kustomization with ConfigMapGenerator Examples

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/configmapgenerator

Demonstrates various ways to use configMapGenerator, including from files, environment files, literals, and options for labels and annotations.

```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

# These labels are added to all configmaps and secrets.
generatorOptions:
  labels:
    fruit: apple

configMapGenerator:
- name: my-java-server-props
  behavior: merge
  files:
  - application.properties
  - more.properties
- name: my-java-server-env-file-vars
  envs:
  - my-server-env.properties
  - more-server-props.env
- name: my-java-server-env-vars
  literals:
  - JAVA_HOME=/opt/java/jdk
  - JAVA_TOOL_OPTIONS=-agentlib:hprof
  options:
    disableNameSuffixHash: true
    labels:
      pet: dog
- name: dashboards
  files:
  - mydashboard.json
  options:
    annotations:
      dashboard: "1"
    labels:
      app.kubernetes.io/name: "app1"


```

--------------------------------

### Upgrade All Installed Kubectl Plugins

Source: https://kubectl.docs.kubernetes.io/guides/extending_kubectl/discovering_plugins

Run this command to upgrade all kubectl plugins that were installed via krew and have available updates.

```bash
kubectl krew upgrade

```

--------------------------------

### Build Kustomize Plugin

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/go_plugins

Builds a Go program as a plugin, outputting a .so file. Adjust paths and version tags as necessary.

```bash
go build -buildmode plugin \
    -o ${wherever}/${kind}.so ${wherever}/${kind}.go
```

--------------------------------

### Building a Go Plugin for Kustomize

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/go_plugins

This command builds a Go plugin, compiling the source code into a shared object (.so) file that Kustomize can load. Ensure the build command is run in the directory where Kustomize expects to find the plugin.

```bash
d=$XDG_CONFIG_HOME/kustomize/plugin\
/${apiVersion}/LOWERCASE(${kind})

go build -buildmode plugin \
   -o $d/${kind}.so $d/${kind}.go

```

--------------------------------

### Kustomize Directory Structure Example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/glossary

Illustrates a common directory layout for Kustomize projects, separating base configurations from environment-specific overlays.

```yaml
├── base
│   ├── deployment.yaml
│   ├── kustomization.yaml
│   └── service.yaml
└── overlays
    ├── dev
    │   ├── kustomization.yaml
    │   └── patch.yaml
    ├── prod
    │   ├── kustomization.yaml
    │   └── patch.yaml
    └── staging
        ├── kustomization.yaml
        └── patch.yaml

```

--------------------------------

### Complex Example Top-Level Kustomization YAML with Vars

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/vars

Top-level Kustomization file in a complex example, defining vars for service names.

```yaml
resources:
- wordpress
- mysql
patchesStrategicMerge:
- patch.yaml
namePrefix: demo-

vars:
- name: WORDPRESS_SERVICE
  objref:
    kind: Service
    name: wordpress
    apiVersion: v1
- name: MYSQL_SERVICE
  objref:
    kind: Service
    name: mysql
    apiVersion: v1


```

--------------------------------

### Build Kustomize Overlays

Source: https://kubectl.docs.kubernetes.io/guides/config_management/components

These commands demonstrate how to build the YAML manifests for different Kustomize overlays using `kustomize build`.

```bash
kustomize build overlays/community
```

```bash
kustomize build overlays/enterprise
```

```bash
kustomize build overlays/dev
```

--------------------------------

### Transformer Annotation Structure Example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/buildmetadata

This example shows the structure of the `config.kubernetes.io/transformations` annotation, detailing fields like `ref`, `repo`, `configuredIn`, and `configuredBy`.

```yaml
config.kubernetes.io/transformations: |
  - ref: v0.0.0 
    repo: http://github.com/examplerepo 
    configuredIn: path/to/transformerconfig 
    configuredBy: 
      kind: Transformer
      apiVersion: builtin 
      name: foo
      namespace: default  

```

--------------------------------

### Set Demo Home Directory

Source: https://kubectl.docs.kubernetes.io/guides/example/multi_base

Sets up a temporary directory for the Kustomize demo. This is a shell command.

```shell
DEMO_HOME = $(mktemp -d)
```

--------------------------------

### Building a Kustomize Application with Plugins

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/exec_plugins

This command builds a Kustomize application, enabling alpha plugins. It demonstrates how to set the XDG_CONFIG_HOME environment variable to point to a custom plugin directory.

```bash
XDG_CONFIG_HOME=$DEMO $DEMO/bin/kustomize build --enable_alpha_plugins $MYAPP
```

--------------------------------

### Verify pod and deployment status

Source: https://kubectl.docs.kubernetes.io/references/kubectl/run

Demonstrates how to check the status of the created pod and deployment using kubectl get pods and kubectl get deployment.

```bash
kubectl get pods

NAME                     READY   STATUS    RESTARTS   AGE
nginx-6db489d4b7-tsfhq   1/1     Running   0          28s

kubectl get deployment

NAME    READY   UP-TO-DATE   AVAILABLE   AGE
nginx   1/1     1            1           44s
```

--------------------------------

### Apply using Kustomization

Source: https://kubectl.docs.kubernetes.io/guides/config_management/apply

It is recommended to run Apply against a kustomization.yaml file using the -k flag. This allows for configuration that spans multiple resources, such as defining a namespace.

```bash
kubectl apply -k kustomization.yaml
```

--------------------------------

### Build and Apply Staging Configuration

Source: https://kubectl.docs.kubernetes.io/guides/config_management/bespoke

Builds the Kustomize configuration for the staging environment and pipes the output to kubectl for application. This applies the resources defined in the staging overlay.

```bash
kustomize build ~/ldap/overlays/staging | kubectl apply -f -

```

--------------------------------

### Verify job creation and status

Source: https://kubectl.docs.kubernetes.io/references/kubectl/create/job

After creating a job, you can verify its status and the status of the Pods it created using `kubectl get jobs` and `kubectl get pods`.

```bash
kubectl get jobs

NAME    COMPLETIONS    DURATION    AGE
my-job  1/1            8S          35s

kubectl get pods

NAME           READY   STATUS   RESTARTS   AGE 
my-job-mqwpv   1/1     Running  0          15s
```

--------------------------------

### Get current pods

Source: https://kubectl.docs.kubernetes.io/references/kubectl/autoscale

Before scaling, you can check the current number of running pods using 'kubectl get pods'. This helps in observing the effect of the autoscaling command.

```bash
$ kubectl get pods

NAME                     READY   STATUS    RESTARTS   AGE
nginx-6db489d4b7-zcc8h   1/1     Running   0          5s


```

--------------------------------

### Build Kubectl Binary

Source: https://kubectl.docs.kubernetes.io/contributing/kubectl

Build the Kubectl binary using 'go build' after navigating to the kubectl command directory. Then, run the version command to verify the build.

```bash
cd cmd/kubectl
go build -v
./kubectl version
```

--------------------------------

### Create Overlay Directories

Source: https://kubectl.docs.kubernetes.io/guides/config_management/offtheshelf

Create separate directories for staging and production overlays. These directories will contain environment-specific customizations.

```bash
mkdir -p ~/ldap/overlays/staging
mkdir -p ~/ldap/overlays/production
```

--------------------------------

### Rejecting Specific Resources

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/replacements

Example of using the 'reject' field to exclude specific resources from being targeted by a replacement. This example rejects resources that are both of kind Deployment and named 'my-deploy'.

```yaml
reject:
- kind: Deployment
  name: my-deploy

```

--------------------------------

### Get Raw Resource as YAML

Source: https://kubectl.docs.kubernetes.io/guides/resource_printing/raw

Use `kubectl get` with the `-o yaml` flag to print the raw resource in YAML format. This is useful for inspecting all fields of a resource.

```bash
kubectl get deployments -o yaml

```

```yaml
apiVersion: v1
items:
- apiVersion: extensions/v1beta1
  kind: Deployment
  metadata:
    annotations:
      deployment.kubernetes.io/revision: "1"
    creationTimestamp: 2018-11-15T18:58:03Z
    generation: 1
    labels:
      app: nginx
    name: nginx
    namespace: default
    resourceVersion: "1672574"
    selfLink: /apis/extensions/v1beta1/namespaces/default/deployments/nginx
    uid: 6131547f-e908-11e8-9ff6-42010a8a00d1
  spec:
    progressDeadlineSeconds: 600
    replicas: 1
    revisionHistoryLimit: 10
    selector:
      matchLabels:
        app: nginx
    strategy:
      rollingUpdate:
        maxSurge: 25%
        maxUnavailable: 25%
      type: RollingUpdate
    template:
      metadata:
        creationTimestamp: null
        labels:
          app: nginx
      spec:
        containers:
        - image: nginx
          imagePullPolicy: Always
          name: nginx
          resources: {}
          terminationMessagePath: /dev/termination-log
          terminationMessagePolicy: File
        dnsPolicy: ClusterFirst
        restartPolicy: Always
        schedulerName: default-scheduler
        securityContext: {}
        terminationGracePeriodSeconds: 30
  status:
    availableReplicas: 1
    conditions:
    - lastTransitionTime: 2018-11-15T18:58:10Z
      lastUpdateTime: 2018-11-15T18:58:10Z
      message: Deployment has minimum availability.
      reason: MinimumReplicasAvailable
      status: "True"
      type: Available
    - lastTransitionTime: 2018-11-15T18:58:03Z
      lastUpdateTime: 2018-11-15T18:58:10Z
      message: ReplicaSet "nginx-78f5d695bd" has successfully progressed.
      reason: NewReplicaSetAvailable
      status: "True"
      type: Progressing
    observedGeneration: 1
    readyReplicas: 1
    replicas: 1
    updatedReplicas: 1
kind: List
metadata:
  resourceVersion: ""
  selfLink: ""

```

--------------------------------

### Custom Resource Definition Example

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/openapi

An example of a custom resource definition (CRD) for 'MyResource' with an 'image' field in its spec. This resource can be managed and patched using a custom OpenAPI schema.

```yaml
apiVersion: example.com/v1alpha1
kind: MyResource
metadata:
  name: service
spec:
  template:
    spec:
      containers:
      - name: server
        image: server
        command: example
        ports:
        - name: grpc
          protocol: TCP
          containerPort: 8080

```

--------------------------------

### Display specific labels as columns with kubectl get

Source: https://kubectl.docs.kubernetes.io/references/kubectl/get/options/labels

Use the -L flag with 'kubectl get' to specify which labels should be displayed as separate columns in the output. This is useful for quickly viewing key-value pairs associated with your resources.

```bash
kubectl get deployments -L=app
```

--------------------------------

### Show Kind in kubectl Get Output

Source: https://kubectl.docs.kubernetes.io/references/kubectl/get/options/show_kind

Use the --show-kind flag with 'kubectl get' to include the Group.Kind in the Name column of the output. This is useful for clarifying which API version is being used when the group is omitted from the resource type.

```bash
kubectl get deployments --show-kind

```

--------------------------------

### Create Kustomization with Flags

Source: https://kubectl.docs.kubernetes.io/references/kustomize/cmd/create

Use the `kustomize create` command with flags to initialize a kustomization with specified namespace, resources, and labels.

```bash
kustomize create --namespace=myapp --resources=deployment.yaml,service.yaml --labels=app:myapp

```

--------------------------------

### Explain a Deployment Resource

Source: https://kubectl.docs.kubernetes.io/guides/resource_printing/cluster_information

Use `kubectl explain` to get information about a specific resource type like Deployment. Specify the API version if needed.

```bash
kubectl explain deployment --api-version apps/v1

```

--------------------------------

### Build and Apply Production Configuration

Source: https://kubectl.docs.kubernetes.io/guides/config_management/bespoke

Builds the Kustomize configuration for the production environment and pipes the output to kubectl for application. This applies the resources defined in the production overlay.

```bash
kustomize build ~/ldap/overlays/production | kubectl apply -f -

```

--------------------------------

### Get Deployments with kubectl

Source: https://kubectl.docs.kubernetes.io/references/kubectl/apply

Retrieves the status of all deployments in the Kubernetes cluster.

```bash
kubectl get deployments

```

--------------------------------

### Define OS for Linux

Source: https://kubectl.docs.kubernetes.io/installation/kubectl/binaries

Set the OS variable to 'linux/amd64' for Linux installations.

```bash
export os="linux/amd64"

```

--------------------------------

### Kubernetes Deployment YAML

Source: https://kubectl.docs.kubernetes.io/references/kubectl/apply

Example YAML definition for a Kubernetes Deployment resource.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: the-deployment
spec:
  replicas: 5
  template:
    containers:
      - name: the-container
        image: registry/container:latest

```

--------------------------------

### Create Working Directory

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/exec_plugins

Creates a temporary directory to use for the Kustomize plugin demonstration.

```bash
DEMO=$(mktemp -d)
```

--------------------------------

### Get deployments command

Source: https://kubectl.docs.kubernetes.io/references/kubectl/edit

This command retrieves a list of all deployments in the current namespace.

```bash
$ kubectl get deployments

```

--------------------------------

### List Kustomization Files

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/exec_plugins

Lists the files within the Kustomization directory to review the created configuration.

```bash
ls -C1 $MYAPP
```

--------------------------------

### List Application Files

Source: https://kubectl.docs.kubernetes.io/guides/extending_kustomize/containerized_krm_functions

This command lists the files created for the Kustomize application, allowing for a review of the configuration.

```bash
ls -C1 $MYAPP

```

--------------------------------

### Example Service resource

Source: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/commonlabels

A sample Service resource file that would be processed by Kustomize. Labels defined in commonLabels will be added to this resource.

```yaml
# service.yaml
apiVersion: v1
kind: Service
metadata:
  name: example


```

--------------------------------

### Get Logs for a Deployment

Source: https://kubectl.docs.kubernetes.io/references/kubectl/logs

This command retrieves the logs from the default container of a specified deployment.

```bash
$ kubectl logs deployment/nginx

```
Tokens:
Raw