Skip to content

Commit 3b05b26

Browse files
authored
Merge pull request #60887 from bmcelvee/OSDOCS-4883-new
OSDOCS-4883: Document OSD/ROSA managed Ingress improvements
2 parents 8adf5c3 + fc297e0 commit 3b05b26

10 files changed

+837
-7
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
:pipelines-title: Red Hat OpenShift Pipelines
2323
:logging-sd: Red Hat OpenShift Logging
2424
:ServerlessProductName: OpenShift Serverless
25+
:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
26+
:rh-openstack: RHOSP
2527
:rhoda: Red Hat OpenShift Database Access
2628
:rhoda-short: RHODA
2729
:rhods: Red Hat OpenShift Data Science

applications/deployments/osd-config-custom-domains-applications.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
66

77
toc::[]
88

9-
You can configure a custom domain for your applications. Custom domains are specific wildcard domains that can be used with {product-title} applications.
9+
[NOTE]
10+
====
11+
Starting with {product-title} 4.14, the Custom Domain Operator is deprecated. To manage Ingress in {product-title} 4.14, use the Ingress Operator. The functionality is unchanged for {product-title} 4.13 and earlier versions.
12+
====
13+
14+
You can configure a custom domain for your applications. Custom domains are specific wildcard domains that can be used with {product-title} applications.
1015

1116
include::modules/osd-applications-config-custom-domains.adoc[leveloffset=+1]
1217
include::modules/osd-applications-renew-custom-domains.adoc[leveloffset=+1]

