Skip to content

Commit 93aa8de

Browse files
committed
OSDOCS-11830 Split Networking content for ROSA with HCP
1 parent 3608559 commit 93aa8de

16 files changed

+142
-73
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -779,6 +779,80 @@ Topics:
779779
# - Name: Advanced OADP features and functionalities
780780
# File: oadp-advanced-topics
781781
---
782+
Name: Networking
783+
Dir: networking
784+
Distros: openshift-rosa-hcp
785+
Topics:
786+
- Name: About networking
787+
File: about-managed-networking
788+
- Name: Networking Operators
789+
Dir: networking_operators
790+
Distros: openshift-rosa-hcp
791+
Topics:
792+
- Name: AWS Load Balancer Operator
793+
File: aws-load-balancer-operator
794+
- Name: DNS Operator in Red Hat OpenShift Service on AWS
795+
File: dns-operator
796+
- Name: Ingress Operator in Red Hat OpenShift Service on AWS
797+
File: ingress-operator
798+
- Name: Ingress Node Firewall Operator in Red Hat OpenShift Service on AWS
799+
File: ingress-node-firewall-operator
800+
- Name: Network verification
801+
File: network-verification
802+
- Name: Configuring a cluster-wide proxy during installation
803+
File: configuring-cluster-wide-proxy
804+
- Name: CIDR range definitions
805+
File: cidr-range-definitions
806+
- Name: Network security
807+
Dir: network_security
808+
Distros: openshift-rosa-hcp
809+
Topics:
810+
- Name: Understanding network policy APIs
811+
File: network-policy-apis
812+
- Name: Admin network policy
813+
Dir: AdminNetworkPolicy
814+
Distros: openshift-rosa-hcp
815+
Topics:
816+
- Name: About AdminNetworkPolicy
817+
File: ovn-k-anp
818+
- Name: About BaselineAdminNetworkPolicy
819+
File: ovn-k-banp
820+
- Name: Network policy
821+
Dir: network_policy
822+
Distros: openshift-rosa-hcp
823+
Topics:
824+
- Name: About network policy
825+
File: about-network-policy
826+
- Name: Creating a network policy
827+
File: creating-network-policy
828+
- Name: Viewing a network policy
829+
File: viewing-network-policy
830+
- Name: Editing a network policy
831+
File: editing-network-policy
832+
- Name: Deleting a network policy
833+
File: deleting-network-policy
834+
- Name: Defining a default network policy for projects
835+
File: default-network-policy
836+
- Name: Configuring multitenant isolation with network policy
837+
File: multitenant-network-policy
838+
- Name: Configuring the primary cluster network
839+
Dir: ovn_kubernetes_network_provider
840+
Distros: openshift-rosa-hcp
841+
Topics:
842+
- Name: About the OVN-Kubernetes network plugin
843+
File: about-ovn-kubernetes
844+
- Name: Configuring an egress IP address
845+
File: configuring-egress-ips-ovn
846+
# OpenShift SDN not supported for HCP
847+
- Name: Configuring Routes
848+
Dir: routes
849+
Distros: openshift-rosa-hcp
850+
Topics:
851+
- Name: Route configuration
852+
File: route-configuration
853+
- Name: Secured routes
854+
File: secured-routes
855+
---
782856
Name: Nodes
783857
Dir: nodes
784858
Distros: openshift-rosa-hcp

modules/running-network-verification-manually-ocm.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ ROSA
3333
endif::openshift-rosa[]
3434
cluster.
3535
* You are the cluster owner or you have the cluster editor role.
36+
//TODO OSDOCS-11830 I am both of these things and I can't see anything related to this in OCM; is this only available after a specific version? upgrading test cluster to see if this appears for later cluster versions
3637
3738
.Procedure
3839

networking/about-managed-networking.adoc

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,28 @@ toc::[]
1010

1111
The following are some of the most commonly used {openshift-networking} features available on your cluster:
1212

13-
* Cluster Network Operator for network plugin management
14-
+
13+
* Cluster Network Operator for network plugin management.
14+
15+
ifdef::openshift-rosa-hcp[]
16+
* Primary cluster network provided by xref:../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#about-ovn-kubernetes[OVN-Kubernetes], the default Container Network Interface (CNI) plugin.
17+
endif::openshift-rosa-hcp[]
18+
19+
ifndef::openshift-rosa-hcp[]
1520
* Primary cluster network provided by either of the following Container Network Interface (CNI) plugins:
1621
+
1722
** xref:../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#about-ovn-kubernetes[OVN-Kubernetes network plugin], which is the default CNI plugin.
1823
** {OCP-short} SDN network plugin, which was deprecated in {OCP-short} 4.16 and removed in {OCP-short} 4.17.
1924

