helm3

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package helm3 provides a data source implementation that can extract k8s objects out of helm3 charts

Index

Constants

View Source
const (
	Scheme = "helm3"
)

Scheme is the scheme supported by this data source

Variables

This section is empty.

Functions

func New

func New(name string, configVar string) ds.DataSourceWithLifecycle

New creates a new helm3 data source

func SetDefaultNamespaceVar

func SetDefaultNamespaceVar(s string)

SetDefaultNamespaceVar sets the name of the external variable that is always set to the default namespace to use.

Types

type Config

type Config struct {
	Command string `json:"command"`           // the executable that is run, default is "helm"
	Timeout string `json:"timeout,omitempty"` // command timeout as a duration string
	// contains filtered or unexported fields
}

Config is the configuration of the data source. TODO: add version check, SHA check options etc.

type TemplateConfig

type TemplateConfig struct {
	Name    string                 `json:"name,omitempty"`
	Options TemplateOptions        `json:"options,omitempty"`
	Values  map[string]interface{} `json:"values,omitempty"`
}

TemplateConfig is the configuration for the template command that includes options and values. TODO: make a schema for this and validate inputs before JSON unmarshal

type TemplateOptions

type TemplateOptions struct {
	Namespace                string   `json:"namespace,omitempty"`
	CreateNamespace          bool     `json:"createNamespace,omitempty"`
	APIVersions              []string `json:"apiVersions,omitempty"`
	DependencyUpdate         bool     `json:"dependencyUpdate,omitempty"`
	Description              string   `json:"description"`
	Devel                    bool     `json:"devel"`
	DisableOpenAPIValidation bool     `json:"disableOpenapiValidation,omitempty"`
	GenerateName             bool     `json:"generateName,omitempty"`
	IncludeCRDs              bool     `json:"includeCrds,omitempty"`
	IsUpgrade                bool     `json:"isUpgrade,omitempty"`
	SkipCRDs                 bool     `json:"skipCrds,omitempty"`
	SkipTests                bool     `json:"skipTests,omitempty"`
	InsecureSkipTLSVerify    bool     `json:"insecureSkipTlsVerify,omitempty"`
	KubeVersion              string   `json:"kubeVersion,omitempty"`
	NameTemplate             string   `json:"nameTemplate,omitempty"`
	NoHooks                  bool     `json:"noHooks,omitempty"`
	PassCredentials          bool     `json:"passCredentials,omitempty"`
	Password                 string   `json:"password,omitempty" fld:"secure"`
	RenderSubchartNotes      bool     `json:"renderSubchartNotes,omitempty"`
	Replace                  bool     `json:"replace,omitempty"`
	Repo                     string   `json:"repo,omitempty"`
	ShowOnly                 []string `json:"showOnly,omitempty"`
	Username                 string   `json:"username,omitempty"`
	Validate                 bool     `json:"validate,omitempty"`
	Verify                   bool     `json:"verify,omitempty"`
	Version                  string   `json:"version,omitempty"`
}

TemplateOptions are a subset of command line arguments that can be passed to `helm template`

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL