Skip to content

Commit ccd1d60

Browse files
moreautmoreaut
committed
Update the documentation to reflect the new names
1 parent 30da015 commit ccd1d60

11 files changed

+102
-237
lines changed

‎NAME-CHANGES.md

Lines changed: 0 additions & 166 deletions
This file was deleted.

‎README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ In this documentation, several important terms are used and are intended to have
3636
| Secret | A Kubernetes secret is a named object that can store secret information like usernames, passwords, X.509 certificates, or any other arbitrary data. |
3737
|Service | A Kubernetes service exposes application endpoints inside a pod to other pods, or outside the Kubernetes cluster. A service may also provide additional features like load balancing. |
3838

39-
4039
# Getting Started
4140

4241
Before using the operator, it is highly recommended to read the [design philosophy](site/design.md) to develop an understanding of the operator's design, and the [architectural overview](site/architecture.md) to understand its architecture, including how WebLogic domains are deployed in Kubernetes using the operator. It is also worth reading the details of the [Kubernetes RBAC definitions](site/rbac.md) required by the operator.
@@ -192,6 +191,11 @@ Replace `NAMESPACE` with the namespace that the operator is running in.
192191
To remove more than one operator, repeat these steps for each operator namespace.
193192

194193

194+
# Recent Changes
195+
196+
See [Recent changes](site/recent-changes.md) for recent changes to the weblogic operator, including any backwards incompatible changes.
197+
198+
195199
# Developer guide
196200

197201
Developers interested in this project are encouraged to read the [Developer guide](site/developer.md) to learn how to build the project, run tests, and so on. The Developer guide also provides details about the structure of the code, coding standards, and the Asynchronous Call facility used in the code to manage calls to the Kuberentes API.

‎kubernetes/create-weblogic-operator-inputs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ externalOperatorCert:
7272
externalOperatorKey:
7373

7474
# Controls whether or not the operator will start a Java remote debug server on the
75-
# provided port and will suspend execution until a remote debugger has attached.
75+
# provided port and suspend execution until a remote debugger has attached.
7676
# The 'internalDebugHttpPort' property controls the port number inside the Kubernetes
7777
# cluster and the 'externalDebugHttpPort' property controls the port number outside
7878
# the Kubernetes cluster.

‎site/creating-domain.md

Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Creating a WebLogic domain
22

3-
The WebLogic domain must be installed into the folder that will be mounted as `/shared/domain`. The recommended approach is to use the provided `create-domain-job.sh` script; however, instructions are also provided for manually installing and configuring a WebLogic domain (see [Manually creating a domain](manually-creating-domain.md)).
3+
The WebLogic domain must be installed into the folder that will be mounted as `/shared/domain`. The recommended approach is to use the provided `create-weblogic-domain.sh` script; however, instructions are also provided for manually installing and configuring a WebLogic domain (see [Manually creating a domain](manually-creating-domain.md)).
44

55
Note that there is a short video demonstration of the domain creation process available [here](https://youtu.be/Ey7o8ldKv9Y).
66

@@ -89,38 +89,41 @@ For other providers, consult the documentation for the provider for instructions
8989

9090
## Customizing the domain parameters file
9191

92-
The domain is created with the provided installation script (`create-domain-job.sh`). The input to this script is the file `create-domain-job-inputs.yaml`, which needs to be updated to reflect the target environment.
92+
The domain is created with the provided installation script (`create-weblogic-domain.sh`). The input to this script is the file `create-weblogic-domain-inputs.yaml`, which needs to be updated to reflect the target environment.
9393

9494
The following parameters must be provided in the input file:
9595

9696
### CONFIGURATION PARAMETERS FOR THE CREATE DOMAIN JOB
9797

98-
| Parameter | Definition | Default |
98+
| Parameter | Definition | Default |
9999
| --- | --- | --- |
100-
| adminPort | Port number for the Administration Server. | 7001 |
101-
| adminServerName | The name of the Administration Server. | admin-server |
102-
| createDomainScript | Script used to create the domain. This parameter should not be modified. | /u01/weblogic/create-domain-script.sh |
103-
| domainName | Name of the WebLogic domain to create. | base_domain |
104-
| domainUid | Unique ID that will be used to identify this particular domain. This ID must be unique across all domains in a Kubernetes cluster. | domain1 |
105-
| enableLoadBalancerAdminPort | Determines whether the load balancer administration port should be exposed outside the Kubernetes cluster. | false |
106-
| imagePullSecretName | Name of the Kubernetes secret for the Docker Store, used to pull the WebLogic Server image. | docker-store-secret |
107-
| loadBalancerAdminPort | The node port for the load balancer to accept admin requests. | 30315 |
108-
| loadBalancerWebPort | The node port for the load balancer to accept user traffic. | 30305 |
109-
| managedServerCount | Number of Managed Server instances to generate for the domain. | 2 |
110-
| managedServerNameBase | Base string used to generate Managed Server names. | managed-server |
111-
| managedServerPort | Port number for each Managed Server. | 8001 |
112-
| namespace | The Kubernetes namespace to create the domain in. | default |
113-
| persistencePath | Physical path of the persistent volume storage. | /scratch/k8s_dir/persistentVolume001 |
114-
| persistenceSize | Total storage allocated by the persistent volume. | 10Gi |
115-
| persistenceStorageClass | Name of the storage class to set for the persistent volume and persistent volume claim. | weblogic |
116-
| persistenceVolumeClaimName | Name of the Kubernetes persistent volume claim for this domain. | pv001-claim |
117-
| persistenceVolumeName | Name of the Kubernetes persistent volume for this domain. | pv001 |
118-
| productionModeEnabled | Boolean indicating if production mode is enabled for the domain. | true |
119-
| replaceExistingDomain | If set to 'true' the script will remove any data it finds in the persistent volume before creating the new domain. Use with caution. | false |
120-
| secretName | Name of the Kubernetes secret for the Administration Server's username and password. | domain1-weblogic-credentials |
121-
| secretsMountPath | Path for mounting secrets. This parameter should not be modified. | /var/run/secrets-domain1 |
122-
| startupControl | Determines which WebLogic servers will be started up. Legal values are 'NONE', 'ALL', 'ADMIN', 'SPECIFIED', or 'AUTO' | AUTO |
123-
| T3ChannelPort | Port for the T3Channel of the NetworkAccessPoint. | 7002 |
100+
| adminPort | Port number for the Administration Server inside the Kubernetes cluster. | 7001 |
101+
| adminNodePort | Port number of the Administration Server outside the Kubernetes cluster. | 30701 |
102+
| adminServerName | The name of the Administration Server. | admin-server |
103+
| clusterName | The name of WebLogic Cluster instance to generate for the domain. | cluster-1 |
104+
| configuredManagedServerCount | Number of Managed Server instances to generate for the domain. | 2 |
105+
| domainName | Name of the WebLogic domain to create. | base_domain |
106+
| domainUID | Unique ID that will be used to identify this particular domain. This ID must be unique across all domains in a Kubernetes cluster. | no default |
107+
| exposeAdminNodePort | Boolean indicating if the the Administration Server is exposed outside of the Kubernetes cluster. | false |
108+
| exposeAdminT3Channel | Boolean indicating if the T3 admin channel is exposed outside the Kubernetes cluster. | false |
109+
| initialManagedServerReplicas | The number of managed servers to initially start for the domain | 2 |
110+
| javaOptions | Java options for starting the Admin and Managed servers. | -Dweblogic.StdoutDebugEnabled=false |
111+
| loadBalancer | The kind of load balancer to create. Legal values are 'NONE' and 'TRAEFIK'. | TRAEFIK |
112+
| loadBalancerDashboardPort | The node port for the load balancer to accept dashboard traffic. | 30315 |
113+
| loadBalancerWebPort | The node port for the load balancer to accept user traffic. | 30305 |
114+
| managedServerNameBase | Base string used to generate Managed Server names. | managed-server |
115+
| managedServerPort | Port number for each Managed Server. | 8001 |
116+
| namespace | The Kubernetes namespace to create the domain in. | default |
117+
| productionModeEnabled | Boolean indicating if production mode is enabled for the domain. | true |
118+
| startupControl | Determines which WebLogic servers will be started up. Legal values are 'NONE', 'ALL', 'ADMIN', 'SPECIFIED', or 'AUTO' | AUTO |
119+
| t3ChannelPort | Port for the T3Channel of the NetworkAccessPoint. | 30012 |
120+
| t3PublicAddress | Public address for the t3 channel. | kubernetes |
121+
| weblogicCredentialsSecretName | Name of the Kubernetes secret for the Administration Server's username and password. | domain1-weblogic-credentials |
122+
| weblogicDomainStoragePath | Physical path of the storage for the weblogic domain. | no default |
123+
| weblogicDomainStorageSize | Total storage allocated for weblogic domain. | 10Gi |
124+
| weblogicDomainStorageType | Type of storage for the weblogic domain. Legal values are 'NFS' and 'HOST_PATH". | HOST_PATH |
125+
| weblogicDomainStorageNFSServer| The name of ip address of the NFS server for the weblogic domain's storage. | no default |
126+
| weblogicImagePullSecretName | Name of the Kubernetes secret for the Docker Store, used to pull the WebLogic Server image. | docker-store-secret |
124127

125128
## Limitations of the create domain script
126129

@@ -137,13 +140,17 @@ Oracle intends to remove these limitations in a future release.
137140
To execute the script and create a domain, issue the following command:
138141

139142
```
140-
./create-domain-job.sh –i create-domain-job-inputs.yaml
143+
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /scratch/user-projects:
144+
export OUTPUT_DIR="/path/to/weblogic-operator-output-directory"
145+
mkdir -p $OUTPUT_DIR
146+
./create-weblogic-domain.sh –i create-domain-job-inputs.yaml -o $OUTPUT_DIR
141147
```
142148

143149
## What the script does
144150

145151
The script will perform the following steps:
146152

153+
* Create a directory for the generated Kubernetes YAML files for this domain. The pathname is $OUTPUT_DIR/weblogic-domains/<domainUID parameter from create-weblogic-domain-inputs.yaml.
147154
* Create Kubernetes YAML files based on the provided inputs.
148155
* Create a persistent volume for the shared state.
149156
* Create a persistent volume claim for that volume.
@@ -220,7 +227,7 @@ spec:
220227
claimName: domain1-pv001-claim
221228
- name: secrets
222229
secret:
223-
secretName: domain1-weblogic-credentials
230+
weblogicCredentialsSecretName: domain1-weblogic-credentials
224231
225232
(many more lines omitted)
226233
```

0 commit comments

Comments
 (0)