20-
ifdef::openshift-rosa[]
21-
22-
[IMPORTANT]
23-
====
24-
Before upgrading {rosa-classic} clusters that are configured with the OpenShift SDN network plugin to version 4.17, you must migrate to the OVN-Kubernetes network plugin. For more information, see _Migrating from the OpenShift SDN network plugin to the OVN-Kubernetes network plugin_ in the _Additional resources_ section.
25-
====
26-
endif::openshift-rosa[]
27-
28-
ifdef::openshift-dedicated[]
29-
25+
ifdef::openshift-rosa,openshift-dedicated[]
3026
[IMPORTANT]
3127
====
32-
Before upgrading {product-title} clusters that are configured with the OpenShift SDN network plugin to version 4.17, you must migrate to the OVN-Kubernetes network plugin. For more information, see _Migrating from the OpenShift SDN network plugin to the OVN-Kubernetes network plugin_ in the _Additional resources_ section.
28+
Before upgrading {rosa-classic} clusters that are configured with the OpenShift SDN network plugin to version 4.17, you must migrate to the OVN-Kubernetes network plugin. For more information, see _Migrating from the OpenShift SDN network plugin to the OVN-Kubernetes network plugin_.
3329
====
34-
endif::openshift-dedicated[]
35-
3630

3731
[discrete]
3832
[role="_additional-resources"]
3933
[id="additional-resources_{context}"]
4034
== Additional resources
41-
4235
* link:https://access.redhat.com/articles/7065170[{OCP-short} SDN CNI removal in OCP 4.17]
43-
ifdef::openshift-rosa[]
4436
* xref:../networking/ovn_kubernetes_network_provider/migrate-from-openshift-sdn.adoc#migrate-from-openshift-sdn[Migrating from the OpenShift SDN network plugin to the OVN-Kubernetes network plugin]
45-
endif::openshift-rosa[]
46-
47-
ifdef::openshift-dedicated[]
48-
49-
* xref:../networking/ovn_kubernetes_network_provider/migrate-from-openshift-sdn-osd.adoc#migrate-from-openshift-sdn-osd[Migrating from the OpenShift SDN network plugin to the OVN-Kubernetes network plugin]
50-
endif::openshift-dedicated[]
51-
37+
endif::openshift-rosa,openshift-dedicated[]

networking/network-verification.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ ifdef::openshift-rosa[]
4444
* Egress is available to the required domain and port combinations that are specified in the xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#osd-aws-privatelink-firewall-prerequisites_rosa-sts-aws-prereqs[AWS firewall prerequisites] section.
4545
endif::openshift-rosa[]
4646

47+
// TODO OSDOCS-11830 - should we be using the terms that get used in the AWS UI, e.g. "DNS resolution" and "DNS hostnames" options are enabled?
48+
4749
include::modules/automatic-network-verification-bypassing.adoc[leveloffset=+1]
4850
ifdef::openshift-dedicated[]
4951
include::modules/running-network-verification-manually-ocm.adoc[leveloffset=+1]
@@ -53,3 +55,7 @@ include::modules/running-network-verification-manually.adoc[leveloffset=+1]
5355
include::modules/running-network-verification-manually-ocm.adoc[leveloffset=+2]
5456
include::modules/running-network-verification-manually-cli.adoc[leveloffset=+2]
5557
endif::openshift-rosa[]
58+
ifdef::openshift-rosa-hcp[]
59+
//TODO OSDOCS-11830 I can't see the manual OCM verification at all so setting this up while I wait for cluster upgrades to work out if this only comes in after a certain version
60+
include::modules/running-network-verification-manually-cli.adoc[leveloffset=+1]
61+
endif::openshift-rosa-hcp[]

networking/network_security/network_policy/about-network-policy.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[id="about-network-policy"]
33
= About network policy
44
include::_attributes/common-attributes.adoc[]
5-
ifdef::openshift-dedicated,openshift-rosa[]
5+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
7-
endif::openshift-dedicated,openshift-rosa[]
7+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
88
:context: about-network-policy
99

1010
toc::[]
@@ -19,7 +19,7 @@ include::modules/nw-networkpolicy-optimize-ovn.adoc[leveloffset=+1]
1919
== Next steps
2020

