From dad7455418625427f16707926aaee5f3cddbdf07 Mon Sep 17 00:00:00 2001 From: Lenny Phan Date: Wed, 12 Jan 2022 06:57:11 +0000 Subject: [PATCH 1/5] Update documentation for port-forward for wlst --- .../accessing-the-domain/port-forward.md | 23 +++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md index e1dc3619fb3..b83373b9b5b 100644 --- a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md +++ b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md @@ -63,11 +63,26 @@ This behavior depends on your version and domain resource configuration: [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/documentation/domains/Domain.md). * For Istio-enabled domains running Istio versions prior to 1.10, - the operator already adds a - network channel with a `localhost` listen address for each - existing port. This means that no additional configuration is required - to enable port forwarding when Istio is enabled. + you must add an additional network channel to the WebLogic Administration Server + configured with the following attributes: + * Protocol defined as `t3`. + * Listen address defined with `localhost`. + * Listen port. Note, you should choose a port that does not conflict with any ports defined + in any of the additional network channels created for use with Istio versions prior to v1.10. For more details, see [Added network channels for Istio versions prior to v1.10]({{< relref "/userguide/istio/istio#added-network-channels-for-istio-versions-prior-to-v110" >}}). + * Enable `HTTP` protocol for this network channel. + * Do _NOT_ set an `external listen address` or `external listen port` on the network access point. + +For example, here is a snippet of a WebLogic domain `config.xml` file for channel `PortForward` +```xml + + PortForward + t3 + localhost + 8989 + true + +``` {{% notice note %}} If your domain is already running, and you have made configuration changes, From 62a4d01a2dbb848eb9bd884f76ee833c1f9621cf Mon Sep 17 00:00:00 2001 From: Lenny Phan Date: Wed, 12 Jan 2022 20:03:27 +0000 Subject: [PATCH 2/5] Add example snippets for domain home types --- .../accessing-the-domain/port-forward.md | 40 ++++++++++++++----- 1 file changed, 29 insertions(+), 11 deletions(-) diff --git a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md index b83373b9b5b..94e983b96a6 100644 --- a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md +++ b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md @@ -67,21 +67,38 @@ This behavior depends on your version and domain resource configuration: configured with the following attributes: * Protocol defined as `t3`. * Listen address defined with `localhost`. - * Listen port. Note, you should choose a port that does not conflict with any ports defined + * Listen port. Note, you should choose a port value that does not conflict with any ports defined in any of the additional network channels created for use with Istio versions prior to v1.10. For more details, see [Added network channels for Istio versions prior to v1.10]({{< relref "/userguide/istio/istio#added-network-channels-for-istio-versions-prior-to-v110" >}}). * Enable `HTTP` protocol for this network channel. - * Do _NOT_ set an `external listen address` or `external listen port` on the network access point. + * Do _NOT_ set an `external listen address` or `external listen port`. -For example, here is a snippet of a WebLogic domain `config.xml` file for channel `PortForward` +For example, here is a snippet of a WebLogic domain `config.xml` file for channel `PortForward` for the Admin Server ```xml - - PortForward - t3 - localhost - 8989 - true - + + admin-server + + PortForward + t3 + localhost + 7890 + true + + +``` +For Model in Image (MII) and Domain Home in Image (DII), here is a snippet model configuration for channel `PortForward` for the Admin Server +```yaml +topology: + ... + Server: + 'admin-server': + ListenPort: 7001 + NetworkAccessPoint: + PortForward: + Protocol: 't3' + ListenAddress: 'localhost' + ListenPort: '7890' + HttpEnabledForThisProtocol: true ``` {{% notice note %}} @@ -90,7 +107,8 @@ then you will need to rerun its introspector job and ensure that the admin pod restarts for the configuration changes to take effect. {{% /notice %}} -When administration channel port forwarding is enabled, +If Istio is _not_ enabled on the domain or for Istio enabled domains running +Istio 1.10 and later, when administration channel port forwarding is enabled, the operator automatically adds the following network channels (also known as Network Access Points) to the WebLogic Administration Server Pod: From 4831cc31e3c3ff42e36625f35a8fcec25b9b8550 Mon Sep 17 00:00:00 2001 From: Lenny Phan Date: Thu, 13 Jan 2022 19:14:22 +0000 Subject: [PATCH 3/5] first update based on review --- .../managing-domains/accessing-the-domain/port-forward.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md index 94e983b96a6..2a12167fb0b 100644 --- a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md +++ b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md @@ -67,13 +67,13 @@ This behavior depends on your version and domain resource configuration: configured with the following attributes: * Protocol defined as `t3`. * Listen address defined with `localhost`. - * Listen port. Note, you should choose a port value that does not conflict with any ports defined + * Listen port. Note: Choose a port value that does not conflict with any ports defined in any of the additional network channels created for use with Istio versions prior to v1.10. For more details, see [Added network channels for Istio versions prior to v1.10]({{< relref "/userguide/istio/istio#added-network-channels-for-istio-versions-prior-to-v110" >}}). * Enable `HTTP` protocol for this network channel. * Do _NOT_ set an `external listen address` or `external listen port`. -For example, here is a snippet of a WebLogic domain `config.xml` file for channel `PortForward` for the Admin Server +For example, here is a snippet of a WebLogic domain `config.xml` file for channel `PortForward` for the Administration Server. ```xml admin-server @@ -86,7 +86,7 @@ For example, here is a snippet of a WebLogic domain `config.xml` file for channe ``` -For Model in Image (MII) and Domain Home in Image (DII), here is a snippet model configuration for channel `PortForward` for the Admin Server +For Model in Image (MII) and Domain in Image (DII), here is a snippet model configuration for channel `PortForward` for the Administration Server. ```yaml topology: ... From b4e92f20548633b837aaf75c3d3d23209daf2109 Mon Sep 17 00:00:00 2001 From: Lenny Phan Date: Thu, 13 Jan 2022 21:27:52 +0000 Subject: [PATCH 4/5] add additional doc updates --- .../accessing-the-domain/port-forward.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md index 2a12167fb0b..ec8bafbb4ef 100644 --- a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md +++ b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md @@ -62,17 +62,24 @@ This behavior depends on your version and domain resource configuration: command or see the domain resource [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/documentation/domains/Domain.md). -* For Istio-enabled domains running Istio versions prior to 1.10, +* If WLST access is required for Istio-enabled domains running Istio versions prior to 1.10, you must add an additional network channel to the WebLogic Administration Server configured with the following attributes: * Protocol defined as `t3`. - * Listen address defined with `localhost`. + * Listen address defined with `localhost`. (Note: Stting the address to localhost is solely + for self documenting purposes. The address can be set to any value, and the operator will override + it to the required value regardless.) * Listen port. Note: Choose a port value that does not conflict with any ports defined in any of the additional network channels created for use with Istio versions prior to v1.10. For more details, see [Added network channels for Istio versions prior to v1.10]({{< relref "/userguide/istio/istio#added-network-channels-for-istio-versions-prior-to-v110" >}}). * Enable `HTTP` protocol for this network channel. * Do _NOT_ set an `external listen address` or `external listen port`. +{{% notice note %}} +It is not necessary to add an additional network channel, for Istio-enabled domains running Istio +versions prior to 1.10, to the WebLogic Administration Server if only console access is required . +{{% /notice %}} + For example, here is a snippet of a WebLogic domain `config.xml` file for channel `PortForward` for the Administration Server. ```xml From 81d3e8e32d73ceb0f9773d3b25d708d916efbce3 Mon Sep 17 00:00:00 2001 From: Lenny Phan Date: Thu, 13 Jan 2022 21:39:46 +0000 Subject: [PATCH 5/5] minor edits from review --- .../accessing-the-domain/port-forward.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md index ec8bafbb4ef..0a16be919ce 100644 --- a/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md +++ b/documentation/staging/content/userguide/managing-domains/accessing-the-domain/port-forward.md @@ -66,9 +66,9 @@ This behavior depends on your version and domain resource configuration: you must add an additional network channel to the WebLogic Administration Server configured with the following attributes: * Protocol defined as `t3`. - * Listen address defined with `localhost`. (Note: Stting the address to localhost is solely - for self documenting purposes. The address can be set to any value, and the operator will override - it to the required value regardless.) + * Listen address defined with `localhost`. (Note: Setting the address to localhost is solely + for self-documenting purposes. The address can be set to any value, and the operator will override + it to the required value.) * Listen port. Note: Choose a port value that does not conflict with any ports defined in any of the additional network channels created for use with Istio versions prior to v1.10. For more details, see [Added network channels for Istio versions prior to v1.10]({{< relref "/userguide/istio/istio#added-network-channels-for-istio-versions-prior-to-v110" >}}). @@ -76,8 +76,8 @@ This behavior depends on your version and domain resource configuration: * Do _NOT_ set an `external listen address` or `external listen port`. {{% notice note %}} -It is not necessary to add an additional network channel, for Istio-enabled domains running Istio -versions prior to 1.10, to the WebLogic Administration Server if only console access is required . +For Istio-enabled domains running Istio versions prior to 1.10, if console only access is required, +then it is not necessary to add an additional network channel to the WebLogic Administration Server. {{% /notice %}} For example, here is a snippet of a WebLogic domain `config.xml` file for channel `PortForward` for the Administration Server.