namespace

Documentation

Overview

Package namespace manipulates the k8s api of namespace object

Index

• type Namespace
  • func New(options ...Option) *Namespace
  • func (n *Namespace) Create(ns string, labels map[string]string) error
  • func (n *Namespace) Delete(ns string, force ...bool) error
  • func (n *Namespace) Exists(ns string) error
  • func (n *Namespace) Update(ns string, labels map[string]string) error
• type Option
  • func WithKubernetesClient(k kubernetes.Interface) Option

Types

type Namespace

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

Namespace is the object to manipulate k8s api of namespace

func New

func New(options ...Option) *Namespace

New news a Namespace

func (*Namespace) Create

func (n *Namespace) Create(ns string, labels map[string]string) error

Create creates a k8s namespace TODO: Need to pass in the namespace structure

func (*Namespace) Delete

func (n *Namespace) Delete(ns string, force ...bool) error

Delete deletes a k8s namespace (deletes all dependents in the foreground)

func (*Namespace) Exists

func (n *Namespace) Exists(ns string) error

Exists decides whether a namespace exists

func (*Namespace) Update

func (n *Namespace) Update(ns string, labels map[string]string) error

type Option

type Option func(*Namespace)

Option configures a Namespace

func WithKubernetesClient

func WithKubernetesClient(k kubernetes.Interface) Option

WithKubernetesClient provides an Option