Skip to content

Commit ce3296b

Browse files
authored
Merge pull request #78504 from dkwon17/update-wto-docs
Provide example network policies for the web terminal operator
2 parents 229836a + ad36659 commit ce3296b

File tree

2 files changed

+41
-2
lines changed

2 files changed

+41
-2
lines changed

modules/odc-access-web-terminal.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The web terminal remains open until you close it or until you close the browser
2323
+
2424
[NOTE]
2525
====
26+
* One `DevWorkspace` CR defines the web terminal of one user. This CR contains details about the user's web terminal status and container image components.
2627
* The `DevWorkspace` CR is created only if it does not already exist.
2728
ifndef::openshift-rosa,openshift-dedicated[]
2829
* The `openshift-terminal` project is the default project used for cluster administrators. They do not have the option to choose another project. The {web-terminal-op} installs the DevWorkspace Operator as a dependency.

web_console/web_terminal/troubleshooting-web-terminal.adoc

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,44 @@ toc::[]
99
[id="troubleshooting-web-terminal-network-policies"]
1010
== Web terminal and network policies
1111

12-
The web terminal might fail to launch if the cluster has network policies configured. To initialize a web terminal instance, the {web-terminal-op} must communicate with the web terminal's pod to verify it is running, and the {product-title} web console needs to send information to automatically log in to the cluster within the terminal. If either step fails, the web terminal fails to initialize and the terminal panel appears to be in a loading state.
12+
The web terminal might fail to start if the cluster has network policies configured. To start a web terminal instance, the {web-terminal-op} must communicate with the web terminal's pod to verify it is running, and the {product-title} web console needs to send information to automatically log in to the cluster within the terminal. If either step fails, the web terminal fails to start and the terminal panel is in a loading state until a `context deadline exceeded error` occurs.
1313

14-
To avoid this issue, ensure that the network policies for namespaces that are used for terminals allow ingress from the `openshift-console` and `openshift-operators` namespaces.
14+
To avoid this issue, ensure that the network policies for namespaces that are used for terminals allow ingress from the `openshift-console` and `openshift-operators` namespaces.
15+
16+
The following samples show `NetworkPolicy` objects for allowing ingress from the `openshift-console` and `openshift-operators` namespaces.
17+
18+
.Allowing ingress from the `openshift-console` namespace
19+
[source,yaml]
20+
----
21+
apiVersion: networking.k8s.io/v1
22+
kind: NetworkPolicy
23+
metadata:
24+
name: allow-from-openshift-console
25+
spec:
26+
ingress:
27+
- from:
28+
- namespaceSelector:
29+
matchLabels:
30+
kubernetes.io/metadata.name: openshift-console
31+
podSelector: {}
32+
policyTypes:
33+
- Ingress
34+
----
35+
36+
.Allowing ingress from the `openshift-operators` namespace
37+
[source,yaml]
38+
----
39+
apiVersion: networking.k8s.io/v1
40+
kind: NetworkPolicy
41+
metadata:
42+
name: allow-from-openshift-operators
43+
spec:
44+
ingress:
45+
- from:
46+
- namespaceSelector:
47+
matchLabels:
48+
kubernetes.io/metadata.name: openshift-operators
49+
podSelector: {}
50+
policyTypes:
51+
- Ingress
52+
----

0 commit comments

Comments
 (0)