v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the gateway.nginx.org API group.

+kubebuilder:object:generate=true +groupName=gateway.nginx.org

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type ControllerLogLevel
• type Logging
  • func (in *Logging) DeepCopy() *Logging
  • func (in *Logging) DeepCopyInto(out *Logging)
• type NginxGateway
  • func (in *NginxGateway) DeepCopy() *NginxGateway
  • func (in *NginxGateway) DeepCopyInto(out *NginxGateway)
  • func (in *NginxGateway) DeepCopyObject() runtime.Object
• type NginxGatewayConditionReason
• type NginxGatewayConditionType
• type NginxGatewayList
  • func (in *NginxGatewayList) DeepCopy() *NginxGatewayList
  • func (in *NginxGatewayList) DeepCopyInto(out *NginxGatewayList)
  • func (in *NginxGatewayList) DeepCopyObject() runtime.Object
• type NginxGatewaySpec
  • func (in *NginxGatewaySpec) DeepCopy() *NginxGatewaySpec
  • func (in *NginxGatewaySpec) DeepCopyInto(out *NginxGatewaySpec)
• type NginxGatewayStatus
  • func (in *NginxGatewayStatus) DeepCopy() *NginxGatewayStatus
  • func (in *NginxGatewayStatus) DeepCopyInto(out *NginxGatewayStatus)

Constants

const (
	// NginxGatewayConditionValid is a condition that is true when the NginxGateway
	// configuration is syntactically and semantically valid.
	NginxGatewayConditionValid NginxGatewayConditionType = "Valid"

	// NginxGatewayReasonValid is a reason that is used with the "Valid" condition when the condition is True.
	NginxGatewayReasonValid NginxGatewayConditionReason = "Valid"

	// NginxGatewayReasonInvalid is a reason that is used with the "Valid" condition when the condition is False.
	NginxGatewayReasonInvalid NginxGatewayConditionReason = "Invalid"
)

const GroupName = "gateway.nginx.org"

GroupName specifies the group name used to register the objects.

Variables

var (
	// SchemeBuilder collects functions that add things to a scheme. It's to allow
	// code to compile without explicitly referencing generated types. You should
	// declare one in each package that will have generated deep copy or conversion
	// functions.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme applies all the stored functions to the scheme. A non-nil error
	// indicates that one function failed and the attempt was abandoned.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ControllerLogLevel

type ControllerLogLevel string

ControllerLogLevel type defines the logging level for the control plane.

+kubebuilder:validation:Enum=info;debug;error

const (
	// ControllerLogLevelInfo is the info level for control plane logging.
	ControllerLogLevelInfo ControllerLogLevel = "info"

	// ControllerLogLevelDebug is the debug level for control plane logging.
	ControllerLogLevelDebug ControllerLogLevel = "debug"

	// ControllerLogLevelError is the error level for control plane logging.
	ControllerLogLevelError ControllerLogLevel = "error"
)

type Logging

type Logging struct {
	// Level defines the logging level.
	//
	// +optional
	// +kubebuilder:default=info
	Level *ControllerLogLevel `json:"level,omitempty"`
}

Logging defines logging related settings for the control plane.

func (*Logging) DeepCopy

func (in *Logging) DeepCopy() *Logging

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

func (*Logging) DeepCopyInto

func (in *Logging) DeepCopyInto(out *Logging)

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

type NginxGateway

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

	// NginxGatewaySpec defines the desired state of the NginxGateway.
	Spec NginxGatewaySpec `json:"spec"`

	// NginxGatewayStatus defines the state of the NginxGateway.
	Status NginxGatewayStatus `json:"status,omitempty"`
}

NginxGateway represents the dynamic configuration for an NGINX Kubernetes Gateway control plane.

func (*NginxGateway) DeepCopy

func (in *NginxGateway) DeepCopy() *NginxGateway

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

func (*NginxGateway) DeepCopyInto

func (in *NginxGateway) DeepCopyInto(out *NginxGateway)

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

func (*NginxGateway) DeepCopyObject

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

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

type NginxGatewayConditionReason

type NginxGatewayConditionReason string

NginxGatewayConditionReason defines the set of reasons that explain why a particular NginxGateway condition type has been raised.

type NginxGatewayConditionType

type NginxGatewayConditionType string

NginxGatewayConditionType is a type of condition associated with an NginxGateway. This type should be used with the NginxGatewayStatus.Conditions field.

type NginxGatewayList

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

NginxGatewayList contains a list of NginxGateways.

func (*NginxGatewayList) DeepCopy

func (in *NginxGatewayList) DeepCopy() *NginxGatewayList

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

func (*NginxGatewayList) DeepCopyInto

func (in *NginxGatewayList) DeepCopyInto(out *NginxGatewayList)

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

func (*NginxGatewayList) DeepCopyObject

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

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

type NginxGatewaySpec

type NginxGatewaySpec struct {
	// Logging defines logging related settings for the control plane.
	//
	// +optional
	Logging *Logging `json:"logging,omitempty"`
}

NginxGatewaySpec defines the desired state of the NginxGateway.

func (*NginxGatewaySpec) DeepCopy

func (in *NginxGatewaySpec) DeepCopy() *NginxGatewaySpec

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

func (*NginxGatewaySpec) DeepCopyInto

func (in *NginxGatewaySpec) DeepCopyInto(out *NginxGatewaySpec)

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

type NginxGatewayStatus

type NginxGatewayStatus struct {
	// +optional
	// +listType=map
	// +listMapKey=type
	// +kubebuilder:validation:MaxItems=8
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

NginxGatewayStatus defines the state of the NginxGateway.

func (*NginxGatewayStatus) DeepCopy

func (in *NginxGatewayStatus) DeepCopy() *NginxGatewayStatus

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

func (*NginxGatewayStatus) DeepCopyInto

func (in *NginxGatewayStatus) DeepCopyInto(out *NginxGatewayStatus)

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