Skip to content

Commit 6f21301

Browse files
authored
Merge pull request #60520 from ShaunaDiaz/OSDOCS-5762
OSDOCS-5762: clarify firewalld use language
2 parents 284459c + 1136984 commit 6f21301

File tree

5 files changed

+56
-30
lines changed

5 files changed

+56
-30
lines changed

microshift_networking/microshift-firewall.adoc

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

99
Firewalls are not required in {product-title}, but using a firewall can prevent undesired access to the {product-title} API.
1010

11-
include::modules/microshift-firewall-config.adoc[leveloffset=+1]
11+
include::modules/microshift-firewall-about.adoc[leveloffset=+1]
12+
13+
[role="_additional-resources"]
14+
[id="additional-resources"]
15+
.Additional resources
16+
17+
* xref:../microshift_networking/microshift-firewall.adoc#microshift-firewall-req-settings_microshift-firewall[Required firewall settings]
18+
* xref:..//microshift_networking/microshift-firewall.adoc#microshift-firewall-allow-traffic_microshift-firewall[Allowing network traffic through the firewall]
19+
1220
include::modules/microshift-firewalld-install.adoc[leveloffset=+1]
1321
include::modules/microshift-firewall-req-settings.adoc[leveloffset=+1]
1422
include::modules/microshift-firewall-opt-settings.adoc[leveloffset=+1]
1523
include::modules/microshift-firewall-allow-traffic.adoc[leveloffset=+1]
1624
include::modules/microshift-firewall-apply-settings.adoc[leveloffset=+1]
1725
include::modules/microshift-firewall-verify-settings.adoc[leveloffset=+1]
18-
include::modules/microshift-firewall-known-issue.adoc[leveloffset=+1]
26+
27+
[role="_additional-resources"]
28+
[id="additional-resources_microshift-using-a-firewall"]
29+
.Additional resources
30+
31+
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_firewalls_and_packet_filters/using-and-configuring-firewalld_firewall-packet-filters[RHEL: Using and configuring firewalld]
32+
33+
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_firewalls_and_packet_filters/using-and-configuring-firewalld_firewall-packet-filters#viewing-the-current-status-and-settings-of-firewalld_using-and-configuring-firewalld[RHEL: Viewing the current status of firewalld]
34+
35+
include::modules/microshift-firewall-known-issue.adoc[leveloffset=+1]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift_networking/microshift-firewall.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="microshift-firewall-about_{context}"]
7+
= About network traffic through the firewall
8+
9+
Firewalld is a networking service that runs in the background and responds to connection requests, creating a dynamic customizable host-based firewall. If you are using {op-system-ostree-first} with {product-title}, firewalld should already be installed and you just need to configure it. Details are provided in procedures that follow. Overall, you must explicitly allow the following OVN-Kubernetes traffic when the `firewalld` service is running:
10+
11+
CNI pod to CNI pod::
12+
CNI pod to Host-Network pod
13+
Host-Network pod to Host-Network pod
14+
15+
CNI pod::
16+
The Kubernetes pod that uses the CNI network
17+
18+
Host-Network pod::
19+
The Kubernetes pod that uses host network
20+
You can configure the `firewalld` service by using the following procedures. In most cases, firewalld is part of {rhel} installations. If you do not have firewalld, you can install it with the simple procedure in this section.
21+
22+
[IMPORTANT]
23+
====
24+
{product-title} pods must have access to the internal CoreDNS component and API servers.
25+
====

modules/microshift-firewall-allow-traffic.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * microshift_networking/microshift-firewall.adoc
44

55
:_content-type: PROCEDURE
6-
[id="microshift-firewall-network-traffic_{context}"]
6+
[id="microshift-firewall-allow-traffic_{context}"]
77
= Allowing network traffic through the firewall
88

99
You can allow network traffic through the firewall by first configuring the IP address range with either default or custom values, and then allow internal traffic from pods through the network gateway by inserting the DNS server.

modules/microshift-firewall-config.adoc

Lines changed: 0 additions & 25 deletions
This file was deleted.

modules/microshift-firewalld-install.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,19 @@
66
[id="microshift-firewall-install_{context}"]
77
= Installing the firewalld service
88

9-
Use the following procedure to install and run the `firewalld` service for {product-title}.
9+
If you are using {op-system-ostree}, firewalld should be installed. To use the service, you can simply configure it. The following procedure can be used if you do not have firewalld, but want to use it.
10+
1011

1112
.Procedure
1213

13-
. To install the `firewalld` service, run the following command:
14+
. Optional: Check for firewalld on your system by running the following command:
15+
+
16+
[source,terminal]
17+
----
18+
$ rpm -q firewalld
19+
----
20+
21+
. If the `firewalld` service is not installed, run the following command:
1422
+
1523
[source,terminal]
1624
----
@@ -23,3 +31,4 @@ $ sudo dnf install -y firewalld
2331
----
2432
$ sudo systemctl enable firewalld --now
2533
----
34+

0 commit comments

Comments
 (0)