2121
* xref:../../../networking/network_security/network_policy/creating-network-policy.adoc#creating-network-policy[Creating a network policy]
22-
ifndef::openshift-rosa,openshift-dedicated[]
22+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
2323
* Optional: xref:../../../networking/network_security/network_policy/default-network-policy.adoc#default-network-policy[Defining a default network policy for projects]
2424

2525
[role="_additional-resources"]

networking/network_security/network_policy/creating-network-policy.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[id="creating-network-policy"]
33
= Creating a network policy
44
include::_attributes/common-attributes.adoc[]
5-
ifdef::openshift-dedicated,openshift-rosa[]
5+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
7-
endif::openshift-dedicated,openshift-rosa[]
7+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
88
:context: creating-network-policy
99

1010
toc::[]
@@ -23,11 +23,11 @@ include::modules/nw-networkpolicy-allow-application-all-namespaces.adoc[leveloff
2323

2424
include::modules/nw-networkpolicy-allow-application-particular-namespace.adoc[leveloffset=+1]
2525

26-
ifdef::openshift-rosa,openshift-dedicated[]
26+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
2727
include::modules/nw-networkpolicy-create-ocm.adoc[leveloffset=+1]
2828
endif::[]
2929

30-
ifndef::openshift-rosa,openshift-dedicated[]
30+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
3131
[role="_additional-resources"]
3232
== Additional resources
3333

networking/network_security/network_policy/deleting-network-policy.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
[id="deleting-network-policy"]
33
= Deleting a network policy
44
include::_attributes/common-attributes.adoc[]
5-
ifdef::openshift-dedicated,openshift-rosa[]
5+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
7-
endif::openshift-dedicated,openshift-rosa[]
7+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
88
:context: deleting-network-policy
99

1010
toc::[]
1111

1212
As a user with the `admin` role, you can delete a network policy from a namespace.
1313

1414
include::modules/nw-networkpolicy-delete-cli.adoc[leveloffset=+1]
15-
ifdef::openshift-dedicated,openshift-rosa[]
15+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1616
include::modules/nw-networkpolicy-delete-ocm.adoc[leveloffset=+1]
1717
endif::[]

networking/network_security/network_policy/multitenant-network-policy.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[id="multitenant-network-policy"]
33
= Configuring multitenant isolation with network policy
44
include::_attributes/common-attributes.adoc[]
5-
ifdef::openshift-dedicated,openshift-rosa[]
5+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
7-
endif::openshift-dedicated,openshift-rosa[]
7+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
88
:context: multitenant-network-policy
99

1010
toc::[]
@@ -18,7 +18,7 @@ Configuring network policies as described in this section provides network isola
1818

1919
include::modules/nw-networkpolicy-multitenant-isolation.adoc[leveloffset=+1]
2020

21-
ifndef::openshift-rosa,openshift-dedicated[]
21+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
2222
[id="multitenant-network-policy-next-steps"]
2323
== Next steps
2424

networking/network_security/network_policy/viewing-network-policy.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[id="viewing-network-policy"]
33
= Viewing a network policy
44
include::_attributes/common-attributes.adoc[]
5-
ifdef::openshift-dedicated,openshift-rosa[]
5+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
7-
endif::openshift-dedicated,openshift-rosa[]
7+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
88
:context: viewing-network-policy
99

1010
toc::[]
@@ -15,6 +15,6 @@ include::modules/nw-networkpolicy-object.adoc[leveloffset=+1]
1515

1616
include::modules/nw-networkpolicy-view-cli.adoc[leveloffset=+1]
1717

18-
ifdef::openshift-dedicated,openshift-rosa[]
18+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1919
include::modules/nw-networkpolicy-view-ocm.adoc[leveloffset=+1]
2020
endif::[]

networking/networking_operators/dns-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ toc::[]
88

99
In {product-title}, the DNS Operator deploys and manages a CoreDNS instance to provide a name resolution service to pods inside the cluster, enables DNS-based Kubernetes Service discovery, and resolves internal `cluster.local` names.
1010

11-
ifndef::openshift-rosa,openshift-osd[]
11+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-osd[]
1212
include::modules/nw-dns-operator.adoc[leveloffset=+1]
1313

1414
include::modules/nw-dns-view.adoc[leveloffset=+1]
1515
endif::[]
1616

1717
include::modules/nw-dns-forward.adoc[leveloffset=+1]
1818

19-
ifndef::openshift-rosa,openshift-osd[]
19+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-osd[]
2020
include::modules/nw-dns-operator-status.adoc[leveloffset=+1]
2121

2222
include::modules/nw-dns-operator-logs.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)