Skip to content

Commit 1b0fc7f

Browse files
rosemarymaranomarkxnelson
authored andcommitted
Improve Quick Start (#1153)
* improve Quick Start * incorporate feedback * address Russ' concerns * revise ReadyApp curl command
1 parent c493217 commit 1b0fc7f

File tree

8 files changed

+88
-122
lines changed

8 files changed

+88
-122
lines changed

docs-source/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Oracle is finding ways for organizations using WebLogic Server to run important
1414
* Scale WebLogic domains by starting and stopping Managed Servers on demand, or by integrating with a REST API to initiate scaling based on WLDF, Prometheus, Grafana, or other rules.
1515
* Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
1616

17-
The fastest way to experience the operator is to follow the [Quick Start guide]({{< relref "/quickstart/_index.md" >}}), or you can peruse our [documentation]({{< relref "/userguide/_index.md" >}}), read our [blogs](https://blogs.oracle.com/weblogicserver/updated-weblogic-kubernetes-support-with-operator-20), or try out the [samples]({{< relref "/samples/_index.md" >}}).
17+
The fastest way to experience the operator is to follow the [Quick Start guide]({{< relref "/quickstart/_index.md" >}}), or you can peruse our [documentation]({{< relref "/userguide/_index.md" >}}), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples]({{< relref "/samples/_index.md" >}}).
1818

1919
***
2020
The [current release of the operator](https://github.com/oracle/weblogic-kubernetes-operator/releases) is 2.2.1.

docs-source/content/quickstart/create-domain.md

Lines changed: 22 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ weight: 6
66
---
77

88

9-
1. Create a Kubernetes secret containing the `username` and `password` for the domain using the [`create-weblogic-credentials`](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain-credentials/create-weblogic-credentials.sh) script:
9+
1. For use in the following steps:
10+
11+
* Select a user name and password, following the required rules for password creation (at least 8 alphanumeric characters with at least one number or special character).
12+
* Pick or create a directory to which you can write output.
13+
14+
1. Create a Kubernetes secret for the WebLogic administrator credentials containing the `username` and `password` for the domain, using the [create-weblogic-credentials](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain-credentials/create-weblogic-credentials.sh) script:
1015

1116
```bash
1217
$ kubernetes/samples/scripts/create-weblogic-domain-credentials/create-weblogic-credentials.sh \
@@ -17,58 +22,22 @@ weight: 6
1722
with the value you provided. For example, the command above would create a secret named
1823
`sample-domain1-weblogic-credentials`.
1924

20-
1. Create a new image with a domain home by running the [`create-domain`](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain.sh) script.
21-
Follow the directions in the [sample]({{< relref "/samples/simple/domains/domain-home-in-image/_index.md" >}}),
22-
including:
23-
24-
* Copying the sample `kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain-inputs.yaml` file and updating your copy with the `domainUID` (`sample-domain1`),
25-
domain namespace (`sample-domain1-ns`), and the `domainHomeImageBase` (`container-registry.oracle.com/middleware/weblogic:12.2.1.3`).
26-
27-
* Setting `weblogicCredentialsSecretName` to the name of the secret containing the WebLogic credentials, in this case, `sample-domain1-weblogic-credentials`.
28-
29-
* Leaving the `image` empty unless you need to tag the new image that the script builds to a different name.
30-
{{% notice note %}}
31-
If you set the `domainHomeImageBuildPath` property to `./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt`, make sure that your `JAVA_HOME` is set to a Java JDK version 1.8 or later.
32-
{{% /notice %}}
25+
1. Create a new image with a domain home by running the [create-domain](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain.sh) script. First, copy the sample [create-domain-inputs.yaml](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain-inputs.yaml) file and update your copy with:
26+
* `domainUID`: `sample-domain1`
27+
* `image`: Leave empty unless you need to tag the new image that the script builds to a different name.
28+
* `weblogicCredentialsSecretName`: `sample-domain1-weblogic-credentials`
29+
* `namespace`: `sample-domain1-ns`
30+
* `domainHomeImageBase`: `container-registry.oracle.com/middleware/weblogic:12.2.1.3`
3331

3432
For example, assuming you named your copy `my-inputs.yaml`:
3533

3634
```bash
3735
$ cd kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image
38-
$ ./create-domain.sh -i my-inputs.yaml -o /some/output/directory -u <username> -p <password> -e
39-
```
40-
41-
You need to provide the WebLogic administration user name and password in the `-u` and `-p` options
42-
respectively, as shown in the example.
43-
{{% notice note %}}
44-
When using this sample, the WebLogic Server credentials that you specify, in three separate places, must be consistent:
45-
46-
- The secret that you create for the credentials.
47-
- The properties files in the sample project you choose to create the Docker image from.
48-
- The parameters you supply to the `create-domain.sh` script.
49-
{{% /notice %}}
50-
51-
52-
If you specify the `-e` option, the script will generate the
53-
Kubernetes YAML files *and* apply them to your cluster. If you omit the `-e` option, the
54-
script will just generate the YAML files, but will not take any action on your cluster.
55-
56-
If you run the sample from a machine that is remote to the Kubernetes cluster, and you need to push the new image to a registry that is local to the cluster, you need to do the following:
57-
58-
* Set the `image` property in the inputs file to the target image name (including the registry hostname/port, and the tag if needed).
59-
* If you want Kubernetes to pull the image from a private registry, create a Kubernetes secret to hold your credentials and set the `imagePullSecretName` property in the inputs file to the name of the secret.
60-
{{% notice note %}}
61-
The Kubernetes secret must be in the same namespace where the domain will be running.
62-
For more information, see [domain home in image protection]({{<relref "/security/domain-security/image-protection.md#weblogic-domain-in-docker-image-protection">}})
63-
in the ***Security*** section.
64-
{{% /notice %}}
65-
* Run the `create-domain.sh` script without the `-e` option.
66-
* Push the `image` to the registry.
67-
* Run the following command to create the domain.
68-
69-
```bash
70-
$ kubectl apply -f /some/output/directory/weblogic-domains/sample-domain1/domain.yaml
36+
$ ./create-domain.sh -i my-inputs.yaml -o /<your output directory> -u <username> -p <password> -e
7137
```
38+
{{% notice note %}}You need to provide the same WebLogic domain administrator user name and password in the `-u` and `-p` options
39+
respectively, as you provided when creating the Kubernetes secret in Step 1.
40+
{{% /notice %}}
7241

7342
1. Confirm that the operator started the servers for the domain:
7443

@@ -102,19 +71,13 @@ in the ***Security*** section.
10271

10372
1. To confirm that the load balancer noticed the new Ingress and is successfully routing to the domain's server pods,
10473
you can send a request to the URL for the "WebLogic ReadyApp framework" which will return a HTTP 200 status code, as
105-
shown in the example below. If you used the host-based routing Ingress sample, you will need to
106-
provide the hostname in the `-H` option.
107-
108-
Substitute the Node IP address of the worker node for `your.server.com`. You can find it by running:
74+
shown in the example below.
10975
110-
```bash
111-
$ kubectl get po -n sample-domain1-ns -o wide
112-
```
11376
```
114-
$ curl -v -H 'host: sample-domain1.org' http://your.server.com:30305/weblogic/ready
115-
About to connect() to your.server.com port 30305 (#0)
77+
$ curl -v -H 'host: sample-domain1.org' http://localhost:30305/weblogic/ready
78+
About to connect() to localhost port 30305 (#0)
11679
Trying 10.196.1.64...
117-
Connected to your.server.com (10.196.1.64) port 30305 (#0)
80+
Connected to localhost (10.196.1.64) port 30305 (#0)
11881
> GET /weblogic/ HTTP/1.1
11982
> User-Agent: curl/7.29.0
12083
> Accept: */*
@@ -124,7 +87,7 @@ in the ***Security*** section.
12487
< Content-Length: 0
12588
< Date: Thu, 20 Dec 2018 14:52:22 GMT
12689
< Vary: Accept-Encoding
127-
< Connection #0 to host your.server.com left intact
90+
< Connection #0 to host localhost left intact
12891
```
12992
{{% notice note %}}
13093
Depending on where your Kubernetes cluster is running, you may need to open firewall ports or update security lists to allow ingress to this port.
@@ -135,6 +98,4 @@ Depending on where your Kubernetes cluster is running, you may need to open fire
13598
13699
a. Edit the `my-inputs.yaml` file (assuming that you named your copy `my-inputs.yaml`) to set `exposedAdminNodePort: true`.
137100
138-
b. Open a browser to `http://your.server.com:30701`.
139-
140-
c. As in step 5, substitute the Node IP address of the worker node for `your.server.com`.
101+
b. Open a browser to `http://localhost:30701`.

docs-source/content/quickstart/get-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ and accept the license agreement for the [WebLogic Server image](https://hub.doc
2525
1. Pull the Traefik load balancer image:
2626

2727
```bash
28-
$ docker pull traefik:1.7.6
28+
$ docker pull traefik:1.7.12
2929
```
3030

3131
1. Obtain the WebLogic image from the [Oracle Container Registry](https://container-registry.oracle.com).

0 commit comments

Comments
 (0)