From 5aa3d33e51360f3484dfc47a458c10f7981951e2 Mon Sep 17 00:00:00 2001 From: Jason Boxman Date: Fri, 9 Oct 2020 13:54:24 -0400 Subject: [PATCH] Sync egress firewall filename IDs --- _topic_map.yml | 8 +-- modules/nw-egressnetworkpolicy-about.adoc | 4 +- modules/nw-egressnetworkpolicy-create.adoc | 4 +- modules/nw-egressnetworkpolicy-delete.adoc | 4 +- modules/nw-egressnetworkpolicy-edit.adoc | 4 +- modules/nw-egressnetworkpolicy-object.adoc | 4 +- modules/nw-egressnetworkpolicy-view.adoc | 57 +++++++++++++++---- ...c => configuring-egress-firewall-ovn.adoc} | 4 +- ....adoc => editing-egress-firewall-ovn.adoc} | 4 +- ...adoc => removing-egress-firewall-ovn.adoc} | 4 +- ....adoc => viewing-egress-firewall-ovn.adoc} | 4 +- 11 files changed, 67 insertions(+), 34 deletions(-) rename networking/ovn_kubernetes_network_provider/{configuring-egress-firewall.adoc => configuring-egress-firewall-ovn.adoc} (84%) rename networking/ovn_kubernetes_network_provider/{editing-egress-firewall.adoc => editing-egress-firewall-ovn.adoc} (78%) rename networking/ovn_kubernetes_network_provider/{removing-egress-firewall.adoc => removing-egress-firewall-ovn.adoc} (82%) rename networking/ovn_kubernetes_network_provider/{viewing-egress-firewall.adoc => viewing-egress-firewall-ovn.adoc} (80%) diff --git a/_topic_map.yml b/_topic_map.yml index 7ddc76af73..f89260492c 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -647,13 +647,13 @@ Topics: - Name: Rollback to the OpenShift SDN default CNI network provider File: rollback-to-openshift-sdn - Name: Configuring an egress firewall for a project - File: configuring-egress-firewall + File: configuring-egress-firewall-ovn - Name: Viewing an egress firewall for a project - File: viewing-egress-firewall + File: viewing-egress-firewall-ovn - Name: Editing an egress firewall for a project - File: editing-egress-firewall + File: editing-egress-firewall-ovn - Name: Removing an egress firewall from a project - File: removing-egress-firewall + File: removing-egress-firewall-ovn - Name: Enabling multicast for a project File: enabling-multicast Distros: openshift-origin,openshift-enterprise,openshift-webscale diff --git a/modules/nw-egressnetworkpolicy-about.adoc b/modules/nw-egressnetworkpolicy-about.adoc index 14f6b93a45..cef6d88fe1 100644 --- a/modules/nw-egressnetworkpolicy-about.adoc +++ b/modules/nw-egressnetworkpolicy-about.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // // * networking/openshift_sdn/configuring-egress-firewall.adoc -// * networking/ovn_kubernetes_network_provider/configuring-egress-firewall.adoc +// * networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc -ifeval::["{context}" == "ovn-configuring-egress-firewall"] +ifeval::["{context}" == "configuring-egress-firewall-ovn"] :ovn: :kind: EgressFirewall endif::[] diff --git a/modules/nw-egressnetworkpolicy-create.adoc b/modules/nw-egressnetworkpolicy-create.adoc index 5b158a04d6..9d787fae9c 100644 --- a/modules/nw-egressnetworkpolicy-create.adoc +++ b/modules/nw-egressnetworkpolicy-create.adoc @@ -1,14 +1,14 @@ // Module included in the following assemblies: // // * networking/openshift_sdn/configuring-egress-firewall.adoc -// * networking/ovn_kubernetes_network_provider/configuring-egress-firewall.adoc +// * networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc ifeval::["{context}" == "openshift-sdn-egress-firewall"] :kind: EgressNetworkPolicy :obj: egressnetworkpolicy.network.openshift.io/v1 :cni: OpenShift SDN endif::[] -ifeval::["{context}" == "ovn-configuring-egress-firewall"] +ifeval::["{context}" == "configuring-egress-firewall-ovn"] :kind: EgressFirewall :obj: egressfirewall.k8s.ovn.org/v1 :cni: OVN-Kubernetes diff --git a/modules/nw-egressnetworkpolicy-delete.adoc b/modules/nw-egressnetworkpolicy-delete.adoc index 6d0f85c1ee..817efa5599 100644 --- a/modules/nw-egressnetworkpolicy-delete.adoc +++ b/modules/nw-egressnetworkpolicy-delete.adoc @@ -1,14 +1,14 @@ // Module included in the following assemblies: // // * networking/openshift-sdn/removing-egress-firewall.adoc -// * networking/ovn_kubernetes_network_provider/removing-egress-firewall.adoc +// * networking/ovn_kubernetes_network_provider/removing-egress-firewall-ovn.adoc ifeval::["{context}" == "openshift-sdn-egress-firewall"] :kind: EgressNetworkPolicy :res: egressnetworkpolicy :cni: OpenShift SDN endif::[] -ifeval::["{context}" == "ovn-removing-egress-firewall"] +ifeval::["{context}" == "removing-egress-firewall-ovn"] :kind: EgressFirewall :res: egressfirewall :cni: OVN-Kubernetes diff --git a/modules/nw-egressnetworkpolicy-edit.adoc b/modules/nw-egressnetworkpolicy-edit.adoc index 4f33400185..c3ed797f13 100644 --- a/modules/nw-egressnetworkpolicy-edit.adoc +++ b/modules/nw-egressnetworkpolicy-edit.adoc @@ -1,14 +1,14 @@ // Module included in the following assemblies: // // * networking/openshift_sdn/editing-egress-firewall.adoc -// * networking/ovn_kubernetes_network_provider/editing-egress-firewall.adoc +// * networking/ovn_kubernetes_network_provider/editing-egress-firewall-ovn.adoc ifeval::["{context}" == "openshift-sdn-egress-firewall"] :kind: EgressNetworkPolicy :res: egressnetworkpolicy :cni: OpenShift SDN endif::[] -ifeval::["{context}" == "ovn-editing-egress-firewall"] +ifeval::["{context}" == "editing-egress-firewall-ovn"] :kind: EgressFirewall :res: egressfirewall :cni: OVN-Kubernetes diff --git a/modules/nw-egressnetworkpolicy-object.adoc b/modules/nw-egressnetworkpolicy-object.adoc index d37c703fe4..3a63f832ea 100644 --- a/modules/nw-egressnetworkpolicy-object.adoc +++ b/modules/nw-egressnetworkpolicy-object.adoc @@ -1,14 +1,14 @@ // Module included in the following assemblies: // // * networking/openshift_sdn/configuring-egress-firewall.adoc -// * networking/ovn_kubernetes_network_provider/configuring-egress-firewall.adoc +// * networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc ifeval::["{context}" == "openshift-sdn-egress-firewall"] :kind: EgressNetworkPolicy :api: network.openshift.io/v1 :openshift-sdn: endif::[] -ifeval::["{context}" == "ovn-configuring-egress-firewall"] +ifeval::["{context}" == "configuring-egress-firewall-ovn"] :kind: EgressFirewall :api: k8s.ovn.org/v1 :ovn: diff --git a/modules/nw-egressnetworkpolicy-view.adoc b/modules/nw-egressnetworkpolicy-view.adoc index bcb7b1cc95..afe86149e9 100644 --- a/modules/nw-egressnetworkpolicy-view.adoc +++ b/modules/nw-egressnetworkpolicy-view.adoc @@ -1,33 +1,66 @@ // Module included in the following assemblies: // -// networking/openshift-sdn/configuring-egressnetworkpolicy.adoc +// * networking/openshift_sdn/configuring-egress-firewall.adoc +// * networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc + +ifeval::["{context}" == "openshift-sdn-viewing-egress-firewall"] +:kind: EgressNetworkPolicy +:res: egressnetworkpolicy +:cni: OpenShift SDN +endif::[] +ifeval::["{context}" == "viewing-egress-firewall-ovn"] +:kind: EgressFirewall +:res: egressfirewall +:cni: OVN-Kubernetes +endif::[] [id="nw-egressnetworkpolicy-view_{context}"] += Viewing an {kind} object -= Viewing NetworkPolicy objects - -You can list the EgressNetworkPolicy objects in your cluster. +You can view an {kind} object in your cluster. .Prerequisites -* A cluster using the OpenShift SDN network plug-in. -* Install the OpenShift CLI (`oc`). +* A cluster using the {cni} default Container Network Interface (CNI) network provider plug-in. +* Install the OpenShift Command-line Interface (CLI), commonly known as `oc`. * You must log in to the cluster. .Procedure -* To view the names of the EgressNetworkPolicy objects defined in your cluster, +. Optional: To view the names of the {kind} objects defined in your cluster, enter the following command: + +[source,terminal,subs="attributes"] ---- -$ oc get egressnetworkpolicy -o go-template='{{range .items}}{{.metadata.name}}{{end}}' +$ oc get {res} --all-namespaces ---- -* Optional: You can inspect a specific policy object by entering the following -command: +. To inspect a policy, enter the following command. Replace `` with the name of the policy to inspect. + +[source,terminal,subs="attributes+"] ---- -$ oc get egressnetworkpolicy -o yaml +$ oc describe {res} ---- + -Replace `` with the name of the policy to inspect. +[source,terminal] +.Example output +---- +Name: default +Namespace: project1 +Created: 20 minutes ago +Labels: +Annotations: +Rule: Allow to 1.2.3.0/24 +Rule: Allow to www.example.com +Rule: Deny to 0.0.0.0/0 +---- + +ifdef::kind[] +:!kind: +endif::[] +ifdef::res[] +:!res: +endif::[] +ifdef::cni[] +:!cni: +endif::[] diff --git a/networking/ovn_kubernetes_network_provider/configuring-egress-firewall.adoc b/networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc similarity index 84% rename from networking/ovn_kubernetes_network_provider/configuring-egress-firewall.adoc rename to networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc index 6595989b40..3d6a936e99 100644 --- a/networking/ovn_kubernetes_network_provider/configuring-egress-firewall.adoc +++ b/networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc @@ -1,7 +1,7 @@ -[id="ovn-configuring-egress-firewall"] +[id="configuring-egress-firewall-ovn"] = Configuring an egress firewall for a project include::modules/common-attributes.adoc[] -:context: ovn-configuring-egress-firewall +:context: configuring-egress-firewall-ovn toc::[] diff --git a/networking/ovn_kubernetes_network_provider/editing-egress-firewall.adoc b/networking/ovn_kubernetes_network_provider/editing-egress-firewall-ovn.adoc similarity index 78% rename from networking/ovn_kubernetes_network_provider/editing-egress-firewall.adoc rename to networking/ovn_kubernetes_network_provider/editing-egress-firewall-ovn.adoc index ba7f4a984c..604a8244b9 100644 --- a/networking/ovn_kubernetes_network_provider/editing-egress-firewall.adoc +++ b/networking/ovn_kubernetes_network_provider/editing-egress-firewall-ovn.adoc @@ -1,7 +1,7 @@ -[id="ovn-editing-egress-firewall"] +[id="editing-egress-firewall-ovn"] = Editing an egress firewall for a project include::modules/common-attributes.adoc[] -:context: ovn-editing-egress-firewall +:context: editing-egress-firewall-ovn toc::[] diff --git a/networking/ovn_kubernetes_network_provider/removing-egress-firewall.adoc b/networking/ovn_kubernetes_network_provider/removing-egress-firewall-ovn.adoc similarity index 82% rename from networking/ovn_kubernetes_network_provider/removing-egress-firewall.adoc rename to networking/ovn_kubernetes_network_provider/removing-egress-firewall-ovn.adoc index cd27dd4f41..4278f5bce4 100644 --- a/networking/ovn_kubernetes_network_provider/removing-egress-firewall.adoc +++ b/networking/ovn_kubernetes_network_provider/removing-egress-firewall-ovn.adoc @@ -1,7 +1,7 @@ -[id="ovn-removing-egress-firewall"] +[id="removing-egress-firewall-ovn"] = Removing an egress firewall from a project include::modules/common-attributes.adoc[] -:context: ovn-removing-egress-firewall +:context: removing-egress-firewall-ovn toc::[] diff --git a/networking/ovn_kubernetes_network_provider/viewing-egress-firewall.adoc b/networking/ovn_kubernetes_network_provider/viewing-egress-firewall-ovn.adoc similarity index 80% rename from networking/ovn_kubernetes_network_provider/viewing-egress-firewall.adoc rename to networking/ovn_kubernetes_network_provider/viewing-egress-firewall-ovn.adoc index 0242f3a2ca..0d4cf54cd4 100644 --- a/networking/ovn_kubernetes_network_provider/viewing-egress-firewall.adoc +++ b/networking/ovn_kubernetes_network_provider/viewing-egress-firewall-ovn.adoc @@ -1,7 +1,7 @@ -[id="ovn-viewing-egress-firewall"] +[id="viewing-egress-firewall-ovn"] = Viewing an egress firewall for a project include::modules/common-attributes.adoc[] -:context: ovn-viewing-egress-firewall +:context: viewing-egress-firewall-ovn toc::[]