v1

Documentation

Overview

Definitions for the Kubernetes types

Index

• func NewNamespaceClient(client client.Client) *namespaceClient
• func NewSecretClient(client client.Client) *secretClient
• func NewServiceAccountClient(client client.Client) *serviceAccountClient
• type Clientset
  • func NewClientset(client client.Client) Clientset
  • func NewClientsetFromConfig(cfg *rest.Config) (Clientset, error)
• type MulticlusterClientset
  • func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset
• type MulticlusterNamespaceClient
  • func NewMulticlusterNamespaceClient(client multicluster.Client) MulticlusterNamespaceClient
• type MulticlusterSecretClient
  • func NewMulticlusterSecretClient(client multicluster.Client) MulticlusterSecretClient
• type MulticlusterServiceAccountClient
  • func NewMulticlusterServiceAccountClient(client multicluster.Client) MulticlusterServiceAccountClient
• type NamespaceClient
• type NamespaceReader
• type NamespaceSlice
• type NamespaceStatusWriter
• type NamespaceTransitionFunction
• type NamespaceWriter
• type SecretClient
• type SecretReader
• type SecretSlice
• type SecretStatusWriter
• type SecretTransitionFunction
• type SecretWriter
• type ServiceAccountClient
• type ServiceAccountReader
• type ServiceAccountSlice
• type ServiceAccountStatusWriter
• type ServiceAccountTransitionFunction
• type ServiceAccountWriter

Functions

func NewNamespaceClient

func NewNamespaceClient(client client.Client) *namespaceClient

func NewSecretClient

func NewSecretClient(client client.Client) *secretClient

func NewServiceAccountClient

func NewServiceAccountClient(client client.Client) *serviceAccountClient

Types

type Clientset

type Clientset interface {
	// clienset for the v1/v1 APIs
	Secrets() SecretClient
	// clienset for the v1/v1 APIs
	ServiceAccounts() ServiceAccountClient
	// clienset for the v1/v1 APIs
	Namespaces() NamespaceClient
}

clienset for the /v1 APIs

func NewClientset

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig

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

type MulticlusterClientset

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

MulticlusterClientset for the /v1 APIs

func NewMulticlusterClientset

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

type MulticlusterNamespaceClient

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

Provides NamespaceClients for multiple clusters.

func NewMulticlusterNamespaceClient

func NewMulticlusterNamespaceClient(client multicluster.Client) MulticlusterNamespaceClient

type MulticlusterSecretClient

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

Provides SecretClients for multiple clusters.

func NewMulticlusterSecretClient

func NewMulticlusterSecretClient(client multicluster.Client) MulticlusterSecretClient

type MulticlusterServiceAccountClient

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

Provides ServiceAccountClients for multiple clusters.

func NewMulticlusterServiceAccountClient

func NewMulticlusterServiceAccountClient(client multicluster.Client) MulticlusterServiceAccountClient

type NamespaceClient

type NamespaceClient interface {
	NamespaceReader
	NamespaceWriter
	NamespaceStatusWriter
}

Client knows how to perform CRUD operations on Namespaces.

type NamespaceReader

type NamespaceReader interface {
	// Get retrieves a Namespace for the given object key
	GetNamespace(ctx context.Context, name string) (*v1.Namespace, error)

	// List retrieves list of Namespaces for a given namespace and list options.
	ListNamespace(ctx context.Context, opts ...client.ListOption) (*v1.NamespaceList, error)
}

Reader knows how to read and list Namespaces.

type NamespaceSlice

type NamespaceSlice []*Namespace

NamespaceSlice represents a slice of *Namespace

type NamespaceStatusWriter

type NamespaceStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given Namespace object.
	UpdateNamespaceStatus(ctx context.Context, obj *v1.Namespace, opts ...client.SubResourceUpdateOption) error

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

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

type NamespaceTransitionFunction

type NamespaceTransitionFunction func(existing, desired *v1.Namespace) error

NamespaceTransitionFunction instructs the NamespaceWriter how to transition between an existing Namespace object and a desired on an Upsert

type NamespaceWriter

