Skip to content

Commit 1358ae9

Browse files
edits (#3545)
1 parent 6c55439 commit 1358ae9

File tree

5 files changed

+51
-51
lines changed

5 files changed

+51
-51
lines changed

documentation/staging/content/managing-domains/accessing-the-domain/port-forward.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Use port forwarding"
33
date: 2019-02-23T17:39:15-05:00
44
draft: false
55
weight: 3
6-
description: "Use port forwarding to access WebLogic Server Administration Consoles and WLST."
6+
description: "Use port forwarding to access WebLogic Server administration consoles and WLST."
77
---
88

99
{{< table_of_contents >}}
@@ -21,7 +21,7 @@ from a private local network without exposing WebLogic's ports to a public netwo
2121

2222
Here are the steps:
2323

24-
1. Set up [WebLogic Administration Server network channels for port forward access](#set-up-administration-server-network-channels-for-port-forward-access).
24+
1. Set up [Administration Server network channels for port forward access](#set-up-administration-server-network-channels-for-port-forward-access).
2525
1. If you are setting up WLST access
2626
and your port forwarding local port is not going to be the same as the
2727
port number on the WebLogic Administration Server Pod,
@@ -129,7 +129,7 @@ When one or more custom administration channels are configured | internal-admin$
129129
### Port forward to an Administration Server Pod
130130
131131
If you have
132-
[set up WebLogic Administration Server network channels for port forward access](#set-up-administration-server-network-channels-for-port-forward-access),
132+
[set up Administration Server network channels for port forward access](#set-up-administration-server-network-channels-for-port-forward-access),
133133
then you can run a `kubectl port-forward` command to access such a channel. The command:
134134
* By default, opens a port of your choosing on `localhost`
135135
on the machine where you run the command.
@@ -164,7 +164,7 @@ For example, if you have a WebLogic domain with:
164164
* An Administration Server named `admin-server` listening on non-SSL listen port `7001`
165165
* No administration port or administration channels configured on the Administration Server
166166

167-
And, you have [set up WebLogic Administration Server network channels for port forward access](#set-up-administration-server-network-channels-for-port-forward-access) for this domain,
167+
And, you have [set up Administration Server network channels for port forward access](#set-up-administration-server-network-channels-for-port-forward-access) for this domain,
168168
then you can run either of the following commands to forward local port `32015` to
169169
the Administration Server Pod:
170170

documentation/staging/content/managing-domains/accessing-the-domain/remote-admin-console.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ along with the URL of the WebLogic Server Administration Server's administration
2626

2727
**Notes:**
2828
* An Administration Server administration port typically is the same as its default port unless either an SSL port or an administration port is configured and enabled.
29-
* If your domain home type is either [Domain in Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}}) or [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}), then do not use the WebLogic Remote Console to make changes to the WebLogic domain configuration as these changes are ephemeral and will be lost when servers restart. See [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}).
29+
* If your domain home type is either [Domain in Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}}) or [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}), then do not use the WebLogic Remote Console to make changes to the WebLogic domain configuration because these changes are ephemeral and will be lost when servers restart. See [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}).
3030

3131

