Documentation
¶
Overview ¶
Package werf is the backend that installs through Nelm, the deployment engine of werf: the operator prepares charts as for the helm backend and runs nelm for each component. Nelm keeps Helm-compatible release history, so this backend can roll back. The nelm binary ships in the operator image.
Index ¶
- type Backend
- func (b *Backend) Apply(ctx context.Context, c backend.Component) (backend.State, error)
- func (b *Backend) Name() string
- func (b *Backend) Rollback(ctx context.Context, c backend.Component, toRevision int) (backend.State, error)
- func (b *Backend) Status(ctx context.Context, c backend.Component) (backend.State, error)
- func (b *Backend) Uninstall(ctx context.Context, c backend.Component) error
- type Runner
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Backend ¶
type Backend struct {
// Run runs the nelm binary; NewBackend sets it.
Run Runner
// Kubeconfig is the file nelm talks to the cluster with.
Kubeconfig string
// TempDir receives values files.
TempDir string
// Secrets reads the platform values Secret.
Secrets kubernetes.Interface
// HistoryLimit bounds stored release revisions; it must exceed the
// PackageRevision history, or rollbacks would target pruned releases.
HistoryLimit int
}
Backend runs nelm.
func NewBackend ¶
func NewBackend(binary, tempDir string, cfg *rest.Config, secrets kubernetes.Interface) (*Backend, error)
NewBackend writes a kubeconfig for nelm from cfg, so it acts with the operator's own identity, and runs binary.
func (*Backend) Rollback ¶
func (b *Backend) Rollback(ctx context.Context, c backend.Component, toRevision int) (backend.State, error)
Rollback re-deploys an earlier release revision.
Click to show internal directories.
Click to hide internal directories.