Skip to content

Commit 5a3228a

Browse files
rosemarymaranorjeberhard
authored andcommitted
minor edits, jenkins-ignore
1 parent 0d21398 commit 5a3228a

File tree

3 files changed

+87
-88
lines changed

3 files changed

+87
-88
lines changed

docs-source/content/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ draft: false
88

99
| Date | Version | Introduces backward incompatibilities | Change |
1010
| --- | --- | --- | --- |
11-
| TBD | v2.2 | no | Added support for FMW Infrastructure domains. WebLogic server instances are now gracefully shutdown by default and shutdown options are configurable. Operator is now built and runs on JDK 11.
11+
| TBD | v2.2 | no | Added support for FMW Infrastructure domains. WebLogic Server instances are now gracefully shutdown by default and shutdown options are configurable. Operator is now built and runs on JDK 11.
1212
| April 4, 2019 | v2.1 | no | Customers can add init and sidecar containers to generated pods.
1313
| March 4, 2019 | v2.0.1 | no | OpenShift support is now certified. Many bug fixes, including fixes for configuration overrides, cluster services, and domain status processing.
1414
| January 24, 2019 | v2.0 | yes; not compatible with 1.x releases, but is compatible with 2.0-rc2. | Final version numbers and documentation updates.

docs-source/content/samples/simple/domains/fmw-domain/_index.md

Lines changed: 39 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: "FMW Infrastructure domain"
33
date: 2019-04-18T07:32:31-05:00
44
weight: 2
5-
description: "Sample for creating a FMW Infrastructure domain home on an existing PV or
5+
description: "Sample for creating a FMW Infrastructure domain home on an existing PV or
66
PVC, and the domain resource YAML file for deploying the generated WebLogic domain."
77
---
88

99

10-
The sample scripts demonstrate the creation of a FMW Infrastructure domain home on an
11-
existing Kubernetes persistent volume (PV) and persistent volume claim (PVC). The scripts
12-
also generate the domain YAML file, which can then be used to start the Kubernetes
13-
artifacts of the corresponding domain. Optionally, the scripts start up the domain,
10+
The sample scripts demonstrate the creation of a FMW Infrastructure domain home on an
11+
existing Kubernetes persistent volume (PV) and persistent volume claim (PVC). The scripts
12+
also generate the domain YAML file, which can then be used to start the Kubernetes
13+
artifacts of the corresponding domain. Optionally, the scripts start up the domain,
1414
and WebLogic Server pods and services.
1515

