1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 15:46:57 +01:00
Files
openshift-docs/modules/ingress-operator.adoc
2025-07-29 14:06:49 -05:00

88 lines
2.4 KiB
Plaintext

// Module included in the following assemblies:
//
// * operators/operator-reference.adoc
// * installing/overview/cluster-capabilities.adoc
ifeval::["{context}" == "cluster-capabilities"]
:cluster-caps:
endif::[]
ifeval::["{context}" == "operator-reference"]
:operator-ref:
endif::[]
:_mod-docs-content-type: REFERENCE
[id="ingress-operator_{context}"]
ifdef::operator-ref[= Ingress Operator]
ifdef::cluster-caps[= Ingress Capability]
ifdef::cluster-caps[]
The Ingress Operator provides the features for the Ingress Capability. The Ingress Capability is enabled by default.
[IMPORTANT]
====
If you set the `baselineCapabilitySet` field to `None`, you must explicitly enable the Ingress Capability, because the installation of a cluster fails if the Ingress Capability is disabled.
====
endif::cluster-caps[]
The Ingress Operator configures and manages the {product-title} router.
[discrete]
== Project
link:https://github.com/openshift/cluster-ingress-operator[openshift-ingress-operator]
[discrete]
== CRDs
* `clusteringresses.ingress.openshift.io`
** Scope: Namespaced
** CR: `clusteringresses`
** Validation: No
[discrete]
== Configuration objects
* Cluster config
** Type Name: `clusteringresses.ingress.openshift.io`
** Instance Name: `default`
** View Command:
+
[source,terminal]
----
$ oc get clusteringresses.ingress.openshift.io -n openshift-ingress-operator default -o yaml
----
[discrete]
== Notes
The Ingress Operator sets up the router in the `openshift-ingress` project and creates the deployment for the router:
[source,terminal]
----
$ oc get deployment -n openshift-ingress
----
The Ingress Operator uses the `clusterNetwork[].cidr` from the `network/cluster` status to determine what mode (IPv4, IPv6, or dual stack) the managed Ingress Controller (router) should operate in. For example, if `clusterNetwork` contains only a v6 `cidr`, then the Ingress Controller operates in IPv6-only mode.
In the following example, Ingress Controllers managed by the Ingress Operator will run in IPv4-only mode because only one cluster network exists and the network is an IPv4 `cidr`:
[source,terminal]
----
$ oc get network/cluster -o jsonpath='{.status.clusterNetwork[*]}'
----
.Example output
[source,terminal]
----
map[cidr:10.128.0.0/14 hostPrefix:23]
----
ifeval::["{context}" == "operator-reference"]
:!operator-ref:
endif::[]
ifeval::["{context}" == "cluster-caps"]
:!cluster-caps:
endif::[]