Skip to content

Commit 395e9a8

Browse files
committed
Merge branch 'pv-domain-simplify-doc-update-withsample-new' of orahub.oci.oraclecorp.com:weblogic-cloud/weblogic-kubernetes-operator into pv-domain-simplify-doc-update-withsample-new
2 parents 3c246f9 + 27cc6aa commit 395e9a8

File tree

6 files changed

+54
-61
lines changed

6 files changed

+54
-61
lines changed

documentation/4.1/content/managing-domains/domain-on-pv/domain-creation-images.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ title = "Domain creation images"
33
date = 2019-02-23T16:45:16-05:00
44
weight = 25
55
pre = "<b> </b>"
6-
description = "Domain creation images supply the WDT models for Domain on PV."
6+
description = "Domain creation images supply the WDT model for Domain on PV."
77
+++
88

99
{{< table_of_contents >}}
1010

1111
### Introduction
1212

13-
Domain creation images are used for supplying model files, variable files,
14-
application archive files, and WebLogic Deploy Tooling (WDT) installation files when deploying a domain using
15-
a Domain on PV model. You will distribute model files, application archives, and the
16-
WebLogic Deploy Tooling executable using these images. Then, the operator uses WDT and WDT models to
13+
Domain creation images are used for supplying WebLogic Deploy Tooling (WDT) model files, WDT variables files,
14+
WDT application archive files (collectively known as WDT model files), and WDT installation files when deploying a domain using
15+
a Domain on PV model. You distribute WDT model files and the
16+
WDT executable using these images, then the operator uses them to
1717
manage the domain.
1818

1919
**Note:** These images are _only_ used for creating the domain and will not be used to update the domain.
@@ -27,7 +27,7 @@ which defaults to `Always` if the `image` ends in `:latest` and `IfNotPresent`,
2727
otherwise.
2828
If image pull secrets are required for pulling the images, then the secrets must be referenced using `domain.spec.imagePullSecrets`.
2929

