ingress: document ignore label

Documents how to ignore an ingress resource. Part of openservicemesh/osm#3582 Signed-off-by: Shashank Ram <[email protected]>
shashankram · Jun 18, 2021 · 5eb0a7e · 5eb0a7e
1 parent 2943f4b
commit 5eb0a7e
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/content/docs/tasks/traffic_management/ingress.md b/content/docs/tasks/traffic_management/ingress.md
@@ -83,6 +83,21 @@ Patch the MeshConfig by setting useHTTPSIngress:false.
 kubectl patch meshconfig osm-mesh-config -n osm-system -p '{"spec":{"traffic":{"useHTTPSIngress":false}}}'  --type=merge
 ```
 
+### Ignoring an ingress resource
+
+When an ingress resource is applied in a namespace that is monitored by OSM, OSM control plane will process the resource and configure the corresponding backends specified in the ingress resource based on the ingress rules. In some scenarios, it may be required to inform the OSM control plane to ignore certain ingress resources, such as when an ingress resource is only meant to program an ingress controller and not an application backend managed by OSM. An ingress resource can be ignored using the `openservicemesh.io/ignore` label.
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: httpbin-ingress
+  namespace: httpbin
+  labels:
+    openservicemesh.io/ignore: true
+```
+> Note: The value applied to this label does not matter.
+
 ## How it works
 
 ### Exposing an HTTP or HTTPS service using Ingress