3232
{{% notice warning %}}
@@ -119,7 +119,7 @@ see [Use a `NodePort` for WLST]({{< relref "/managing-domains/accessing-the-doma
119119
Administration Server Pod according to these
120120
[instructions]({{< relref "/managing-domains/accessing-the-domain/port-forward.md" >}}).
121121

122-
**NOTE:** If you plan to run the Remote Console
122+
**NOTE:** If you plan to run the Remote Console
123123
on a different machine than the port forwarding command,
124124
then the port forwarding command needs to specify a `--address` parameter
125125
with the IP address of the machine that is hosting the command.

documentation/staging/content/managing-domains/accessing-the-domain/weblogic-admin-console.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Use the Administration Console"
33
date: 2019-02-23T17:39:15-05:00
44
draft: false
55
weight: 1
6-
description: "Use the WebLogic Administration Console with domains running in Kubernetes."
6+
description: "Use the WebLogic Server Administration Console with domains running in Kubernetes."
77
---
88

99
{{< table_of_contents >}}
@@ -13,17 +13,17 @@ You can access the WebLogic Server Administration Console external to the Kubern
1313

1414
* [Use a load balancer](#use-a-load-balancer)
1515

16-
* Use an [Administration Server `NodePort`](#use-an-administration-server-nodeport).
16+
* Use an [Administration Server `NodePort`](#use-an-administration-server-nodeport)
1717

18-
* [Use a `kubectl port-forward` connection](#use-a-kubectl-port-forward-connection).
18+
* [Use a `kubectl port-forward` connection](#use-a-kubectl-port-forward-connection)
1919

2020
**Notes:**
21-
* For production use cases, Oracle recommends using a load balancer with ingress path routing rules and an SSL port to access the WebLogic Server Administration Console.
21+
* For production use cases, Oracle recommends using a load balancer with ingress path routing rules and an SSL port to access the WebLogic Server Administration Console.
2222

23-
* To verify that your load balancer, NodePort, or kubectl port-forward setup is working as expected, see [Test]({{< relref "#test" >}}).
23+
* To verify that your load balancer, NodePort, or `kubectl port-forward` setup is working as expected, see [Test]({{< relref "#test" >}}).
2424

25-
* Do not use the WebLogic Server Administration Console to start or stop servers, or for scaling clusters. See [Starting and stopping servers]({{< relref "/managing-domains/domain-lifecycle/startup#starting-and-stopping-servers" >}}) and [Scaling]({{< relref "/managing-domains/domain-lifecycle/scaling.md" >}}).
26-
* If your domain home type is either [Domain in Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}}) or [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}), then do not use the Administration Console to make changes to the WebLogic domain configuration as these changes are ephemeral and will be lost when servers restart. See [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}).
25+
* Do not use the WebLogic Server Administration Console to start or stop servers, or for scaling clusters. See [Starting and stopping servers]({{< relref "/managing-domains/domain-lifecycle/startup#starting-and-stopping-servers" >}}) and [Scaling]({{< relref "/managing-domains/domain-lifecycle/scaling.md" >}}).
26+
* If your domain home type is either [Domain in Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}}) or [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}), then do not use the Administration Console to make changes to the WebLogic domain configuration because these changes are ephemeral and will be lost when servers restart. See [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}).
2727

2828
{{% notice warning %}}
2929
Externally exposing administrative, RMI, or T3 capable WebLogic channels
@@ -32,17 +32,17 @@ port forwarding, or a similar method can create an insecure configuration.
3232
For more information, see [External network access security]({{<relref "/security/domain-security/weblogic-channels.md">}}).
3333
{{% /notice %}}
3434

35-
### Use a load balancer
36-
To access WebLogic Server Administration Console through a load balancer, first set up an [Ingress]({{< relref "/managing-domains/accessing-the-domain/ingress/_index.md">}}). This, in combination with SSL, is the best practice approach for production use cases.
35+
### Use a load balancer
36+
To access the WebLogic Server Administration Console through a load balancer, first set up an [Ingress]({{< relref "/managing-domains/accessing-the-domain/ingress/_index.md">}}). This, in combination with SSL, is the best practice approach for production use cases.
3737

38-
{{% notice note %}} The following `path-routing` ingress instructions do not apply when you need to concurrently access multiple domains in the same Kubernetes cluster through the same external load balancer port. For the multiple domain use case, see the [Host-based routing](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/traefik/README.md#host-based-routing) sample and make sure that the host names are resolvable by your DNS server (e.g. `domain1.org` and `domain2.org` in the sample).
38+
{{% notice note %}} The following `path-routing` ingress instructions do not apply when you need to concurrently access multiple domains in the same Kubernetes cluster through the same external load balancer port. For the multiple domain use case, see the [Host-based routing](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/traefik/README.md#host-based-routing) sample and make sure that the host names are resolvable by your DNS server (for example, `domain1.org` and `domain2.org` in the sample).
3939
{{% /notice %}}
4040

4141
#### Configure ingress path routing rules for a non-SSL port
42-
The following example sets up an ingress path routing rule to access a WebLogic Server Administration Console through a non-SSL port.
42+
The following example sets up an ingress path routing rule to access a WebLogic Server Administration Console through a non-SSL port.
4343

4444
1. Set up a `path-routing` YAML file for a Traefik load balancer:
45-
45+
4646
```yaml
4747
apiVersion: traefik.containo.us/v1alpha1
4848
kind: IngressRoute
@@ -62,30 +62,30 @@ The following example sets up an ingress path routing rule to access a WebLogic
6262
port: 7001
6363
```
6464
65-
2. Open the following URL from your browser to access the WebLogic Server Administration Console:
65+
2. To access the WebLogic Server Administration Console, open the following URL from your browser:
6666
6767
```
6868
http://${HOSTNAME}:${LB_PORT}/console
6969
```
7070
Where:
71-
71+
7272
* `${HOSTNAME}` is where the ingress load balancer is running.
73-
73+
7474
* To determine the `${LB_PORT}` when using a Traefik load balancer:
7575

7676
`$ export LB_PORT=$(kubectl -n traefik get service traefik-operator -o jsonpath='{.spec.ports[?(@.name=="web")].nodePort}')`
7777

78-
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) type domain, then you can add an ingress path routing rule for PathPrefix `/em` and access the Fusion Middleware Control (Enterprise Manager) Console using the following URL:
78+
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) domain, then you can add an ingress path routing rule for the PathPrefix `/em` and access Fusion Middleware Control (Enterprise Manager) using the following URL:
7979

