deployment

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 25, 2022 License: Apache-2.0 Imports: 33 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ERR_TYPE_TOOLS  = fmt.Errorf("type must be string *appsv1.Deployment, or appsv1.Deployment")
	ERR_TYPE_CREATE = fmt.Errorf("type must be string, []byte, *appsv1.Deployment, appsv1.Deployment, runtime.Object or map[string]interface{}")
	ERR_TYPE_UPDATE = ERR_TYPE_CREATE
	ERR_TYPE_APPLY  = ERR_TYPE_CREATE
	ERR_TYPE_DELETE = ERR_TYPE_CREATE
	ERR_TYPE_GET    = ERR_TYPE_CREATE
)

Functions

This section is empty.

Types

type Handler

type Handler struct {
	Options *types.HandlerOptions
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, kubeconfig, namespace string) (handler *Handler, err error)

New returns a deployment handler from kubeconfig or in-cluster config.

func NewOrDie added in v0.3.0

func NewOrDie(ctx context.Context, kubeconfig, namespace string) *Handler

NewOrDie simply call New() to get a deployment handler. panic if there is any error occurs.

func (*Handler) Apply

func (h *Handler) Apply(obj interface{}) (*appsv1.Deployment, error)

Apply applies deployment from type string, []byte, *appsv1.Deployment, appsv1.Deployment, runtime.Object or map[string]interface{}.

func (*Handler) ApplyFromBytes

func (h *Handler) ApplyFromBytes(data []byte) (deploy *appsv1.Deployment, err error)

ApplyFromBytes pply deployment from bytes.

func (*Handler) ApplyFromFile

func (h *Handler) ApplyFromFile(filename string) (deploy *appsv1.Deployment, err error)

ApplyFromFile applies deployment from yaml file.

func (*Handler) ApplyFromObject added in v0.3.0

func (h *Handler) ApplyFromObject(obj runtime.Object) (*appsv1.Deployment, error)

ApplyFromObject applies deployment from runtime.Object.

func (*Handler) ApplyFromUnstructured added in v0.3.0

func (h *Handler) ApplyFromUnstructured(u map[string]interface{}) (*appsv1.Deployment, error)

ApplyFromUnstructured applies deployment from map[string]interface{}.

func (*Handler) Clientset added in v0.2.0

func (h *Handler) Clientset() *kubernetes.Clientset

Clientset returns underlying clientset.

func (*Handler) Create

func (h *Handler) Create(obj interface{}) (*appsv1.Deployment, error)

Create creates deployment from type string, []byte, *appsv1.Deployment, appsv1.Deployment, runtime.Object or map[string]interface{}.

func (*Handler) CreateFromBytes

func (h *Handler) CreateFromBytes(data []byte) (*appsv1.Deployment, error)

CreateFromBytes creates deployment from bytes.

func (*Handler) CreateFromFile

func (h *Handler) CreateFromFile(filename string) (*appsv1.Deployment, error)

CreateFromFile creates deployment from yaml file.

func (*Handler) CreateFromObject added in v0.3.0

func (h *Handler) CreateFromObject(obj runtime.Object) (*appsv1.Deployment, error)

CreateFromObject creates deployment from runtime.Object.

func (*Handler) CreateFromUnstructured added in v0.3.0

func (h *Handler) CreateFromUnstructured(u map[string]interface{}) (*appsv1.Deployment, error)

CreateFromUnstructured creates deployment from map[string]interface{}.

func (*Handler) DeepCopy

func (in *Handler) DeepCopy() *Handler

func (*Handler) Delete

func (h *Handler) Delete(obj interface{}) error

If passed parameter type is string, it will simply call DeleteByName instead of DeleteFromFile. You should always explicitly call DeleteFromFile to delete a deployment from file path.

func (*Handler) DeleteByName

func (h *Handler) DeleteByName(name string) error

DeleteByName deletes deployment by name.

func (*Handler) DeleteFromBytes

func (h *Handler) DeleteFromBytes(data []byte) error

DeleteFromBytes deletes deployment from bytes.

func (*Handler) DeleteFromFile

func (h *Handler) DeleteFromFile(filename string) error

DeleteFromFile deletes deployment from yaml file.

func (*Handler) DeleteFromObject added in v0.3.0

func (h *Handler) DeleteFromObject(obj runtime.Object) error

DeleteFromObject deletes deployment from runtime.Object.

func (*Handler) DeleteFromUnstructured added in v0.3.0

func (h *Handler) DeleteFromUnstructured(u map[string]interface{}) error

DeleteFromUnstructured deletes deployment from map[string]interface{}.

func (*Handler) DiscoveryClient added in v0.2.0

func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient

DiscoveryClient returns underlying discovery client.

func (*Handler) DynamicClient added in v0.2.0

func (h *Handler) DynamicClient() dynamic.Interface

DynamicClient returns underlying dynamic client.

func (*Handler) Get

func (h *Handler) Get(obj interface{}) (*appsv1.Deployment, error)

If passed parameter type is string, it will simply call GetByName instead of GetFromFile. You should always explicitly call GetFromFile to get a deployment from file path.

func (*Handler) GetAge

func (h *Handler) GetAge(object interface{}) (time.Duration, error)

GetAge returns deployment age.

func (*Handler) GetByName

func (h *Handler) GetByName(name string) (*appsv1.Deployment, error)

