Skip to content

Commit 6dc1226

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 2ac06a5 + d3731de commit 6dc1226

File tree

9 files changed

+41
-43
lines changed

9 files changed

+41
-43
lines changed

documentation/4.1/content/managing-domains/choosing-a-model/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ When using the operator to start WebLogic Server instances from a domain, you ha
4141
- **[Domain on PV]({{< relref "/samples/domains/domain-home-on-pv/_index.md" >}})**:
4242
- Set the domain resource `domain.spec.domainHomeSourceType` attribute to `PersistentVolume`.
4343
- Supply a WebLogic installation in an image and supply a WebLogic configuration as a domain home in a persistent volume.
44-
- Optionally supply domain resource `domain.spec.configuration.initialDomainOnPV` section to provide information for the Operator to create the initial domain home.
44+
- Optionally supply the domain resource `domain.spec.configuration.initialDomainOnPV` section to provide information for the Operator to create the initial domain home.
4545
- Supply WebLogic applications in the persistent volume.
46-
- Update the WebLogic configuration using WLST, or WebLogic Server Administration Console.
46+
- Update the WebLogic configuration using WLST, or the WebLogic Server Administration Console.
4747
- Optionally use [configuration overrides]({{< relref "/managing-domains/configoverrides/_index.md" >}})
48-
supplied in a Kubernetes ConfigMap. Use this only if WLST, or WebLogic Server Administration Console does not fit your deployment strategy.
48+
supplied in a Kubernetes ConfigMap. Use this only if WLST, or the WebLogic Server Administration Console does not fit your deployment strategy.
4949

5050
Note that you can use different domain home types for different domains; there's no restriction on having domains with different domain home types in the same Kubernetes cluster or namespace.
5151

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ 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 artifacts for Domain on PV."
6+
description = "Domain creation images supply the WDT models for Domain on PV."
77
+++
88

99
{{< table_of_contents >}}
@@ -13,14 +13,14 @@ description = "Domain creation images supply the WDT artifacts for Domain on PV.
1313
Domain creation images are used for supplying model files, variable files,
1414
application archive files, and WebLogic Deploy Tooling (WDT) installation files when deploying a domain using
1515
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 artifacts to
16+
WebLogic Deploy Tooling executable using these images. Then, the operator uses WDT and WDT models 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.
2020

2121
### Configuration
2222

23-
You can configure one or more WDT artifacts images in a domain resource.
23+
You can configure one or more domain creation images in a domain resource.
2424

2525
Optionally, you can set the `imagePullPolicy`,
2626
which defaults to `Always` if the `image` ends in `:latest` and `IfNotPresent`,
@@ -47,12 +47,12 @@ and installation files in the image using the `sourceModelHome` and `sourceWDTIn
4747
#### Source locations
4848

4949
Use the optional attributes `sourceModelHome` and
50-
`sourceWdtInstallHome` to specify non-default locations of
51-
WebLogic Deploy Tooling model and installation files in your image(s).
50+
`sourceWdtInstallHome` to specify non-default locations for the
51+
WebLogic Deploy Tooling 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.
54-
- Set to a path - Must point to an existing location containing WDT model and installation files, respectively.
55-
- `None` - Indicates that the image has no WDT models or installation files, respectively.
54+
- 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.
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,
@@ -69,9 +69,7 @@ For example source locations, see [Configuration example 2](#example-2-source-lo
6969
#### Multiple images
7070

7171
If specifying multiple images with model files in their respective `sourceModelHome`
72-
directories, then model files are merged.
73-
The operator will merge the model files from multiple images in the same order in which images appear under `model.auxiliaryImages` or `domain.domainCreationImages`.
74-
Files from later images take precedence over files from earlier images.
72+
directories, then model files are merged. Files from later images take precedence over files from earlier images.
7573

7674
When specifying multiple images, ensure that only one of the images supplies a WDT installation location using
7775
`sourceWDTInstallHome`.

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ the WebLogic Server Administration Console, WebLogic Scripting Tool (WLST), or o
2323
The `initializeDomainOnPv` section:
2424

2525
- Creates the PersistentVolume (PV) and/or PersistenVolumeClaim (PVC), if needed.
26-
- Creates the JRF schema, if needed.
27-
- Creates the WebLogic domain home, based on the provided WDT models on the persistent volume.
26+
- Creates the RCU schema, if needed.
27+
- Creates the WebLogic domain home on the persistent volume based on the provided WDT models.
2828

2929
### High level use case
3030

@@ -40,8 +40,8 @@ these tools; the data and operations _cannot_ be described using WDT 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 YAML files and support including
44-
application archives in a ZIP file. For more information about the model format
43+
They compactly define a WebLogic domain using model files, variable properties files, and application archives files.
44+
For more information about the model format
4545
and its integration,
4646
see [Usage]({{< relref "/managing-domains/domain-on-pv/usage.md" >}})
4747
and [Working with WDT Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).
@@ -53,19 +53,18 @@ The WDT model format is fully described in the open source,
5353
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:
56-
- Merges your WDT artifacts.
57-
- Runs WDT tooling to generate a domain home.
56+
- Merges your WDT model files.
57+
- Runs WDT Create Domain tool to create a domain home.
5858

5959
- After the introspector job completes:
60-
- The operator creates a ConfigMap named `DOMAIN_UID-weblogic-domain-introspect-cm`
61-
(possibly with some additional maps distinguished by serial names).
60+
- The operator creates one or more ConfigMap following the pattern `DOMAIN_UID-weblogic-domain-introspect-cm***`.
6261
- The operator subsequently boots your domain's WebLogic Server pods.
6362

6463
### Runtime updates
6564

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

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

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ To use this feature, provide the following information:
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.
30-
- [Domain WDT artifacts](#domain-creation-wdt-artifacts) - This is where the WDT binaries, WDT model, WDT archive, and WDT variables files reside.
31-
- [Optional WDT artifacts ConfigMap](#optional-wdt-artifacts-configmap) - Optional, WDT model, WDT variables files.
30+
- [Domain WDT models](#domain-creation-models) - This is where the WDT binaries, WDT model, WDT archive, and WDT variables files reside.
31+
- [Optional WDT models ConfigMap](#optional-wdt-models-configmap) - Optional, WDT model, WDT variables files.
3232
- [Domain resource YAML file]({{< relref "/reference/domain-resource.md">}}) - This is for deploying the domain with WebLogic Kubernetes Operator.
3333

3434

@@ -42,7 +42,7 @@ To use this feature, provide the following information:
4242

4343
#### WebLogic base image
4444

45-
Because the domain will be created on a persistent volume, the base image should contain only the WebLogic product binary and JDK.
45+
Because the domain will be created on a persistent volume, the base image should contain only the FMW product binary and the JDK.
4646

4747
```
4848
spec:
@@ -52,7 +52,7 @@ spec:
5252
You can specify your own image, use a patched image from `container-registry.oracle.com`, or create and patch an image using the
5353
[WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) (WIT).
5454

