Skip to content

Commit 7293f3d

Browse files
doxiaorjeberhard
authored andcommitted
Improve readme and inputs comments for custom create domain scripts
Signed-off-by: doxiao <[email protected]>
1 parent 389214b commit 7293f3d

File tree

2 files changed

+33
-10
lines changed

2 files changed

+33
-10
lines changed

kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ The following parameters can be provided in the inputs file.
7474
| `adminServerName` | Name of the Administration Server. | `admin-server` |
7575
| `clusterName` | Name of the WebLogic cluster instance to generate for the domain. | `cluster-1` |
7676
| `configuredManagedServerCount` | Number of Managed Server instances to generate for the domain. | `5` |
77-
| `createDomainFilesDir` | Directory to get all the create domain scripts and supporting files, including the script that is specified by the `createDomainScriptName` property. By default, this directory is set to the relative path `wlst`, and the create script will use the built-in WLST offline scripts in the `wlst` directory to create the WebLogic domain. It can also be set to the relative path `wdt`, and then the built-in WDT scripts will be used instead. An absolute path is also supported to point to an arbitrary directory in the file system. | `wlst` |
78-
| `createDomainScriptsMountPath` | Mount path of the directory where the create domain scripts are located inside the pod. | `/u01/weblogic` |
79-
| `createDomainScriptName` | Script that creates the domain. | `create-domain-job.sh` |
77+
| `createDomainFilesDir` | Directory on the host machine to locate all the files to create a WebLogic domain, including the script that is specified in the `createDomainScriptName` property. By default, this directory is set to the relative path `wlst`, and the create script will use the built-in WLST offline scripts in the `wlst` directory to create the WebLogic domain. It can also be set to the relative path `wdt`, and then the built-in WDT scripts will be used instead. An absolute path is also supported to point to an arbitrary directory in the file system. The built-in scripts can be replaced by the user-provided scripts or model files as long as those files are in the specified directory. Files in this directory are put into a Kubernetes config map, which in turn is mounted to the `createDomainScriptsMountPath`, so that the Kubernetes pod can use the scripts and supporting files to creates a domain home. | `wlst` |
78+
| `createDomainScriptsMountPath` | Mount path where the create domain scripts are located inside a pod. The `create-domain.sh` script creates a Kubernetes job to run the script (specified in the `createDomainScriptName` property) in a Kubernetes pod to create a domain home. Files in the `createDomainFilesDir` directory are mounted to this location in the pod, so that the Kubernetes pod can use the scripts and supporting files to creates a domain home. | `/u01/weblogic` |
79+
| `createDomainScriptName` | Script that the create domain script uses to create a WebLogic domain. The `create-domain.sh` script creates a Kubernetes job to run this script to create a domain home. The script is located in the in-pod directory that is specified in the `createDomainScriptsMountPath` property. If you need to provide your own scripts, instead of using the built-it scripts, to create the domain home, you need to set here the name of the script that you want the create domain job to run. | `create-domain-job.sh` |
8080
| `domainHome` | Home directory of the WebLogic domain. If not specified, the value is derived from the `domainUID` as `/shared/domains/<domainUID>`. | `/shared/domains/domain1` |
8181
| `domainPVMountPath` | Mount path of the domain persistent volume. | `/shared` |
8282
| `domainUID` | Unique ID that will be used to identify this particular domain. Used as the name of the generated WebLogic domain as well as the name of the Kubernetes domain resource. This ID must be unique across all domains in a Kubernetes cluster. This ID cannot contain any character that is not valid in a Kubernetes service name. | `domain1` |

kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain-inputs.yaml

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2018, Oracle Corporation and/or its affiliates. All rights reserved.
1+
# Copyright 2018,2019, Oracle Corporation and/or its affiliates. All rights reserved.
22
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
33

44
# The version of this inputs file. Do not modify.
@@ -97,14 +97,37 @@ persistentVolumeClaimName: domain1-weblogic-sample-pvc
9797
# Mount path of the domain persistent volume.
9898
domainPVMountPath: /shared
9999

100-
# Mount path of the directory where the create domain scripts are located inside the pod
100+
# Mount path where the create domain scripts are located inside a pod
101+
#
102+
# The `create-domain.sh` script creates a Kubernetes job to run the script (specified in the
103+
# `createDomainScriptName` property) in a Kubernetes pod to create a WebLogic home. Files
104+
# in the `createDomainFilesDir` directory are mounted to this location in the pod, so that
105+
# a Kubernetes pod can use the scripts and supporting files to creates a domain home.
101106
createDomainScriptsMountPath: /u01/weblogic
102107

103-
# Script that creates the domain.
108+
# Script that the create domain script uses to create a WebLogic domain
109+
#
110+
# The `create-domain.sh` script creates a Kubernetes job to run this script to create a
111+
# domain home. The script is located in the in-pod directory that is specified in the
112+
# `createDomainScriptsMountPath` property.
113+
#
114+
# If you need to provide your own scripts, instead of using the built-it scripts, to create
115+
# the domain home, you need to set here the name of the script that you want the create
116+
# domain job to run.
104117
createDomainScriptName: create-domain-job.sh
105118

106-
# Directory to get all the create domain scripts and supporting files, including
107-
# the script that is specified by the createDomainScriptName property.
108-
# The default is the "wlst" subdirectory under the directory where the
109-
# create-domain.sh script is located.
119+
# Directory on the host machine to locate all the files to create a WebLogic domain
120+
# It contains the script that is specified in the `createDomainScriptName` property.
121+
#
122+
# By default, this directory is set to the relative path `wlst`, and the create script will
123+
# use the built-in WLST offline scripts in the `wlst` directory to create the WebLogic domain.
124+
# It can also be set to the relative path `wdt`, and then the built-in WDT scripts will be
125+
# used instead.
126+
#
127+
# An absolute path is also supported to point to an arbitrary directory in the file system.
128+
#
129+
# The built-in scripts can be replaced by the user-provided scripts or model files as long
130+
# as those files are in the specified directory. Files in this directory are put into a
131+
# Kubernetes config map, which in turn is mounted to the `createDomainScriptsMountPath`,
132+
# so that the Kubernetes pod can use the scripts and supporting files to creates a domain home.
110133
createDomainFilesDir: wlst

0 commit comments

Comments
 (0)