Packages > pkg.pkl-lang.org/pkl-pantry/k8s.contrib

k8s.contrib.Converter2.0.0

Overview
Properties
Methods

module k8s.contrib.Converter

A library for converting Kubernetes YAML to Pkl

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/k8s.contrib@2.0.0#/Converter.pkl
Pkl version:: 0.31.0 or higher
Source code:: Converter.pkl
Known subtypes in package:
Known usages in package:
All versions:

Example:

import "package://pkg.pkl-lang.org/pkl-pantry/k8s.contrib@<version>#/Converter.pkl"

resultingPkl = new Converter { input = read("path/to/resource.yml") }.result

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

input: String|Resource Source

The input kubernetes YAML string, or parsed Resource pointing to the YAML string.

This property is ignored if resourcesToConvert is set.
link

resourcesToConvert: List<Mapping>Source

The Kubernetes resources to convert.

Each resource is an object of type Mapping as produced by yaml.Parser.

Defaults to the resources contained in the YAML file passed with -p input=path/to/file.yml.
link

resourceConverters: Mapping<String, (Mapping) -> Any>Source

Converters to be sequentially applied to resourcesToConvert.

The default resourceConverters suffice to convert standard Kubernetes resources.
link
customResourceTemplates: Mapping<String, Mapping<String, K8sResource>>Source

Resource templates to be used for converting custom resources.
The first String key is the resource's kind, the second its apiVersion.

Example:
```
customResourceTemplates {
  ["Custom"] {
     ["v1"] = import("Custom.pkl")
  }
}
```
link

result: String Source

The resulting converted Kubernetes resources, in Pkl.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

getResourceTemplate(resource: Mapping): K8sResource Source
link

function

getResourceTemplateUri(resource: Mapping): String Source
link

function

resourceConverterFn(resource: unknown): unknownSource