modules/nw-ingress-controller-configuration-parameters.adoc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,31 @@ If empty, the default value is `ingress.config.openshift.io/cluster` `.spec.doma
3131
|`endpointPublishingStrategy`
3232
|`endpointPublishingStrategy` is used to publish the Ingress Controller endpoints to other networks, enable load balancer integrations, and provide access to other systems.
3333

34+
ifndef::openshift-rosa,openshift-dedicated[]
3435
On GCP, AWS, and Azure you can configure the following `endpointPublishingStrategy` fields:
36+
endif::openshift-rosa,openshift-dedicated[]
37+
38+
ifdef::openshift-rosa,openshift-dedicated[]
39+
You can configure the following `endpointPublishingStrategy` fields:
40+
endif::openshift-rosa,openshift-dedicated[]
3541

3642
* `loadBalancer.scope`
3743
* `loadBalancer.allowedSourceRanges`
3844
3945
If not set, the default value is based on `infrastructure.config.openshift.io/cluster` `.status.platform`:
4046

47+
ifdef::openshift-rosa,openshift-dedicated[]
4148
* Amazon Web Services (AWS): `LoadBalancerService` (with External scope)
49+
endif::openshift-rosa,openshift-dedicated[]
50+
ifdef::openshift-dedicated[]
51+
* Google Cloud Platform (GCP): `LoadBalancerService` (with External scope)
52+
endif::openshift-dedicated[]
53+
ifndef::openshift-rosa,openshift-dedicated[]
4254
* Azure: `LoadBalancerService` (with External scope)
4355
* Google Cloud Platform (GCP): `LoadBalancerService` (with External scope)
4456
* Bare metal: `NodePortService`
4557
* Other: `HostNetwork`
58+
endif::openshift-rosa,openshift-dedicated[]
4659
+
4760
[NOTE]
4861
====
@@ -74,13 +87,14 @@ On {rh-openstack-first}, the `LoadBalancerService` endpoint publishing strategy
7487

7588
For more information, see the "Setting cloud provider options" section of the {rh-openstack} installation documentation.
7689
====
77-
90+
ifndef::openshift-rosa[]
7891
For most platforms, the `endpointPublishingStrategy` value can be updated. On GCP, you can configure the following `endpointPublishingStrategy` fields:
7992

8093
* `loadBalancer.scope`
8194
* `loadbalancer.providerParameters.gcp.clientAccess`
8295
* `hostNetwork.protocol`
8396
* `nodePort.protocol`
97+
endif::openshift-rosa[]
8498
8599
|`defaultCertificate`
86100
|The `defaultCertificate` value is a reference to a secret that contains the default certificate that is served by the Ingress Controller. When Routes do not specify their own certificate, `defaultCertificate` is used.

modules/nw-ingress-default-internal.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88

99
You can configure the `default` Ingress Controller for your cluster to be internal by deleting and recreating it.
1010

11+
ifndef::openshift-rosa,openshift-dedicated[]
1112
[WARNING]
1213
====
1314
If your cloud provider is Microsoft Azure, you must have at least one public load balancer that points to your nodes.
1415
If you do not, all of your nodes will lose egress connectivity to the internet.
1516
====
17+
endif::openshift-rosa,openshift-dedicated[]
1618

1719
[IMPORTANT]
1820
====

modules/nw-ingress-setting-internal-lb.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@
99
When creating an Ingress Controller on cloud platforms, the Ingress Controller is published by a public cloud load balancer by default.
1010
As an administrator, you can create an Ingress Controller that uses an internal cloud load balancer.
1111

12+
ifndef::openshift-rosa,openshift-dedicated[]
1213
[WARNING]
1314
====
1415
If your cloud provider is Microsoft Azure, you must have at least one public load balancer that points to your nodes.
1516
If you do not, all of your nodes will lose egress connectivity to the internet.
1617
====
18+
endif::openshift-rosa,openshift-dedicated[]
1719

1820
[IMPORTANT]
1921
====

modules/rosa-edit-objects.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,32 @@ $ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
8585
|--cluster
8686
|Required: The name or ID (string) of the cluster to which the ingress will be added.
8787

88+
|--cluster-routes-hostname
89+
|Components route hostname for OAuth, console, and download.
90+
91+
|--cluster-routes-tls-secret-ref
92+
|Components route TLS secret reference for OAuth, console, and download.
93+
94+
|--excluded-namespaces
95+
|Excluded namespaces for ingress. Format is a comma-separated list `value1, value2...`. If no values are specified, all namespaces will be exposed.
96+
8897
|--label-match
8998
|The label match (string) for ingress. The format must be a comma-delimited list of key=value pairs. If no label is specified, all routes are exposed on both routers.
9099

100+
|--lb-type
101+
|Type of Load Balancer. Options are `classic`, `nlb`.
102+
103+
|--namespace-ownership-policy
104+
|Namespace Ownership Policy for ingress. Options are `Strict` and `InterNamespaceAllowed`. Default is `Strict`.
105+
91106
|--private
92107
|Restricts the application route to direct, private connectivity.
108+
109+
|--route-selector
110+
|Route Selector for ingress. Format is a comma-separated list of key=value. If no label is specified, all routes will be exposed on both routers. For legacy ingress support these are inclusion labels, otherwise they are treated as exclusion label.
111+
112+
|--wildcard-policy
113+
|Wildcard Policy for ingress. Options are `WildcardsDisallowed` and `WildcardsAllowed`. Default is `WildcardsDisallowed`.
93114
|===
94115

95116
.Optional arguments inherited from parent commands
@@ -113,6 +134,7 @@ $ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
113134
.Examples
114135

115136
Make an additional ingress with the ID `a1b2` as a private connection on a cluster named `mycluster`.
137+
116138
[source,terminal]
117139
----
118140
$ rosa edit ingress --private --cluster=mycluster a1b2
@@ -132,6 +154,13 @@ Update the default ingress using the sub-domain identifier `apps` on a cluster n
132154
$ rosa edit ingress --private=false --cluster=mycluster apps
133155
----
134156

157+
Update the load balancer type of the `apps2` ingress.
158+
159+
[source,terminal]
160+
----
161+
$ rosa edit ingress --lb-type=nlb --cluster=mycluster apps2
162+
----
163+
135164
[id="rosa-edit-machinepool_{context}"]
136165
== edit machinepool
137166

0 commit comments

Comments
 (0)