deploy

package
v0.2.3 Latest Latest
Warning

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

Go to latest
Published: Jun 15, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package deploy installs a Podplane app template onto a Kubernetes cluster by rendering values and invoking Helm against a cached chart.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Logs

func Logs(opts LogsOptions) error

Logs invokes `kubectl logs --follow` for pods belonging to the named app.

func Remove

func Remove(opts RemoveOptions) error

Remove invokes `helm uninstall` for the named release.

func Run

func Run(opts Options) error

Run renders Helm values from opts and invokes `helm upgrade --install` for the resolved chart. The caller is responsible for ensuring opts.ChartPath exists (typically via EnsureChart).

Types

type Chart

type Chart struct {
	Path     string
	Template deps.TemplateChart
}

Chart is a resolved template chart in the local dependency cache.

func EnsureChart

func EnsureChart(c *config.Config, template string, wrap func(download func(progress func(deps.DownloadEvent)) error) error) (Chart, error)

EnsureChart returns the local Helm chart path for template, downloading dependencies first when the chart is missing from the cache. wrap, if non-nil, brackets the download call so callers can render a UI around it; it receives the download function to invoke with a progress callback.

type LogsOptions

type LogsOptions struct {
	Name       string
	Namespace  string
	Context    string
	Kubeconfig string
}

LogsOptions controls log streaming for a deployed app.

type Options

type Options struct {
	Template         string
	Name             string
	ChartPath        string
	Image            string
	Env              []string
	Hostname         string
	Path             string
	Port             int
	RuntimeDirectory string
	Set              []string
	Namespace        string
	Context          string
	Kubeconfig       string
	Wait             bool
	Timeout          time.Duration
}

Options controls a single app deployment.

type RemoveOptions

type RemoveOptions struct {
	Name       string
	Namespace  string
	Context    string
	Kubeconfig string
}

RemoveOptions controls removal of a previously deployed app.

Jump to

Keyboard shortcuts

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