live

Documentation

Index

• Constants
• Variables
• func InstallResourceGroupCRD(factory cmdutil.Factory) error
• func InvToUnstructuredFunc(inv inventory.InventoryInfo) *unstructured.Unstructured
• func IsResourceGroupInventory(obj *unstructured.Unstructured) (bool, error)
• func Load(f util.Factory, path string, stdIn io.Reader) ([]*unstructured.Unstructured, kptfilev1.Inventory, error)
• func ResourceGroupCRDApplied(factory cmdutil.Factory) bool
• func ToInventoryInfo(inventory kptfilev1.Inventory) (inventory.InventoryInfo, error)
• func WrapInventoryInfoObj(obj *unstructured.Unstructured) inventory.InventoryInfo
• func WrapInventoryObj(obj *unstructured.Unstructured) inventory.Inventory
• type ApplyCRDTask
  • func NewApplyCRDTask(factory cmdutil.Factory, crd *unstructured.Unstructured) *ApplyCRDTask
  • func (a *ApplyCRDTask) Action() event.ResourceAction
  • func (a *ApplyCRDTask) ClearTimeout()
  • func (a *ApplyCRDTask) Identifiers() object.ObjMetadataSet
  • func (a *ApplyCRDTask) Name() string
  • func (a *ApplyCRDTask) Start(taskContext *taskrunner.TaskContext)
• type InventoryFilter
  • func (i *InventoryFilter) Filter(object *yaml.RNode) (*yaml.RNode, error)
• type InventoryInfoValidationError
  • func (e *InventoryInfoValidationError) Error() string
• type InventoryResourceGroup
  • func (icm *InventoryResourceGroup) GetObject() (*unstructured.Unstructured, error)
  • func (icm *InventoryResourceGroup) ID() string
  • func (icm *InventoryResourceGroup) Load() (object.ObjMetadataSet, error)
  • func (icm *InventoryResourceGroup) Name() string
  • func (icm *InventoryResourceGroup) Namespace() string
  • func (icm *InventoryResourceGroup) Store(objMetas object.ObjMetadataSet) error
  • func (icm *InventoryResourceGroup) Strategy() inventory.InventoryStrategy
• type MultipleInventoryInfoError
  • func (e *MultipleInventoryInfoError) Error() string
• type ResourceGroupPathManifestReader
  • func (r *ResourceGroupPathManifestReader) Read() ([]*unstructured.Unstructured, error)
• type ResourceGroupStreamManifestReader
  • func (p *ResourceGroupStreamManifestReader) Read() ([]*unstructured.Unstructured, error)

Constants

const NoLocalConfigAnnoVal = "false"

Variables

var ResourceGroupGVK = schema.GroupVersionKind{
	Group:   "kpt.dev",
	Version: "v1alpha1",
	Kind:    "ResourceGroup",
}

ResourceGroupGVK is the group/version/kind of the custom resource used to store inventory.

Functions

func InstallResourceGroupCRD

func InstallResourceGroupCRD(factory cmdutil.Factory) error

InstallResourceGroupCRD applies the custom resource definition for the ResourceGroup by creating and running a TaskQueue of Tasks necessary. The Tasks are 1) Apply CRD task, 2) Wait Task (for CRD to become established), and 3) Reset RESTMapper task. Returns an error if a non-"AlreadyExists" error is returned on the event channel. Runs the CRD installation in a separate goroutine (timeout ensures no hanging).

func InvToUnstructuredFunc

func InvToUnstructuredFunc(inv inventory.InventoryInfo) *unstructured.Unstructured

func IsResourceGroupInventory

func IsResourceGroupInventory(obj *unstructured.Unstructured) (bool, error)

IsResourceGroupInventory returns true if the passed object is a ResourceGroup inventory object; false otherwise. If an error occurs, then false is returned and the error.

func Load

func Load(f util.Factory, path string, stdIn io.Reader) ([]*unstructured.Unstructured, kptfilev1.Inventory, error)

Load reads resources either from disk or from an input stream. It filters out resources that should be ignored and defaults the namespace for namespace-scoped resources that doesn't have the namespace set. It also looks for inventory information inside Kptfile resources. It returns the resources in unstructured format and the inventory information. If no inventory information is found, that is not considered an error here.

func ResourceGroupCRDApplied

func ResourceGroupCRDApplied(factory cmdutil.Factory) bool

ResourceGroupCRDApplied returns true if the inventory ResourceGroup CRD is available from the current RESTMapper, or false otherwise.

func ToInventoryInfo

func ToInventoryInfo(inventory kptfilev1.Inventory) (inventory.InventoryInfo, error)

ToInventoryInfo takes the information in the provided inventory object and return an InventoryResourceGroup implementation of the InventoryInfo interface.

func WrapInventoryInfoObj

func WrapInventoryInfoObj(obj *unstructured.Unstructured) inventory.InventoryInfo

func WrapInventoryObj

