k8s

Documentation

Index

• Variables
• func PullPolicyFromString(ppStr string) (api.PullPolicy, error)
• type ErrInvalidPullPolicy
  • func (e ErrInvalidPullPolicy) Error() string
• type FakeSecret
  • func (f *FakeSecret) Create(secret *api.Secret) (*api.Secret, error)
  • func (f *FakeSecret) Delete(name string) error
  • func (f *FakeSecret) Get(name string) (*api.Secret, error)
  • func (f *FakeSecret) List(opts api.ListOptions) (*api.SecretList, error)
  • func (f *FakeSecret) Update(secret *api.Secret) (*api.Secret, error)
  • func (f *FakeSecret) Watch(opts api.ListOptions) (watch.Interface, error)
• type FakeSecretsNamespacer
  • func (f *FakeSecretsNamespacer) Secrets(namespace string) client.SecretsInterface
• type NamespaceLister
• type PodWatcher
  • func NewPodWatcher(c *client.Client, ns string) *PodWatcher

Variables

var (

	// ValidPullPolicies is the set of pull policies that this package considers valid
	ValidPullPolicies = map[api.PullPolicy]struct{}{
		api.PullAlways:       {},
		api.PullIfNotPresent: {},
		api.PullNever:        {},
	}
)

Functions

func PullPolicyFromString

func PullPolicyFromString(ppStr string) (api.PullPolicy, error)

PullPolicyFromString converts a string into an api.PullPolicy. returns an error if the string does not match a pull policy in ValidPullPolicies()

Types

type ErrInvalidPullPolicy

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

ErrInvalidPullPolicy is the error returned when trying to convert an unknown string to an api.PullPolicy

func (ErrInvalidPullPolicy) Error

func (e ErrInvalidPullPolicy) Error() string

Error is the error interface implementation

type FakeSecret

type FakeSecret struct {
	FnGet    func(string) (*api.Secret, error)
	FnCreate func(*api.Secret) (*api.Secret, error)
	FnUpdate func(*api.Secret) (*api.Secret, error)
}

FakeSecret is a mock function that can be swapped in for (k8s.io/kubernetes/pkg/client/unversioned).SecretsInterface, so you can unit test your code.

func (*FakeSecret) Create

func (f *FakeSecret) Create(secret *api.Secret) (*api.Secret, error)

Create is the interface definition.

func (*FakeSecret) Delete

func (f *FakeSecret) Delete(name string) error

Delete is the interface definition.

func (*FakeSecret) Get

func (f *FakeSecret) Get(name string) (*api.Secret, error)

Get is the interface definition.

func (*FakeSecret) List

func (f *FakeSecret) List(opts api.ListOptions) (*api.SecretList, error)

List is the interface definition.

func (*FakeSecret) Update

func (f *FakeSecret) Update(secret *api.Secret) (*api.Secret, error)

Update is the interface definition.

func (*FakeSecret) Watch

func (f *FakeSecret) Watch(opts api.ListOptions) (watch.Interface, error)

Watch is the interface definition.

type FakeSecretsNamespacer

type FakeSecretsNamespacer struct {
	Fn func(string) client.SecretsInterface
}

FakeSecretsNamespacer is a mock function that can be swapped in for an (k8s.io/kubernetes/pkg/client/unversioned).SecretsNamespacer, so you can unit test you code

func (*FakeSecretsNamespacer) Secrets

func (f *FakeSecretsNamespacer) Secrets(namespace string) client.SecretsInterface

Secrets is the interface definition.

type NamespaceLister

type NamespaceLister interface {
	List(opts api.ListOptions) (*api.NamespaceList, error)
}

NamespaceLister is a (k8s.io/kubernetes/pkg/client/unversioned).NamespaceInterface compatible interface which only has the List function. It's used in places that only need List to make them easier to test and more easily swappable with other implementations (should the need arise).

Example usage:

var nsl NamespaceLister
nsl = kubeClient.Namespaces()

type PodWatcher

type PodWatcher struct {
	Store      cache.StoreToPodLister
	Controller *cache.Controller
}

PodWatcher is a struct which holds the return values of (k8s.io/kubernetes/pkg/controller/framework).NewIndexerInformer together.

func NewPodWatcher

func NewPodWatcher(c *client.Client, ns string) *PodWatcher

NewPodWatcher creates a new BuildPodWatcher useful to list the pods using a cache which gets updated based on the watch func.