resource

Documentation

Overview

Package resource contains helpers to generate Kubernetes API objects.

Index

• func NewContainer(name string, opts ...ObjectOption) *corev1.Container
• func NewDeployment(ns, name string, opts ...ObjectOption) *appsv1.Deployment
• func NewKnService(ns, name string, opts ...ObjectOption) *servingv1.Service
• type ObjectOption
  • func Container(c *corev1.Container) ObjectOption
  • func Controller(obj kmeta.OwnerRefable) ObjectOption
  • func EnvVar(name, val string) ObjectOption
  • func EnvVarFromSecret(name, secretName, secretKey string) ObjectOption
  • func EnvVars(evs ...corev1.EnvVar) ObjectOption
  • func Image(img string) ObjectOption
  • func Label(key, val string) ObjectOption
  • func PodLabel(key, val string) ObjectOption
  • func Port(name string, port int32) ObjectOption
  • func Probe(path, port string) ObjectOption
  • func Selector(key, val string) ObjectOption

Functions

func NewContainer

func NewContainer(name string, opts ...ObjectOption) *corev1.Container

NewContainer creates a Container object.

func NewDeployment

func NewDeployment(ns, name string, opts ...ObjectOption) *appsv1.Deployment

NewDeployment creates a Deployment object.

func NewKnService

func NewKnService(ns, name string, opts ...ObjectOption) *servingv1.Service

NewKnService creates a Knative Service object.

Types

type ObjectOption

type ObjectOption func(interface{})

ObjectOption is a functional option for building Kubernetes API objects.

func Container

func Container(c *corev1.Container) ObjectOption

Container adds a container to a PodSpecable's Pod template.

func Controller

func Controller(obj kmeta.OwnerRefable) ObjectOption

Controller sets the given object as the controller (owner) of an API object.

func EnvVar

func EnvVar(name, val string) ObjectOption

EnvVar sets the value of a Container's environment variable.

func EnvVarFromSecret

func EnvVarFromSecret(name, secretName, secretKey string) ObjectOption

EnvVarFromSecret sets the value of a Container's environment variable to a reference to a Kubernetes Secret.

func EnvVars

func EnvVars(evs ...corev1.EnvVar) ObjectOption

EnvVars sets the value of multiple environment variables.

func Image

func Image(img string) ObjectOption

Image sets a Container's image.

func Label

func Label(key, val string) ObjectOption

Label sets the value of an API object's label.

func PodLabel

func PodLabel(key, val string) ObjectOption

PodLabel sets the value of a label of a PodSpecable's Pod template.

func Port

func Port(name string, port int32) ObjectOption

Port adds a port to a Container.

func Probe

func Probe(path, port string) ObjectOption

Probe sets the HTTP readiness probe of a Deployment's first container.

func Selector

func Selector(key, val string) ObjectOption

Selector adds a label selector to a Deployment's spec, ensuring a corresponding label exists in the Pod template.