8080
```
8181
http://${HOSTNAME}:${LB_PORT}/em
8282
```
83-
#### Configure ingress path routing rules for a SSL port and enable `WebLogic Plugin Enabled`
84-
The following example sets up load balancer routing for access to a WebLogic Server Administration Console through a SSL port.
83+
#### Configure ingress path routing rules for an SSL port and enable `WebLogic Plugin Enabled`
84+
The following example sets up load balancer routing for access to the WebLogic Server Administration Console through an SSL port.
8585

86-
1. Enable `WebLogic Plugin Enabled` setting in the WebLogic configuration:
86+
1. Enable the `WebLogic Plugin Enabled` setting in the WebLogic configuration:
8787

88-
The WebLogic configuration setting `WebLogic plugin Enabled`, when set to true, informs the WebLogic Server about the presence of a load balancer proxy. Failure to have this setting enabled causes unexpected results in cases where the client IP address is required or when SSL terminates at the load balancer.
88+
The WebLogic configuration setting `WebLogic Plugin Enabled`, when set to `true`, informs WebLogic Server about the presence of a load balancer proxy. Failure to have this setting enabled causes unexpected results in cases where the client IP address is required or when SSL terminates at the load balancer.
8989

9090
When using WDT to configure a WebLogic domain, use the resource section at the domain level in a model YAML file:
9191
```yaml
@@ -104,7 +104,7 @@ The following example sets up load balancer routing for access to a WebLogic Ser
104104
```
105105
2. Configure an ingress path routing rule and update the ingress resource with a `customRequestHeaders` value:
106106

107-
For example, see the following `path-routing` YAML file for a Traefik load balancer. In the case of SSL termination, Traefik must pass a custom header `WL-Proxy-SSL:true` to the WebLogic Server endpoints.
107+
For example, see the following `path-routing` YAML file for a Traefik load balancer. In the case of SSL termination, Traefik must pass a custom header `WL-Proxy-SSL:true` to the WebLogic Server endpoints.
108108

109109
```yaml
110110
apiVersion: traefik.containo.us/v1alpha1
@@ -115,7 +115,7 @@ The following example sets up load balancer routing for access to a WebLogic Ser
115115
name: traefik-console-tls
116116
namespace: weblogic-domain
117117
spec:
118-
entryPoints:
118+
entryPoints:
119119
- websecure
120120
routes:
121121
- kind: Rule
@@ -142,17 +142,17 @@ The following example sets up load balancer routing for access to a WebLogic Ser
142142
```
143143
3. Access the WebLogic Server Administration Console using the HTTPS port:
144144
145-
Get the SSL port from the Kubernetes service.
145+
Get the SSL port from the Kubernetes service:
146146
```shell
147147
# Get the ingress controller secure web port
148148
$ SSLPORT=$(kubectl -n traefik get service traefik-operator -o jsonpath='{.spec.ports[?(@.name=="websecure")].nodePort}')
149149
```
150-
Use the following URL from your browser to access the WebLogic Server Administration Console:
150+
From your browser, use the following URL to access the WebLogic Server Administration Console:
151151
```
152152
https://${HOSTNAME}:${SSLPORT}/console
153153
```
154154

155-
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) type domain, then you can add an ingress path routing rule for PathPrefix `/em` and access the Fusion Middleware Control (Enterprise Manager) Console using the following URL:
155+
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) domain, then you can add an ingress path routing rule for the PathPrefix `/em` and access Fusion Middleware Control (Enterprise Manager) using the following URL:
156156

