k8sutil

Documentation

Overview

Package k8sutil provides helper for interacting with Kubernetes API.

Index

• Constants
• func CreateOrUpdateNamespace(ns Namespace, nsclient corev1typed.NamespaceInterface) error
• func ListNamespaces(nsclient corev1typed.NamespaceInterface) (*v1.NamespaceList, error)
• func LoadManifests(files map[string]string) ([]manifest, error)
• func NewClientset(data []byte) (*kubernetes.Clientset, error)
• func RolloutDaemonSet(ctx context.Context, dsi clientappsv1.DaemonSetInterface, name string) error
• func RolloutDeployment(ctx context.Context, deployClient clientappsv1.DeploymentInterface, ...) error
• func SplitYAMLDocuments(yamlObj string) ([]string, error)
• func YAMLToUnstructured(yamlObj []byte) (*unstructured.Unstructured, error)
• type Getter
  • func NewGetter(data []byte) (*Getter, error)
  • func (c *Getter) ToDiscoveryClient() (discovery.CachedDiscoveryInterface, error)
  • func (c *Getter) ToRESTConfig() (*rest.Config, error)
  • func (c *Getter) ToRESTMapper() (meta.RESTMapper, error)
  • func (c *Getter) ToRawKubeConfigLoader() clientcmd.ClientConfig
• type Namespace
• type ObjectMetadata
  • func YAMLToObjectMetadata(yamlObj string) (ObjectMetadata, error)
• type WaitOptions

Constants

const RolloutTimeout = 15 * time.Minute

RolloutTimeout is the timeout to wait for a daemonset or deployment to rollout changes.

const (
	// WaitDefaultTimeout is default timeout after which watching for workload should return error.
	WaitDefaultTimeout = 5 * time.Minute
)

Functions

func CreateOrUpdateNamespace

func CreateOrUpdateNamespace(ns Namespace, nsclient corev1typed.NamespaceInterface) error

CreateOrUpdateNamespace creates the release namespace or updates the namespace if it already exists.

func ListNamespaces

func ListNamespaces(nsclient corev1typed.NamespaceInterface) (*v1.NamespaceList, error)

ListNamespaces lists the namespaces present in the cluster.

func LoadManifests

func LoadManifests(files map[string]string) ([]manifest, error)

LoadManifests parses a map of Kubernetes manifests. Deprecated: YAMLToObjectMetadata should be used instead.

func NewClientset

func NewClientset(data []byte) (*kubernetes.Clientset, error)

NewClientset creates new Kubernetes Client set object from the contents of the given kubeconfig file.

func RolloutDaemonSet

func RolloutDaemonSet(ctx context.Context, dsi clientappsv1.DaemonSetInterface, name string) error

RolloutDaemonSet runs rolloutRestartDaemonSet and will wait for the DaemonSet to be fully rolled out.

func RolloutDeployment

func RolloutDeployment(ctx context.Context, deployClient clientappsv1.DeploymentInterface, name string) error

RolloutDeployment runs rolloutRestartDeployment and will wait for the DaemonSet to be fully rolled out.

func SplitYAMLDocuments

func SplitYAMLDocuments(yamlObj string) ([]string, error)

SplitYAMLDocuments separates a YAML file with multiple YAML documents separated by `---` into separate YAML files and returns a list.

func YAMLToUnstructured

func YAMLToUnstructured(yamlObj []byte) (*unstructured.Unstructured, error)

YAMLToUnstructured accepts a Kubernetes manifest in YAML format and returns an object of type `unstructured.Unstructured`. This object has many methods that can be used by the consumer to extract metadata from the Kubernetes manifest.

Types

type Getter

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

Getter implements k8s.io/cli-runtime/pkg/genericclioptions.RESTClientGetter interface.

func NewGetter

func NewGetter(data []byte) (*Getter, error)

NewGetter takes content of kubeconfig file as an argument and returns implementation of RESTClientGetter k8s interface.

func (*Getter) ToDiscoveryClient

func (c *Getter) ToDiscoveryClient() (discovery.CachedDiscoveryInterface, error)

ToDiscoveryClient is part of k8s.io/cli-runtime/pkg/genericclioptions.RESTClientGetter interface.

func (*Getter) ToRESTConfig

func (c *Getter) ToRESTConfig() (*rest.Config, error)

ToRESTConfig is part of k8s.io/cli-runtime/pkg/genericclioptions.RESTClientGetter interface.

func (*Getter) ToRESTMapper

func (c *Getter) ToRESTMapper() (meta.RESTMapper, error)

ToRESTMapper is part of k8s.io/cli-runtime/pkg/genericclioptions.RESTClientGetter interface.

func (*Getter) ToRawKubeConfigLoader

func (c *Getter) ToRawKubeConfigLoader() clientcmd.ClientConfig

ToRawKubeConfigLoader is part of k8s.io/cli-runtime/pkg/genericclioptions.RESTClientGetter interface.

type Namespace

type Namespace struct {
	Name        string
	Labels      map[string]string
	Annotations map[string]string
}

Namespace struct for holding the Lokomotive specific metadata. when installing cluster or components.

type ObjectMetadata

type ObjectMetadata struct {
	Version string
	Kind    string
	Name    string
}

ObjectMetadata uniquely identifies any object in the list of YAML manifests.

func YAMLToObjectMetadata

func YAMLToObjectMetadata(yamlObj string) (ObjectMetadata, error)

YAMLToObjectMetadata extracts Kubernetes metadata from any YAML manifest and return an ObjectMetadata.

type WaitOptions

type WaitOptions struct {
	Generation int64
	Timeout    time.Duration
}

WaitOptions holds optional arguments for WaitFor... functions group.