kubernetes

Documentation

Overview

Package kubernetes provides data types and custom marshalers for Kubernetes API objects.

Interaction with the Kubernetes API should be handled by the kubectl subpackage.

Index

• func ConstructK8sComponentsCM(components components.Components, clusterVersion string) (corev1.ConfigMap, error)
• func MarshalK8SResources(resources any) ([]byte, error)
• func MarshalK8SResourcesList(resources []runtime.Object) ([]byte, error)
• func UnmarshalK8SResources(data []byte, into any) error
• type ConfigMaps
  • func (s ConfigMaps) Marshal() ([]byte, error)
• type Marshaler
• type Secrets
  • func (s Secrets) Marshal() ([]byte, error)

Functions

func ConstructK8sComponentsCM

func ConstructK8sComponentsCM(components components.Components, clusterVersion string) (corev1.ConfigMap, error)

ConstructK8sComponentsCM creates a k8s-components config map for the given components.

func MarshalK8SResources

func MarshalK8SResources(resources any) ([]byte, error)

MarshalK8SResources marshals every field of a struct into a k8s resource YAML.

func MarshalK8SResourcesList

func MarshalK8SResourcesList(resources []runtime.Object) ([]byte, error)

MarshalK8SResourcesList marshals every element of a slice into a k8s resource YAML.

func UnmarshalK8SResources

func UnmarshalK8SResources(data []byte, into any) error

UnmarshalK8SResources takes YAML and converts it into a k8s resources struct.

Types

type ConfigMaps

type ConfigMaps []*corev1.ConfigMap

ConfigMaps represent a list of k8s ConfigMap.

func (ConfigMaps) Marshal

func (s ConfigMaps) Marshal() ([]byte, error)

Marshal marshals config maps into multiple YAML documents.

type Marshaler

type Marshaler interface {
	Marshal() ([]byte, error)
}

Marshaler is used by all k8s resources that can be marshaled to YAML.

type Secrets

type Secrets []*k8s.Secret

Secrets represent a list of k8s Secret.

func (Secrets) Marshal

func (s Secrets) Marshal() ([]byte, error)

Marshal marshals secrets into multiple YAML documents.