Skip to content

Commit e6dc77d

Browse files
ankediaankedia
committed
Merge remote-tracking branch 'origin/pv-domain-simplify-withsample-doc-update-4.1' into pv-domain-simplify-doc-update-withsample-new
2 parents 442e6a9 + 3927cec commit e6dc77d

File tree

65 files changed

+3663
-1803
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+3663
-1803
lines changed

‎documentation/4.1/content/managing-domains/accessing-the-domain/ingress/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Information about how to install and configure these ingress controllers to load
7070
- [NGINX guide](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/kubernetes/samples/charts/nginx/README.md)
7171

7272
{{% notice note %}}
73-
For production environments, we recommend NGINX, Traefik (2.2.1 or later) ingress controllers or the load balancer provided by your cloud provider.
73+
For production environments, we recommend NGINX, Traefik (2.2.1 or later) ingress controllers, and Apache webtier or the load balancer provided by your cloud provider.
7474
{{% /notice %}}
7575

7676
Samples are also provided for the Traefik ingress controller, showing how to manage multiple WebLogic clusters as the backends, using different routing rules, host-routing and path-routing; and TLS termination: [Traefik samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/kubernetes/samples/charts/traefik/samples).

‎documentation/4.1/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/4.1/content/managing-domains/choosing-a-model/_index.md

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

‎documentation/4.1/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/4.1/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/4.1/content/managing-domains/domain-on-pv/domain-creation-images.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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 artifacts for Domain on PV."
7+
+++
8+
9+
{{< table_of_contents >}}
10+
11+
### Introduction
12+
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 artifacts 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 WDT artifacts 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 the WebLogic Deploy Tooling model
31+
and installation files in the image 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 of
51+
WebLogic Deploy Tooling model and installation files in your 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 WDT model and installation files, respectively.
55+
- `None` - Indicates that the image has no WDT models or installation files, 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 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.
75+
76+
When specifying multiple images, ensure that only one of the images supplies a WDT installation location using
77+
`sourceWDTInstallHome`.
78+
{{% notice warning %}}
79+
If you provide more than one WDT installation home among multiple images,
80+
then the domain deployment will fail.
81+
Set `sourceWDTInstallHome` to `None`, or make sure there are no files in `/auxiliary/weblogic-deploy`,
82+
for all but one of your specified domain creation images.
83+
{{% /notice %}}
84+
85+
For an example of configuring multiple images, see [Configuration example 3](#example-3-multiple-images).
86+
87+
### Configuration examples
88+
89+
The following configuration examples illustrate each of the previously described sections.
90+
91+
#### Example 1: Basic configuration
92+
93+
This example specifies the image location; all other fields are at default values.
94+
95+
```
96+
spec:
97+
configuration:
98+
initializeDomainOnPV:
99+
domainCreationImages:
100+
- image: wdt-model-image:v1
101+
```
102+
103+
#### Example 2: Source locations
104+
105+
This example is the same as Example 1, except that it specifies the source locations for the WebLogic Deploy Tooling model and installation files.
106+
107+
```
108+
spec:
109+
configuration:
110+
configuration:
111+
initializeDomainOnPV:
112+
domainCreationImages:
113+
- image: wdt-model-image:v1
114+
sourceModelHome: /foo/models
115+
sourceWDTInstallHome: /bar/weblogic-deploy
116+
```
117+
118+
#### Example 3: Multiple images
119+
120+
This example is the same as Example 1, except it configures multiple images and sets the `sourceWDTInstallHome`
121+
for the second image to `None`.
122+
In this case, the source location of the WebLogic Deploy Tooling installation from the second image `wdt-model-image2:v1` will be ignored.
123+
124+
```
125+
spec:
126+
configuration:
127+
initializeDomainOnPV:
128+
domainCreationImages:
129+
- image: wdt-model-image:v1
130+
- image: wdt-model-image2:v1
131+
sourceWDTInstallHome: None
132+
```

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

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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 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
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 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).
22+
23+
The `initializeDomainOnPv` section:
24+
25+
- 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.
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 Meta Data Service (MDS), Oracle Application Development Framework (ADF), or Oracle Service Bus (OSB).
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 Service Bus 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 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
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 artifacts.
57+
- Runs WDT tooling to generate a domain home.
58+
59+
- 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).
62+
- The operator subsequently boots your domain's WebLogic Server pods.
63+
64+
### Runtime updates
65+
66+
You control runtime updates to the WebLogic domain configuration using tools, such as Fusion Middleware Control, product-specific WLST functions,
67+
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_.
69+
70+
Some changes may require triggering an introspector job. For example:
71+
72+
- After you change the WebLogic domain credential in the WebLogic Server Administration Console, in the domain resource YAML file, you must:
73+
74+
- Update the credentials in `domain.spec.webLogicCredentialsSecret`.
75+
- Update the value of `domain.spec.introspectVersion`.
76+
77+
- If you change any WebLogic domain topology, such as using the WebLogic Server Administration Console to add clusters or servers, you must:
78+
79+
- Update the value of `domain.spec.introspectVersion` in the domain resource YAML file.
80+
- 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)