Skip to content

Commit 50905ce

Browse files
committed
Addressed Monica's review comments on Domain on PV samples documentation.
1 parent 152652b commit 50905ce

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

documentation/4.1/content/samples/domains/domain-home-on-pv/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Domain on PV sample uses a WebLogic Deploy Tooling (WDT) model to specify yo
1616

1717
#### Domain on PV domain types (WLS and JRF)
1818

19-
Domain on PV is supported on two types of domains: a standard WLS domain and an Oracle Fusion Middleware Infrastructure, Java Required Files (JRF) domain. This sample demonstrates both WLS and JRF domain types.
19+
Domain on PV is supported on two types of domains: a standard Oracle WebLogic Server domain and an Oracle Fusion Middleware Infrastructure, Java Required Files (JRF) domain. This sample demonstrates both Oracle WebLogic Server and JRF domain types.
2020

2121
The JRF domain path through the sample includes additional steps required for JRF: deploying an infrastructure database, initializing the database using the Repository Creation Utility (RCU) tool, referencing the infrastructure database from the WebLogic configuration, setting an Oracle Platform Security Services (OPSS) wallet password, and exporting or importing an OPSS wallet file. JRF domains may be used by Oracle products that layer on top of WebLogic Server, such as SOA and OSB.
2222

documentation/4.1/content/samples/domains/domain-home-on-pv/build-domain-creation-image.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,20 @@ description: "Create WebLogic images using the WebLogic Image Tool and WebLogic
1313

1414
The image build process uses the WebLogic Image Tool to create a Domain on PV `domain creation image`. This image contains:
1515
- A WebLogic Deploy Tooling installation (expected in an image's `/auxiliary/weblogic-deploy` directory by default).
16-
- WDT model YAML, property, and archive files (expected in directory `/auxiliary/models` by default).
16+
- WDT model YAML, WDT variables, and WDT archive ZIP files (expected in directory `/auxiliary/models` by default).
1717

1818
### Build the domain creation image
1919

2020
Use the steps in the following sections to build the domain creation image.
2121

22-
#### Understand your first archive
22+
#### Understand your first WDT archive ZIP file
2323

24-
The sample includes a predefined archive directory in `/tmp/sample/wdt-artifacts/archives/archive-v1` that you will use to create an archive ZIP file for the image.
24+
The sample includes a predefined WDT archive directory in `/tmp/sample/wdt-artifacts/archives/archive-v1` that you will use to create an WDT archive ZIP file for the image.
2525

26-
The archive top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an 'exploded' sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archives are:
27-
- A model image can contain multiple WDT archives.
28-
- WDT archives can contain multiple applications, libraries, and other components.
29-
- WDT archives have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory.
26+
The WDT archive ZIP top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an 'exploded' sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archive ZIP files are:
27+
- A domain creation image can contain multiple WDT archive ZIP files.
28+
- WDT archive ZIP files can contain multiple applications, libraries, and other components.
29+
- WDT archive ZIP files have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory.
3030

3131
{{%expand "If you are interested in the web application source, click here to see the JSP code." %}}
3232

@@ -126,11 +126,11 @@ The archive top directory, named `wlsdeploy`, contains a directory named `applic
126126

127127
The application displays important details about the WebLogic Server instance that it's running on: namely its domain name, cluster name, and server name, as well as the names of any data sources that are targeted to the server. Also, you can see that application output reports that it's at version `v1`; you will update this to `v2` in a later use case that demonstrates upgrading the application.
128128

129-
#### Stage a ZIP file of the archive
129+
#### Stage a WDT archive ZIP file
130130

131-
When you create the image, you will use the files in the staging directory, `/tmp/sample/wdt-artifacts/wdt-model-files/WLS-v1`. In preparation, you need it to contain a ZIP file of the WDT application archive.
131+
When you create the image, you will use the files in the staging directory, `/tmp/sample/wdt-artifacts/wdt-model-files/WLS-v1`. In preparation, you need it to contain a WDT application archive (a ZIP) file.
132132

133-
Run the following commands to create your application archive ZIP file and put it in the expected directory:
133+
Run the following commands to create your WDT application archive ZIP file and put it in the expected directory:
134134

135135
```
136136
# Delete existing archive.zip in case we have an old leftover version
@@ -139,21 +139,21 @@ Run the following commands to create your application archive ZIP file and put i
139139
$ rm -f /tmp/sample/wdt-artifacts/wdt-model-files/WLS-v1/archive.zip
140140
```
141141
```
142-
# Move to the directory which contains the source files for our archive
142+
# Move to the directory which contains the source files for our WDT application archive
143143
```
144144
```shell
145145
$ cd /tmp/sample/wdt-artifacts/archives/archive-v1
146146
```
147147

148-
Using the [WDT archive helper tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/archive_helper/), create the archive in the location that we will use later when we run the WebLogic Image Tool.
148+
Using the [WDT archive helper tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/archive_helper/), create the WDT archive in the location that we will use later when we run the WebLogic Image Tool.
149149

150150
```shell
151151
$ /tmp/sample/wdt-artifacts/weblogic-deploy/bin/archiveHelper.sh add application -archive_file=/tmp/sample/wdt-artifacts/wdt-model-files/WLS-v1/archive.zip -source=wlsdeploy/applications/myapp-v1
152152
```
153153

154-
#### Stage the model files
154+
#### Stage the WDT model YAML files
155155

156-
In this step, you explore the staged WDT model YAML file and properties in the `/tmp/sample/wdt-artifacts/wdt-model-files/WLS-v1` directory. The model in this directory references the web application in your archive, configures a WebLogic Server Administration Server, and configures a WebLogic cluster. It consists of two files only, `model.10.properties`, a file with a single property, and, `model.10.yaml`, a YAML file with your WebLogic configuration `model.10.yaml`.
156+
In this step, you explore the staged WDT model YAML file and WDT variables file in the `/tmp/sample/wdt-artifacts/wdt-model-files/WLS-v1` directory. The WDT model YAML file in this directory references the web application in your WDT archive ZIP file, configures a WebLogic Administration Server, and configures a WebLogic cluster. It consists of two files only, `model.10.properties`, a WDT variable file with a single property, and, `model.10.yaml`, a WDT model YAML file with your WebLogic configuration `model.10.yaml`.
157157

158158
```
159159
CLUSTER_SIZE=5
@@ -270,7 +270,7 @@ resources:
270270
{{% /expand %}}
271271

272272

273-
The model files:
273+
The WDT model YAML files:
274274

275275
- Define a WebLogic domain with:
276276
- Cluster `cluster-1`
@@ -279,15 +279,15 @@ The model files:
279279
- A Work Manager `SampleWM` configured with minimum threads constraint `SampleMinThreads` and maximum threads constraint `SampleMaxThreads`
280280

281281
- Use macros to inject external values:
282-
- The property file `CLUSTER_SIZE` property is referenced in the model YAML file `DynamicClusterSize` and `MaxDynamicClusterSize` fields using a PROP macro.
283-
- The model file domain name is injected using a custom environment variable named `CUSTOM_DOMAIN_NAME` using an ENV macro.
282+
- The WDT variables file `CLUSTER_SIZE` property is referenced in the WDT model YAML file `DynamicClusterSize` and `MaxDynamicClusterSize` fields using a PROP macro.
283+
- The WDT model YAML file domain name is injected using a custom environment variable named `CUSTOM_DOMAIN_NAME` using an ENV macro.
284284
- You set this environment variable later in this sample using an `env` field in its Domain.
285-
- _This conveniently provides a simple way to deploy multiple differently named domains using the same model image._
286-
- The model file administrator user name and password are set using a `weblogic-credentials` secret macro reference to the WebLogic credential secret.
285+
- _This conveniently provides a simple way to deploy multiple differently named domains using the same domain creation image._
286+
- The WDT model YAML file administrator user name and password are set using a `weblogic-credentials` secret macro reference to the WebLogic credential secret.
287287
- This secret is in turn referenced using the `webLogicCredentialsSecret` field in the Domain.
288288
- The `weblogic-credentials` is a reserved name that always dereferences to the owning Domain actual WebLogic credentials secret name.
289289

290-
An image can contain multiple properties files, archive ZIP files, and YAML files but in this sample you use just one of each. For a complete description of WDT model file naming conventions, file loading order, and macro syntax, see [Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}) in the user documentation.
290+
An image can contain multiple WDT variables files, WDT archive ZIP files, and WDT model YAML files but in this sample you use just one of each. For a complete description of WDT model YAML file naming conventions, file loading order, and macro syntax, see [Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}) in the user documentation.
291291

