Documentation
¶
Overview ¶
Package helm provides a Helm chart deployer implementation.
Index ¶
- Variables
- type Manager
- func (m *Manager) Deploy(ctx context.Context, deployerConfig *v2.DeployerConfig, ...) error
- func (m *Manager) Status(ctx context.Context, deployerConfig *v2.DeployerConfig, ...) (*deployer.Status, error)
- func (m *Manager) Type() string
- func (m *Manager) Undeploy(ctx context.Context, deployerConfig *v2.DeployerConfig, ...) error
- func (m *Manager) Validate(deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrNotHelmDeployer is returned when attempting to operate on a non-Helm deployer. ErrNotHelmDeployer = errors.New("deployer is not a Helm deployer") // ErrRepositoryNotFound is returned when a repository referenced by a deployer is not found. ErrRepositoryNotFound = errors.New("repository not found") // ErrValuesFileNotFound is returned when a referenced values file doesn't exist. ErrValuesFileNotFound = errors.New("values file not found") )
Functions ¶
This section is empty.
Types ¶
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager implements deployer.Manager for Helm chart deployers.
func NewManager ¶
NewManager creates a new Helm deployer manager.
func (*Manager) Deploy ¶
func (m *Manager) Deploy(ctx context.Context, deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) error
Deploy deploys the Helm chart to the cluster. If the chart is already deployed, this upgrades it to match the current configuration.
func (*Manager) Status ¶
func (m *Manager) Status(ctx context.Context, deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) (*deployer.Status, error)
Status returns the current status of the Helm chart deployment.
func (*Manager) Undeploy ¶
func (m *Manager) Undeploy(ctx context.Context, deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) error
Undeploy removes the Helm chart from the cluster.
func (*Manager) Validate ¶
func (m *Manager) Validate(deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) error
Validate validates the helm deployer configuration and referenced files.
Click to show internal directories.
Click to hide internal directories.