Skip to content

Latest commit

 

History

History
194 lines (115 loc) · 5.59 KB

API.md

File metadata and controls

194 lines (115 loc) · 5.59 KB
Raw

API Reference

Constructs

Kustomize

Represents a Kustomize deployment.

Use this construct to import an existing Kustomize directory and incorporate it into your constructs.

Initializers 

import { Kustomize } from 'cdk8s-kustomize'

new Kustomize(scope: Construct, id: string, props: KustomizeProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props KustomizeProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Kustomize } from 'cdk8s-kustomize'

Kustomize.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
apiObjects cdk8s.ApiObject[] Returns all the included API objects.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

apiObjectsRequired 
public readonly apiObjects: ApiObject[];
  • Type: cdk8s.ApiObject[]

Returns all the included API objects.

Structs

KustomizeProps

Options for Kustomize.

Initializer 

import { KustomizeProps } from 'cdk8s-kustomize'

const kustomizeProps: KustomizeProps = { ... }

Properties

Name Type Description
url string URL or path to the Kustomize directory.
kustomizeExecutable string | string[] The local kustomize executable to use in order to create the manifest.
kustomizeFlags string[] Additional flags to add to the kustomize execution.
urlRequired 
public readonly url: string;
  • Type: string

URL or path to the Kustomize directory.

GoGetter URLs are supported: for example to get github's CrunchyData postgres operator, subdirectory kustomize/install/default, from the master ref - use:

https://github.com/CrunchyData/postgres-operator-examples//kustomize/install/default?ref=2085b73c85f3c30f0a0b1d3f5fe17b22c3eede3

See https://github.com/kubernetes-sigs/kustomize/blob/master/examples/remoteBuild.md for more information

kustomizeExecutableOptional 
public readonly kustomizeExecutable: string | string[];
  • Type: string | string[]
  • Default: ["kubectl", "kustomize"]

The local kustomize executable to use in order to create the manifest.

kustomizeFlagsOptional 
public readonly kustomizeFlags: string[];
  • Type: string[]
  • Default: []

Additional flags to add to the kustomize execution.