kube

package
v5.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 1, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Apply 

func Apply(ctx context.Context, path string, options *ApplyOptions) error

func ApplyWithBody 

func ApplyWithBody(ctx context.Context, body io.Reader, options *ApplyOptions) error

func Down 

func Down(ctx context.Context, path string, options DownOptions) (*entitiesTypes.KubePlayReport, error)

func DownWithBody 

func DownWithBody(ctx context.Context, body io.Reader, options DownOptions) (*entitiesTypes.KubePlayReport, error)

func Generate 

func Generate(ctx context.Context, nameOrIDs []string, options generate.KubeOptions) (*entitiesTypes.GenerateKubeReport, error)

Kube generate Kubernetes YAML (v1 specification)

func Play 

func Play(ctx context.Context, path string, options *PlayOptions) (*entitiesTypes.KubePlayReport, error)

func PlayWithBody 

func PlayWithBody(ctx context.Context, body io.Reader, options *PlayOptions) (*entitiesTypes.KubePlayReport, error)

Types

type ApplyOptions 

type ApplyOptions struct {
	// Kubeconfig - path to the cluster's kubeconfig file.
	Kubeconfig *string
	// Namespace - namespace to deploy the workload in on the cluster.
	Namespace *string
	// CACertFile - the path to the CA cert file for the Kubernetes cluster.
	CACertFile *string
	// File - the path to the Kubernetes yaml to deploy.
	File *string
	// Service - creates a service for the container being deployed.
	Service *bool
}

ApplyOptions are optional options for applying kube YAML files to a k8s cluster

func (*ApplyOptions) Changed 

func (o *ApplyOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ApplyOptions) GetCACertFile 

func (o *ApplyOptions) GetCACertFile() string

GetCACertFile returns value of field CACertFile

func (*ApplyOptions) GetFile 

func (o *ApplyOptions) GetFile() string

GetFile returns value of field File

func (*ApplyOptions) GetKubeconfig 

func (o *ApplyOptions) GetKubeconfig() string

GetKubeconfig returns value of field Kubeconfig

func (*ApplyOptions) GetNamespace 

func (o *ApplyOptions) GetNamespace() string

GetNamespace returns value of field Namespace

func (*ApplyOptions) GetService 

func (o *ApplyOptions) GetService() bool

GetService returns value of field Service

func (*ApplyOptions) ToParams 

func (o *ApplyOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*ApplyOptions) WithCACertFile 

func (o *ApplyOptions) WithCACertFile(value string) *ApplyOptions

WithCACertFile set field CACertFile to given value

func (*ApplyOptions) WithFile 

func (o *ApplyOptions) WithFile(value string) *ApplyOptions

WithFile set field File to given value

func (*ApplyOptions) WithKubeconfig 

func (o *ApplyOptions) WithKubeconfig(value string) *ApplyOptions

WithKubeconfig set field Kubeconfig to given value

func (*ApplyOptions) WithNamespace 

func (o *ApplyOptions) WithNamespace(value string) *ApplyOptions

WithNamespace set field Namespace to given value

func (*ApplyOptions) WithService 

func (o *ApplyOptions) WithService(value bool) *ApplyOptions

WithService set field Service to given value

type DownOptions 

type DownOptions struct {
	// Force - remove volumes on --down
	Force *bool
}

DownOptions are optional options for tearing down kube YAML files to a k8s cluster

func (*DownOptions) Changed 

func (o *DownOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*DownOptions) GetForce 

func (o *DownOptions) GetForce() bool

GetForce returns value of field Force

func (*DownOptions) ToParams 

func (o *DownOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*DownOptions) WithForce 

func (o *DownOptions) WithForce(value bool) *DownOptions

WithForce set field Force to given value

type PlayOptions 

