helmdeployer

Documentation

Overview

Copyright The Helm Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func GetSetID(bundleID, labelPrefix, labelSuffix string) string
• func Template(bundleID string, manifest *manifest.Manifest, ...) ([]runtime.Object, error)
• type DeployedBundle
• type Helm
  • func NewHelm(namespace, defaultNamespace, labelPrefix, labelSuffix string, ...) (*Helm, error)
  • func (h *Helm) Delete(bundleID, releaseName string) error
  • func (h *Helm) Deploy(bundleID string, manifest *manifest.Manifest, ...) (*Resources, error)
  • func (h *Helm) EnsureInstalled(bundleID, resourcesID string) (bool, error)
  • func (h *Helm) ListDeployments() ([]DeployedBundle, error)
  • func (h *Helm) RemoveExternalChanges(bd *fleet.BundleDeployment) (string, error)
  • func (h *Helm) Resources(bundleID, resourcesID string) (*Resources, error)
  • func (h *Helm) ResourcesFromPreviousReleaseVersion(bundleID, resourcesID string) (*Resources, error)
• type Resources

Constants

const (
	BundleIDAnnotation           = "fleet.cattle.io/bundle-id"
	CommitAnnotation             = "fleet.cattle.io/commit"
	AgentNamespaceAnnotation     = "fleet.cattle.io/agent-namespace"
	ServiceAccountNameAnnotation = "fleet.cattle.io/service-account"
	DefaultServiceAccount        = "fleet-default"
	KeepResourcesAnnotation      = "fleet.cattle.io/keep-resources"
	HelmUpgradeInterruptedError  = "another operation (install/upgrade/rollback) is in progress"
	MaxHelmHistory               = 2
	CRDKind                      = "CustomResourceDefinition"
)

Variables

var (
	ErrNoRelease    = errors.New("failed to find release")
	ErrNoResourceID = errors.New("no resource ID available")
	DefaultKey      = "values.yaml"
)

Functions

func GetSetID

func GetSetID(bundleID, labelPrefix, labelSuffix string) string

GetSetID constructs a identifier from the provided args, bundleID "fleet-agent" is special

func Template

func Template(bundleID string, manifest *manifest.Manifest, options fleet.BundleDeploymentOptions) ([]runtime.Object, error)

Template runs helm template and returns the resources as a list of objects, without applying them.

Types

type DeployedBundle

type DeployedBundle struct {
	// BundleID is the bundle.Name
	BundleID string
	// ReleaseName is actually in the form "namespace/release name"
	ReleaseName string
	// KeepResources indicate if resources should be kept when deleting a GitRepo or Bundle
	KeepResources bool
}

type Helm

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

func NewHelm

func NewHelm(namespace, defaultNamespace, labelPrefix, labelSuffix string, getter genericclioptions.RESTClientGetter,
	serviceAccountCache corecontrollers.ServiceAccountCache, configmapCache corecontrollers.ConfigMapCache, secretCache corecontrollers.SecretCache) (*Helm, error)

func (*Helm) Delete

func (h *Helm) Delete(bundleID, releaseName string) error

Delete the release for the given bundleID. releaseName is a key in the format "namespace/name". If releaseName is empty, search for a matching release.

func (*Helm) Deploy

func (h *Helm) Deploy(bundleID string, manifest *manifest.Manifest, options fleet.BundleDeploymentOptions) (*Resources, error)

func (*Helm) EnsureInstalled

func (h *Helm) EnsureInstalled(bundleID, resourcesID string) (bool, error)

func (*Helm) ListDeployments

func (h *Helm) ListDeployments() ([]DeployedBundle, error)

ListDeployments returns a list of bundles by listing all helm releases via helm's storage driver (secrets)

func (*Helm) RemoveExternalChanges

func (h *Helm) RemoveExternalChanges(bd *fleet.BundleDeployment) (string, error)

RemoveExternalChanges does a helm rollback to remove changes made outside of fleet. It removes the helm history entry if the rollback fails.

func (*Helm) Resources

func (h *Helm) Resources(bundleID, resourcesID string) (*Resources, error)

Resources returns the resources from the helm release history

func (*Helm) ResourcesFromPreviousReleaseVersion

func (h *Helm) ResourcesFromPreviousReleaseVersion(bundleID, resourcesID string) (*Resources, error)

type Resources

type Resources struct {
	ID               string           `json:"id,omitempty"`
	DefaultNamespace string           `json:"defaultNamespace,omitempty"`
	Objects          []runtime.Object `json:"objects,omitempty"`
}