Documentation ¶
Overview ¶
Package helmut provides functions to perform unit tests on the helm chart.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Manifests ¶
type Manifests struct {
// contains filtered or unexported fields
}
Manifests stores the rendered manifests.
func NewManifests ¶
func NewManifests(options ...SchemeOption) *Manifests
NewManifests creates and returns new Manifests. If SchemeOption is omitted, the default scheme will be used.
type ObjectKey ¶
ObjectKey is that uniquely identifies an object. Used as the key for the map that holds the object.
func NewObjectKey ¶
func NewObjectKey(namespace, name string, gvk schema.GroupVersionKind) ObjectKey
NewObjectKey creates and returns a new ObjectKey.
func NewObjectKeyFromObject ¶
func NewObjectKeyFromObject(obj runtime.Object, options ...SchemeOption) (ObjectKey, error)
NewObjectKeyFromObject creates and returns an ObjectKey from an object. If SchemeOption is omitted, the default scheme will be used.
func (ObjectKey) GetGroupVersionKind ¶
func (k ObjectKey) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns group,version,kind.
func (ObjectKey) GetNamespace ¶
GetNamespace returns the namespace of the object.
type Option ¶
type Option func(*option)
Option is an option to specify when calling RenderTemplates.
func WithAPIVersions ¶
WithAPIVersions specifies the apiVersions. This is equivalent to the "--api-versions" option of the "helm template" command.
func WithIncludeCRDs ¶
func WithIncludeCRDs() Option
WithIncludeCRDs will include CRDs in the templated output. This is equivalent to the "--include-crds" option of the "helm template" command.
func WithNamespace ¶
WithNamespace specifies the namespace. This is equivalent to the "--namespace" option of the "helm template" command.
func WithSet ¶
WithSet set values just like the command line. (can specify multiple or separate values with commas: key1=val1,key2=val2) This is equivalent to the "--set" option of the "helm template" command.
func WithSetFile ¶
WithSetFile set values just like the command line. (can specify multiple or separate values with commas: key1=val1,key2=val2) This is equivalent to the "set-file" option of the "helm template" command.
func WithSetString ¶
WithSetString set STRING values just like the command line. (can specify multiple or separate values with commas: key1=val1,key2=val2) This is equivalent to the "--set-string" option of the "helm template" command.
func WithValues ¶
WithValues specifies values in a YAML file or a URL (can specify multiple). This is equivalent to the "--values" or "-f" option of the "helm template" command.
type Renderer ¶
type Renderer struct {
// contains filtered or unexported fields
}
Renderer will perform the equivalent of the "helm template" command to render the manifests.
func New ¶
func New(options ...SchemeOption) *Renderer
New creates and returns a new Renderer. option allows you to specify the scheme to be used by the Renderer. For example, specify the scheme in which the custom resource is registered.
func (*Renderer) RenderTemplates ¶
RenderTemplates will execute the equivalent of the "helm template" command and return the result.
type SchemeOption ¶
type SchemeOption func(*schemeOption)
SchemeOption is an option to specify the scheme. If not specified, the default scheme provided by client-go will be used.
func WithScheme ¶
func WithScheme(scheme *runtime.Scheme) SchemeOption
WithScheme specifies the scheme.