helm

package
v0.1.11 Latest Latest
Warning

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

 Go to latest Published: Dec 29, 2025 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConfigMap 

type ConfigMap struct {
	// contains filtered or unexported fields
}

ConfigMap represents a Kubernetes ConfigMap

func (*ConfigMap) Get 

func (c *ConfigMap) Get(key string) (string, error)

Get retrieves a ConfigMap value by key

type Deployment added in v0.1.2 

type Deployment struct {
	Name      string
	Namespace string
	// contains filtered or unexported fields
}

func (*Deployment) GetReplicas added in v0.1.2 

func (d *Deployment) GetReplicas() (int, error)

type Helm added in v0.1.1 

type Helm = clickyExec.WrapperFunc

type HelmChart 

type HelmChart struct {
	flanksourceCtx.Context
	// contains filtered or unexported fields
}

HelmChart represents a Helm chart with fluent interface

func NewHelmChart 

func NewHelmChart(ctx flanksourceCtx.Context, chartPath string) *HelmChart

NewHelmChart creates a new HelmChart builder

func (*HelmChart) Delete 

func (h *HelmChart) Delete() *HelmChart

Delete deletes the Helm release

func (*HelmChart) DryRun 

func (h *HelmChart) DryRun() *HelmChart

DryRun enables dry-run mode

func (*HelmChart) Error 

func (h *HelmChart) Error() error

Error returns the last error

func (*HelmChart) ForceConflicts added in v0.1.5 

func (h *HelmChart) ForceConflicts() *HelmChart

func (*HelmChart) ForceReplace added in v0.1.7 

func (h *HelmChart) ForceReplace() *HelmChart

func (*HelmChart) GetConfigMap 

func (h *HelmChart) GetConfigMap(name string) *ConfigMap

GetConfigMap returns a ConfigMap accessor

func (*HelmChart) GetPVC 

func (h *HelmChart) GetPVC(name string) *PVC

GetPVC returns a PersistentVolumeClaim accessor

func (*HelmChart) GetPod 

func (h *HelmChart) GetPod(selector string) *Pod

GetPod returns a Pod accessor for the current release

func (*HelmChart) GetSecret 

func (h *HelmChart) GetSecret(name string) *Secret

GetSecret returns a Secret accessor

func (*HelmChart) GetStatefulSet 

func (h *HelmChart) GetStatefulSet(name string) *StatefulSet

GetStatefulSet returns a StatefulSet accessor

func (*HelmChart) GetStatus added in v0.1.2 

func (h *HelmChart) GetStatus() (*HelmStatus, error)

Status returns the Helm release status

func (*HelmChart) GetValue 

func (h *HelmChart) GetValue(path ...string) string

func (*HelmChart) GetValues 

func (h *HelmChart) GetValues() map[string]interface{}

func (*HelmChart) Install 

func (h *HelmChart) Install() error

Install installs the Helm chart

func (*HelmChart) InstallOrUpgrade added in v0.1.2 

func (h *HelmChart) InstallOrUpgrade() error

func (*HelmChart) Kubectl added in v0.1.2 

func (h *HelmChart) Kubectl() clickyExec.WrapperFunc

func (*HelmChart) Matches added in v0.1.1 

func (h *HelmChart) Matches(o Object) bool

func (*HelmChart) MustSucceed 

func (h *HelmChart) MustSucceed() *HelmChart

MustSucceed panics if there was an error

func (*HelmChart) Namespace 

func (h *HelmChart) Namespace(ns string) *HelmChart

Namespace sets the namespace

func (*HelmChart) NoColor 

func (h *HelmChart) NoColor() *HelmChart

NoColor disables colored output

func (*HelmChart) Release 

func (h *HelmChart) Release(name string) *HelmChart

Release sets the release name

func (*HelmChart) Repository added in v0.1.10 

func (h *HelmChart) Repository(repo, url string) *HelmChart

Repository sets the repository

func (*HelmChart) Result 

func (h *HelmChart) Result() *clickyExec.ExecResult

Result returns the last command result

func (*HelmChart) SetValue 

func (h *HelmChart) SetValue(key string, value interface{}) *HelmChart

SetValue sets a single value using dot notation

func (*HelmChart) Status 

func (h *HelmChart) Status() (string, error)

Status returns the Helm release status

func (*HelmChart) Upgrade 

func (h *HelmChart) Upgrade() error

Upgrade upgrades the Helm release

func (*HelmChart) Values 

func (h *HelmChart) Values(values map[string]interface{}) *HelmChart

Values sets or merges Helm values

func (*HelmChart) Wait 

func (h *HelmChart) Wait() *HelmChart

Wait enables waiting for resources to be ready

func (*HelmChart) WaitFor 

func (h *HelmChart) WaitFor(timeout time.Duration) *HelmChart

WaitFor sets the wait timeout

type HelmStatus added in v0.1.2 

type HelmStatus struct {
	Name      string         `json:"name"`
	Info      HelmStatusInfo `json:"info"`
	Manifest  string         `json:"manifest"`
	Version   int            `json:"version"`
	Namespace string         `json:"namespace"`
}

