1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
|
package v1
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
corev1 "k8s.io/api/core/v1"
)
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// IngressController describes a managed ingress controller for the cluster. The
// controller can service OpenShift Route and Kubernetes Ingress resources.
//
// When an IngressController is created, a new ingress controller deployment is
// created to allow external traffic to reach the services that expose Ingress
// or Route resources. Updating this resource may lead to disruption for public
// facing network connections as a new ingress controller revision may be rolled
// out.
//
// https://kubernetes.io/docs/concepts/services-networking/ingress-controllers
//
// Whenever possible, sensible defaults for the platform are used. See each
// field for more details.
type IngressController struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// spec is the specification of the desired behavior of the IngressController.
Spec IngressControllerSpec `json:"spec,omitempty"`
// status is the most recently observed status of the IngressController.
Status IngressControllerStatus `json:"status,omitempty"`
}
// IngressControllerSpec is the specification of the desired behavior of the
// IngressController.
type IngressControllerSpec struct {
// domain is a DNS name serviced by the ingress controller and is used to
// configure multiple features:
//
// * For the LoadBalancerService endpoint publishing strategy, domain is
// used to configure DNS records. See endpointPublishingStrategy.
//
// * When using a generated default certificate, the certificate will be valid
// for domain and its subdomains. See defaultCertificate.
//
// * The value is published to individual Route statuses so that end-users
// know where to target external DNS records.
//
// domain must be unique among all IngressControllers, and cannot be
// updated.
//
// If empty, defaults to ingress.config.openshift.io/cluster .spec.domain.
//
// +optional
Domain string `json:"domain,omitempty"`
// replicas is the desired number of ingress controller replicas. If unset,
// defaults to 2.
//
// +optional
Replicas *int32 `json:"replicas,omitempty"`
// endpointPublishingStrategy is used to publish the ingress controller
// endpoints to other networks, enable load balancer integrations, etc.
//
// If unset, the default is based on
// infrastructure.config.openshift.io/cluster .status.platform:
//
// AWS: LoadBalancerService
// Libvirt: HostNetwork
//
// Any other platform types (including None) default to HostNetwork.
//
// endpointPublishingStrategy cannot be updated.
//
// +optional
EndpointPublishingStrategy *EndpointPublishingStrategy `json:"endpointPublishingStrategy,omitempty"`
// defaultCertificate is a reference to a secret containing the default
// certificate served by the ingress controller. When Routes don't specify
// their own certificate, defaultCertificate is used.
//
// The secret must contain the following keys and data:
//
// tls.crt: certificate file contents
// tls.key: key file contents
//
// If unset, a wildcard certificate is automatically generated and used. The
// certificate is valid for the ingress controller domain (and subdomains) and
// the generated certificate's CA will be automatically integrated with the
// cluster's trust store.
//
// The in-use certificate (whether generated or user-specified) will be
// automatically integrated with OpenShift's built-in OAuth server.
//
// +optional
DefaultCertificate *corev1.LocalObjectReference `json:"defaultCertificate,omitempty"`
// namespaceSelector is used to filter the set of namespaces serviced by the
// ingress controller. This is useful for implementing shards.
//
// If unset, the default is no filtering.
//
// +optional
NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"`
// routeSelector is used to filter the set of Routes serviced by the ingress
// controller. This is useful for implementing shards.
//
// If unset, the default is no filtering.
//
// +optional
RouteSelector *metav1.LabelSelector `json:"routeSelector,omitempty"`
// nodePlacement enables explicit control over the scheduling of the ingress
// controller.
//
// If unset, defaults are used. See NodePlacement for more details.
//
// +optional
NodePlacement *NodePlacement `json:"nodePlacement,omitempty"`
}
// NodePlacement describes node scheduling configuration for an ingress
// controller.
type NodePlacement struct {
// nodeSelector is the node selector applied to ingress controller
// deployments.
//
// If unset, the default is:
//
// beta.kubernetes.io/os: linux
// node-role.kubernetes.io/worker: ''
//
// If set, the specified selector is used and replaces the default.
//
// +optional
NodeSelector *metav1.LabelSelector `json:"nodeSelector,omitempty"`
// tolerations is a list of tolerations applied to ingress controller
// deployments.
//
// The default is an empty list.
//
// See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
//
// +optional
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
}
// EndpointPublishingStrategyType is a way to publish ingress controller endpoints.
type EndpointPublishingStrategyType string
const (
// LoadBalancerService publishes the ingress controller using a Kubernetes
// LoadBalancer Service.
LoadBalancerServiceStrategyType EndpointPublishingStrategyType = "LoadBalancerService"
// HostNetwork publishes the ingress controller on node ports where the
// ingress controller is deployed.
HostNetworkStrategyType EndpointPublishingStrategyType = "HostNetwork"
// Private does not publish the ingress controller.
PrivateStrategyType EndpointPublishingStrategyType = "Private"
)
// EndpointPublishingStrategy is a way to publish the endpoints of an
// IngressController, and represents the type and any additional configuration
// for a specific type.
type EndpointPublishingStrategy struct {
// type is the publishing strategy to use. Valid values are:
//
// * LoadBalancerService
//
// Publishes the ingress controller using a Kubernetes LoadBalancer Service.
//
// In this configuration, the ingress controller deployment uses container
// networking. A LoadBalancer Service is created to publish the deployment.
//
// See: https://kubernetes.io/docs/concepts/services-networking/#loadbalancer
//
// If domain is set, a wildcard DNS record will be managed to point at the
// LoadBalancer Service's external name. DNS records are managed only in DNS
// zones defined by dns.config.openshift.io/cluster .spec.publicZone and
// .spec.privateZone.
//
// Wildcard DNS management is currently supported only on the AWS platform.
//
// * HostNetwork
//
// Publishes the ingress controller on node ports where the ingress controller
// is deployed.
//
// In this configuration, the ingress controller deployment uses host
// networking, bound to node ports 80 and 443. The user is responsible for
// configuring an external load balancer to publish the ingress controller via
// the node ports.
//
// * Private
//
// Does not publish the ingress controller.
//
// In this configuration, the ingress controller deployment uses container
// networking, and is not explicitly published. The user must manually publish
// the ingress controller.
Type EndpointPublishingStrategyType `json:"type"`
}
var (
// Available indicates the ingress controller deployment is available.
IngressControllerAvailableConditionType = "Available"
// LoadBalancerManaged indicates the management status of any load balancer
// service associated with an ingress controller.
LoadBalancerManagedIngressConditionType = "LoadBalancerManaged"
// LoadBalancerReady indicates the ready state of any load balancer service
// associated with an ingress controller.
LoadBalancerReadyIngressConditionType = "LoadBalancerReady"
// DNSManaged indicates the management status of any DNS records for the
// ingress controller.
DNSManagedIngressConditionType = "DNSManaged"
// DNSReady indicates the ready state of any DNS records for the ingress
// controller.
DNSReadyIngressConditionType = "DNSReady"
)
// IngressControllerStatus defines the observed status of the IngressController.
type IngressControllerStatus struct {
// availableReplicas is number of observed available replicas according to the
// ingress controller deployment.
AvailableReplicas int32 `json:"availableReplicas"`
// selector is a label selector, in string format, for ingress controller pods
// corresponding to the IngressController. The number of matching pods should
// equal the value of availableReplicas.
Selector string `json:"selector"`
// domain is the actual domain in use.
Domain string `json:"domain"`
// endpointPublishingStrategy is the actual strategy in use.
EndpointPublishingStrategy *EndpointPublishingStrategy `json:"endpointPublishingStrategy,omitempty"`
// conditions is a list of conditions and their status.
//
// Available means the ingress controller deployment is available and
// servicing route and ingress resources (i.e, .status.availableReplicas
// equals .spec.replicas)
//
// There are additional conditions which indicate the status of other
// ingress controller features and capabilities.
//
// * LoadBalancerManaged
// - True if the following conditions are met:
// * The endpoint publishing strategy requires a service load balancer.
// - False if any of those conditions are unsatisfied.
//
// * LoadBalancerReady
// - True if the following conditions are met:
// * A load balancer is managed.
// * The load balancer is ready.
// - False if any of those conditions are unsatisfied.
//
// * DNSManaged
// - True if the following conditions are met:
// * The endpoint publishing strategy and platform support DNS.
// * The ingress controller domain is set.
// * dns.config.openshift.io/cluster configures DNS zones.
// - False if any of those conditions are unsatisfied.
//
// * DNSReady
// - True if the following conditions are met:
// * DNS is managed.
// * DNS records have been successfully created.
// - False if any of those conditions are unsatisfied.
Conditions []OperatorCondition `json:"conditions,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// IngressControllerList contains a list of IngressControllers.
type IngressControllerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []IngressController `json:"items"`
}
|