overview

Documentation

Overview

Code generated by "mdtogo"; DO NOT EDIT.

Index

• Variables

Variables

var READMEExamples = `` /* 1863-byte string literal not displayed */

var READMELong = `
kpt is a toolkit to help you manage, examine, manipulate, customize, validate, and apply Kubernetes resource
configuration files, both manually and programmatically.  (And has a name short enough that you don't have to alias it to ` + "`" + `k` + "`" + `).

A primary goal of kpt is to facilitate configuration reuse. The two primary sets of capabilities that are required to enable reuse are:
1. The ability to distribute/publish/share, compose, and update groups of configuration artifacts, commonly known as packages.
2. The ability to adapt them to your use cases, which we call customization.

In order to facilitate programmatic operations, kpt:
1. Relies upon git as the source of truth
2. Represents configuration as data, specifically Kubernetes resources serialized as YAML or JSON.

For compatibility with other arbitrary formats, kpt supports generating resource configuration data from templates,
configuration DSLs, and programs.

kpt functionality is subdivided into command groups, each of which operates on a particular set of entities, with a consistent command syntax and pattern of inputs and outputs.

| Command Group | Description                                                                     |
|---------------|---------------------------------------------------------------------------------|
| [pkg]         | fetch, update, and sync configuration files using git                           |
| [cfg]         | examine and modify configuration files                                          |
| [fn]          | generate, transform, validate configuration files using containerized functions |
| [live]        | reconcile the live state with configuration files                               |

---

#### [pkg] Package Management

Fetch, update, and sync configuration files using git.

- Fetch and customize blueprints published by others.
- Fetch the standard scaffolding for your new service.
- Update your customized package by merging changes from upstream.

**Data Flow**: git repo -> kpt [pkg] -> local files or stdout

| Configuration Read From | Configuration Written To |
|-------------------------|--------------------------|
| git repository          | local files              |

---

#### [cfg] Configuration Management

Examine and modify configuration files.

- Display structured and condensed views of your resources
- Filter and display resources by constraints
- Set high-level knobs published by the package
- Define and expose new knobs to simplify routine modifications

**Data Flow**: local configuration or stdin -> kpt [cfg] -> local configuration or stdout

| Configuration Read From | Configuration Written To |
|-------------------------|--------------------------|
| local files or stdin    | local files or stdout    |

---

#### [fn] Configuration Functions

Generate, transform, validate configuration files using containerized functions.

- Generate resources from code, DSLs, templates, etc.
- Apply cross-cutting transformations to resources
- Validate resources

*` + "`" + `fn` + "`" + ` is different from ` + "`" + `cfg` + "`" + ` in that it executes programs published as container images, rather
than statically compiled into kpt.*

**Data Flow**:  local configuration or stdin -> kpt [fn] (runs a container) -> local configuration or stdout

| Configuration Read From | Configuration Written To |
|-------------------------|--------------------------|
| local files or stdin    | local files or stdout    |

---

#### [live] Live-state Management

Reconcile configuration files with the live state.

- Apply package resources to cluster
- Preview changes before applying them
- Wait until a package has been fully reconciled with the live state
- Delete package resources from cluster

**Data Flow**: local configuration or stdin -> kpt live -> apiserver (Kubernetes cluster)

| Configuration Read From | Configuration Written To |
|-------------------------|--------------------------|
| local files or stdin    | apiserver                |
| apiserver               | stdout                   |

---
`

var READMEShort = `<link rel="stylesheet" type="text/css" href="/kpt/gifs/asciinema-player.css" />`