v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=ngrok.com

Index

• Variables
• type Ngrok
  • func (in *Ngrok) DeepCopy() *Ngrok
  • func (in *Ngrok) DeepCopyInto(out *Ngrok)
  • func (in *Ngrok) DeepCopyObject() runtime.Object
• type NgrokList
  • func (in *NgrokList) DeepCopy() *NgrokList
  • func (in *NgrokList) DeepCopyInto(out *NgrokList)
  • func (in *NgrokList) DeepCopyObject() runtime.Object
• type NgrokSpec
  • func (in *NgrokSpec) DeepCopy() *NgrokSpec
  • func (in *NgrokSpec) DeepCopyInto(out *NgrokSpec)
  • func (n *NgrokSpec) Validate() error
• type NgrokStatus
  • func (in *NgrokStatus) DeepCopy() *NgrokStatus
  • func (in *NgrokStatus) DeepCopyInto(out *NgrokStatus)
• type PodSpec
  • func (in *PodSpec) DeepCopy() *PodSpec
  • func (in *PodSpec) DeepCopyInto(out *PodSpec)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "ngrok.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type Ngrok

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

	Spec   NgrokSpec   `json:"spec,omitempty"`
	Status NgrokStatus `json:"status,omitempty"`
}

Ngrok is the Schema for the Ngrok API +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.status",description="Ngrok status" +kubebuilder:printcolumn:name="URL",type="string",JSONPath=".status.url",description="Ngrok URL"

func (*Ngrok) DeepCopy

func (in *Ngrok) DeepCopy() *Ngrok

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ngrok.

func (*Ngrok) DeepCopyInto

func (in *Ngrok) DeepCopyInto(out *Ngrok)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Ngrok) DeepCopyObject

func (in *Ngrok) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NgrokList

type NgrokList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Ngrok `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object NgrokList contains a list of Ngrok

func (*NgrokList) DeepCopy

func (in *NgrokList) DeepCopy() *NgrokList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NgrokList.

func (*NgrokList) DeepCopyInto

func (in *NgrokList) DeepCopyInto(out *NgrokList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NgrokList) DeepCopyObject

func (in *NgrokList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NgrokSpec

type NgrokSpec struct {
	Service string `json:"service"`
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=65535
	Port int32 `json:"port"`

	// +kubebuilder:validation:Enum=http;tcp;tls
	// +kubebuilder:default:=http
	// +optional
	Protocol string `json:"protocol"`

	// +optional
	AuthToken string `json:"authtoken"`

	// +kubebuilder:validation:Enum=plain;secret
	// +kubebuilder:default:=plain
	// +optional
	AuthTokenType string `json:"authtoken_type"`

	// +kubebuilder:validation:Enum=us;eu;ap;au;sa;jp;in
	// +optional
	Region string `json:"region"`

	// +optional
	Auth string `json:"auth"`

	// +optional
	HostHeader string `json:"host_header"`

	// +kubebuilder:validation:Enum="true";"false";both
	// +optional
	BindTLS string `json:"bind_tls"`

	// +kubebuilder:validation:Enum=true;false
	// +kubebuilder:default:=false
	// +optional
	Inspect bool `json:"inspect"`

	// +optional
	Hostname string `json:"hostname"`

	// +optional
	RemoteAddr string `json:"remote_addr"`

	// +kubebuilder:default:={image: zufardhiyaulhaq/ngrok}
	// +optional
	PodSpec PodSpec `json:"podSpec"`
}

NgrokSpec defines the desired state of Ngrok

func (*NgrokSpec) DeepCopy

func (in *NgrokSpec) DeepCopy() *NgrokSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NgrokSpec.

func (*NgrokSpec) DeepCopyInto

func (in *NgrokSpec) DeepCopyInto(out *NgrokSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NgrokSpec) Validate

func (n *NgrokSpec) Validate() error

type NgrokStatus

type NgrokStatus struct {
	Status string `json:"status"`
	URL    string `json:"url"`
}

NgrokStatus defines the observed state of Ngrok

func (*NgrokStatus) DeepCopy

func (in *NgrokStatus) DeepCopy() *NgrokStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NgrokStatus.

func (*NgrokStatus) DeepCopyInto

func (in *NgrokStatus) DeepCopyInto(out *NgrokStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PodSpec

type PodSpec struct {
	// +optional
	Image string `json:"image"`
}

func (*PodSpec) DeepCopy

func (in *PodSpec) DeepCopy() *PodSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodSpec.

func (*PodSpec) DeepCopyInto

func (in *PodSpec) DeepCopyInto(out *PodSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.