func WrapInventoryObj(obj *unstructured.Unstructured) inventory.Inventory

WrapInventoryObj takes a passed ResourceGroup (as a resource.Info), wraps it with the InventoryResourceGroup and upcasts the wrapper as an the Inventory interface.

Types

type ApplyCRDTask

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

ApplyCRDTask encapsulates information necessary to apply a Custom Resource Definition (CRD) as a task within a task queue. Implements the Task interface.

func NewApplyCRDTask

func NewApplyCRDTask(factory cmdutil.Factory, crd *unstructured.Unstructured) *ApplyCRDTask

NewApplyCRDTask returns a pointer to an ApplyCRDTask struct, containing fields to run the task.

func (*ApplyCRDTask) Action

func (a *ApplyCRDTask) Action() event.ResourceAction

func (*ApplyCRDTask) ClearTimeout

func (a *ApplyCRDTask) ClearTimeout()

func (*ApplyCRDTask) Identifiers

func (a *ApplyCRDTask) Identifiers() object.ObjMetadataSet

func (*ApplyCRDTask) Name

func (a *ApplyCRDTask) Name() string

func (*ApplyCRDTask) Start

func (a *ApplyCRDTask) Start(taskContext *taskrunner.TaskContext)

Start function is called to start the task running.

type InventoryFilter

type InventoryFilter struct {
	Inventories []*kptfilev1.Inventory
}

InventoryFilter is an implementation of the yaml.Filter interface that extracts inventory information from Kptfile resources.

func (*InventoryFilter) Filter

func (i *InventoryFilter) Filter(object *yaml.RNode) (*yaml.RNode, error)

type InventoryInfoValidationError

type InventoryInfoValidationError struct {
	errors.ValidationError
}

InventoryInfoValidationError is the error returned if validation of the inventory information fails.

func (*InventoryInfoValidationError) Error

func (e *InventoryInfoValidationError) Error() string

type InventoryResourceGroup

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

InventoryResourceGroup wraps a ResourceGroup resource and implements the Inventory and InventoryInfo interface. This wrapper loads and stores the object metadata (inventory) to and from the wrapped ResourceGroup.

func (*InventoryResourceGroup) GetObject

func (icm *InventoryResourceGroup) GetObject() (*unstructured.Unstructured, error)

GetObject returns the wrapped object (ResourceGroup) as a resource.Info or an error if one occurs.

func (*InventoryResourceGroup) ID

func (icm *InventoryResourceGroup) ID() string

func (*InventoryResourceGroup) Load

func (icm *InventoryResourceGroup) Load() (object.ObjMetadataSet, error)

Load is an Inventory interface function returning the set of object metadata from the wrapped ResourceGroup, or an error.

func (*InventoryResourceGroup) Name

func (icm *InventoryResourceGroup) Name() string

Name(), Namespace(), and ID() are InventoryResourceGroup functions to implement the InventoryInfo interface.

func (*InventoryResourceGroup) Namespace

func (icm *InventoryResourceGroup) Namespace() string

func (*InventoryResourceGroup) Store

func (icm *InventoryResourceGroup) Store(objMetas object.ObjMetadataSet) error

Store is an Inventory interface function implemented to store the object metadata in the wrapped ResourceGroup. Actual storing happens in "GetObject".

func (*InventoryResourceGroup) Strategy

func (icm *InventoryResourceGroup) Strategy() inventory.InventoryStrategy

type MultipleInventoryInfoError

type MultipleInventoryInfoError struct{}

MultipleInventoryInfoError is the error returned if there are multiple Kptfile resources in a stream which has inventory information.

func (*MultipleInventoryInfoError) Error

func (e *MultipleInventoryInfoError) Error() string

type ResourceGroupPathManifestReader

type ResourceGroupPathManifestReader struct {
	PkgPath string

	manifestreader.ReaderOptions
}

ResourceGroupPathManifestReader encapsulates the default path manifest reader.

func (*ResourceGroupPathManifestReader) Read

func (r *ResourceGroupPathManifestReader) Read() ([]*unstructured.Unstructured, error)

Read reads the manifests and returns them as Info objects. Generates and adds a ResourceGroup inventory object from Kptfile data. If unable to generate the ResourceGroup inventory object from the Kptfile, it is NOT an error.

type ResourceGroupStreamManifestReader

type ResourceGroupStreamManifestReader struct {
	ReaderName string
	Reader     io.Reader

	manifestreader.ReaderOptions
}

ResourceGroupStreamManifestReader encapsulates the default stream manifest reader.

func (*ResourceGroupStreamManifestReader) Read

func (p *ResourceGroupStreamManifestReader) Read() ([]*unstructured.Unstructured, error)

Read reads the manifests and returns them as Info objects. Transforms the Kptfile into the ResourceGroup inventory object, and appends it to the rest of the standard StreamManifestReader generated objects. Returns an error if one occurs. If the ResourceGroup inventory object does not exist, it is NOT an error.