workflowcontext

Documentation

Overview

Package workflowcontext contains utility functions for populating workflow context specific data in a context.Context.

Data appropriate for the context includes anything that cannot be determined at time of object construction. For example, a bootstrap cluster does not exist when executing management workflows, therefore a Kubeconfig isn't available to communicate with the cluster so must be passed as contextual data.

Index

• func BootstrapCluster(ctx context.Context) *types.Cluster
• func ManagementCluster(ctx context.Context) *types.Cluster
• func WithBootstrapAsManagementCluster(ctx context.Context, cluster *types.Cluster) context.Context
• func WithBootstrapCluster(ctx context.Context, cluster *types.Cluster) context.Context
• func WithManagementCluster(ctx context.Context, cluster *types.Cluster) context.Context
• func WithWorkloadCluster(ctx context.Context, cluster *types.Cluster) context.Context
• func WorkloadCluster(ctx context.Context) *types.Cluster

Functions

func BootstrapCluster

func BootstrapCluster(ctx context.Context) *types.Cluster

BootstrapCluster retrieves the bootstrap cluster configured in ctx or returns a nil pointer.

func ManagementCluster

func ManagementCluster(ctx context.Context) *types.Cluster

ManagementCluster retrieves the management cluster configured in ctx or returns a nil pointer.

func WithBootstrapAsManagementCluster

func WithBootstrapAsManagementCluster(ctx context.Context, cluster *types.Cluster) context.Context

WithBootstrapAsManagementCluster is shorthand for WithBootstrapCluster followed by WithManagementCluster.

func WithBootstrapCluster

func WithBootstrapCluster(ctx context.Context, cluster *types.Cluster) context.Context

WithBootstrapCluster returns a context based on ctx containing the target cluster kubeconfig.

func WithManagementCluster

func WithManagementCluster(ctx context.Context, cluster *types.Cluster) context.Context

WithManagementCluster returns a context based on ctx containing a management cluster.

func WithWorkloadCluster

func WithWorkloadCluster(ctx context.Context, cluster *types.Cluster) context.Context

WithWorkloadCluster returns a context based on ctx containing the target cluster kubeconfig.

func WorkloadCluster

func WorkloadCluster(ctx context.Context) *types.Cluster

WorkloadCluster retrieves the workload cluster configured in ctx or returns a nil pointer.