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

k8s.contrib.crd.generate1.0.6

Overview
Properties
Methods

module k8s.contrib.crd.generate

Generate Pkl sources from CustomResourceDefinition documents.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/k8s.contrib.crd@1.0.6#/generate.pkl
Pkl version:: 0.25.0 or higher
Source code:: generate.pkl
Known subtypes:
Known usages:
All versions:: 3.0.0, 2.0.2, 2.0.1, 2.0.0, 1.0.14, 1.0.13, 1.0.12, 1.0.11, 1.0.10, 1.0.9, 1.0.8, 1.0.7, 1.0.6, 1.0.5, 1.0.4, 1.0.3, 1.0.2, 1.0.1, 1.0.0

Limitations:

Cannot generate not, allOf, or anyOf combinators correctly due to limitations in Pkl's model.
- Union types exist, but they are logically the same as oneOf (only one subschema can match).
- Intersection types do not exist (can use this to model allOf).
Cannot generate tuple types (this is missing in Pkl).
Properties called default cannot be generated (currently a limitation of the json parser).

TODO:

Handle usages of allOf. We can do this by merging subschemas into a larger schema.
Copy doc comments from a class or typealias to its usage sites if there isn't a doc comment already.
Handle if schema root is not an object type (Example: ansible's schema root has "type": "array").
Handle if schema root should be a mapping (it has additionalProperties or patternProperties set).

Sample CLI usage:

pkl eval package://pkg.pkl-lang.org/pkl-pantry/k8s.contrib.crd@<version>#/generate.pkl \
  -m . \
  -p source="https://raw.githubusercontent.com/monzo/egress-operator/master/config/crd/bases/egress.monzo.com_externalservices.yaml"

Setting up replacement of Kube native types with types from the k8s standard library can be done with amending:

amends "package://pkg.pkl-lang.org/pkl-pantry/k8s.contrib.crd@<version>#/generate.pkl"

import "package://pkg.pkl-lang.org/pkl-k8s/k8s@1.0.1#/api/core/v1/ResourceRequirements.pkl"

source = "https://raw.githubusercontent.com/monzo/egress-operator/master/config/crd/bases/egress.monzo.com_externalservices.yaml"

converters {
  ["externalservices.egress.monzo.com"] {
    [List("spec", "resources")] = ResourceRequirements
  }
}

To figure out which paths you need to override, try running with -p logPaths.

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

k8sVersion: String(semver.isValid(this))Source

The version of the Pkl Kubernetes package to import.

This property is not used if k8sImportPath is set directly.

link

k8sImportPath: String Source

The base path to use for the Kubernetes imports.

Examples:

// Change the version
k8sImportPath = "package://pkg.pkl-lang.org/pkl-k8s/k8s@1.0.0#"

// Use dependency notation, assuming the dependency is called `@k8s`.
k8sImportPath = "@k8s"

link

source: String Source

Where to find the CRDs; can be a URI (https:, file: etc), an absolute file path, or a relative file path
link

sourceContents: String|Resource Source

The CRD's source contents, as computed from source.
link

logPaths: Boolean?Source

Whether to log out every path we find in each CRD to aid in setting converters.

Default: false.
link
converters: Mapping<String, Mapping<List<String>, (Module|Class|TypeAlias)>>?Source

Type conversions when generating property types.
This is a two-dimensional mapping, where top-level entries designate CRD names (for example, "restateclusters.restate.dev").

The inner mapping specifies how individual paths within a CRD should be mapped to a custom type.

Example:
```
converters {
  ["restateclusters.restate.dev"] {
    [List("spec", "compute", "env", "env")] = EnvVar
  }
}
```
link

modules: Listing<ModuleGenerator>Source

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)
```