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: docs-source/content/userguide/managing-domains/configoverrides/_index.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,21 +61,21 @@ For a detailed walk-through of the runtime flow, see the [Internal design flow](
61
61
62
62
* A WebLogic domain home must not contain any situational configuration XML file in its `optconfig` directory that was not placed there by the operator. Any existing situational configuration XML files in this directory will be deleted and replaced by your operator override templates (if any).
63
63
64
-
* If you want to override a JDBC, JMS, or WLDF (diagnostics) module, the original module must be located in your domain home `config/jdbc`, `config/jms`, and `config/diagnostics` directory, respectively. These are the default locations for these types of modules.
64
+
* If you want to override a JDBC, JMS, or WLDF (diagnostics) module, then the original module must be located in your domain home `config/jdbc`, `config/jms`, and `config/diagnostics` directory, respectively. These are the default locations for these types of modules.
65
65
66
66
---
67
67
### Typical overrides
68
68
69
69
Typical attributes for overrides include:
70
70
71
71
* User names, passwords, and URLs for:
72
-
* JDBC datasources
72
+
* JDBC data sources
73
73
* JMS bridges, foreign servers, and SAF
74
74
* Network channel public addresses:
75
75
* For remote RMI clients (T3, JMS, EJB, JTA)
76
76
* For remote WLST clients
77
77
* Debugging
78
-
* Tuning (`MaxMessageSize`, etc.)
78
+
* Tuning (`MaxMessageSize`, and such)
79
79
80
80
---
81
81
### Unsupported overrides
@@ -187,13 +187,14 @@ The secret macro `SECRETNAME` field must reference the name of a Kubernetes secr
187
187
**Check each item below to ensure custom situational configuration takes effect:**
188
188
189
189
* Reference the name of the current bean and each parent bean in any hierarchy you override.
190
+
* Note that the `combine-mode` verbs (`add` and `replace`) should be omitted for beans that are already defined in your original domain home configuration.
190
191
* See [Override template samples](#override-template-samples) for examples.
191
192
* Use situational config `replace` and `add` verbs as follows:
192
-
* If you are adding a new bean that doesn't already exist in your original domain home `config.xml`, specify `add` on the MBean itself and on each attribute within the bean.
193
+
* If you are adding a new bean that doesn't already exist in your original domain home `config.xml`, then specify `add` on the MBean itself and on each attribute within the bean.
193
194
* See the `server-debug` stanza in [Override template samples](#override-template-samples) for an example.
194
-
* If you are adding a new attribute to an existing bean in the domain home `config.xml`, the attribute needs an `add` verb.
195
+
* If you are adding a new attribute to an existing bean in the domain home `config.xml`, then the attribute needs an `add` verb.
195
196
* See the `max-message-size` stanza in [Override template samples](#override-template-samples) for an example.
196
-
* If you are changing the value of an existing attribute within a domain home `config.xml`, the attribute needs a `replace` verb.
197
+
* If you are changing the value of an existing attribute within a domain home `config.xml`, then the attribute needs a `replace` verb.
197
198
* See the `public-address` stanza in [Override template samples](#override-template-samples) for an example.
198
199
* When overriding `config.xml`:
199
200
* The XML namespace (`xmlns:` in the XML) must be exactly as specified in [Override template schemas](#override-template-schemas).
@@ -274,7 +275,7 @@ The following `jdbc-testDS.xml` override template demonstrates setting the URL,
274
275
* Templates can embed macros that reference environment variables or Kubernetes secrets. See [Override template macros](#override-template-macros).
275
276
* Create a Kubernetes configuration map from the directory of templates.
276
277
* The configuration map must be in the same Kubernetes namespace as the domain.
277
-
* If the configuration map is going to be used by a single `DOMAIN_UID`, we recommend adding the `weblogic.domainUID=<mydomainuid>` label to help track the resource.
278
+
* If the configuration map is going to be used by a single `DOMAIN_UID`, then we recommend adding the `weblogic.domainUID=<mydomainuid>` label to help track the resource.
278
279
* For example, assuming `./mydir` contains your `version.txt` and situation configuration template files:
279
280
```
280
281
kubectl -n MYNAMESPACE create cm MYCMNAME --from-file ./mydir
@@ -283,15 +284,15 @@ The following `jdbc-testDS.xml` override template demonstrates setting the URL,
283
284
* Create any Kubernetes secrets referenced by a template 'secret macro'.
284
285
* Secrets can have multiple keys (files) that can hold either cleartext or base64 values. We recommend that you use base64 values for passwords via `Opaque` type secrets in their `data` field, so that they can't be easily read at a casual glance. For more information, see https://kubernetes.io/docs/concepts/configuration/secret/.
285
286
* Secrets must be in the same Kubernetes namespace as the domain.
286
-
* If a secret is going to be used by a single `DOMAIN_UID`, we recommend adding the `weblogic.domainUID=<mydomainuid>` label to help track the resource.
287
+
* If a secret is going to be used by a single `DOMAIN_UID`, then we recommend adding the `weblogic.domainUID=<mydomainuid>` label to help track the resource.
* Configure the name of the configuration map in the domain CR `configOverrides` field.
293
294
* Configure the names of each secret in domain CR.
294
-
* If the secret contains the WebLogic admin `username` and `password` keys, set the domain CR `webLogicCredentialsSecret` field.
295
+
* If the secret contains the WebLogic admin `username` and `password` keys, then set the domain CR `webLogicCredentialsSecret` field.
295
296
* For all other secrets, add them to the domain CR `configOverrideSecrets` field. Note: This must be in an array format even if you only add one secret (see the sample domain resource YAML below).
296
297
* Any override changes require stopping all WebLogic pods, applying your domain resource (if it changed), and restarting the WebLogic pods before they can take effect.
297
298
* Custom override changes on an existing running domain, such as updating an override configuration map, a secret, or a domain resource, will not take effect until all running WebLogic Server pods in your domain are shutdown (so no servers are left running), and the domain is subsequently restarted with your new domain resource (if it changed), or with your existing domain resource (if you haven't changed it).
@@ -322,7 +323,7 @@ spec:
322
323
---
323
324
### Debugging
324
325
325
-
Incorrectly formatted override files may be accepted without warnings or errors, and will not prevent WebLogic pods from booting. So it is important to make sure that the template files are correct in a QA environment, otherwise your WebLogic Servers may start even though critically required overrides are failing to take effect.
326
+
Incorrectly formatted override files may be accepted without warnings or errors and will not prevent WebLogic pods from booting. So, it is important to make sure that the template files are correct in a QA environment, otherwise your WebLogic Servers may start even though critically required overrides are failing to take effect.
326
327
327
328
* Make sure you've followed each step in the [Step-by-step guide](#step-by-step-guide).
328
329
@@ -335,7 +336,7 @@ Incorrectly formatted override files may be accepted without warnings or errors,
335
336
336
337
* If WebLogic pods do start, then:
337
338
* Search your Administration Server pod's `kubectl log` for the keyword `situational`, for example `kubectl logs MYADMINPOD | grep -i situational`.
338
-
* The only WebLogic Server log lines that match should look something like like:
339
+
* The only WebLogic Server log lines that match should look something like:
* This line indicates a situational configuration file has been loaded.
341
342
* If the search yields Warning or Error lines, then the format of the custom situational configuration template is incorrect, and the Warning or Error text should describe the problem.
@@ -350,9 +351,9 @@ Incorrectly formatted override files may be accepted without warnings or errors,
350
351
```
351
352
* Look in your `DOMAIN_HOME/optconfig` directory.
352
353
* This directory, or a subdirectory within this directory, should contain each of your custom situational configuration files.
353
-
* If it doesn't, this likely indicates your domain resource `configOverrides` was not set to match your custom override configuration map name, or that your custom override configuration map does not contain your override files.
354
+
* If it doesn't, then this likely indicates your domain resource `configOverrides` was not set to match your custom override configuration map name, or that your custom override configuration map does not contain your override files.
354
355
355
-
* If you'd like to verify that the situational configuration is taking effect in the WebLogic MBean tree, one way to do this is to compare the `server config` and `domain config` MBean tree values.
356
+
* If you'd like to verify that the situational configuration is taking effect in the WebLogic MBean tree, then one way to do this is to compare the `server config` and `domain config` MBean tree values.
356
357
* The `domain config` value should reflect the original value in your domain home configuration.
357
358
* The `server config` value should reflect the overridden value.
358
359
* For example, assuming your `DOMAIN_UID` is `domain1`, and your domain contains a WebLogic Server named `admin-server`, then:
@@ -373,7 +374,7 @@ Incorrectly formatted override files may be accepted without warnings or errors,
* NOTE: The WebLogic console will _not_ reflect any override changes. You cannot use the console to verify overrides are taking effect.
377
+
* **NOTE**: The WebLogic console will _not_ reflect any override changes. You cannot use the console to verify overrides are taking effect.
377
378
378
379
379
380
---
@@ -383,9 +384,9 @@ Incorrectly formatted override files may be accepted without warnings or errors,
383
384
* The introspector job's pod:
384
385
* Mounts the Kubernetes configuration map and secrets specified via the operator domain resource `configOverrides`, `webLogicCredentialsSecret`, and `configOverrideSecrets` fields.
385
386
* Reads the mounted situational configuration templates from the configuration map and expands them to create the actual situational configuration files for the domain:
386
-
* It expands some fixed replaceable values (e.g. `${env:DOMAIN_UID}`).
387
-
* It expands referenced secrets by reading the value from the corresponding mounted secret file (e.g. `${secret:mysecret.mykey}`).
388
-
* It optionally encrypts secrets using offline WLST to encrypt the value - useful for passwords (e.g. `${secret:mysecret.mykey:encrypt}`).
387
+
* It expands some fixed replaceable values (for example, `${env:DOMAIN_UID}`).
388
+
* It expands referenced secrets by reading the value from the corresponding mounted secret file (for example, `${secret:mysecret.mykey}`).
389
+
* It optionally encrypts secrets using offline WLST to encrypt the value - useful for passwords (for example, `${secret:mysecret.mykey:encrypt}`).
389
390
* It returns expanded situational configuration files to the operator.
390
391
* It reports any errors when attempting expansion to the operator.
0 commit comments