1616
#### Prerequisites
@@ -20,22 +20,22 @@ Before you begin, read this document, [Domain resource]({{< relref "/userguide/m
2020
The following prerequisites must be handled prior to running the create domain script:
2121

2222
* Make sure the WebLogic operator is running.
23-
* The operator requires FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied.
23+
* The operator requires FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied.
2424
* Create a Kubernetes namespace for the domain unless the intention is to use the default namespace.
25-
* In the same Kubernetes namespace, create the Kubernetes persistent volume (PV) where the domain
26-
home will be hosted, and the Kubernetes persistent volume claim (PVC) for the domain. For samples
25+
* In the same Kubernetes namespace, create the Kubernetes persistent volume (PV) where the domain
26+
home will be hosted, and the Kubernetes persistent volume claim (PVC) for the domain. For samples
2727
to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/simple/storage/_index.md" >}}).
28-
By default, the `create-domain.sh` script creates a domain with the `domainUID` set to `domain1`
29-
and expects the PVC `domain1-weblogic-sample-pvc` to be present. You can create
30-
`domain1-weblogic-sample-pvc` using
28+
By default, the `create-domain.sh` script creates a domain with the `domainUID` set to `domain1`
29+
and expects the PVC `domain1-weblogic-sample-pvc` to be present. You can create
30+
`domain1-weblogic-sample-pvc` using
3131
[create-pv-pvc.sh](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/create-pv-pvc.sh)
3232
with an inputs file that has the `domainUID` set to `domain1`.
33-
* Create the Kubernetes secrets `username` and `password` of the admin account in the same Kubernetes
33+
* Create the Kubernetes secrets `username` and `password` of the administrative account in the same Kubernetes
3434
namespace as the domain.
3535

3636
#### Use the script to create a domain
3737

38-
Make a copy of the `create-domain-inputs.yaml` file, and run the create script, pointing it at
38+
Make a copy of the `create-domain-inputs.yaml` file, and run the create script, pointing it at
3939
your inputs file and an output directory:
4040

4141
```
@@ -46,24 +46,24 @@ $ ./create-domain.sh \
4646

4747
The script will perform the following steps:
4848

49-
* Create a directory for the generated Kubernetes YAML files for this domain if it does not
50-
already exist. The pathname is `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>`.
49+
* Create a directory for the generated Kubernetes YAML files for this domain if it does not
50+
already exist. The path name is `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>`.
5151
If the directory already exists, its contents must be removed before using this script.
52-
* Create a Kubernetes job that will start up a utility FMW Infrastructure container and run
52+
* Create a Kubernetes job that will start up a utility FMW Infrastructure container and run
5353
offline WLST scripts to create the domain on the shared storage.
5454
* Run and wait for the job to finish.
5555
* Create a Kubernetes domain YAML file, `domain.yaml`, in the directory that is created above.
5656
This YAML file can be used to create the Kubernetes resource using the `kubectl create -f`
5757
or `kubectl apply -f` command:
58-
58+
5959
```
6060
$ kubectl apply -f /path/to/output-directory/weblogic-domains/<domainUID>/domain.yaml
6161
```
6262
63-
* Create a convenient utility script, `delete-domain-job.yaml`, to clean up the domain home
63+
* Create a convenient utility script, `delete-domain-job.yaml`, to clean up the domain home
6464
created by the create script.
6565
66-
As a convenience, using the `-e` option, the script can optionally create the domain object,
66+
As a convenience, using the `-e` option, the script can optionally create the domain object,
6767
which in turn results in the creation of the corresponding WebLogic Server pods and services as well.
6868
6969
The usage of the create script is as follows:
@@ -79,15 +79,15 @@ usage: create-domain.sh -o dir -i file [-e] [-v] [-h]
7979

8080
```
8181
82-
If you copy the sample scripts to a different location, make sure that you copy everything in
83-
the `<weblogic-kubernetes-operator-project>/kubernetes/samples/scripts` directory together
82+
If you copy the sample scripts to a different location, make sure that you copy everything in
83+
the `<weblogic-kubernetes-operator-project>/kubernetes/samples/scripts` directory together
8484
into the target directory, maintaining the original directory hierarchy.
8585
8686
The default domain created by the script has the following characteristics:
8787
8888
* An Administration Server named `admin-server` listening on port `7001`.
8989
* A configured cluster named `cluster-1` of size 5.
90-
* Five Managed Servers, named `managed-server1`, `managed-server2` and so on, listening on port `8001`.
90+
* Five Managed Servers, named `managed-server1`, `managed-server2`, and so on, listening on port `8001`.
9191
* Log files that are located in `/shared/logs/<domainUID>`.
9292
* No applications deployed.
9393
* No data sources or JMS resources.
@@ -118,7 +118,7 @@ The following parameters can be provided in the inputs file.
118118
| `imagePullSecretName` | Name of the Kubernetes secret to access the Docker Store to pull the WebLogic Server Docker image. The presence of the secret will be validated when this parameter is specified. | |
119119
| `includeServerOutInPodLog` | Boolean indicating whether to include the server .out to the pod's stdout. | `true` |
120120
| `initialManagedServerReplicas` | Number of Managed Servers to initially start for the domain. | `2` |
121-
| `javaOptions` | Java options for starting the Administration and Managed Servers. A Java option can have references to one or more of the following pre-defined variables to obtain WebLogic domain information: `$(DOMAIN_NAME)`, `$(DOMAIN_HOME)`, `$(ADMIN_NAME)`, `$(ADMIN_PORT)`, and `$(SERVER_NAME)`. | `-Dweblogic.StdoutDebugEnabled=false` |
121+
| `javaOptions` | Java options for starting the Administration Server and Managed Servers. A Java option can have references to one or more of the following pre-defined variables to obtain WebLogic domain information: `$(DOMAIN_NAME)`, `$(DOMAIN_HOME)`, `$(ADMIN_NAME)`, `$(ADMIN_PORT)`, and `$(SERVER_NAME)`. | `-Dweblogic.StdoutDebugEnabled=false` |
122122
| `logHome` | The in-pod location for domain log, server logs, server out, and Node Manager log files. If not specified, the value is derived from the `domainUID` as `/shared/logs/<domainUID>`. | `/shared/logs/domain1` |
123123
| `managedServerNameBase` | Base string used to generate Managed Server names. | `managed-server` |
124124
| `managedServerPort` | Port number for each Managed Server. | `8001` |
@@ -134,24 +134,24 @@ The following parameters can be provided in the inputs file.
134134
| `rcuDatabaseURL` | The database URL. | `database:1521/service` |
135135
| `rcuCredentialsSecret` | The Kubernetes secret containing the database credentials. | `domain1-rcu-credentials` |
136136
137-
Note that the names of the Kubernetes resources in the generated YAML files may be formed with the
138-
value of some of the properties specified in the `create-inputs.yaml` file. Those properties include
139-
the `adminServerName`, `clusterName` and `managedServerNameBase`. If those values contain any
140-
characters that are invalid in a Kubernetes service name, those characters are converted to
141-
valid values in the generated YAML files. For example, an uppercase letter is converted to a
137+
Note that the names of the Kubernetes resources in the generated YAML files may be formed with the
138+
value of some of the properties specified in the `create-inputs.yaml` file. Those properties include
139+
the `adminServerName`, `clusterName` and `managedServerNameBase`. If those values contain any
140+
characters that are invalid in a Kubernetes service name, those characters are converted to
141+
valid values in the generated YAML files. For example, an uppercase letter is converted to a
142142
lowercase letter and an underscore `("_")` is converted to a hyphen `("-")`.
143143
144-
The sample demonstrates how to create a WebLogic domain home and associated Kubernetes resources for a domain
145-
that only has one cluster. In addition, the sample provides the capability for users to supply their own scripts
144+
The sample demonstrates how to create a WebLogic domain home and associated Kubernetes resources for a domain
145+
that has one cluster only. In addition, the sample provides the capability for users to supply their own scripts
146146
to create the domain home for other use cases. The generated domain YAML file could also be modified to cover more use cases.
147147
148148
#### Verify the results
149149
150150
The create script will verify that the domain was created, and will report failure if there was any error.
151-
However, it may be desirable to manually verify the domain, even if just to gain familiarity with the
151+
However, it may be desirable to manually verify the domain, even if just to gain familiarity with the
152152
various Kubernetes objects that were created by the script.
153153
154-
Note that the example results below use the `default` Kubernetes namespace. If you are using a different
154+
Note that the example results below use the `default` Kubernetes namespace. If you are using a different
155155
namespace, you need to replace `NAMESPACE` in the example `kubectl` commands with the actual Kubernetes namespace.
156156
157157
##### Generated YAML files with the default inputs
@@ -184,10 +184,10 @@ spec:
184184
imagePullPolicy: "IfNotPresent"
185185
# Identify which Secret contains the credentials for pulling an image
186186
#imagePullSecrets:
187-
#- name:
187+
#- name:
188188
# Identify which Secret contains the WebLogic Admin credentials (note that there is an example of
189189
# how to create that Secret at the end of this file)
190-
webLogicCredentialsSecret:
190+
webLogicCredentialsSecret:
191191
name: fmw-domain-weblogic-credentials
192192
# Whether to include the server out file into the pod's stdout, default is true
193193
includeServerOutInPodLog: true
@@ -335,7 +335,7 @@ Spec:
335335
Name: JAVA_OPTIONS
336336
Value: -Dweblogic.StdoutDebugEnabled=false
337337
Name: USER_MEM_ARGS
338-
Value: -XX:+UseContainerSupport -Djava.security.egd=file:/dev/./urandom
338+
Value: -XX:+UseContainerSupport -Djava.security.egd=file:/dev/./urandom
339339
Init Containers:
340340
Labels:
341341
Liveness Probe:
@@ -411,9 +411,9 @@ Events: <none>
411411
```
412412
413413
In the `Status` section of the output, the available servers and clusters are listed.
414-
Note that if this command is issued very soon after the script finishes, there may be
414+
Note that if this command is issued very soon after the script finishes, there may be
415415
no servers available yet, or perhaps only the Administration Server but no Managed Servers.
416-
The operator will start up the Administration Server first and wait for it to become ready
416+
The operator will start up the Administration Server first and wait for it to become ready
417417
before starting the Managed Servers.
418418
419419
#### Verify the pods
@@ -461,12 +461,11 @@ fmw-domain-managed-server4 ClusterIP None <none> 8
461461
462462
#### Delete the generated domain home
463463
464-
Sometimes in production, but most likely in testing environments, you might want to remove the domain
465-
home that is generated using the `create-domain.sh` script. Do this by running the generated
464+
Sometimes in production, but most likely in testing environments, you might want to remove the domain
465+
home that is generated using the `create-domain.sh` script. Do this by running the generated
466466
`delete domain job` script in the `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>` directory.
467467
468468
```
469469
$ kubectl create -f delete-domain-job.yaml
470470

471471
```
472-

0 commit comments

Comments
 (0)