Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the approuting v1alpha1 API group +kubebuilder:object:generate=true +groupName=approuting.kubernetes.azure.com
Index ¶
- Constants
- Variables
- type ManagedObjectReference
- type NginxIngressController
- func (in *NginxIngressController) DeepCopy() *NginxIngressController
- func (in *NginxIngressController) DeepCopyInto(out *NginxIngressController)
- func (in *NginxIngressController) DeepCopyObject() runtime.Object
- func (n *NginxIngressController) Default()
- func (n *NginxIngressController) GetCondition(t string) *metav1.Condition
- func (n *NginxIngressController) SetCondition(c metav1.Condition)
- func (n *NginxIngressController) Valid() string
- type NginxIngressControllerList
- type NginxIngressControllerSpec
- type NginxIngressControllerStatus
Constants ¶
const ( // ConditionTypeAvailable indicates whether the NGINX Ingress Controller is available. Its condition status is one of // - "True" when the NGINX Ingress Controller is available and can be used // - "False" when the NGINX Ingress Controller is not available and cannot offer full functionality // - "Unknown" when the NGINX Ingress Controller's availability cannot be determined ConditionTypeAvailable = "Available" // ConditionTypeIngressClassReady indicates whether the IngressClass exists. Its condition status is one of // - "True" when the IngressClass exists // - "False" when the IngressClass does not exist // - "Collision" when the IngressClass exists, but it's not owned by the NginxIngressController. // - "Unknown" when the IngressClass's existence cannot be determined ConditionTypeIngressClassReady = "IngressClassReady" // ConditionTypeControllerAvailable indicates whether the NGINX Ingress Controller deployment is available. Its condition status is one of // - "True" when the NGINX Ingress Controller deployment is available // - "False" when the NGINX Ingress Controller deployment is not available // - "Unknown" when the NGINX Ingress Controller deployment's availability cannot be determined ConditionTypeControllerAvailable = "ControllerAvailable" // ConditionTypeProgressing indicates whether the NGINX Ingress Controller availability is progressing. Its condition status is one of // - "True" when the NGINX Ingress Controller availability is progressing // - "False" when the NGINX Ingress Controller availability is not progressing // - "Unknown" when the NGINX Ingress Controller availability's progress cannot be determined ConditionTypeProgressing = "Progressing" )
const (
// MaxCollisions is the maximum number of collisions allowed when generating a name for a managed resource. This corresponds to the status.CollisionCount
MaxCollisions = 5
)
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "approuting.kubernetes.azure.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 )
Functions ¶
This section is empty.
Types ¶
type ManagedObjectReference ¶
type ManagedObjectReference struct { // Name is the name of the managed object Name string `json:"name"` // Namespace is the namespace of the managed object. If not specified, the resource is cluster-scoped // +optional Namespace string `json:"namespace"` // Kind is the kind of the managed object Kind string `json:"kind"` // APIGroup is the API group of the managed object. If not specified, the resource is in the core API group // +optional APIGroup string `json:"apiGroup"` }
ManagedObjectReference is a reference to an object
func (*ManagedObjectReference) DeepCopy ¶
func (in *ManagedObjectReference) DeepCopy() *ManagedObjectReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedObjectReference.
func (*ManagedObjectReference) DeepCopyInto ¶
func (in *ManagedObjectReference) DeepCopyInto(out *ManagedObjectReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NginxIngressController ¶
type NginxIngressController struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // +required Spec NginxIngressControllerSpec `json:"spec,omitempty"` // +optional Status NginxIngressControllerStatus `json:"status,omitempty"` }
NginxIngressController is the Schema for the nginxingresscontrollers API
func (*NginxIngressController) DeepCopy ¶
func (in *NginxIngressController) DeepCopy() *NginxIngressController
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NginxIngressController.
func (*NginxIngressController) DeepCopyInto ¶
func (in *NginxIngressController) DeepCopyInto(out *NginxIngressController)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NginxIngressController) DeepCopyObject ¶
func (in *NginxIngressController) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*NginxIngressController) Default ¶
func (n *NginxIngressController) Default()
func (*NginxIngressController) GetCondition ¶
func (n *NginxIngressController) GetCondition(t string) *metav1.Condition
func (*NginxIngressController) SetCondition ¶
func (n *NginxIngressController) SetCondition(c metav1.Condition)
func (*NginxIngressController) Valid ¶
func (n *NginxIngressController) Valid() string
Valid checks this NginxIngressController to see if it's valid. Returns a string describing the validation error, if any, or empty string if there is no error.
type NginxIngressControllerList ¶
type NginxIngressControllerList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []NginxIngressController `json:"items"` }
NginxIngressControllerList contains a list of NginxIngressController
func (*NginxIngressControllerList) DeepCopy ¶
func (in *NginxIngressControllerList) DeepCopy() *NginxIngressControllerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NginxIngressControllerList.
func (*NginxIngressControllerList) DeepCopyInto ¶
func (in *NginxIngressControllerList) DeepCopyInto(out *NginxIngressControllerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NginxIngressControllerList) DeepCopyObject ¶
func (in *NginxIngressControllerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NginxIngressControllerSpec ¶
type NginxIngressControllerSpec struct { // IngressClassName is the name of the IngressClass that will be used for the NGINX Ingress Controller. Defaults to metadata.name if // not specified. // +optional // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable" IngressClassName string `json:"ingressClassName,omitempty"` // ControllerNamePrefix is the name to use for the managed NGINX Ingress Controller resources. // +optional // +kubebuilder:default=nginx // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable" ControllerNamePrefix string `json:"controllerNamePrefix,omitempty"` // LoadBalancerAnnotations is a map of annotations to apply to the NGINX Ingress Controller's Service. Common annotations // will be from the Azure LoadBalancer annotations here https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#loadbalancer-annotations // +optional LoadBalancerAnnotations map[string]string `json:"loadBalancerAnnotations,omitempty"` }
NginxIngressControllerSpec defines the desired state of NginxIngressController
func (*NginxIngressControllerSpec) DeepCopy ¶
func (in *NginxIngressControllerSpec) DeepCopy() *NginxIngressControllerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NginxIngressControllerSpec.
func (*NginxIngressControllerSpec) DeepCopyInto ¶
func (in *NginxIngressControllerSpec) DeepCopyInto(out *NginxIngressControllerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NginxIngressControllerStatus ¶
type NginxIngressControllerStatus struct { // Conditions is an array of current observed conditions for the NGINX Ingress Controller // +optional // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions"` // ControllerReplicas is the desired number of replicas of the NGINX Ingress Controller // +optional ControllerReplicas int32 `json:"controllerReplicas"` // ControllerReadyReplicas is the number of ready replicas of the NGINX Ingress Controller deployment // +optional ControllerReadyReplicas int32 `json:"controllerReadyReplicas"` // ControllerAvailableReplicas is the number of available replicas of the NGINX Ingress Controller deployment // +optional ControllerAvailableReplicas int32 `json:"controllerAvailableReplicas"` // +optional ControllerUnavailableReplicas int32 `json:"controllerUnavailableReplicas"` // Count of hash collisions for the managed resources. The App Routing Operator uses this field // as a collision avoidance mechanism when it needs to create the name for the managed resources. // +optional // +kubebuilder:validation:Maximum=5 CollisionCount int32 `json:"collisionCount"` // ManagedResourceRefs is a list of references to the managed resources // +optional ManagedResourceRefs []ManagedObjectReference `json:"managedResourceRefs,omitempty"` }
NginxIngressControllerStatus defines the observed state of NginxIngressController
func (*NginxIngressControllerStatus) DeepCopy ¶
func (in *NginxIngressControllerStatus) DeepCopy() *NginxIngressControllerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NginxIngressControllerStatus.
func (*NginxIngressControllerStatus) DeepCopyInto ¶
func (in *NginxIngressControllerStatus) DeepCopyInto(out *NginxIngressControllerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.