lib

Documentation

Index

• func Add(...) error
• func CheckResponsibility(ctx context.Context, lsClient client.Client, obj *metav1.PartialObjectMetadata, ...) (*lsv1alpha1.ResolvedTarget, bool, bool, lserrors.LsError)
• func CreateOrUpdateExport(ctx context.Context, kubeWriter *read_write_layer.Writer, ...) error
• func ExpandManagedResourceManifests(origManifests []managedresource.Manifest) ([]managedresource.Manifest, error)
• func ExpandManifests(manifests []*runtime.RawExtension) ([]*runtime.RawExtension, error)
• func GetKubeconfigFromTargetConfig(config *targettypes.KubernetesClusterTargetConfig) ([]byte, error)
• func GetRegistryPullSecretsFromContext(lsCtx *lsv1alpha1.Context) []lsv1alpha1.ObjectReference
• func GetRestConfigAndClientAndClientSet(ctx context.Context, resolvedTarget *lsv1alpha1.ResolvedTarget, ...) (_ *rest.Config, _ client.Client, _ kubernetes.Interface, err error)
• func GetTargetClient(ctx context.Context, primaryTargetClient client.Client, lsClient client.Client, ...) (targetClient client.Client, err error)
• func HandleReconcileResult(ctx context.Context, err lserrors.LsError, ...) error
• func IsDeployItemFinished(di *lsv1alpha1.DeployItem) bool
• func NewController(...) *controller
• func NewTypePredicate(dtype lsv1alpha1.DeployItemType) predicate.Predicate
• type Deployer
• type DeployerArgs
  • func (args *DeployerArgs) Default()
  • func (args DeployerArgs) Validate() error

Functions

func Add

func Add(lsUncachedClient, lsCachedClient, hostUncachedClient, hostCachedClient client.Client,
	finishedObjectCache *lsutil.FinishedObjectCache,
	log logging.Logger, lsMgr, hostMgr manager.Manager, args DeployerArgs, maxNumberOfWorkers int, lockingEnabled bool, callerName string) error

Add adds a deployer to the given managers using the given args.

func CheckResponsibility

func CheckResponsibility(ctx context.Context, lsClient client.Client, obj *metav1.PartialObjectMetadata,
	deployerType lsv1alpha1.DeployItemType, targetSelectors []lsv1alpha1.TargetSelector) (*lsv1alpha1.ResolvedTarget, bool, bool, lserrors.LsError)

func CreateOrUpdateExport

func CreateOrUpdateExport(ctx context.Context, kubeWriter *read_write_layer.Writer, kubeClient client.Client, deployItem *lsv1alpha1.DeployItem, values interface{}) error

CreateOrUpdateExport creates or updates the export of a deploy item.

func ExpandManagedResourceManifests

func ExpandManagedResourceManifests(origManifests []managedresource.Manifest) ([]managedresource.Manifest, error)

func ExpandManifests

func ExpandManifests(manifests []*runtime.RawExtension) ([]*runtime.RawExtension, error)

func GetKubeconfigFromTargetConfig

func GetKubeconfigFromTargetConfig(config *targettypes.KubernetesClusterTargetConfig) ([]byte, error)

GetKubeconfigFromTargetConfig fetches the kubeconfig from a given config. If the config defines the target from a secret that secret is read from all provided clients.

func GetRegistryPullSecretsFromContext

func GetRegistryPullSecretsFromContext(lsCtx *lsv1alpha1.Context) []lsv1alpha1.ObjectReference

GetRegistryPullSecretsFromContext returns the object references to registry pull secrets defined by the landscaper context.

func GetRestConfigAndClientAndClientSet

func GetRestConfigAndClientAndClientSet(ctx context.Context, resolvedTarget *lsv1alpha1.ResolvedTarget, lsUncachedClient client.Client) (_ *rest.Config, _ client.Client, _ kubernetes.Interface, err error)

func GetTargetClient

func GetTargetClient(
	ctx context.Context,
	primaryTargetClient client.Client,
	lsClient client.Client,
	deployItem *lsv1alpha1.DeployItem,
	secondaryTargetName *string) (targetClient client.Client, err error)

GetTargetClient is used to determine the client to read resources for custom readiness checks, export collection, and deletion groups. Usually it is the client obtained from the Target of the DeployItem. In some scenarios however, the Landscaper deploys an installer on a primary target cluster, and the installer deploys the actual application on a secondary target cluster.

func HandleReconcileResult

func HandleReconcileResult(ctx context.Context, err lserrors.LsError, oldDeployItem, deployItem *lsv1alpha1.DeployItem,
	lsClient client.Client, lsEventRecorder record.EventRecorder, finishedObjectCache *lsutil.FinishedObjectCache) error

func IsDeployItemFinished

func IsDeployItemFinished(di *lsv1alpha1.DeployItem) bool

func NewController

func NewController(lsUncachedClient, lsCachedClient, hostUncachedClient, hostCachedClient client.Client,
	finishedObjectCache *lsutil.FinishedObjectCache,
	lsScheme *runtime.Scheme,
	lsEventRecorder record.EventRecorder,
	hostScheme *runtime.Scheme,
	args DeployerArgs,
	maxNumberOfWorkers int,
	lockingEnabled bool,
	callerName string) *controller

NewController creates a new generic deployitem controller.

func NewTypePredicate

func NewTypePredicate(dtype lsv1alpha1.DeployItemType) predicate.Predicate

Types

type Deployer

type Deployer interface {
	// Reconcile the deployitem.
	Reconcile(ctx context.Context, lsContext *lsv1alpha1.Context, di *lsv1alpha1.DeployItem, target *lsv1alpha1.ResolvedTarget) error
	// Delete the deployitem.
	Delete(ctx context.Context, lsContext *lsv1alpha1.Context, di *lsv1alpha1.DeployItem, target *lsv1alpha1.ResolvedTarget) error
	// Abort the deployitem progress.
	Abort(ctx context.Context, lsContext *lsv1alpha1.Context, di *lsv1alpha1.DeployItem, target *lsv1alpha1.ResolvedTarget) error
	// ExtensionHooks returns all registered extension hooks.
	ExtensionHooks() extension.ReconcileExtensionHooks
}

Deployer defines a controller that acts upon deployitems.

type DeployerArgs

type DeployerArgs struct {
	Name            string
	Version         string
	Identity        string
	Type            lsv1alpha1.DeployItemType
	Deployer        Deployer
	TargetSelectors []lsv1alpha1.TargetSelector
	Options         ctrl.Options
}

DeployerArgs defines the deployer arguments for the initializing a generic deployer controller.

func (*DeployerArgs) Default

func (args *DeployerArgs) Default()

Default defaults deployer arguments

func (DeployerArgs) Validate

func (args DeployerArgs) Validate() error

Validate validates the provided deployer arguments