resource

Documentation

Index

• func CleanupResources(ctx spi.ComponentContext, objects []client.Object) error
• func CreateOrUpdateResourceFromBytes(data []byte, log *zap.SugaredLogger) error
• func CreateOrUpdateResourceFromBytesUsingConfig(data []byte, config *rest.Config) error
• func CreateOrUpdateResourceFromFile(file string, log *zap.SugaredLogger) error
• func CreateOrUpdateResourceFromFileInCluster(file string, kubeconfigPath string) error
• func CreateOrUpdateResourceFromFileInClusterInGeneratedNamespace(file string, kubeconfigPath string, namespace string) error
• func CreateOrUpdateResourceFromFileInGeneratedNamespace(file string, namespace string) error
• func DeleteResourceFromFile(file string, log *zap.SugaredLogger) error
• func DeleteResourceFromFileInCluster(file string, kubeconfigPath string) error
• func DeleteResourceFromFileInClusterInGeneratedNamespace(file string, kubeconfigPath string, namespace string) error
• func DeleteResourceFromFileInGeneratedNamespace(file string, namespace string) error
• func PatchResourceFromBytes(gvr schema.GroupVersionResource, patchType types.PatchType, namespace string, ...) error
• func PatchResourceFromFileInCluster(gvr schema.GroupVersionResource, namespace string, name string, ...) error
• func VerifyResourcesDeleted(ctx spi.ComponentContext, objects []client.Object) error
• type Resource
  • func (r Resource) Delete() error
  • func (r Resource) Exists() (bool, error)
  • func (r Resource) RemoveFinalizers() error
  • func (r Resource) RemoveFinalizersAndDelete() error

Functions

func CleanupResources

func CleanupResources(ctx spi.ComponentContext, objects []client.Object) error

CleanupResources deletes and removes finalizers from resources

func CreateOrUpdateResourceFromBytes

func CreateOrUpdateResourceFromBytes(data []byte, log *zap.SugaredLogger) error

CreateOrUpdateResourceFromBytes creates or updates a Kubernetes resources from a YAML data byte array. The cluster used is the one set by default in the environment

func CreateOrUpdateResourceFromBytesUsingConfig

func CreateOrUpdateResourceFromBytesUsingConfig(data []byte, config *rest.Config) error

CreateOrUpdateResourceFromBytesUsingConfig creates or updates a Kubernetes resource from bytes. This is intended to be equivalent to `kubectl apply`

func CreateOrUpdateResourceFromFile

func CreateOrUpdateResourceFromFile(file string, log *zap.SugaredLogger) error

CreateOrUpdateResourceFromFile creates or updates a Kubernetes resources from a YAML file. This is intended to be equivalent to `kubectl apply` The cluster used is the one set by default in the environment

func CreateOrUpdateResourceFromFileInCluster

func CreateOrUpdateResourceFromFileInCluster(file string, kubeconfigPath string) error

CreateOrUpdateResourceFromFileInCluster is identical to CreateOrUpdateResourceFromFile, except that it uses the cluster specified by the kubeconfigPath argument instead of the default cluster in the environment

func CreateOrUpdateResourceFromFileInClusterInGeneratedNamespace

func CreateOrUpdateResourceFromFileInClusterInGeneratedNamespace(file string, kubeconfigPath string, namespace string) error

CreateOrUpdateResourceFromFileInClusterInGeneratedNamespace is identical to CreateOrUpdateResourceFromFileInGeneratedNamespace, except that it uses the cluster specified by the kubeconfigPath argument instead of the default cluster in the environment

func CreateOrUpdateResourceFromFileInGeneratedNamespace

func CreateOrUpdateResourceFromFileInGeneratedNamespace(file string, namespace string) error

CreateOrUpdateResourceFromFileInGeneratedNamespace creates or updates a Kubernetes resources from a YAML file. Namespaces are not in the resource yaml files. They are generated and passed in Resources will be created in the namespace that is passed in This is intended to be equivalent to `kubectl apply` The cluster used is the one set by default in the environment

func DeleteResourceFromFile

func DeleteResourceFromFile(file string, log *zap.SugaredLogger) error

DeleteResourceFromFile deletes Kubernetes resources using names found in a YAML file. This is intended to be equivalent to `kubectl delete`

func DeleteResourceFromFileInCluster

func DeleteResourceFromFileInCluster(file string, kubeconfigPath string) error

DeleteResourceFromFileInCluster is identical to DeleteResourceFromFile, except that // it uses the cluster specified by the kubeconfigPath argument instead of the default cluster in the environment

func DeleteResourceFromFileInClusterInGeneratedNamespace

func DeleteResourceFromFileInClusterInGeneratedNamespace(file string, kubeconfigPath string, namespace string) error

DeleteResourceFromFileInClusterInGeneratedNamespace is identical to DeleteResourceFromFileInGeneratedNamespace, except that it uses the cluster specified by the kubeconfigPath argument instead of the default cluster in the environment

func DeleteResourceFromFileInGeneratedNamespace

func DeleteResourceFromFileInGeneratedNamespace(file string, namespace string) error

DeleteResourceFromFileInGeneratedNamespace deletes Kubernetes resources using names found in a YAML file. The namespace is generated and passed in

func PatchResourceFromBytes

func PatchResourceFromBytes(gvr schema.GroupVersionResource, patchType types.PatchType, namespace string, name string, patchDataJSON []byte, config *rest.Config) error

PatchResourceFromBytes patches a Kubernetes resource from bytes. The contents of the byte slice must be in JSON format. This is intended to be equivalent to `kubectl patch`.

func PatchResourceFromFileInCluster

func PatchResourceFromFileInCluster(gvr schema.GroupVersionResource, namespace string, name string, patchFile string, kubeconfigPath string) error

PatchResourceFromFileInCluster patches a Kubernetes resource from a given patch file in the specified cluster If the given patch file has a ".yaml" extension, the contents will be converted to JSON This is intended to be equivalent to `kubectl patch`

func VerifyResourcesDeleted

func VerifyResourcesDeleted(ctx spi.ComponentContext, objects []client.Object) error

VerifyResourcesDeleted verifies resources have been fully cleaned up

Types

type Resource

type Resource struct {
	Namespace string
	Name      string
	Client    client.Client
	Object    client.Object
	Log       vzlog.VerrazzanoLogger
}

func (Resource) Delete

func (r Resource) Delete() error

Delete deletes a resource if it exists, not found error is ignored

func (Resource) Exists

func (r Resource) Exists() (bool, error)

Exists returns true if the Resource exists

func (Resource) RemoveFinalizers

func (r Resource) RemoveFinalizers() error

RemoveFinalizers removes all finalizers from a resource

func (Resource) RemoveFinalizersAndDelete

func (r Resource) RemoveFinalizersAndDelete() error

RemoveFinializersAndDelete removes all finalizers from a resource and deletes the resource