30-
Also, optionally, you can configure the [source locations](#source-locations) of the WebLogic Deploy Tooling model
30+
Also, optionally, you can configure the [source locations](#source-locations) of the WDT model
3131
and installation files in the image using the `sourceModelHome` and `sourceWDTInstallHome` fields, as described in this
3232
[section](#source-locations).
3333

@@ -37,7 +37,7 @@ and installation files in the image using the `sourceModelHome` and `sourceWDTIn
3737

3838
### References
3939

40-
- Run the ` kubectl explain domain.spec.configuration.initializeDomainOnPV.domain.domainCreationImages` command or
40+
- Run the ` kubectl explain domain.spec.configuration.initializeDomainOnPV.domain.domainCreationImages` command, or
4141

4242
- See the `initializeDomainOnPV.domain.domainCreationImages` section
4343
in the domain resource
@@ -46,13 +46,13 @@ and installation files in the image using the `sourceModelHome` and `sourceWDTIn
4646

4747
#### Source locations
4848

49-
Use the optional attributes `sourceModelHome` and
50-
`sourceWdtInstallHome` to specify non-default locations for the
51-
WebLogic Deploy Tooling model and installation files in your domain creation image(s).
49+
Use the optional attributes, `sourceModelHome` and
50+
`sourceWdtInstallHome`, to specify non-default locations for the
51+
WDT model and installation files in your domain creation image(s).
5252
Allowed values for `sourceModelHome` and `sourceWdtInstallHome`:
5353
- Unset - Defaults to `/auxiliary/models` and `/auxiliary/weblogic-deploy`, respectively.
5454
- Set to a path - Must point to an existing location containing WDT model and WDT installation files, respectively.
55-
- `None` - Indicates that the image has no WDT models files and installation files, respectively.
55+
- `None` - Indicates that the image has no WDT model files and installation files, respectively.
5656

5757
If you set the `sourceModelHome` or `sourceWDTInstallHome` to `None` or,
5858
the source attributes are left unset and there are no files at the default locations,
@@ -68,8 +68,8 @@ For example source locations, see [Configuration example 2](#example-2-source-lo
6868

6969
#### Multiple images
7070

71-
If specifying multiple images with model files in their respective `sourceModelHome`
72-
directories, then model files are merged. Files from later images take precedence over files from earlier images.
71+
If specifying multiple images with WDT model files in their respective `sourceModelHome`
72+
directories, then WDT model files are merged. Files from later images take precedence over files from earlier images.
7373

7474
When specifying multiple images, ensure that only one of the images supplies a WDT installation location using
7575
`sourceWDTInstallHome`.
@@ -100,7 +100,7 @@ spec:
100100

101101
#### Example 2: Source locations
102102

103-
This example is the same as Example 1, except that it specifies the source locations for the WebLogic Deploy Tooling model and installation files.
103+
This example is the same as Example 1, except that it specifies the source locations for the WDT model and installation files.
104104

105105
```
106106
spec:
@@ -117,7 +117,7 @@ spec:
117117

118118
This example is the same as Example 1, except it configures multiple images and sets the `sourceWDTInstallHome`
119119
for the second image to `None`.
120-
In this case, the source location of the WebLogic Deploy Tooling installation from the second image `wdt-model-image2:v1` will be ignored.
120+
In this case, the source location of the WDT installation from the second image `wdt-model-image2:v1` will be ignored.
121121

122122
```
123123
spec:

documentation/4.1/content/managing-domains/domain-on-pv/overview.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ description = "Learn how to create a domain on a persistent volume."
1010

1111
### Overview
1212

13-
Domain on persistent volume (Domain on PV) is one of the operator's [domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}) choices.
14-
Domain on PV requires that the domain home exists on a persistent volume. The domain home can be created either manually
13+
Domain on persistent volume (Domain on PV) is an operator [domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}),
14+
which requires that the domain home exists on a persistent volume. The domain home can be created either manually
1515
or automatically by specifying the section, `domain.spec.configuration.initializeDomainOnPV`, in the domain resource YAML file.
1616
The initial domain topology and resources are described using [WebLogic Deploy Tooling (WDT) models](#weblogic-deploy-tooling-models).
1717

1818
**NOTE**: The `initializeDomainOnPV` section provides a **one time only** domain home initialization.
1919
The operator creates the domain when the domain resource is first deployed. After the domain is created,
2020
this section is ignored. Subsequent domain life cycle updates must be controlled by
21-
the WebLogic Server Administration Console, WebLogic Scripting Tool (WLST), or other mechanisms. See the [High level use case](#high-level-use-case).
21+
the WebLogic Server Administration Console, the WebLogic Remote Console, WebLogic Scripting Tool (WLST), or other mechanisms. See the [High level use case](#high-level-use-case).
2222

2323
The `initializeDomainOnPv` section:
2424

@@ -33,14 +33,14 @@ The typical Domain on PV use case is for an application life cycle that requires
3333
For example, you might use frameworks like Meta Data Service (MDS), Oracle Application Development Framework (ADF), or Oracle Service Bus (OSB).
3434
These frameworks require a running domain and the lifecycle operations are persisted to the file system. Typically,
3535
after the initial domain is created, you use tools like Fusion Middleware Control, product-specific WLST functions,
36-
the WebLogic Server Administration Console, the Service Bus Console, or JDeveloper for lifecycle operations. The changes are managed by
36+
the WebLogic Server Administration Console, the WebLogic Remote Console, the Service Bus Console, or JDeveloper for lifecycle operations. The changes are managed by
3737
these tools; the data and operations _cannot_ be described using WDT models.
3838

3939
### WebLogic Deploy Tooling models
4040

4141
WDT models are a convenient and simple alternative to WLST
4242
configuration scripts and templates.
43-
They compactly define a WebLogic domain using model files, variable property files, and application archive files.
43+
They compactly define a WebLogic domain using model files, variable properties files, and application archive files.
4444
For more information about the model format
4545
and its integration,
4646
see [Usage]({{< relref "/managing-domains/domain-on-pv/usage.md" >}})
@@ -54,16 +54,16 @@ When you deploy a Domain on PV domain resource YAML file:
5454

5555
- The operator will run a Kubernetes Job, called an introspector job, that:
5656
- Merges your WDT model files.
57-
- Runs WDT Create Domain tool to create a domain home.
57+
- Runs the WDT Create Domain Tool to create a domain home.
5858

5959
- After the introspector job completes:
60-
- The operator creates one or more ConfigMap following the pattern `DOMAIN_UID-weblogic-domain-introspect-cm***`.
60+
- The operator creates one or more ConfigMaps following the pattern `DOMAIN_UID-weblogic-domain-introspect-cm***`.
6161
- The operator subsequently boots your domain's WebLogic Server pods.
6262

6363
### Runtime updates
6464

6565
You control runtime updates to the WebLogic domain configuration using tools, such as Fusion Middleware Control, product-specific WLST functions,
66-
the WebLogic Server Administration Console, the Service Bus Console, the WebLogic Remote Console or the JDeveloper. After the initial domain is created, subsequent updates to the
66+
the WebLogic Server Administration Console, the WebLogic Remote Console, the Service Bus Console, or JDeveloper. After the initial domain is created, subsequent updates to the
6767
source of the WDT model files or any referenced macros _will be ignored_.
6868

6969
Some changes may require triggering an introspector job. For example:

documentation/4.1/content/managing-domains/domain-on-pv/usage.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ WebLogic domain.
2323

2424
To use this feature, provide the following information:
2525

26-
- [WebLogic base image](#weblogic-base-image) - This is the Fusion Middleware Software to be used. For example, WebLogic Server or Fusion Middleware Infrastructure.
26+
- [WebLogic base image](#weblogic-base-image) - This is the Fusion Middleware Software to be used, for example, WebLogic Server or Fusion Middleware Infrastructure.
2727
- [Volumes and VolumeMounts information](#volumes-and-volumemounts-information) - This follows the standard Kubernetes pod requirements for mounting persistent volumes.
2828
- [PersistentVolume and PersistentVolumeClaim](#persistent-volume-and-persistent-volume-claim) - This is environment specific and usually requires assistance from your administrator to provide the underlying details, such as `storageClass` or any permissions.
2929
- [Domain information](#domain-information) - This describes the domain type and whether the operator should create the RCU schema.
@@ -32,13 +32,12 @@ To use this feature, provide the following information:
3232
- [Domain resource YAML file]({{< relref "/reference/domain-resource.md">}}) - This is for deploying the domain in WebLogic Kubernetes Operator.
3333

3434

35-
- For details about each field,
36-
- See the `initializeDomainOnPV` section
35+
For details about each field, see the `initializeDomainOnPV` section
3736
in the domain resource
3837
[schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md),
39-
or use the command `kubectl explain domain.spec.configuration.initializeDomainOnPV`
38+
or use the command `kubectl explain domain.spec.configuration.initializeDomainOnPV`.
4039

41-
- For a basic configuration example, see [Basic configuration](#basic-configuration).
40+
For a basic configuration example, see [Basic configuration](#basic-configuration).
4241

4342
#### WebLogic base image
4443

@@ -67,7 +66,7 @@ Specify an image that describes the domain topology, resources, and applications
6766
| `domainCreationImages` | WDT domain images. | An array of images. | Y |
6867

6968
In this image or images, you must provide the required WDT installer [binaries](https://github.com/oracle/weblogic-deploy-tooling/releases),
70-
and also the WDT model files, WDT variable files, and WDT archives files. The operator will use them to create the initial domain.
69+
and also the WDT model files, WDT variables files, and WDT archive files. The operator will use them to create the initial domain.
7170

7271
For additional options in `domainCreationImages`, use the following command to obtain the details.
7372

@@ -84,7 +83,7 @@ The image layout follows this directory structure:
8483

8584
You can create your own image using your familiar method or use the [WebLogic Image Tool (WIT)](https://github.com/oracle/weblogic-image-tool).
8685

87-
For example, because the file structure is the same as an [Auxiliary Image]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}) that's used in the Model in Image domain home type, you can
86+
For example, because the file structure is the same as an [Auxiliary Image]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}) that's used in the Model in Image domain home source type, you can
8887
use the same WIT command `createAuxImage`.
8988

9089
```
@@ -97,7 +96,7 @@ $ imagetool.sh createAuxImage --wdtArchive /home/acme/myapp/wdt/myapp.zip \
9796

9897
#### Optional WDT models ConfigMap
9998

100-
Optionally, you can provide a Kubernetes ConfigMap with additional WDT models and WDT variable files as supplements or overrides to
99+
Optionally, you can provide a Kubernetes ConfigMap with additional WDT models and WDT variables files as supplements or overrides to
101100
those in `domainCreationImages`.
102101

103102
```
@@ -110,7 +109,7 @@ those in `domainCreationImages`.
110109

111110
| Field | Notes | Values | Required |
112111
|---------------------------|-------------------------------------------------------|------------------------------------|----------|
113-
| `domainCreationConfigMap` | Optional WDT models and WDT varaible files in ConfigMap. | ConfigMap name. | N |
112+
| `domainCreationConfigMap` | Optional WDT models and WDT variables files in ConfigMap. | ConfigMap name. | N |
114113

115114
The files inside this ConfigMap must have file extensions, `.yaml`, `.properties`, or `.zip`.
116115

@@ -188,10 +187,9 @@ spec:
188187
| `persistentVolumeClaim` | Specification of the persistent volume claim if the operator is creating it. | Specification of the persistent volume claim if you want operator to create it. | N (operator will not create any persistent volume claim) |
189188
190189
191-
Not all the fields in the standard Kubernetes PV and PVC are supported. For the list of supported fields in `persistentVolume` and `persistentVolumeClaim`, see
192-
- See the `initializeDomainOnPV.peristentVolume` and `initializeDomainOnPV.peristentVolumeClaim` section
190+
Not all the fields in the standard Kubernetes PV and PVC are supported. For the list of supported fields in `persistentVolume` and `persistentVolumeClaim`, see the `initializeDomainOnPV.peristentVolume` and `initializeDomainOnPV.peristentVolumeClaim` section
193191
in the domain resource
194-
[schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md), or use the commands
192+
[schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md), or use the commands:
195193
```
196194
kubectl explain domain.spec.configuration.initializeDomainOnPV.persistentVolume
197195
kubectl explain domain.spec.configuration.initializeDomainOnPV.persistentVolumeClaim
@@ -212,7 +210,7 @@ to specify any `persistentVolume` or `persistentVolumeClaim` under the `intiali
212210
213211
For JRF-based domains, before proceeding, please be sure to read this document, [JRF domains]({{< relref "/managing-domains/working-with-wdt-models/jrf-domain.md">}}).
214212
215-
This is the section describing the WebLogic domain. For example,
213+
This is the section describing the WebLogic domain. For example:
216214
217215
```
218216
spec:

documentation/4.1/content/managing-domains/model-in-image/overview.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,21 @@ description = "Introduction to Model in Image, description of its runtime behavi
1010

1111
### Introduction
1212

13-
Model in Image is an alternative to the operator's Domain in Image and Domain in PV domain types. See [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}) for a comparison of operator domain types.
14-
15-
Unlike Domain in PV and Domain in Image, Model in Image eliminates the need to pre-create your WebLogic domain home prior to deploying your Domain YAML file.
13+
Model in Image is an alternative to the operator's Domain in Image and Domain on PV domain home source types. For a comparison, see [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}). Unlike Domain on PV and Domain in Image, Model in Image eliminates the need to pre-create your WebLogic domain home prior to deploying your Domain YAML file.
1614

1715
It enables:
1816

1917
- Defining a WebLogic domain home configuration using WebLogic Deploy Tooling (WDT) model files and application archives.
2018
- Embedding these files in a single image that also contains a WebLogic installation,
2119
and using the WebLogic Image Tool (WIT) to generate this image. Or, alternatively,
22-
embedding the files in one or more application specific images.
20+
embedding the files in one or more application-specific images.
2321
- Optionally, supplying additional model files using a Kubernetes ConfigMap.
2422
- Supplying Kubernetes Secrets that resolve macro references within the models.
2523
For example, a secret can be used to supply a database credential.
26-
- Updating WDT model files and artifacts at runtime. The WDT models are considered the source of truth and matches the domain configuration at all time. For example, you can add a data source
24+
- Updating WDT model files at runtime. The WDT models are considered the source of truth and match the domain configuration at all times. For example, you can add a data source
2725
to a running domain. See [Runtime updates](#runtime-updates) for details.
2826

29-
This feature is supported for standard WLS domains.
30-
31-
For JRF domains, use [Domain on PV]({{< relref "/managing-domains/domain-on-pv/overview.md" >}}).
27+
This feature is supported for standard WLS domains. For JRF domains, use [Domain on PV]({{< relref "/managing-domains/domain-on-pv/overview.md" >}}).
3228

3329
### WebLogic Deploy Tooling models
3430

@@ -52,8 +48,7 @@ When you deploy a Model in Image domain resource YAML file:
5248
- Packages the domain home and passes it to the operator.
5349

5450
- After the introspector job completes:
55-
- The operator creates a ConfigMap named `DOMAIN_UID-weblogic-domain-introspect-cm`
56-
(possibly with some additional maps distinguished by serial names) and puts the packaged domain home in it.
51+
- The operator creates one or more ConfigMaps following the pattern `DOMAIN_UID-weblogic-domain-introspect-cm***`.
5752
- The operator subsequently boots your domain's WebLogic Server pods.
5853
- The pods will obtain their domain home from the ConfigMap.
5954

0 commit comments

Comments
 (0)