v1

Documentation

Overview

+k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=sigs.k8s.io/apiserver-builder-alpha/example/podexec/pkg/apis/podexec +k8s:defaulter-gen=TypeMeta +groupName=podexec.example.com

Index

• func ExecLocation(getter corev1client.CoreV1Interface, connInfo kubelet.ConnectionInfoGetter, ...) (*url.URL, http.RoundTripper, error)
• type Pod
  • func (in *Pod) GetArbitrarySubResources() []resource.ArbitrarySubResource
  • func (in *Pod) GetGroupVersionResource() schema.GroupVersionResource
  • func (in *Pod) GetObjectMeta() *metav1.ObjectMeta
  • func (in *Pod) IsStorageVersion() bool
  • func (in *Pod) NamespaceScoped() bool
  • func (in *Pod) New() runtime.Object
  • func (in *Pod) NewList() runtime.Object
• type PodExec
  • func (p *PodExec) Connect(ctx context.Context, id string, options runtime.Object, ...) (http.Handler, error)
  • func (p *PodExec) ConnectMethods() []string
  • func (p PodExec) New() runtime.Object
  • func (p *PodExec) NewConnectOptions() (runtime.Object, bool, string)
  • func (p *PodExec) SubResourceName() string
• type PodList
• type PodSpec
• type PodStatus

Functions

func ExecLocation

func ExecLocation(
	getter corev1client.CoreV1Interface,
	connInfo kubelet.ConnectionInfoGetter,
	ctx context.Context,
	name string,
	opts *PodExec,
) (*url.URL, http.RoundTripper, error)

ExecLocation returns the exec URL for a pod container. If opts.Container is blank and only one container is present in the pod, that container is used.

Types

type Pod

type Pod struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PodSpec   `json:"spec,omitempty"`
	Status PodStatus `json:"status,omitempty"`
}

Pod +k8s:openapi-gen=true

func (*Pod) GetArbitrarySubResources

func (in *Pod) GetArbitrarySubResources() []resource.ArbitrarySubResource

func (*Pod) GetGroupVersionResource

func (in *Pod) GetGroupVersionResource() schema.GroupVersionResource

func (*Pod) GetObjectMeta

func (in *Pod) GetObjectMeta() *metav1.ObjectMeta

func (*Pod) IsStorageVersion

func (in *Pod) IsStorageVersion() bool

func (*Pod) NamespaceScoped

func (in *Pod) NamespaceScoped() bool

func (*Pod) New

func (in *Pod) New() runtime.Object

func (*Pod) NewList

func (in *Pod) NewList() runtime.Object

type PodExec

type PodExec struct {
	metav1.TypeMeta `json:",inline"`

	// Stdin if true indicates that stdin is to be redirected for the exec call
	Stdin bool

	// Stdout if true indicates that stdout is to be redirected for the exec call
	Stdout bool

	// Stderr if true indicates that stderr is to be redirected for the exec call
	Stderr bool

	// TTY if true indicates that a tty will be allocated for the exec call
	TTY bool

	// Container in which to execute the command.
	Container string

	// Command is the remote command to execute; argv array; not executed within a shell.
	Command []string
}

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*PodExec) Connect

func (p *PodExec) Connect(ctx context.Context, id string, options runtime.Object, responder rest.Responder) (http.Handler, error)

func (*PodExec) ConnectMethods

func (p *PodExec) ConnectMethods() []string

func (PodExec) New

func (p PodExec) New() runtime.Object

func (*PodExec) NewConnectOptions

func (p *PodExec) NewConnectOptions() (runtime.Object, bool, string)

func (*PodExec) SubResourceName

func (p *PodExec) SubResourceName() string

type PodList

type PodList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Pod `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

type PodSpec

type PodSpec struct {
}

PodSpec defines the desired state of Pod

type PodStatus

type PodStatus struct {
}

PodStatus defines the observed state of Pod