Skip to content

Commit 0ce1672

Browse files
author
Daniel Chadwick
committed
ocpbugs18537 Documenting ingressWithoutClassName alert
1 parent 24b1e68 commit 0ce1672

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

_topic_maps/_topic_map.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1655,6 +1655,9 @@ Topics:
16551655
- Name: Configuring ingress cluster traffic using load balancer allowed source ranges
16561656
File: configuring-ingress-cluster-traffic-load-balancer-allowed-source-ranges
16571657
Distros: openshift-enterprise,openshift-origin
1658+
- Name: Patching existing ingress objects
1659+
File: configuring-ingress-cluster-patch-fields
1660+
Distros: openshift-enterprise,openshift-origin
16581661
# Kubernetes NMState (TECHNOLOGY PREVIEW)
16591662
- Name: Kubernetes NMState
16601663
Dir: k8s_nmstate

modules/nw-patch-fields-example.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-patch-fields.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="nw-patch-fields-example_{context}"]
7+
= Patching Ingress objects to resolve an ingressWithoutClassName alert
8+
9+
The `ingressClassName` field specifies the name of the `IngressClass` object. You must define the `ingressClassName` field for each `Ingress` object.
10+
11+
If you have not defined the `ingressClassName` field for an `Ingress` object, you could experience routing issues. After 24 hours, you will receive an `ingressWithoutClassName` alert to remind you to set the `ingressClassName` field.
12+
13+
.Procedure
14+
15+
Patch the `Ingress` objects with a completed `ingressClassName` field to ensure proper routing and functionality.
16+
17+
. List all `IngressClass` objects:
18+
+
19+
[source,terminal]
20+
----
21+
$ oc get ingressclass
22+
----
23+
24+
. List all `Ingress` objects in all namespaces:
25+
+
26+
[source,terminal]
27+
----
28+
$ oc get ingress -A
29+
----
30+
31+
. Patch the `Ingress` object:
32+
+
33+
[source,terminal]
34+
----
35+
$ oc patch ingress/<ingress_name> --type=merge --patch '{"spec":{"ingressClassName":"openshift-default"}}'
36+
----
37+
+
38+
Replace `<ingress_name>` with the name of the `Ingress` object. This command patches the `Ingress` object to include the desired ingress class name.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="configuring-ingress-cluster-patch-fields"]
3+
= Patching existing ingress objects
4+
include::_attributes/common-attributes.adoc[]
5+
:context: configuring-ingress-cluster-patch-fields
6+
7+
toc::[]
8+
9+
You can update or modify the following fields of existing `Ingress` objects without recreating the objects or disrupting services to them:
10+
11+
* Specifications
12+
* Host
13+
* Path
14+
* Backend services
15+
* SSL/TLS settings
16+
* Annotations
17+
18+
// Example: Patching ingress objects with an ingressClassName
19+
include::modules/nw-patch-fields-example.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)