GetByName gets deployment by name.

func (*Handler) GetContainers added in v0.2.0

func (h *Handler) GetContainers(object interface{}) ([]string, error)

GetContainers get all container of this deployment.

func (*Handler) GetFromBytes

func (h *Handler) GetFromBytes(data []byte) (*appsv1.Deployment, error)

GetFromBytes gets deployment from bytes.

func (*Handler) GetFromFile

func (h *Handler) GetFromFile(filename string) (*appsv1.Deployment, error)

GetFromFile gets deployment from yaml file.

func (*Handler) GetFromObject added in v0.3.0

func (h *Handler) GetFromObject(obj runtime.Object) (*appsv1.Deployment, error)

GetFromObject gets deployment from runtime.Object.

func (*Handler) GetFromUnstructured added in v0.3.0

func (h *Handler) GetFromUnstructured(u map[string]interface{}) (*appsv1.Deployment, error)

GetFromUnstructured gets deployment from map[string]interface{}.

func (*Handler) GetImages added in v0.2.0

func (h *Handler) GetImages(object interface{}) ([]string, error)

GetImages get all container images of this deployment.

func (*Handler) GetPV

func (h *Handler) GetPV(object interface{}) ([]string, error)

GetPV get all persistentvolumes mounted by the deployment.

func (*Handler) GetPVC

func (h *Handler) GetPVC(object interface{}) ([]string, error)

GetPVC get all persistentvolumeclaims mounted by the deployment.

func (*Handler) GetPods

func (h *Handler) GetPods(object interface{}) ([]corev1.Pod, error)

GetPods get all pods created by the deployment.

func (*Handler) GetRS

func (h *Handler) GetRS(object interface{}) ([]appsv1.ReplicaSet, error)

GetRS get all replicaset created by the deployment.

func (*Handler) Informer added in v0.2.0

func (h *Handler) Informer() cache.SharedIndexInformer

func (*Handler) IsReady

func (h *Handler) IsReady(name string) bool

IsReady check if the deployment is ready.

func (*Handler) List

func (h *Handler) List(label string) (*appsv1.DeploymentList, error)

List list deployments by labels, alias to "ListByLabel".

func (*Handler) ListAll

func (h *Handler) ListAll() (*appsv1.DeploymentList, error)

ListAll list all deployments in the k8s cluster.

func (*Handler) ListByLabel

func (h *Handler) ListByLabel(labels string) (*appsv1.DeploymentList, error)

ListByLabel list deployments by labels.

func (*Handler) ListByNamespace

func (h *Handler) ListByNamespace(namespace string) (*appsv1.DeploymentList, error)

ListByNamespace list all deployments in the specified namespace.

func (*Handler) Lister added in v0.2.0

func (*Handler) Namespace

func (h *Handler) Namespace() string

func (*Handler) RESTClient added in v0.2.0

func (h *Handler) RESTClient() *rest.RESTClient

RESTClient returns underlying rest client.

func (*Handler) RESTConfig added in v0.3.0

func (h *Handler) RESTConfig() *rest.Config

RESTConfig returns underlying rest config.

func (*Handler) RunInformer

func (h *Handler) RunInformer(
	addFunc func(obj interface{}),
	updateFunc func(oldObj, newObj interface{}),
	deleteFunc func(obj interface{}),
	stopCh chan struct{})

RunInformer

func (*Handler) SetForceDelete

func (h *Handler) SetForceDelete(force bool)

func (*Handler) SetLimit

func (h *Handler) SetLimit(limit int64)

func (*Handler) SetTimeout

func (h *Handler) SetTimeout(timeout int64)

func (*Handler) Update

func (h *Handler) Update(obj interface{}) (*appsv1.Deployment, error)

Update updates deployment from type string, []byte, *appsv1.Deployment, appsv1.Deployment, runtime.Object or map[string]interface{}.

func (*Handler) UpdateFromBytes

func (h *Handler) UpdateFromBytes(data []byte) (*appsv1.Deployment, error)

UpdateFromBytes updates deployment from bytes.

func (*Handler) UpdateFromFile

func (h *Handler) UpdateFromFile(filename string) (*appsv1.Deployment, error)

UpdateFromFile updates deployment from yaml file.

func (*Handler) UpdateFromObject added in v0.3.0

func (h *Handler) UpdateFromObject(obj runtime.Object) (*appsv1.Deployment, error)

UpdateFromObject updates deployment from runtime.Object.

func (*Handler) UpdateFromUnstructured added in v0.3.0

func (h *Handler) UpdateFromUnstructured(u map[string]interface{}) (*appsv1.Deployment, error)

UpdateFromUnstructured updates deployment from map[string]interface{}.

func (*Handler) WaitReady

func (h *Handler) WaitReady(name string) error

WaitReady waiting for the deployment to be in the ready status.

func (*Handler) Watch

func (h *Handler) Watch(name string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

Watch watch deployment by label, alias to "WatchByLabel".

func (*Handler) WatchByLabel

func (h *Handler) WatchByLabel(labelSelector string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

WatchByLabel watch deployment by label.

func (*Handler) WatchByName

func (h *Handler) WatchByName(name string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

WatchByName watch deployment by name.

func (*Handler) WithDryRun

func (h *Handler) WithDryRun() *Handler

func (*Handler) WithNamespace

func (h *Handler) WithNamespace(namespace string) *Handler

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL