Skip to content

Commit ced9fcd

Browse files
robertpatrickrobertpatrick
committed
Merge branch 'dopv-doc-updates' into 'main'
4.1.0 - Changes to the Domain on PV user guide and samples documentation for both Domain on PV and Model in Image See merge request weblogic-cloud/weblogic-kubernetes-operator!4299
2 parents a6468b7 + 062f986 commit ced9fcd

File tree

37 files changed

+2680
-3425
lines changed

37 files changed

+2680
-3425
lines changed

‎documentation/site/content/managing-domains/aks/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ After clicking **Create** to create this offer, you will go to the **Deployment
309309
| `clusterT3ExternalEndpoint` | This output is not always present:{{< line_break >}}1. You must [create/update the WLS cluster with advanced configuration](https://oracle.github.io/weblogic-azure/aks/).{{< line_break >}}2. You must enable custom T3 channel by setting `enableClusterT3Tunneling=true`.{{< line_break >}}3. You must configure [Networking](#networking) to enable the Azure Load Balancer service for the WLS cluster.{{< line_break >}}{{< line_break >}}This is a fully qualified, public link to custom T3 channel of the WLS cluster.{{< line_break >}}Sample value:`http://20.4.56.3:8005/` |
310310
| `shellCmdtoConnectAks` | AZ CLI command to connect to the AKS cluster.{{< line_break >}}Sample value: {{< line_break >}}`az account set --subscription xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx; az aks get-credentials --resource-group contoso-rg --name contosoakscluster`|
311311
| `shellCmdtoOutputWlsDomainYaml` | Shell command to display the base64 encoded string of the WLS domain resource definition.{{< line_break >}}Sample value: {{< line_break >}}`echo -e YXBpV...mVCg== \| base64 -d > domain.yaml` |
312-
| `shellCmdtoOutputWlsImageModelYaml` | Shell command to display the base64 encoded string of the WLS [image model]({{< relref "/managing-domains/model-in-image/model-files.md" >}}).{{< line_break >}}Sample value:{{< line_break >}}`echo -e IyBDb...3EnC \| base64 -d > model.yaml`|
312+
| `shellCmdtoOutputWlsImageModelYaml` | Shell command to display the base64 encoded string of the WLS [image model]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).{{< line_break >}}Sample value:{{< line_break >}}`echo -e IyBDb...3EnC \| base64 -d > model.yaml`|
313313
| `shellCmdtoOutputWlsImageProperties`|Shell command to display the base64 encoded string of the model properties.{{< line_break >}}Sample value:{{< line_break >}}`echo -e IyBDF...PTUK \| base64 -d > model.properties` |
314314
| `shellCmdtoOutputWlsVersionsandPatches` | Shell command to display the base64 encoded string of the WLS version and patches.{{< line_break >}}Sample value:{{< line_break >}}`echo -e CldlY...gMS4= \| base64 -d > version.info`|
315315

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

Lines changed: 22 additions & 23 deletions
Large diffs are not rendered by default.

‎documentation/site/content/managing-domains/cicd/tools.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,6 @@ Other than the tools themselves, there are three components to the WDT tools:
4242

4343
#### WDT Create Domain Samples
4444

45-
- (Kubernetes) A sample of creating a domain in an image with WDT
46-
can be found in the WebLogic Kubernetes Operator project for creating a
47-
[domain-in-image with WDT]({{< relref "/samples/domains/domain-home-in-image/" >}}).
4845
- (Kubernetes) A [Model in Image sample]({{< relref "/samples/domains/model-in-image/_index.md" >}})
4946
for supplying an image that contains a WDT model only,
5047
instead of a domain home. In this case, the operator generates the domain

‎documentation/site/content/managing-domains/configoverrides/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The behavior when using an unsupported override is undefined.
121121

122122
The operator generates the final configuration overrides, combining customer-provided configuration overrides and operator-generated overrides, during the operator's introspection phase. These overrides are then used when starting or restarting WebLogic Server instances. Starting with operator version 3.0.0, these [overrides can also be distributed]({{< relref "/managing-domains/domain-lifecycle/introspection/_index.md#distributing-changes-to-configuration-overrides" >}}) and applied to already running WebLogic Server instances.
123123

124-
For [Domain on PV]({{< relref "/managing-domains/domain-lifecycle/restarting/_index.md#domain-in-pv" >}}), the ability to change WebLogic domain configuration using traditional management transactions involving the Administration Console or WLST can be combined with the ability to initiate a repeat introspection and distribute updated configuration overrides. This combination supports use cases such as defining a new WebLogic cluster and then immediately starting Managed Server cluster members.
124+
For [Domain on PV]({{< relref "/managing-domains/domain-lifecycle/restarting/_index.md#domain-on-pv" >}}), the ability to change WebLogic domain configuration using traditional management transactions involving the Administration Console or WLST can be combined with the ability to initiate a repeat introspection and distribute updated configuration overrides. This combination supports use cases such as defining a new WebLogic cluster and then immediately starting Managed Server cluster members.
125125

