v1

package
v0.2.7 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2024 License: Apache-2.0 Imports: 8 Imported by: 6

Documentation

Overview

Definitions for the Kubernetes types

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewDaemonSetClient 

func NewDaemonSetClient(client client.Client) *daemonSetClient

func NewDeploymentClient 

func NewDeploymentClient(client client.Client) *deploymentClient

func NewReplicaSetClient 

func NewReplicaSetClient(client client.Client) *replicaSetClient

func NewStatefulSetClient 

func NewStatefulSetClient(client client.Client) *statefulSetClient

Types

type Clientset 

type Clientset interface {
	// clienset for the apps/v1/v1 APIs
	Deployments() DeploymentClient
	// clienset for the apps/v1/v1 APIs
	ReplicaSets() ReplicaSetClient
	// clienset for the apps/v1/v1 APIs
	DaemonSets() DaemonSetClient
	// clienset for the apps/v1/v1 APIs
	StatefulSets() StatefulSetClient
}

clienset for the apps/v1 APIs

func NewClientset 

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig 

func NewClientsetFromConfig(cfg *rest.Config) (Clientset, error)

type DaemonSetClient 

type DaemonSetClient interface {
	DaemonSetReader
	DaemonSetWriter
	DaemonSetStatusWriter
}

Client knows how to perform CRUD operations on DaemonSets.

type DaemonSetReader 

type DaemonSetReader interface {
	// Get retrieves a DaemonSet for the given object key
	GetDaemonSet(ctx context.Context, key client.ObjectKey) (*apps_v1.DaemonSet, error)

	// List retrieves list of DaemonSets for a given namespace and list options.
	ListDaemonSet(ctx context.Context, opts ...client.ListOption) (*apps_v1.DaemonSetList, error)
}

Reader knows how to read and list DaemonSets.

type DaemonSetSlice 

type DaemonSetSlice []*DaemonSet

DaemonSetSlice represents a slice of *DaemonSet

type DaemonSetStatusWriter 

type DaemonSetStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given DaemonSet object.
	UpdateDaemonSetStatus(ctx context.Context, obj *apps_v1.DaemonSet, opts ...client.SubResourceUpdateOption) error

	// Patch patches the given DaemonSet object's subresource.
	PatchDaemonSetStatus(ctx context.Context, obj *apps_v1.DaemonSet, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter knows how to update status subresource of a DaemonSet object.

type DaemonSetTransitionFunction 

type DaemonSetTransitionFunction func(existing, desired *apps_v1.DaemonSet) error

DaemonSetTransitionFunction instructs the DaemonSetWriter how to transition between an existing DaemonSet object and a desired on an Upsert

type DaemonSetWriter 

type DaemonSetWriter interface {
	// Create saves the DaemonSet object.
	CreateDaemonSet(ctx context.Context, obj *apps_v1.DaemonSet, opts ...client.CreateOption) error

	// Delete deletes the DaemonSet object.
	DeleteDaemonSet(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error

	// Update updates the given DaemonSet object.
	UpdateDaemonSet(ctx context.Context, obj *apps_v1.DaemonSet, opts ...client.UpdateOption) error

	// Patch patches the given DaemonSet object.
	PatchDaemonSet(ctx context.Context, obj *apps_v1.DaemonSet, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all DaemonSet objects matching the given options.
	DeleteAllOfDaemonSet(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the DaemonSet object.
	UpsertDaemonSet(ctx context.Context, obj *apps_v1.DaemonSet, transitionFuncs ...DaemonSetTransitionFunction) error
}

Writer knows how to create, delete, and update DaemonSets.

type DeploymentClient 

type DeploymentClient interface {
	DeploymentReader
	DeploymentWriter
	DeploymentStatusWriter
}

Client knows how to perform CRUD operations on Deployments.

type DeploymentReader 

type DeploymentReader interface {
	// Get retrieves a Deployment for the given object key
	GetDeployment(ctx context.Context, key client.ObjectKey) (*apps_v1.Deployment, error)

	// List retrieves list of Deployments for a given namespace and list options.
	ListDeployment(ctx context.Context, opts ...client.ListOption) (*apps_v1.DeploymentList, error)
}

Reader knows how to read and list Deployments.

type DeploymentSlice 

type DeploymentSlice []*Deployment

DeploymentSlice represents a slice of *Deployment

type DeploymentStatusWriter 

type DeploymentStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given Deployment object.
	UpdateDeploymentStatus(ctx context.Context, obj *apps_v1.Deployment, opts ...client.SubResourceUpdateOption) error

	// Patch patches the given Deployment object's subresource.
	PatchDeploymentStatus(ctx context.Context, obj *apps_v1.Deployment, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter knows how to update status subresource of a Deployment object.

type DeploymentTransitionFunction 

type DeploymentTransitionFunction func(existing, desired *apps_v1.Deployment) error

DeploymentTransitionFunction instructs the DeploymentWriter how to transition between an existing Deployment object and a desired on an Upsert

type DeploymentWriter 

type DeploymentWriter interface {
	// Create saves the Deployment object.
	CreateDeployment(ctx context.Context, obj *apps_v1.Deployment, opts ...client.CreateOption) error

	// Delete deletes the Deployment object.
	DeleteDeployment(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error

	// Update updates the given Deployment object.
	UpdateDeployment(ctx context.Context, obj *apps_v1.Deployment, opts ...client.UpdateOption) error

	// Patch patches the given Deployment object.
	PatchDeployment(ctx context.Context, obj *apps_v1.Deployment, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all Deployment objects matching the given options.
	DeleteAllOfDeployment(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the Deployment object.
	UpsertDeployment(ctx context.Context, obj *apps_v1.Deployment, transitionFuncs ...DeploymentTransitionFunction) error
}

Writer knows how to create, delete, and update Deployments.

type MulticlusterClientset 

type MulticlusterClientset interface {
	// Cluster returns a Clientset for the given cluster
	Cluster(cluster string) (Clientset, error)
}

MulticlusterClientset for the apps/v1 APIs

func NewMulticlusterClientset 

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

type MulticlusterDaemonSetClient 

type MulticlusterDaemonSetClient interface {
	// Cluster returns a DaemonSetClient for the given cluster
	Cluster(cluster string) (DaemonSetClient, error)
}

Provides DaemonSetClients for multiple clusters.

func NewMulticlusterDaemonSetClient 

func NewMulticlusterDaemonSetClient(client multicluster.Client) MulticlusterDaemonSetClient

type MulticlusterDeploymentClient 

type MulticlusterDeploymentClient interface {
	// Cluster returns a DeploymentClient for the given cluster
	Cluster(cluster string) (DeploymentClient, error)
}

Provides DeploymentClients for multiple clusters.

func NewMulticlusterDeploymentClient 

func NewMulticlusterDeploymentClient(client multicluster.Client) MulticlusterDeploymentClient

type MulticlusterReplicaSetClient 

type MulticlusterReplicaSetClient interface {
	// Cluster returns a ReplicaSetClient for the given cluster
	Cluster(cluster string) (ReplicaSetClient, error)
}

Provides ReplicaSetClients for multiple clusters.

func NewMulticlusterReplicaSetClient 

func NewMulticlusterReplicaSetClient(client multicluster.Client) MulticlusterReplicaSetClient

type MulticlusterStatefulSetClient 

type MulticlusterStatefulSetClient interface {
	// Cluster returns a StatefulSetClient for the given cluster
	Cluster(cluster string) (StatefulSetClient, error)
}

Provides StatefulSetClients for multiple clusters.

func NewMulticlusterStatefulSetClient 

func NewMulticlusterStatefulSetClient(client multicluster.Client) MulticlusterStatefulSetClient

type ReplicaSetClient 

type ReplicaSetClient interface {
	ReplicaSetReader
	ReplicaSetWriter
	ReplicaSetStatusWriter
}

Client knows how to perform CRUD operations on ReplicaSets.

type ReplicaSetReader 

type ReplicaSetReader interface {
	// Get retrieves a ReplicaSet for the given object key
	GetReplicaSet(ctx context.Context, key client.ObjectKey) (*apps_v1.ReplicaSet, error)

	// List retrieves list of ReplicaSets for a given namespace and list options.
	ListReplicaSet(ctx context.Context, opts ...client.ListOption) (*apps_v1.ReplicaSetList, error)
}

Reader knows how to read and list ReplicaSets.

type ReplicaSetSlice 

type ReplicaSetSlice []*ReplicaSet

ReplicaSetSlice represents a slice of *ReplicaSet

type ReplicaSetStatusWriter 

type ReplicaSetStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given ReplicaSet object.
	UpdateReplicaSetStatus(ctx context.Context, obj *apps_v1.ReplicaSet, opts ...client.SubResourceUpdateOption) error

	// Patch patches the given ReplicaSet object's subresource.
	PatchReplicaSetStatus(ctx context.Context, obj *apps_v1.ReplicaSet, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter knows how to update status subresource of a ReplicaSet object.

type ReplicaSetTransitionFunction 

type ReplicaSetTransitionFunction func(existing, desired *apps_v1.ReplicaSet) error

ReplicaSetTransitionFunction instructs the ReplicaSetWriter how to transition between an existing ReplicaSet object and a desired on an Upsert

type ReplicaSetWriter 

type ReplicaSetWriter interface {
	// Create saves the ReplicaSet object.
	CreateReplicaSet(ctx context.Context, obj *apps_v1.ReplicaSet, opts ...client.CreateOption) error

	// Delete deletes the ReplicaSet object.
	DeleteReplicaSet(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error

	// Update updates the given ReplicaSet object.
	UpdateReplicaSet(ctx context.Context, obj *apps_v1.ReplicaSet, opts ...client.UpdateOption) error

	// Patch patches the given ReplicaSet object.
	PatchReplicaSet(ctx context.Context, obj *apps_v1.ReplicaSet, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all ReplicaSet objects matching the given options.
	DeleteAllOfReplicaSet(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the ReplicaSet object.
	UpsertReplicaSet(ctx context.Context, obj *apps_v1.ReplicaSet, transitionFuncs ...ReplicaSetTransitionFunction) error
}

Writer knows how to create, delete, and update ReplicaSets.

type StatefulSetClient 

type StatefulSetClient interface {
	StatefulSetReader
	StatefulSetWriter
	StatefulSetStatusWriter
}

Client knows how to perform CRUD operations on StatefulSets.

type StatefulSetReader 

type StatefulSetReader interface {
	// Get retrieves a StatefulSet for the given object key
	GetStatefulSet(ctx context.Context, key client.ObjectKey) (*apps_v1.StatefulSet, error)

	// List retrieves list of StatefulSets for a given namespace and list options.
	ListStatefulSet(ctx context.Context, opts ...client.ListOption) (*apps_v1.StatefulSetList, error)
}

Reader knows how to read and list StatefulSets.

type StatefulSetSlice 

type StatefulSetSlice []*StatefulSet

StatefulSetSlice represents a slice of *StatefulSet

type StatefulSetStatusWriter 

type StatefulSetStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given StatefulSet object.
	UpdateStatefulSetStatus(ctx context.Context, obj *apps_v1.StatefulSet, opts ...client.SubResourceUpdateOption) error

	// Patch patches the given StatefulSet object's subresource.
	PatchStatefulSetStatus(ctx context.Context, obj *apps_v1.StatefulSet, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter knows how to update status subresource of a StatefulSet object.

type StatefulSetTransitionFunction 

type StatefulSetTransitionFunction func(existing, desired *apps_v1.StatefulSet) error

StatefulSetTransitionFunction instructs the StatefulSetWriter how to transition between an existing StatefulSet object and a desired on an Upsert

type StatefulSetWriter 

type StatefulSetWriter interface {
	// Create saves the StatefulSet object.
	CreateStatefulSet(ctx context.Context, obj *apps_v1.StatefulSet, opts ...client.CreateOption) error

	// Delete deletes the StatefulSet object.
	DeleteStatefulSet(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error

	// Update updates the given StatefulSet object.
	UpdateStatefulSet(ctx context.Context, obj *apps_v1.StatefulSet, opts ...client.UpdateOption) error

	// Patch patches the given StatefulSet object.
	PatchStatefulSet(ctx context.Context, obj *apps_v1.StatefulSet, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all StatefulSet objects matching the given options.
	DeleteAllOfStatefulSet(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the StatefulSet object.
	UpsertStatefulSet(ctx context.Context, obj *apps_v1.StatefulSet, transitionFuncs ...StatefulSetTransitionFunction) error
}

Writer knows how to create, delete, and update StatefulSets.

Source Files

View all Source files

Directories

Path Synopsis
Definitions for the Kubernetes Controllers
 Definitions for the Kubernetes Controllers
mocks
Package mock_controller is a generated GoMock package.
 Package mock_controller is a generated GoMock package.
Package mock_v1 is a generated GoMock package.
 Package mock_v1 is a generated GoMock package.
mocks
Package mock_v1sets is a generated GoMock package.
 Package mock_v1sets is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.