type PlayOptions struct {
	// Annotations - Annotations to add to Pods
	Annotations map[string]string
	// Authfile - path to an authentication file.
	Authfile *string
	// CertDir - to a directory containing TLS certifications and keys.
	CertDir *string
	// Username for authenticating against the registry.
	Username *string
	// Password for authenticating against the registry.
	Password *string
	// Network - name of the networks to connect to.
	Network *[]string
	// NoHosts - do not generate /etc/hosts file in pod's containers
	NoHosts *bool
	// Quiet - suppress output when pulling images.
	Quiet *bool
	// SignaturePolicy - path to a signature-policy file.
	SignaturePolicy *string
	// SkipTLSVerify - skip https and certificate validation when
	// contacting container registries.
	SkipTLSVerify *bool `schema:"-"`
	// SeccompProfileRoot - path to a directory containing seccomp
	// profiles.
	SeccompProfileRoot *string
	// StaticIPs - Static IP address used by the pod(s).
	StaticIPs *[]net.IP
	// StaticMACs - Static MAC address used by the pod(s).
	StaticMACs *[]net.HardwareAddr
	// ConfigMaps - slice of pathnames to kubernetes configmap YAMLs.
	ConfigMaps *[]string
	// LogDriver for the container. For example: journald
	LogDriver *string
	// LogOptions for the container. For example: journald
	LogOptions *[]string
	// Replace - replace existing pods and containers
	Replace *bool
	// Start - don't start the pod if false
	Start *bool
	// NoTrunc - use annotations that were not truncated to the
	// Kubernetes maximum of 63 characters
	NoTrunc *bool
	// Userns - define the user namespace to use.
	Userns *string
	// Force - remove volumes on --down
	Force *bool
	// PublishPorts - configure how to expose ports configured inside the K8S YAML file
	PublishPorts []string
	// PublishAllPorts - whether to publish all ports defined in the K8S YAML file
	// (containerPort, hostPort) otherwise only hostPort will be published
	PublishAllPorts *bool
	// Wait - indicates whether to return after having created the pods
	Wait             *bool
	ServiceContainer *bool
}

PlayOptions are optional options for replaying kube YAML files

func (*PlayOptions) Changed 

func (o *PlayOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*PlayOptions) GetAnnotations 

func (o *PlayOptions) GetAnnotations() map[string]string

GetAnnotations returns value of field Annotations

func (*PlayOptions) GetAuthfile 

func (o *PlayOptions) GetAuthfile() string

GetAuthfile returns value of field Authfile

func (*PlayOptions) GetCertDir 

func (o *PlayOptions) GetCertDir() string

GetCertDir returns value of field CertDir

func (*PlayOptions) GetConfigMaps 

func (o *PlayOptions) GetConfigMaps() []string

GetConfigMaps returns value of field ConfigMaps

func (*PlayOptions) GetForce 

func (o *PlayOptions) GetForce() bool

GetForce returns value of field Force

func (*PlayOptions) GetLogDriver 

func (o *PlayOptions) GetLogDriver() string

GetLogDriver returns value of field LogDriver

func (*PlayOptions) GetLogOptions 

func (o *PlayOptions) GetLogOptions() []string

GetLogOptions returns value of field LogOptions

func (*PlayOptions) GetNetwork 

func (o *PlayOptions) GetNetwork() []string

GetNetwork returns value of field Network

func (*PlayOptions) GetNoHosts 

func (o *PlayOptions) GetNoHosts() bool

GetNoHosts returns value of field NoHosts

func (*PlayOptions) GetNoTrunc 

func (o *PlayOptions) GetNoTrunc() bool

GetNoTrunc returns value of field NoTrunc

func (*PlayOptions) GetPassword 

func (o *PlayOptions) GetPassword() string

GetPassword returns value of field Password

func (*PlayOptions) GetPublishAllPorts 

func (o *PlayOptions) GetPublishAllPorts() bool

GetPublishAllPorts returns value of field PublishAllPorts

func (*PlayOptions) GetPublishPorts 

func (o *PlayOptions) GetPublishPorts() []string

GetPublishPorts returns value of field PublishPorts

func (*PlayOptions) GetQuiet 

func (o *PlayOptions) GetQuiet() bool

GetQuiet returns value of field Quiet

func (*PlayOptions) GetReplace 

func (o *PlayOptions) GetReplace() bool

GetReplace returns value of field Replace

func (*PlayOptions) GetSeccompProfileRoot 

func (o *PlayOptions) GetSeccompProfileRoot() string

GetSeccompProfileRoot returns value of field SeccompProfileRoot

func (*PlayOptions) GetServiceContainer 

func (o *PlayOptions) GetServiceContainer() bool

GetServiceContainer returns value of field ServiceContainer

func (*PlayOptions) GetSignaturePolicy 

func (o *PlayOptions) GetSignaturePolicy() string

GetSignaturePolicy returns value of field SignaturePolicy

func (*PlayOptions) GetSkipTLSVerify 

func (o *PlayOptions) GetSkipTLSVerify() bool

GetSkipTLSVerify returns value of field SkipTLSVerify

func (*PlayOptions) GetStart 

func (o *PlayOptions) GetStart() bool

GetStart returns value of field Start

func (*PlayOptions) GetStaticIPs 

func (o *PlayOptions) GetStaticIPs() []net.IP

GetStaticIPs returns value of field StaticIPs

func (*PlayOptions) GetStaticMACs 

func (o *PlayOptions) GetStaticMACs() []net.HardwareAddr

GetStaticMACs returns value of field StaticMACs

func (*PlayOptions) GetUsername 

