Skip to content

Commit 7059182

Browse files
authored
Merge pull request #41402 from JStickler/OSSMDOC-472
OSSMDOC-472: Make NetworkPolicy optional.
2 parents d424f37 + 080dd1c commit 7059182

File tree

4 files changed

+29
-11
lines changed

4 files changed

+29
-11
lines changed

modules/ossm-auto-route-enable.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// Module is included in the following assemblies:
22
// * service_mesh/v2x/ossm-traffic-manage.adoc
33
//
4-
4+
:_content-type: REFERENCE
55
[id="ossm-auto-route-enable_{context}"]
6-
= Disabling automatic {ProductName} route creation
6+
= Disabling automatic creation of routes
77

88
By default, the `ServiceMeshControlPlane` resource automatically synchronizes the Gateway resources with OpenShift routes. Disabling the automatic route creation allows you more flexibility to control routes if you have a special case or prefer to control routes manually.
99

modules/ossm-config-disable-networkpolicy.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
////
22
This module included in the following assemblies:
3-
-v2x/servicemesh-release-notes.adoc
3+
-service_mesh/v2x/ossm-traffic-manage.adoc
44
////
5-
5+
:_content-type: PROCEDURE
66
[id="ossm-config-disable-networkpolicy_{context}"]
7-
= Disabling network policies
8-
9-
{ProductName} automatically creates and manages a number of `NetworkPolicies` resources in the control plane and application namespaces. This is to ensure that applications and the control plane can communicate with each other.
7+
= Disabling automatic creation of network policies
108

11-
If you want to disable the automatic creation and management of `NetworkPolicies` resources, for example to enforce company security policies, you can do so. You can edit the `ServiceMeshControlPlane` to set the `spec.security.manageNetworkPolicy` setting to `false`
9+
If you want to disable the automatic creation and management of `NetworkPolicy` resources, for example to enforce company security policies, or to allow direct access to pods in the mesh, you can do so. You can edit the `ServiceMeshControlPlane` and set `spec.security.manageNetworkPolicy` to `false`.
1210

1311
[NOTE]
1412
====
1513
When you disable `spec.security.manageNetworkPolicy` {ProductName} will not create *any* `NetworkPolicy` objects. The system administrator is responsible for managing the network and fixing any issues this might cause.
1614
====
1715

16+
.Prerequisites
17+
18+
* {ProductName} Operator version 2.1.1 or higher installed.
19+
* `ServiceMeshControlPlane` resource updated to version 2.1 or higher.
20+
1821
.Procedure
1922

2023
. In the {product-title} web console, click *Operators* -> *Installed Operators*.
2124

22-
. Select the project where you installed the control plane, for example `istio-system`, from the Project menu.
25+
. Select the project where you installed the control plane, for example `istio-system`, from the *Project* menu.
2326

2427
. Click the {ProductName} Operator. In the *Istio Service Mesh Control Plane* column, click the name of your `ServiceMeshControlPlane`, for example `basic-install`.
2528

@@ -33,7 +36,6 @@ apiVersion: maistra.io/v2
3336
kind: ServiceMeshControlPlane
3437
spec:
3538
security:
36-
trust:
3739
manageNetworkPolicy: false
3840
----
3941
+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
////
2+
This module included in the following assemblies:
3+
-service_mesh/v2x/ossm-traffic-manage.adoc
4+
////
5+
:_content-type: CONCEPT
6+
[id="ossm-understanding-networkpolicy_{context}"]
7+
= Understanding network policies
8+
9+
{ProductName} automatically creates and manages a number of `NetworkPolicies` resources in the control plane and application namespaces. This is to ensure that applications and the control plane can communicate with each other.
10+
11+
For example, if you have configured your {product-title} cluster to use the SDN plug-in, {ProductName} creates a `NetworkPolicy` resource in each member project. This enables ingress to all pods in the mesh from the other mesh members and the control plane. This also restricts ingress to only member projects. If you require ingress from non-member projects, you need to create a `NetworkPolicy` to allow that traffic through. If you remove a namespace from {ProductShortName}, this `NetworkPolicy` resource is deleted from the project.

service_mesh/v2x/ossm-traffic-manage.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,13 @@ OpenShift routes for Istio Gateways are automatically managed in {ProductShortNa
3535
{ProductName} creates the route with the subdomain, but {product-title} must be configured to enable it. Subdomains, for example `*.domain.com`, are supported but not by default. Configure an {product-title} wildcard policy before configuring a wildcard host Gateway. For more information, see xref:../../networking/ingress-operator.adoc#using-wildcard-routes_configuring-ingress[Using wildcard routes].
3636

3737
include::modules/ossm-auto-route.adoc[leveloffset=+2]
38+
3839
include::modules/ossm-auto-route-annotations.adoc[leveloffset=+2]
39-
include::modules/ossm-auto-route-enable.adoc[leveloffset=+2]
4040

41+
include::modules/ossm-auto-route-enable.adoc[leveloffset=+2]
4142

4243
include::modules/ossm-routing-sc.adoc[leveloffset=+2]
44+
45+
include::modules/ossm-networkpolicy-overview.adoc[leveloffset=+1]
46+
47+
include::modules/ossm-config-disable-networkpolicy.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)