292292
#### Create the image with WIT
293293

@@ -322,7 +322,7 @@ This command runs the WebLogic Image Tool to create the image and does the follo
322322
- Copies the WDT ZIP file that's referenced in the WIT cache into the image.
323323
- Note that you cached WDT in WIT using the keyword `latest` when you set up the cache during the sample prerequisites steps.
324324
- This lets WIT implicitly assume it's the desired WDT version and removes the need to pass a `-wdtVersion` flag.
325-
- Copies the specified WDT model, properties, and application archives to image location `/u01/wdt/models`.
325+
- Copies the specified WDT model YAML, WDT variables, and WDT application archive ZIP files to image location `/auxiliary/models`.
326326

327327
When the command succeeds, it should end with output like the following:
328328
```
@@ -332,7 +332,7 @@ When the command succeeds, it should end with output like the following:
332332
Also, if you run the `docker images` command, then you will see an image named `wdt-domain-image:WLS-v1`.
333333

334334
After the image is created, it should have the WDT executables in
335-
`/auxiliary/weblogic-deploy`, and WDT model, property, and archive
335+
`/auxiliary/weblogic-deploy`, and WDT model YAML, WDT variables, and WDT archive ZIP
336336
files in `/auxiliary/models`. You can run `ls` in the Docker
337337
image to verify this:
338338

documentation/4.1/content/samples/domains/domain-home-on-pv/prerequisites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ To do this, follow the same steps as the [Quick Start](https://oracle.github.io/
147147
148148
### Additional prerequisites for JRF domains
149149
150-
**NOTE**: If you're using a WLS domain type, skip this section and continue on to [Build the domain creation image]({{< relref "/samples/domains/domain-home-on-pv/build-domain-creation-image.md" >}})
150+
**NOTE**: If you're using a Domain on PV WLS domain type, skip this section and continue on to [Build the domain creation image]({{< relref "/samples/domains/domain-home-on-pv/build-domain-creation-image.md" >}})
151151
for the Domain on PV sample.
152152
153153
#### JRF prerequisites

0 commit comments

Comments
 (0)