Skip to content

Commit 9f237cd

Browse files
add note for create-domain.sh (#2367)
* add note for create-domain.sh
1 parent a8cf40d commit 9f237cd

File tree

6 files changed

+51
-43
lines changed

6 files changed

+51
-43
lines changed

documentation/staging/content/quickstart/create-domain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ weight: 6
2626

2727
The script's behavior is controlled by an inputs file plus command-line options. The script downloads the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) and [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) and uses these tools to create a new image with a domain home. The script also creates a domain resource YAML file that references the image, and, if the `-e` option is specified, deploys the domain resource to Kubernetes. For a detailed understanding of the steps that the `create-domain.sh` script performs for you, see the bulleted items under [Use the script to create a domain]({{< relref "/samples/simple/domains/domain-home-in-image/#use-the-script-to-create-a-domain" >}})
2828
29-
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes only. In production, we strongly recommend that you use the WebLogic Image Tool and directly work with domain resource files instead.
29+
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes _only_; its contents and the domain resource file that it generates for you might change without notice. In production, we strongly recommend that you use the WebLogic Image Tool and WebLogic Deploy Tooling (when applicable), and directly work with domain resource files instead.
3030
{{% /notice%}}
3131
3232
First, copy the sample [create-domain-inputs.yaml](http://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain-inputs.yaml) file and update your copy with:
@@ -52,7 +52,7 @@ weight: 6
5252
{{% /notice %}}
5353
5454
For the detailed steps that the `create-domain.sh` script performs, see [Domain Home In Image]({{< relref "/samples/simple/domains/domain-home-in-image/_index.md" >}}).
55-
55+
5656
5757
1. Confirm that the operator started the servers for the domain:
5858

documentation/staging/content/samples/simple/azure-kubernetes-service/domain-on-pv.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,9 @@ weblogic-operator-secrets Opaque
144144
##### Create WebLogic Domain
145145
We will use the `kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain.sh` script to create the WLS domain in the persistent volume we created previously.
146146

147+
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes _only_; its contents and the domain resource file that it generates for you might change without notice. In production, we strongly recommend that you use the WebLogic Image Tool and WebLogic Deploy Tooling (when applicable), and directly work with domain resource files instead.
148+
{{% /notice%}}
149+
147150
We need to set up the domain configuration for the WebLogic domain.
148151

149152
1. Check if resources are ready.

documentation/staging/content/samples/simple/domains/domain-home-in-image/_index.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -56,44 +56,46 @@ $ ./create-domain.sh \
5656
-i create-domain-inputs.yaml \
5757
-o /<path to output-directory>
5858
```
59+
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes _only_; its contents and the domain resource file that it generates for you might change without notice. In production, we strongly recommend that you use the WebLogic Image Tool and WebLogic Deploy Tooling (when applicable), and directly work with domain resource files instead.
60+
{{% /notice%}}
5961

6062
The script will perform the following steps:
6163

6264
* Create a directory for the generated properties and Kubernetes YAML files for this domain if it does not already exist. The pathname is `/<path to output-directory>/weblogic-domains/<domainUID>`. If the directory already exists, its contents will be removed.
6365

64-
* Create a properties file, `domain.properties`, in the directory that is created above.
66+
* Create a properties file, `domain.properties`, in the directory that is created above.
6567
This properties file will be used to create a sample WebLogic Server domain.
6668
The `domain.properties` file will be removed upon successful completion of the script.
6769

6870
* Download the latest [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling) (WDT) and [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) installer ZIP files to your `/tmp/dhii-sample/tools` directory.
6971
WIT is required to create your Domain in Image container images, and WDT is required if using `wdt` mode.
7072
Visit the GitHub [WebLogic Deploy Tooling Releases](https://github.com/oracle/weblogic-deploy-tooling/releases) and [WebLogic Image Tool Releases](https://github.com/oracle/weblogic-image-tool/releases) web pages to determine the latest release version for each.
7173

72-
* Set up the WebLogic Image Tool in the `<toolsDir>/imagetool` directory, where `<toolsDir>` is the
74+
* Set up the WebLogic Image Tool in the `<toolsDir>/imagetool` directory, where `<toolsDir>` is the
7375
directory specified in the `toolsDir` parameter in the inputs YAML file. Set the
7476
WIT cache store location to the `<tools>/imagetool-cache` directory and
7577
put a `wdt_<WDT_VERSION>` entry in the tool's cache, which points to the path of the WDT ZIP file installer.
7678
For more information about the WIT cache, see the
7779
[WIT Cache documentation](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/).
7880

79-
* If the optional `-n` option and an encryption key is provided, invoke the WDT
81+
* If the optional `-n` option and an encryption key is provided, invoke the WDT
8082
[Encrypt Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/encrypt/)
81-
in a container running the image specified in `domainHomeImageBase` parameter in your inputs file
83+
in a container running the image specified in `domainHomeImageBase` parameter in your inputs file
8284
to encrypt the password properties in `domain.properties` file. Note that this password encryption
83-
step is skipped if the value of the `mode` parameter in the inputs YAML file is `wlst` because
85+
step is skipped if the value of the `mode` parameter in the inputs YAML file is `wlst` because
8486
the feature is provided by WDT.
8587

86-
* Invoke the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool) to create a
87-
new WebLogic Server domain based on the WebLogic image specified in the `domainHomeImageBase` parameter
88+
* Invoke the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool) to create a
89+
new WebLogic Server domain based on the WebLogic image specified in the `domainHomeImageBase` parameter
8890
from your inputs file. The new WebLogic Server domain is created using one of the
8991
following options based on the value of the `mode` parameter in the inputs YAML file:
9092
* If the value of the `mode` parameter is `wdt`, the WDT model specified in the `createDomainWdtModel`
9193
parameter and the WDT variables in `domain.properties` file are used by the WebLogic Image Tool to create
9294
the new WebLogic Server domain.
9395
* If the value of the `mode` parameter is `wlst`, the offline WLST
9496
script specified in the `createDomainWlstScript` parameter is run to create the new WebLogic Server domain.
95-
96-
* The generated image is tagged with the `image` parameter provided in your inputs file.
97+
98+
* The generated image is tagged with the `image` parameter provided in your inputs file.
9799

98100
{{% notice warning %}}
99101
Oracle strongly recommends storing the image containing the domain home as private
@@ -498,7 +500,3 @@ By default, they are installed under `/tmp/dhii-sample/tools` directory.
498500
```shell
499501
$ rm -rf /tmp/dhii-sample/tools/
500502
```
501-
502-
503-
504-

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ $ ./create-domain.sh \
5151
-i create-domain-inputs.yaml \
5252
-o /<path to output-directory>
5353
```
54+
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes _only_; its contents and the domain resource file that it generates for you might change without notice. In production, we strongly recommend that you use the WebLogic Image Tool and WebLogic Deploy Tooling (when applicable), and directly work with domain resource files instead.
55+
{{% /notice%}}
5456

5557
The script will perform the following steps:
5658

documentation/staging/content/samples/simple/domains/fmw-domain-home-in-image/_index.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ description: "Sample for creating an FMW Infrastructure domain home inside an im
77

88

99
The sample scripts demonstrate the creation of a FMW Infrastructure domain home in an image using
10-
[WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT).
11-
The sample scripts have the option of putting the WebLogic domain log, server logs, server output files,
12-
and the Node Manager logs on an existing Kubernetes PersistentVolume (PV) and PersistentVolumeClaim (PVC).
10+
[WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT).
11+
The sample scripts have the option of putting the WebLogic domain log, server logs, server output files,
12+
and the Node Manager logs on an existing Kubernetes PersistentVolume (PV) and PersistentVolumeClaim (PVC).
1313
The scripts also generate the domain resource YAML file, which can then be used by the scripts or used manually
1414
to start the Kubernetes artifacts of the corresponding domain, including the WebLogic Server pods and services.
1515

@@ -20,8 +20,8 @@ Before you begin, read this document, [Domain resource]({{< relref "/userguide/m
2020
The following prerequisites must be met prior to running the create domain script:
2121

2222
* Make sure the WebLogic Kubernetes Operator is running.
23-
* The operator requires an image with either FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0.
24-
For details on how to obtain or create the image, refer to
23+
* The operator requires an image with either FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0.
24+
For details on how to obtain or create the image, refer to
2525
[FMW Infrastructure domains]({{< relref "/userguide/managing-fmw-domains/fmw-infra/#obtaining-the-fmw-infrastructure-image" >}}).
2626
* Create a Kubernetes Namespace for the domain unless you intend to use the default namespace.
2727
* If `logHomeOnPV` is enabled, create the Kubernetes PersistentVolume where the log home will be hosted, and the Kubernetes PersistentVolumeClaim for the domain in the same Kubernetes Namespace. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/simple/storage/_index.md" >}}).
@@ -38,10 +38,10 @@ The sample for creating domains is in this directory:
3838
```shell
3939
$ cd kubernetes/samples/scripts/create-fmw-infrastructure-domain/domain-home-in-image
4040
```
41-
Make a copy of the `create-domain-inputs.yaml` file, update it with the correct values.
41+
Make a copy of the `create-domain-inputs.yaml` file, update it with the correct values.
4242
If `fwmDomainType` is `JRF`, also update the input files with configurations for accessing the RCU database schema,
4343
including `rcuSchemaPrefix`, `rcuSchemaPassword`, `rcuDatabaseURL`, and `rcuCredentialSecrets`.
44-
Run the create script, pointing it at your inputs file and an output directory, along with user name and password for the WebLogic administrator,
44+
Run the create script, pointing it at your inputs file and an output directory, along with user name and password for the WebLogic administrator,
4545
and if creating a JFR FMW domain, also provide the password for the RCU schema:
4646

4747
```shell
@@ -52,18 +52,20 @@ $ ./create-domain.sh \
5252
-i create-domain-inputs.yaml \
5353
-o /<path to output-directory>
5454
```
55+
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes _only_; its contents and the domain resource file that it generates for you might change without notice. In production, we strongly recommend that you use the WebLogic Image Tool and WebLogic Deploy Tooling (when applicable), and directly work with domain resource files instead.
56+
{{% /notice%}}
5557

5658
The script will perform the following steps:
5759

5860
* Create a directory for the generated Kubernetes YAML files for this domain if it does not
5961
already exist. The path name is `/<path to output-directory>/weblogic-domains/<domainUID>`.
6062
If the directory already exists, its contents must be removed before using this script.
6163

62-
* Create a properties file, `domain.properties`, in the directory that is created above.
63-
This properties file will be used to create a sample FMW Infrastructure domain.
64+
* Create a properties file, `domain.properties`, in the directory that is created above.
65+
This properties file will be used to create a sample FMW Infrastructure domain.
6466
The `domain.properties` file will be removed upon successful completion of the script.
6567

66-
* Download the latest [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT) and [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) installer ZIP files to your `/tmp/dhii-sample/tools` directory.
68+
* Download the latest [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT) and [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) installer ZIP files to your `/tmp/dhii-sample/tools` directory.
6769
WIT is required to create your Domain in Image container images, and WDT is required if using `wdt` mode.
6870
Visit the GitHub [WebLogic Deploy Tooling Releases](https://github.com/oracle/weblogic-deploy-tooling/releases) and [WebLogic Image Tool Releases](https://github.com/oracle/weblogic-image-tool/releases) web pages to determine the latest release version for each.
6971

@@ -74,23 +76,23 @@ The script will perform the following steps:
7476
For more information about the WIT cache, see the
7577
[WIT Cache documentation](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/).
7678

77-
* If the optional `-n` option and an encryption key is provided, invoke the WDT
79+
* If the optional `-n` option and an encryption key is provided, invoke the WDT
7880
[Encrypt Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/encrypt/)
79-
in a container running the image specified in `domainHomeImageBase` parameter in your inputs file
81+
in a container running the image specified in `domainHomeImageBase` parameter in your inputs file
8082
to encrypt the password properties in `domain.properties` file. Note that this password encryption
81-
step is skipped if the value of the `mode` parameter in the inputs YAML file is `wlst` because
83+
step is skipped if the value of the `mode` parameter in the inputs YAML file is `wlst` because
8284
the feature is provided by WDT.
83-
84-
* Invoke the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) to create a new
85-
FWM Infrastructure domain based on the FMW Infrastructure image specified in the `domainHomeImageBase`
86-
parameter from your inputs file. The new WebLogic Server domain is created using one of the
85+
86+
* Invoke the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) to create a new
87+
FWM Infrastructure domain based on the FMW Infrastructure image specified in the `domainHomeImageBase`
88+
parameter from your inputs file. The new WebLogic Server domain is created using one of the
8789
following options based on the value of the `mode` parameter in the inputs YAML file:
88-
* If the value of the `mode` parameter is `wdt`, the WDT model specified in the `createDomainWdtModel`
90+
* If the value of the `mode` parameter is `wdt`, the WDT model specified in the `createDomainWdtModel`
8991
parameter and the WDT variables in `domain.properties` file are used by the WebLogic Image Tool to create
9092
the new WebLogic Server domain.
91-
* If the value of the `mode` parameter is `wlst`, the offline WLST
93+
* If the value of the `mode` parameter is `wlst`, the offline WLST
9294
script specified in the `createDomainWlstScript` parameter is run to create the new WebLogic Server domain.
93-
95+
9496
* The generated image is tagged with the `image` parameter provided in your inputs file.
9597

9698
{{% notice warning %}}
@@ -245,11 +247,11 @@ spec:
245247
246248
# Identify which Secret contains the credentials for pulling an image
247249
#imagePullSecrets:
248-
#- name:
250+
#- name:
249251
250252
# Identify which Secret contains the WebLogic Admin credentials (note that there is an example of
251253
# how to create that Secret at the end of this file)
252-
webLogicCredentialsSecret:
254+
webLogicCredentialsSecret:
253255
name: fmwdomain-weblogic-credentials
254256
255257
# Whether to include the server out file into the pod's stdout, default is true
@@ -336,7 +338,7 @@ spec:
336338
# Istio
337339
# configuration:
338340
# istio:
339-
# enabled:
341+
# enabled:
340342
# readinessPort:
341343
```
342344
@@ -375,7 +377,7 @@ Spec:
375377
Server Pod:
376378
Env:
377379
Name: USER_MEM_ARGS
378-
Value: -Djava.security.egd=file:/dev/./urandom -Xms512m -Xmx1024m
380+
Value: -Djava.security.egd=file:/dev/./urandom -Xms512m -Xmx1024m
379381
Server Start State: RUNNING
380382
Clusters:
381383
Cluster Name: cluster-1
@@ -405,7 +407,7 @@ Spec:
405407
Name: JAVA_OPTIONS
406408
Value: -Dweblogic.StdoutDebugEnabled=false
407409
Name: USER_MEM_ARGS
408-
Value: -Djava.security.egd=file:/dev/./urandom -Xms256m -Xmx1024m
410+
Value: -Djava.security.egd=file:/dev/./urandom -Xms256m -Xmx1024m
409411
Server Start Policy: IF_NEEDED
410412
Web Logic Credentials Secret:
411413
Name: fmwdomain-weblogic-credentials

documentation/staging/content/samples/simple/domains/fmw-domain/_index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Before you begin, read this document, [Domain resource]({{< relref "/userguide/m
2020
The following prerequisites must be met prior to running the create domain script:
2121

2222
* Make sure the WebLogic Kubernetes Operator is running.
23-
* The operator requires an image with either FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0.
24-
For details on how to obtain or create the image, refer to
23+
* The operator requires an image with either FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0.
24+
For details on how to obtain or create the image, refer to
2525
[FMW Infrastructure domains]({{< relref "/userguide/managing-fmw-domains/fmw-infra/#obtaining-the-fmw-infrastructure-image" >}}).
2626
* Create a Kubernetes Namespace for the domain unless you intend to use the default namespace.
2727
* In the same Kubernetes Namespace, create the Kubernetes PersistentVolume (PV) where the domain
@@ -37,7 +37,7 @@ The following prerequisites must be met prior to running the create domain scrip
3737
* Unless you are creating a Restricted-JRF domain, you also need to:
3838
* Configure access to your database. For details, see [here]({{< relref "/userguide/managing-fmw-domains/fmw-infra/_index.md#configuring-access-to-your-database" >}}).
3939
* Create a Kubernetes Secret with the RCU credentials. For details, refer to this [document](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-rcu-credentials/README.md).
40-
40+
4141
#### Use the script to create a domain
4242

4343
The sample for creating domains is in this directory:
@@ -54,6 +54,9 @@ $ ./create-domain.sh \
5454
-o /<path to output-directory>
5555
```
5656

57+
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes _only_; its contents and the domain resource file that it generates for you might change without notice. In production, we strongly recommend that you use the WebLogic Image Tool and WebLogic Deploy Tooling (when applicable), and directly work with domain resource files instead.
58+
{{% /notice%}}
59+
5760
The script will perform the following steps:
5861

5962
* Create a directory for the generated Kubernetes YAML files for this domain if it does not

0 commit comments

Comments
 (0)