157157
```
158158
https://${HOSTNAME}:${SSLPORT}/em
@@ -162,25 +162,25 @@ The following example sets up load balancer routing for access to a WebLogic Ser
162162

163163
Use the following steps to configure a `NodePort` to access the WebLogic Server Administration Console:
164164

165-
1. Update the WebLogic Server configuration for the Administration Server to add a Network Access Point (custom channel) with the HTTP protocol, and expose this channel on a NodePort service using the `domain.spec.adminServer.adminService.channels` attribute.
165+
1. Update the WebLogic Administration Server configuration to add a Network Access Point (custom channel) with the HTTP protocol, and expose this channel on a NodePort service using the `domain.spec.adminServer.adminService.channels` attribute.
166166

167167
For an example of setting up the `NodePort` on an Administration Server, see [Use a `NodePort`]({{< relref "/managing-domains/accessing-the-domain/wlst#use-a-nodeport" >}}). For information about the `NodePort` Service on an Administration Server, see the [Domain resource](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md) document.
168168

169-
2. Use the following URL from your browser to access the WebLogic Server Administration Console:
169+
2. From your browser, use the following URL to access the WebLogic Server Administration Console:
170170

171171
```
172172
http://hostname:adminserver-NodePort/console
173173
```
174174
The `adminserver-NodePort` is the port number of the Administration Server outside the Kubernetes cluster.
175175

176-
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) type domain, then you can also access the Fusion Middleware Control (Enterprise Manager) Console using the following URL:
177-
176+
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) domain, then you can also access Fusion Middleware Control (Enterprise Manager) using the following URL:
177+
178178
```
179179
http://hostname:adminserver-NodePort/em
180180
```
181181

182182
### Use a `kubectl port-forward` connection
183-
A Kubernetes port forward command is convenient for development use cases and is not recommended for production use cases. It creates a local process external to a Kubernetes cluster that accepts external traffic on a dedicated local port and forwards this traffic to a specific pod and port in the Kubernetes cluster. If you have multiple domains, then each domain will require its own dedicated port forward command and a separate local port.
183+
A Kubernetes port forward command is convenient for development use cases but is _not recommended_ for production use cases. It creates a local process external to a Kubernetes cluster that accepts external traffic on a dedicated local port and forwards this traffic to a specific pod and port in the Kubernetes cluster. If you have multiple domains, then each domain will require its own dedicated port forward command and a separate local port.
184184

185185
1. Forward a local port (that is external to
186186
Kubernetes) to the administration port of the
@@ -189,10 +189,10 @@ A Kubernetes port forward command is convenient for development use cases and is
189189

190190
**NOTE:** If you plan to access the WebLogic Server Administration Console from a browser
191191
on a different machine than the port forwarding command,
192-
then the port forwarding command needs to specify a `--address` parameter
192+
then the port forwarding command needs to specify an `--address` parameter
193193
with an externally accessible IP address for the machine that is running the command.
194194

195-
1. Use the following URL in the browser:
195+
1. In the browser, use the following URL:
196196

197197
```
198198
http://${HOSTNAME}:${LOCAL_PORT}/console
@@ -201,12 +201,12 @@ A Kubernetes port forward command is convenient for development use cases and is
201201

202202
* `${HOSTNAME}` is the DNS address or the IP address of the machine
203203
where the `kubectl port-forward` command is running. This is
204-
customizable on the `port-forward` command using `--address` parameter
204+
customizable using the `--address` parameter
205205
and is `localhost` or `127.0.0.1`, by default.
206206

207207
* `${LOCAL_PORT}` is the local port specified on the `kubectl port-forward` command line.
208208

209-
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) type domain, then you can also access the Fusion Middleware Control (Enterprise Manager) Console using the following URL:
209+
If you have an [FMW Infrastructure]({{< relref "/managing-fmw-domains.md" >}}) domain, then you can also access Fusion Middleware Control (Enterprise Manager) using the following URL:
210210

211211
```
212212
http://${HOSTNAME}:${LOCAL_PORT}/em
@@ -226,4 +226,4 @@ $ curl http://${HOSTNAME}:${LB_PORT}/console > /dev/null && echo "Connection suc
226226
Connection succeeded.
227227
```
228228

229-
If successful, then you should see the "Connection succeeded" message in the output from the above command.
229+
If successful, then you will see the `Connection succeeded` message in the output from the command.

0 commit comments

Comments
 (0)