You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/name-changes.md
+95-96Lines changed: 95 additions & 96 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
3
3
The initial version of the WebLogic Server Kubernetes Operator did not use consistent conventions for many customer visible names.
4
4
5
-
We've recently addressed this by:
6
-
*standardizing the names of scripts and input files for creating operators and domains
7
-
*standardizing the input parameter names and values
8
-
*standardizing the names of the generated YAML files
9
-
*requiring that the customer create and specify a directory that the operators' and domains' generated YAML files will be stored in
5
+
We addressed this by:
6
+
*Standardizing the names of scripts and input files for creating operators and domains
7
+
*Standardizing the input parameter names and values
8
+
*Standardizing the names of the generated YAML files
9
+
*Requiring that the customer create and specify a directory that the operators' and domains' generated YAML files will be stored in
10
10
11
11
This changes how operators and domains are created, and also changes the generated artifacts for operators and domains.
12
12
13
-
We're not providing an upgrade tool or backwards compatibility with the previous names. Instead, customers need to use the new script, inputs file and parameter names to recreate their operators and domains.
13
+
We're not providing an upgrade tool or backwards compatibility with the previous names. Instead, customers need to use the new script, inputs file, and parameter names to recreate their operators and domains.
14
14
15
15
This document lists the customer visible naming changes. Also, the WebLogic Server Kubernetes Operator documentation has been updated.
16
16
@@ -22,78 +22,78 @@ The following files are used to create the operator and to create and delete dom
### Generated YAML Files for Operators and Domains
32
32
33
33
The create scripts generate a number of YAML files that are used to configure the corresponding Kubernetes artifacts for the operator and the domains.
34
-
Normally, customers do not use these YAML files. However, customers can look at them. They can also change the operator and domain configuration by editing these files and reapplying them.
34
+
Typically, customers do not use these YAML files. However, customers can look at them. They can also change the operator and domain configuration by editing these files and reapplying them.
35
35
36
36
#### Directory for the Generated YAML Files
37
37
38
-
Previously, these files were placed in the kubernetes directory (e.g. kubernetes/weblogic-operator.yaml). Now, they are placed in per-operator and per-domain directories (since a Kubernetes cluster can have more than one operator and an operator can manage more than one domain).
38
+
Previously, these files were placed in the `kubernetes` directory (for example, `kubernetes/weblogic-operator.yaml`). Now, they are placed in per-operator and per-domain directories (since a Kubernetes cluster can have more than one operator and an operator can manage more than one domain).
39
39
40
-
The customer must create a directory that will parent the per-operator and per-domain directories, and use the -o option to pass the name of that directory to the create script, for example:
The pathname can either be a full path name, or a relative path name. If it's a relative pathname, then it's relative to the directory of the shell invoking the create script.
40
+
The customer must create a directory that will parent the per-operator and per-domain directories, and use the `-o` option to pass the name of that directory to the create script, for example:
The pathname can be either a full path name or a relative path name. If it's a relative pathname, then it's relative to the directory of the shell invoking the create script.
44
44
45
45
The per-operator directory name is:
46
-
<user project dir from -o>/weblogic-operators/<operator namespace from the input YAML file's namespace property>
46
+
`<user project dir from -o>/weblogic-operators/<operator namespace from the input YAML file's namespace property>`.
47
47
48
48
Similarly, the per-domain directory name is:
49
-
<user project dir from -o>/weblogic-domains/<domain uid from the input YAML file's domainUid property>
49
+
`<user project dir from -o>/weblogic-domains/<domain uid from the input YAML file's domainUid property>`.
50
50
51
51
#### What If I Mess Up Creating a Domain or Operator And Want To Do It Again?
52
52
53
53
* Remove the resources that were created for the domain:
*either remove the directory that was generated for that operator / domain, or remove the generated YAML files and the copy of the input file from it
59
-
*make whatever changes you need in your inputs file
60
-
*re-run the create script
58
+
*Either remove the directory that was generated for that operator or domain, or remove the generated YAML files and the copy of the input file from it.
59
+
*Make whatever changes you need in your inputs file.
60
+
*Re-run the create script.
61
61
62
62
If you run the create script without cleaning up the previously generated directory, the create script will tell you about the offending files and then exit without creating anything.
63
63
64
64
#### Location of the Input YAML Files
65
65
66
-
The create scripts support a -i option for specifying the location of the inputs file. Similar to the -o option, the path can either be a full path name or a relative path name. Relative path names are relative to the directory of the shell invoking the create script.
66
+
The create scripts support an `-i` option for specifying the location of the inputs file. Similar to the `-o` option, the path can be either a full path name or a relative path name. Relative path names are relative to the directory of the shell invoking the create script.
67
67
68
-
If -i is not specified, kubernetes/create-weblogic-operator.sh uses kubernetes/create-weblogic-operator-inputs.yaml.
68
+
If `-i` is not specified, `kubernetes/create-weblogic-operator.sh` uses `kubernetes/create-weblogic-operator-inputs.yaml`.
69
69
70
-
Previously, kubernetes/create-domain-job.sh used kubernetes/create-domain-job-inputs.yaml as the input file if -i was not specified. This behavior has been changed. The customer must select a Kubernetes clusterwide unique id for the domain and set the domainUid property in the inputs file to that value. This means that the customer must always modify the inputs file.
70
+
Previously, `kubernetes/create-domain-job.sh` used `kubernetes/create-domain-job-inputs.yaml` as the input file if `-i` was not specified. This behavior has been changed. The customer must select a Kubernetes cluster-wide unique ID for the domain and set the `domainUid` property in the inputs file to that value. This means that the customer must always modify the inputs file.
71
71
72
-
Also, we do not want the customer to have to change files in the operator's install directory. Because of this, the -i option MUST be specified when calling kubernetes/create-weblogic-operator.sh. The basic flow is:
72
+
Also, we do not want the customer to have to change files in the operator's install directory. Because of this, the `-i` option MUST be specified when calling `kubernetes/create-weblogic-operator.sh`. The basic flow is:
73
73
74
-
*pick a user projects directory, e.g. /scratch/my-user-projects
|`persistenceStorageClass`| This property has been removed |
140
+
|`persistenceVolumeClaimName`| This property has been removed |
141
+
|`persistenceVolumeName`| This property has been removed |
142
+
|`secretName`|`weblogicCredentialsSecretName`|
143
+
144
+
#### Properties That Must be Customized
145
145
The following input properties, which used to have default values, now must be uncommented and customized.
146
146
147
147
| Previous Property Name | New Property Name | Previous Default Value | Notes |
148
148
| --- | --- | --- | --- |
149
-
| domainUid | domainUID | domain1 |Since the domain UID is supposed to be unique across the Kubernetes cluster, the customer must choose one. |
150
-
| persistencePath | weblogicDomainStoragePath | /scratch/k8s_dir/persistentVolume001 | The customer must select a directory for the domain's storage. |
151
-
| nfsServer | weblogicDomainStorageNFSServer | nfsServer | If weblogicDomainStorageType is NFS, then the customer must specify the name or IP of the NFS server. |
149
+
|`domainUid`|`domainUID`|`domain1`|Because the domain UID is supposed to be unique across the Kubernetes cluster, the customer must choose one. |
150
+
|`persistencePath`|`weblogicDomainStoragePath`|`/scratch/k8s_dir/persistentVolume001`| The customer must select a directory for the domain's storage. |
151
+
|`nfsServer`|`weblogicDomainStorageNFSServer`|`nfsServer`| If `weblogicDomainStorageType` is NFS, then the customer must specify the name or IP of the NFS server. |
152
152
153
153
#### Property Values
154
154
155
155
| Previous Property Name | New Property Name | Old Property Value | New Property Value |
| service | external-weblogic-operator-service | external-weblogic-operator-srv |
179
-
| service | internal-weblogic-operator-service | internal-weblogic-operator-srv |
180
-
| volume & mount | operator-config-volume | weblogic-operator-cm-volume |
181
-
| volume & mount | operator-secrets-volume | weblogic-operator-secrets-volume |
182
-
| volume & mount | config-map-scripts | create-weblogic-domain-job-cm-volume |
183
-
| volume & mount | pv-storage | weblogic-domain-storage-volume |
184
-
| volume & mount | secrets | weblogic-credentials-volume |
185
-
| volume & mount | scripts | weblogic-domain-cm-volume |
186
-
187
-
Note: The input properties for controlling the domain's persistent volume, persistent volume claim and storage class names have been removed. These names are now derived from the domain uid.
188
-
166
+
| persistent volume |`${domainUid}-${persistenceVolume}` or `${persistenceVolume}`|`${domainUID}-weblogic-domain-pv`|
167
+
| persistent volume claim |`${domainUid}-${persistenceVolumeClaim}` or `${persistenceVolumeClaim}`|`${domainUID}-weblogic-domain-pvc`|
168
+
| storage class name |`${domainUid}` or `${persistenceStorageClass}`|`${domainUID-weblogic-domain-storage-class`|
| service |`external-weblogic-operator-service`|`external-weblogic-operator-srv`|
179
+
| service |`internal-weblogic-operator-service`|`internal-weblogic-operator-srv`|
180
+
| volume & mount |`operator-config-volume`|`weblogic-operator-cm-volume`|
181
+
| volume & mount |`operator-secrets-volume`|`weblogic-operator-secrets-volume`|
182
+
| volume & mount |`config-map-scripts`|`create-weblogic-domain-job-cm-volume`|
183
+
| volume & mount |`pv-storage`|`weblogic-domain-storage-volume`|
184
+
| volume & mount |`secrets`|`weblogic-credentials-volume`|
185
+
| volume & mount |`scripts`|`weblogic-domain-cm-volume`|
186
+
187
+
**Note:** The input properties for controlling the domain's persistent volume, persistent volume claim, and storage class names have been removed. These names are now derived from the domain UID.
0 commit comments