func (HelmStatus) Pretty added in v0.1.2 

func (s HelmStatus) Pretty() api.Text

type HelmStatusInfo added in v0.1.2 

type HelmStatusInfo struct {
	FirstDeployed string `json:"first_deployed"`
	LastDeployed  string `json:"last_deployed"`
	Deleted       string `json:"deleted"`
	Description   string `json:"description"`
	Status        string `json:"status"`
}

type Kind added in v0.1.1 

type Kind struct {
	APIVersion string `json:"apiVersion"`
	Kind       string `json:"kind"`
}

type Kubectl added in v0.1.1 

type Kubectl func(args ...string) (*exec.ExecResult, error)

type Metadata added in v0.1.1 

type Metadata struct {
	Name            string            `json:"name"`
	Namespace       string            `json:"namespace"`
	UID             string            `json:"uid,omitempty"`
	Annotations     map[string]string `json:"annotations"`
	Labels          map[string]string `json:"labels"`
	OwnerReferences []OwnerRef        `json:"ownerReferences"`
	Generation      int64             `json:"generation,omitempty"`
}

type Namespace 

type Namespace struct {
	// contains filtered or unexported fields
}

Namespace represents a Kubernetes namespace with fluent interface

func NewNamespace 

func NewNamespace(name string) *Namespace

NewNamespace creates a new Namespace accessor

func (*Namespace) Create 

func (n *Namespace) Create() *Namespace

Create creates the namespace

func (*Namespace) Delete 

func (n *Namespace) Delete() *Namespace

Delete deletes the namespace

func (*Namespace) GetPods added in v0.1.1 

func (h *Namespace) GetPods(selectors ...string) ([]*Pod, error)

func (*Namespace) MustSucceed 

func (n *Namespace) MustSucceed() *Namespace

MustSucceed panics if there was an error

type Object added in v0.1.1 

type Object struct {
	Metadata `json:"metadata,omitempty"`
	Kind     `json:",inline"`
}

type OwnerRef added in v0.1.1 

type OwnerRef struct {
	Kind `json:",inline"`
	Name string `json:"name"`
	UID  string `json:"uid,omitempty"`
}

func (OwnerRef) AsObject added in v0.1.1 

func (o OwnerRef) AsObject() Object

type PVC 

type PVC struct {
	Metadata `json:",inline"`
	// contains filtered or unexported fields
}

PVC represents a PersistentVolumeClaim

func (*PVC) Status 

func (p *PVC) Status() (map[string]interface{}, error)

Status returns the PVC status

type Pod 

type Pod struct {
	Metadata `json:"metadata,omitempty"`
	Kind     `json:",inline"`
	// contains filtered or unexported fields
}

Pod represents a Kubernetes pod with fluent interface

func (*Pod) Container 

func (p *Pod) Container(name string) *Pod

Container sets the container name

func (*Pod) Error 

func (p *Pod) Error() error

Error returns the last error

func (*Pod) Exec 

func (p *Pod) Exec(command string) *Pod

Exec executes a command in the pod

func (*Pod) ForwardPort added in v0.1.1 

func (p *Pod) ForwardPort(port int) (*int, func())

ForwardPort forwards a port from the pod to the local machine

func (*Pod) GetLogs 

func (p *Pod) GetLogs(lines ...int) string

GetLogs retrieves pod logs

func (*Pod) GetName added in v0.1.1 

func (p *Pod) GetName() string

func (*Pod) GetOwner added in v0.1.1 

func (p *Pod) GetOwner() (*Object, error)

func (*Pod) MustSucceed 

func (p *Pod) MustSucceed() *Pod

MustSucceed panics if there was an error

func (*Pod) Result 

func (p *Pod) Result() string

Result returns the last command result

func (*Pod) Status 

func (p *Pod) Status() (string, error)

Status returns the pod status

func (*Pod) WaitFor 

func (p *Pod) WaitFor(condition string, timeout time.Duration) *Pod

WaitFor waits for a specific condition

func (*Pod) WaitReady 

func (p *Pod) WaitReady() *Pod

WaitReady waits for the pod to be ready

type Secret 

type Secret struct {
	// contains filtered or unexported fields
}

Secret represents a Kubernetes Secret

func (*Secret) Get 

func (s *Secret) Get(key string) (string, error)

Get retrieves a secret value by key

type StatefulSet 

type StatefulSet struct {
	// contains filtered or unexported fields
}

StatefulSet represents a Kubernetes StatefulSet

func (*StatefulSet) GetGeneration 

func (s *StatefulSet) GetGeneration() (int64, error)

GetGeneration returns the current generation

func (*StatefulSet) GetReplicas 

func (s *StatefulSet) GetReplicas() (int, error)

GetReplicas returns the number of ready replicas

func (*StatefulSet) WaitFor 

func (s *StatefulSet) WaitFor(timeout time.Duration) *StatefulSet

WaitFor waits for the StatefulSet rollout to complete

func (*StatefulSet) WaitReady 

func (s *StatefulSet) WaitReady() *StatefulSet

WaitReady waits for the StatefulSet to be ready

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.