Skip to content

README.md

Latest commit

 

History

History
61 lines (41 loc) · 1.53 KB

README.md

File metadata and controls

61 lines (41 loc) · 1.53 KB

set-default-labels

Overview

The set-default-labels function applies KPT label convention to your KPT package.

app.kubernetes.io/name

Running the function can add this label using the value from the root Kptfile name.

This convention believes that all KRM resources under the same kpt package should be served for a specific application. An application (or KPT package) can be composed by other applications (nested sub KPT packages). So the function can accept multiple Kptfile and use the root Kptfile to set the app name.

You can learn more about the recommended labels here.

Usage

This function should be run in a KPT package. It does not require function config.

Run the function once

$ kpt fn eval --image set-default-labels:unstable

Run the function in a Kpt pipeline

Execute the set-default-labels function and save the config to Kptfile pipeline if the function passes.

$ kpt fn eval -t mutator -s -i set-default-labels:unstable

Check the Kptfile file, it now contains the set-default-labels function in its pipeline.

$ cat Kptfile

apiVersion: kpt.dev/v1
kind: Kptfile
metadata:
  name: set-default-label-example
  annotations:
    config.kubernetes.io/local-config: "true"
pipeline:
  mutators:
    - image: gcr.io/kpt-fn/set-default-labels:unstable
$ kpt fn render