55-
#### Domain creation WDT artifacts
55+
#### Domain creation WDT models
5656

5757
Specify an image that describes the domain topology, resources, and applications in the domain resource YAML file.
5858

@@ -66,10 +66,10 @@ Specify an image that describes the domain topology, resources, and applications
6666
|---------------------------|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------------------|
6767
| `domainCreationImages` | WDT domain images. | An array of images. | Y |
6868

69-
In this image or images, you must provide the required WDT [binaries](https://github.com/oracle/weblogic-deploy-tooling/releases),
70-
and also the WDT artifacts. The operator will use the tool and the WDT artifacts to create the initial domain.
69+
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.
7171

72-
For additional options in `domainCreationImages`, use the follow command to obtain the details.
72+
For additional options in `domainCreationImages`, use the following command to obtain the details.
7373

7474
```
7575
kubectl explain domain.spec.configuration.initializeDomainOnPV.domain.domainCreationImages
@@ -78,7 +78,7 @@ kubectl explain domain.spec.configuration.initializeDomainOnPV.domain.domainCrea
7878
The image layout follows this directory structure:
7979

8080
```
81-
/auxiliary/weblogic-delpoy - Unzipped WebLogic Deploy Tooling release file.
81+
/auxiliary/weblogic-deploy - Extracted WebLogic Deploy Tooling installer file.
8282
/auxiliary/models - WDT model, WDT archive, and WDT variables files.
8383
```
8484

@@ -95,9 +95,9 @@ $ imagetool.sh createAuxImage --wdtArchive /home/acme/myapp/wdt/myapp.zip \
9595
--tag myrepo/domain-images:v1
9696
```
9797

98-
#### Optional WDT artifacts ConfigMap
98+
#### Optional WDT models ConfigMap
9999

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

103103
```
@@ -108,9 +108,9 @@ those in `domainCreationImages`.
108108
domainCreationConfigMap: mymodel-domain-configmap
109109
```
110110

111-
| Field | Notes | Values | Required |
112-
|---------------------------|--------------------------------------|------------------------------------|----------|
113-
| `domainCreationConfigMap` | Optional WDT artifacts in ConfigMap. | ConfigMap name. | N |
111+
| Field | Notes | Values | Required |
112+
|---------------------------|-------------------------------------------------------|------------------------------------|----------|
113+
| `domainCreationConfigMap` | Optional WDT models and WDT varaible files in ConfigMap. | ConfigMap name. | N |
114114

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ It enables:
2323
- Optionally, supplying additional model files using a Kubernetes ConfigMap.
2424
- Supplying Kubernetes Secrets that resolve macro references within the models.
2525
For example, a secret can be used to supply a database credential.
26-
- Updating WDT model files and artifacts at runtime. The WDT artifacts are considered the source of truth and matches the domain configuration at all time. For example, you can add a data source
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
2727
to a running domain. See [Runtime updates](#runtime-updates) for details.
2828

2929
This feature is supported for standard WLS domains.
@@ -47,7 +47,7 @@ The WDT model format is fully described in the open source,
4747
When you deploy a Model in Image domain resource YAML file:
4848

4949
- The operator will run a Kubernetes Job called the 'introspector job' that:
50-
- Merges your WDT artifacts.
50+
- Merges your WDT models.
5151
- Runs WDT tooling to generate a domain home.
5252
- Packages the domain home and passes it to the operator.
5353

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ to:
6868
must be supplied in the model home because application archives
6969
are not supported in the [optional WDT model ConfigMap](#optional-wdt-model-configmap).
7070

71-
There are multiple methods for supplying Model in Image WDT artifacts:
71+
There are multiple methods for supplying Model in Image WDT models files, WDT variable files, and WDT archives files:
7272

7373
- Use auxiliary images:
7474
Use [auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}})
@@ -87,7 +87,7 @@ There are multiple methods for supplying Model in Image WDT artifacts:
8787

8888
Use either of the following methods.
8989

90-
- _Manual image creation_ uses Docker commands to layer the WDT artifacts, described in the previous table,
90+
- _Manual image creation_ uses Docker commands to layer the WDT models files, WDT variable files, and WDT archives files, described in the previous table,
9191
on top of your base image into a new image.
9292
- The _WebLogic Image Tool_ (WIT) has built-in options for layering WDT model files,
9393
WDT binaries, WebLogic Server binaries, and WebLogic Server patches in an image.
@@ -185,7 +185,7 @@ that are copied from [Auxiliary Images]({{<relref "/managing-domains/model-in-im
185185

186186
**Notes**:
187187

188-
- There are additional attributes that are common to all domain home source types, such as the `image` field. See the Domain Resource [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md) and [documentation]({{< relref "/managing-domains/domain-resource.md" >}}) for a full list of Domain fields.
188+
- There are additional attributes that are common to all domain home source types, such as the `image` or `clusters` field. See the Domain Resource [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md) and [documentation]({{< relref "/managing-domains/domain-resource.md" >}}) for a full list of Domain fields.
189189

190190
- For fully specified Model in Image Domain YAML file examples,
191191
see the [`kubernetes/samples/scripts/create-weblogic-domain/model-in-image/domain-resources`](https://github.com/oracle/weblogic-kubernetes-operator/tree/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/domain-resources) GitHub directory for the [Model in Image sample]({{< relref "/samples/domains/model-in-image/_index.md" >}}).

documentation/4.1/content/managing-domains/working-with-wdt-models/model-files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ For a description of model file macro references to secrets and environment vari
6969

7070
- For most models, it's useful to minimize or eliminate the usage of model variable files (also known as property files) and use secrets or environment variables instead.
7171

72-
- You can control the order that WDT uses to load your model files, see [WDT artifacts source location and loading order](#wdt-artifacts-source-location-and-loading-order).
72+
- You can control the order that WDT uses to load your model files, see [WDT models location and loading order](#wdt-models-source-location-and-loading-order).
7373

74-
### WDT artifacts source location and loading order
74+
### WDT models source location and loading order
7575

7676
Refer to this section if you need to control the order in which your model files are loaded. The order is important when two or more model files refer to the same configuration, because the last model that's loaded has the highest precedence.
7777

documentation/4.1/content/samples/domains/model-in-image/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ WebLogic Deploy Tooling (WDT) model to specify your WebLogic configuration.
1818

1919
WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using model files, variable properties files, and application archives files. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/).
2020

21-
Furthermore, the Model in Image auxiliary image option lets you supply your WDT model files
21+
Furthermore, the Model in Image auxiliary image option lets you supply your WDT models files, WDT variable files, and WDT archives files
2222
in a small separate image separate from your WebLogic image.
2323

2424
For more information on Model in Image, see the [Model in Image]({{< relref "/managing-domains/model-in-image/_index.md" >}}) user guide. For a comparison of Model in Image to other domain home source types, see [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}).

documentation/4.1/content/samples/domains/model-in-image/initial.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ Run the following `kubectl` commands to deploy the required secrets:
8787
Now, you create a Domain YAML file. A Domain is the key resource that tells the operator how to deploy a WebLogic domain.
8888

8989
Copy the contents of the [domain resource YAML file](https://raw.githubusercontent.com/oracle/weblogic-kubernetes-operator/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/domain-resources/WLS/mii-initial-d1-WLS-v1.yaml) file to a file called `/tmp/sample/mii-initial-domain.yaml` or similar. Alternatively, you can use the file `/tmp/sample/domain-resources/WLS-AI/mii-initial-d1-WLS-AI-v1.yaml` that is included in the sample source.
90+
This file contains both the domain resource and the referenced cluster resource definition. See [Domain and Cluster resources]({{< relref "/managing-domains/domain-resource">}}).
9091

9192
Click [here](https://raw.githubusercontent.com/oracle/weblogic-kubernetes-operator/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/domain-resources/WLS/mii-initial-d1-WLS-v1.yaml) to view the Domain YAML file.
9293

0 commit comments

Comments
 (0)