type NamespaceWriter interface {
	// Create saves the Namespace object.
	CreateNamespace(ctx context.Context, obj *v1.Namespace, opts ...client.CreateOption) error

	// Delete deletes the Namespace object.
	DeleteNamespace(ctx context.Context, name string, opts ...client.DeleteOption) error

	// Update updates the given Namespace object.
	UpdateNamespace(ctx context.Context, obj *v1.Namespace, opts ...client.UpdateOption) error

	// Patch patches the given Namespace object.
	PatchNamespace(ctx context.Context, obj *v1.Namespace, patch client.Patch, opts ...client.PatchOption) error

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

	// Create or Update the Namespace object.
	UpsertNamespace(ctx context.Context, obj *v1.Namespace, transitionFuncs ...NamespaceTransitionFunction) error
}

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

type SecretClient

type SecretClient interface {
	SecretReader
	SecretWriter
	SecretStatusWriter
}

Client knows how to perform CRUD operations on Secrets.

type SecretReader

type SecretReader interface {
	// Get retrieves a Secret for the given object key
	GetSecret(ctx context.Context, key client.ObjectKey) (*v1.Secret, error)

	// List retrieves list of Secrets for a given namespace and list options.
	ListSecret(ctx context.Context, opts ...client.ListOption) (*v1.SecretList, error)
}

Reader knows how to read and list Secrets.

type SecretSlice

type SecretSlice []*Secret

SecretSlice represents a slice of *Secret

type SecretStatusWriter

type SecretStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given Secret object.
	UpdateSecretStatus(ctx context.Context, obj *v1.Secret, opts ...client.SubResourceUpdateOption) error

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

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

type SecretTransitionFunction

type SecretTransitionFunction func(existing, desired *v1.Secret) error

SecretTransitionFunction instructs the SecretWriter how to transition between an existing Secret object and a desired on an Upsert

type SecretWriter

type SecretWriter interface {
	// Create saves the Secret object.
	CreateSecret(ctx context.Context, obj *v1.Secret, opts ...client.CreateOption) error

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

	// Update updates the given Secret object.
	UpdateSecret(ctx context.Context, obj *v1.Secret, opts ...client.UpdateOption) error

	// Patch patches the given Secret object.
	PatchSecret(ctx context.Context, obj *v1.Secret, patch client.Patch, opts ...client.PatchOption) error

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

	// Create or Update the Secret object.
	UpsertSecret(ctx context.Context, obj *v1.Secret, transitionFuncs ...SecretTransitionFunction) error
}

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

type ServiceAccountClient

type ServiceAccountClient interface {
	ServiceAccountReader
	ServiceAccountWriter
	ServiceAccountStatusWriter
}

Client knows how to perform CRUD operations on ServiceAccounts.

type ServiceAccountReader

type ServiceAccountReader interface {
	// Get retrieves a ServiceAccount for the given object key
	GetServiceAccount(ctx context.Context, key client.ObjectKey) (*v1.ServiceAccount, error)

	// List retrieves list of ServiceAccounts for a given namespace and list options.
	ListServiceAccount(ctx context.Context, opts ...client.ListOption) (*v1.ServiceAccountList, error)
}

Reader knows how to read and list ServiceAccounts.

type ServiceAccountSlice

type ServiceAccountSlice []*ServiceAccount

ServiceAccountSlice represents a slice of *ServiceAccount

type ServiceAccountStatusWriter

type ServiceAccountStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given ServiceAccount object.
	UpdateServiceAccountStatus(ctx context.Context, obj *v1.ServiceAccount, opts ...client.SubResourceUpdateOption) error

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

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

type ServiceAccountTransitionFunction

type ServiceAccountTransitionFunction func(existing, desired *v1.ServiceAccount) error

ServiceAccountTransitionFunction instructs the ServiceAccountWriter how to transition between an existing ServiceAccount object and a desired on an Upsert

type ServiceAccountWriter

type ServiceAccountWriter interface {
	// Create saves the ServiceAccount object.
	CreateServiceAccount(ctx context.Context, obj *v1.ServiceAccount, opts ...client.CreateOption) error

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

	// Update updates the given ServiceAccount object.
	UpdateServiceAccount(ctx context.Context, obj *v1.ServiceAccount, opts ...client.UpdateOption) error

	// Patch patches the given ServiceAccount object.
	PatchServiceAccount(ctx context.Context, obj *v1.ServiceAccount, patch client.Patch, opts ...client.PatchOption) error

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

	// Create or Update the ServiceAccount object.
	UpsertServiceAccount(ctx context.Context, obj *v1.ServiceAccount, transitionFuncs ...ServiceAccountTransitionFunction) error
}

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