126126
---
127127
### Override template names and syntax

‎documentation/site/content/managing-domains/domain-on-pv/_index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
+++
2+
title = "Domain on Persistent Volume (PV)"
3+
date = 2020-03-11T16:45:16-05:00
4+
weight = 6
5+
pre = "<b> </b>"
6+
description = "Create and deploy a typical domain on PV."
7+
+++
8+
9+
{{% children style="h4" description="true" %}}

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

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
+++
2+
title = "Domain creation images"
3+
date = 2019-02-23T16:45:16-05:00
4+
weight = 25
5+
pre = "<b> </b>"
6+
description = "Domain creation images supply the WDT model for Domain on PV."
7+
+++
8+
9+
{{< table_of_contents >}}
10+
11+
### Introduction
12+
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 the directory where the WebLogic Deploy Tooling software is installed (known as the WDT Home)
15+
when deploying a domain using a Domain on PV model. You distribute WDT model files and the
16+
WDT executable using these images, then the operator uses them to
17+
manage the domain.
18+
19+
**Note:** These images are _only_ used for creating the domain and will not be used to update the domain.
20+
21+
### Configuration
22+
23+
You can configure one or more domain creation images in a domain resource.
24+
25+
Optionally, you can set the `imagePullPolicy`,
26+
which defaults to `Always` if the `image` ends in `:latest` and `IfNotPresent`,
27+
otherwise.
28+
If image pull secrets are required for pulling the images, then the secrets must be referenced using `domain.spec.imagePullSecrets`.
29+
30+
Also, optionally, you can configure the [source locations](#source-locations) of WDT model files and WDT Home
31+
using the `sourceModelHome` and `sourceWDTInstallHome` fields, as described in this
32+
[section](#source-locations).
33+
34+
- For details about each field, see the [References](#references).
35+
36+
- For a basic configuration example, see [Configuration example 1](#example-1-basic-configuration).
37+
38+
### References
39+
40+
- Run the ` kubectl explain domain.spec.configuration.initializeDomainOnPV.domain.domainCreationImages` command, or
41+
42+
- See the `initializeDomainOnPV.domain.domainCreationImages` section
43+
in the domain resource
44+
[schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md).
45+
46+
47+
#### Source locations
48+
49+
Use the optional attributes, `sourceModelHome` and
50+
`sourceWdtInstallHome`, to specify non-default locations for the
51+
WDT model files and WDT Home in your domain creation image(s).
52+
Allowed values for `sourceModelHome` and `sourceWdtInstallHome`:
53+
- Unset - Defaults to `/auxiliary/models` and `/auxiliary/weblogic-deploy`, respectively.
54+
- Set to a path - Must point to an existing location containing the WDT model files and WDT Home, respectively.
55+
- `None` - Indicates that the image has no WDT model files or WDT Home, respectively.
56+
57+
If you set the `sourceModelHome` or `sourceWDTInstallHome` to `None` or,
58+
the source attributes are left unset and there are no files at the default locations,
59+
then the operator will ignore the source directories. Otherwise,
60+
note that if you set a source directory attribute to a specific value
61+
and there are no files in the specified directory in the domain creation image,
62+
then the domain deployment will fail.
63+
64+
The files in `sourceModelHome` and `sourceWDTInstallHome` directories will be made available in `/aux/models`
65+
and `/aux/weblogic-deploy` directories of the WebLogic Server container in all pods, respectively.
66+
67+
For example source locations, see [Configuration example 2](#example-2-source-locations).
68+
69+
#### Multiple images
70+
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.
73+
74+
When specifying multiple images, ensure that only one of the images supplies a WDT Home using
75+
`sourceWDTInstallHome`.
76+
{{% notice warning %}}
77+
If you provide more than one WDT Home among multiple images,
78+
then the domain deployment will fail.
79+
Set `sourceWDTInstallHome` to `None`, or make sure there are no files in `/auxiliary/weblogic-deploy`,
80+
for all but one of your specified domain creation images.
81+
{{% /notice %}}
82+
83+
For an example of configuring multiple images, see [Configuration example 3](#example-3-multiple-images).
84+
85+
### Configuration examples
86+
87+
The following configuration examples illustrate each of the previously described sections.
88+
89+
#### Example 1: Basic configuration
90+
91+
This example specifies the image location; all other fields are at default values.
92+
93+
```
94+
spec:
95+
configuration:
96+
initializeDomainOnPV:
97+
domainCreationImages:
98+
- image: wdt-model-image:v1
99+
```
100+
101+
#### Example 2: Source locations
102+
103+
This example is the same as Example 1, except that it specifies the source locations for the WDT model files and WDT Home.
104+
105+
```
106+
spec:
107+
configuration:
108+
configuration:
109+
initializeDomainOnPV:
110+
domainCreationImages:
111+
- image: wdt-model-image:v1
112+
sourceModelHome: /foo/models
113+
sourceWDTInstallHome: /bar/weblogic-deploy
114+
```
115+
116+
#### Example 3: Multiple images
117+
118+
This example is the same as Example 1, except it configures multiple images and sets the `sourceWDTInstallHome`
119+
for the second image to `None`.
120+
In this case, the source location of the WDT installation from the second image `wdt-model-image2:v1` will be ignored.
121+
122+
```
123+
spec:
124+
configuration:
125+
initializeDomainOnPV:
126+
domainCreationImages:
127+
- image: wdt-model-image:v1
128+
- image: wdt-model-image2:v1
129+
sourceWDTInstallHome: None
130+
```

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
+++
2+
title = "Overview"
3+
date = 2023-04-26T16:45:16-05:00
4+
weight = 1
5+
pre = "<b> </b>"
6+
description = "Learn how to create a domain on a persistent volume."
7+
+++
8+
9+
{{< table_of_contents >}}
10+
11+
### Overview
12+
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
15+
or automatically by specifying the section, `domain.spec.configuration.initializeDomainOnPV`, in the domain resource YAML file.
16+
The initial domain topology and resources are described using [WebLogic Deploy Tooling (WDT) models](#weblogic-deploy-tooling-models).
17+
18+
**NOTE**: The `initializeDomainOnPV` section provides a **one time only** domain home initialization.
19+
The operator creates the domain when the domain resource is first deployed. After the domain is created,
20+
this section is ignored. Subsequent domain lifecycle updates must be controlled by
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).
22+
23+
The `initializeDomainOnPv` section:
24+
25+
- Creates the PersistentVolume (PV) and/or PersistenVolumeClaim (PVC), if needed.
26+
- Creates the RCU schema, if needed.
27+
- Creates the WebLogic domain home on the persistent volume based on the provided WDT models.
28+
29+
### High level use case
30+
31+
The typical Domain on PV use case is for an application life cycle that requires persisting changes to the permanent file system.
32+
33+
For example, you might use frameworks like Metadata Services (MDS), Oracle Application Development Framework (ADF), or Oracle Web Services Manager (OWSM).
34+
These frameworks require a running domain and the lifecycle operations are persisted to the file system. Typically,
35+
after the initial domain is created, you use tools like Fusion Middleware Control, product-specific WLST functions,
36+
the WebLogic Server Administration Console, the WebLogic Remote Console, or JDeveloper for lifecycle operations. The changes are managed by
37+
these tools; the data and operations _cannot_ be described using WDT models.
38+
39+
### WebLogic Deploy Tooling models
40+
41+
WDT models are a convenient and simple alternative to WLST
42+
configuration scripts.
43+
They compactly define a WebLogic domain using model files, variable properties files, and application archive files.
44+
For more information about the model format
45+
and its integration,
46+
see [Usage]({{< relref "/managing-domains/domain-on-pv/usage.md" >}})
47+
and [Working with WDT Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).
48+
The WDT model format is fully described in the open source,
49+
[WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project.
50+
51+
### Runtime behavior
52+
53+
When you deploy a Domain on PV domain resource YAML file:
54+
55+
- The operator will run a Kubernetes Job, called an introspector job, that:
56+
- Merges your WDT model files.
57+
- Runs the WDT Create Domain Tool to create a domain home.
58+
59+
- After the introspector job completes:
60+
- The operator creates one or more ConfigMaps following the pattern `DOMAIN_UID-weblogic-domain-introspect-cm***`.
61+
- The operator subsequently boots your domain's WebLogic Server pods.
62+
63+
### Runtime updates
64+
65+
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 WebLogic Remote Console, or JDeveloper. After the initial domain is created, subsequent updates to the
67+
source of the WDT model files or any referenced macros _will be ignored_.
68+
69+
Some changes may require triggering an introspector job. For example:
70+
71+
- After you change the WebLogic domain credential in the WebLogic Server Administration Console, in the domain resource YAML file, you must:
72+
73+
- Update the credentials in `domain.spec.webLogicCredentialsSecret`.
74+
- Update the value of `domain.spec.introspectVersion`.
75+
76+
- If you change any WebLogic domain topology, such as using the WebLogic Server Administration Console to add clusters or servers, you must:
77+
78+
- Update the value of `domain.spec.introspectVersion` in the domain resource YAML file.
79+
- Optionally, if you want to fine tune their life cycle or replica counts, then update the domain resource YAML file to add the new clusters or servers.

0 commit comments

Comments
 (0)