func (o *PlayOptions) GetUsername() string

GetUsername returns value of field Username

func (*PlayOptions) GetUserns 

func (o *PlayOptions) GetUserns() string

GetUserns returns value of field Userns

func (*PlayOptions) GetWait 

func (o *PlayOptions) GetWait() bool

GetWait returns value of field Wait

func (*PlayOptions) ToParams 

func (o *PlayOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*PlayOptions) WithAnnotations 

func (o *PlayOptions) WithAnnotations(value map[string]string) *PlayOptions

WithAnnotations set field Annotations to given value

func (*PlayOptions) WithAuthfile 

func (o *PlayOptions) WithAuthfile(value string) *PlayOptions

WithAuthfile set field Authfile to given value

func (*PlayOptions) WithCertDir 

func (o *PlayOptions) WithCertDir(value string) *PlayOptions

WithCertDir set field CertDir to given value

func (*PlayOptions) WithConfigMaps 

func (o *PlayOptions) WithConfigMaps(value []string) *PlayOptions

WithConfigMaps set field ConfigMaps to given value

func (*PlayOptions) WithForce 

func (o *PlayOptions) WithForce(value bool) *PlayOptions

WithForce set field Force to given value

func (*PlayOptions) WithLogDriver 

func (o *PlayOptions) WithLogDriver(value string) *PlayOptions

WithLogDriver set field LogDriver to given value

func (*PlayOptions) WithLogOptions 

func (o *PlayOptions) WithLogOptions(value []string) *PlayOptions

WithLogOptions set field LogOptions to given value

func (*PlayOptions) WithNetwork 

func (o *PlayOptions) WithNetwork(value []string) *PlayOptions

WithNetwork set field Network to given value

func (*PlayOptions) WithNoHosts 

func (o *PlayOptions) WithNoHosts(value bool) *PlayOptions

WithNoHosts set field NoHosts to given value

func (*PlayOptions) WithNoTrunc 

func (o *PlayOptions) WithNoTrunc(value bool) *PlayOptions

WithNoTrunc set field NoTrunc to given value

func (*PlayOptions) WithPassword 

func (o *PlayOptions) WithPassword(value string) *PlayOptions

WithPassword set field Password to given value

func (*PlayOptions) WithPublishAllPorts 

func (o *PlayOptions) WithPublishAllPorts(value bool) *PlayOptions

WithPublishAllPorts set field PublishAllPorts to given value

func (*PlayOptions) WithPublishPorts 

func (o *PlayOptions) WithPublishPorts(value []string) *PlayOptions

WithPublishPorts set field PublishPorts to given value

func (*PlayOptions) WithQuiet 

func (o *PlayOptions) WithQuiet(value bool) *PlayOptions

WithQuiet set field Quiet to given value

func (*PlayOptions) WithReplace 

func (o *PlayOptions) WithReplace(value bool) *PlayOptions

WithReplace set field Replace to given value

func (*PlayOptions) WithSeccompProfileRoot 

func (o *PlayOptions) WithSeccompProfileRoot(value string) *PlayOptions

WithSeccompProfileRoot set field SeccompProfileRoot to given value

func (*PlayOptions) WithServiceContainer 

func (o *PlayOptions) WithServiceContainer(value bool) *PlayOptions

WithServiceContainer set field ServiceContainer to given value

func (*PlayOptions) WithSignaturePolicy 

func (o *PlayOptions) WithSignaturePolicy(value string) *PlayOptions

WithSignaturePolicy set field SignaturePolicy to given value

func (*PlayOptions) WithSkipTLSVerify 

func (o *PlayOptions) WithSkipTLSVerify(value bool) *PlayOptions

WithSkipTLSVerify set field SkipTLSVerify to given value

func (*PlayOptions) WithStart 

func (o *PlayOptions) WithStart(value bool) *PlayOptions

WithStart set field Start to given value

func (*PlayOptions) WithStaticIPs 

func (o *PlayOptions) WithStaticIPs(value []net.IP) *PlayOptions

WithStaticIPs set field StaticIPs to given value

func (*PlayOptions) WithStaticMACs 

func (o *PlayOptions) WithStaticMACs(value []net.HardwareAddr) *PlayOptions

WithStaticMACs set field StaticMACs to given value

func (*PlayOptions) WithUsername 

func (o *PlayOptions) WithUsername(value string) *PlayOptions

WithUsername set field Username to given value

func (*PlayOptions) WithUserns 

func (o *PlayOptions) WithUserns(value string) *PlayOptions

WithUserns set field Userns to given value

func (*PlayOptions) WithWait 

func (o *PlayOptions) WithWait(value bool) *PlayOptions

WithWait set field Wait to given value

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.