Documentation
¶
Index ¶
- Constants
- type Storage
- func (s *Storage) Create(rls *rspb.Release) error
- func (s *Storage) Delete(name string, version int) (*rspb.Release, error)
- func (s *Storage) Deployed(name string) (*rspb.Release, error)
- func (s *Storage) DeployedAll(name string) ([]*rspb.Release, error)
- func (s *Storage) Get(name string, version int) (*rspb.Release, error)
- func (s *Storage) GetRelease(name string, version int) (*rspb.Release, error)
- func (s *Storage) History(name string) ([]*rspb.Release, error)
- func (s *Storage) HistoryUntilRevision(name string, ignoreSinceRevision int) ([]*rspb.Release, error)
- func (s *Storage) Last(name string) (*rspb.Release, error)
- func (s *Storage) ListDeployed() ([]*rspb.Release, error)
- func (s *Storage) ListReleases() ([]*rspb.Release, error)
- func (s *Storage) ListUninstalled() ([]*rspb.Release, error)
- func (s *Storage) Update(rls *rspb.Release) error
Constants ¶
const HelmStorageType = "sh.helm.release.v1"
HelmStorageType is the type field of the Kubernetes storage object which stores the Helm release version. It is modified slightly replacing the '/': sh.helm/release.v1 Note: The version 'v1' is incremented if the release object metadata is modified between major releases. This constant is used as a prefix for the Kubernetes storage object name.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Storage ¶
type Storage struct {
driver.Driver
// MaxHistory specifies the maximum number of historical releases that will
// be retained, including the most recent release. Values of 0 or less are
// ignored (meaning no limits are imposed).
MaxHistory int
Log func(string, ...interface{})
}
Storage represents a storage engine for a Release.
func Init ¶
Init initializes a new storage backend with the driver d. If d is nil, the default in-memory driver is used.
func (*Storage) Create ¶
Create creates a new storage entry holding the release. An error is returned if the storage driver fails to store the release, or a release with an identical key already exists.
func (*Storage) Delete ¶
Delete deletes the release from storage. An error is returned if the storage backend fails to delete the release or if the release does not exist.
func (*Storage) Deployed ¶
Deployed returns the last deployed release with the provided release name, or returns ErrReleaseNotFound if not found.
func (*Storage) DeployedAll ¶
DeployedAll returns all deployed releases with the provided name, or returns ErrReleaseNotFound if not found.
func (*Storage) Get ¶
Get retrieves the release from storage. An error is returned if the storage driver failed to fetch the release, or the release identified by the key, version pair does not exist.
func (*Storage) GetRelease ¶ added in v1.27.2
GetRelease returns a single release revision without decoding the whole history. version == 0 resolves the latest revision (via the driver's LastVersion capability, falling back to decoding the history). The revision is always fetched via Query, so the returned release keeps its unfiltered storage labels; Get is deliberately not used because it strips system labels through filterSystemLabels.
func (*Storage) History ¶
History returns the revision history for the release with the provided name, or returns ErrReleaseNotFound if no such release name exists.
func (*Storage) HistoryUntilRevision ¶
func (*Storage) ListDeployed ¶
ListDeployed returns all releases with Status == DEPLOYED. An error is returned if the storage backend fails to retrieve the releases.
func (*Storage) ListReleases ¶
ListReleases returns all releases from storage. An error is returned if the storage backend fails to retrieve the releases.
func (*Storage) ListUninstalled ¶
ListUninstalled returns all releases with Status == UNINSTALLED. An error is returned if the storage backend fails to retrieve the releases.
Source Files
Directories