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
+29-29Lines changed: 29 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -188,17 +188,17 @@ The secret macro `SECRETNAME` field must reference the name of a Kubernetes secr
188
188
189
189
* Reference the name of the current bean and each parent bean in any hierarchy you override.
190
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.
191
-
* See [Override template samples](#override-template-samples) for examples.
191
+
* See [Override template samples](#override-template-samples) for examples.
192
192
* Use situational config `replace` and `add` verbs as follows:
193
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.
194
-
* See the `server-debug` stanza in [Override template samples](#override-template-samples) for an example.
194
+
* See the `server-debug` stanza in [Override template samples](#override-template-samples) for an example.
195
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.
196
-
* See the `max-message-size` stanza in [Override template samples](#override-template-samples) for an example.
196
+
* See the `max-message-size` stanza in [Override template samples](#override-template-samples) for an example.
197
197
* If you are changing the value of an existing attribute within a domain home `config.xml`, then the attribute needs a `replace` verb.
198
198
* See the `public-address` stanza in [Override template samples](#override-template-samples) for an example.
199
199
* When overriding `config.xml`:
200
200
* The XML namespace (`xmlns:` in the XML) must be exactly as specified in [Override template schemas](#override-template-schemas).
201
-
* For example, use `d:` to reference `config.xml` beans and attributes, `f:` for `add` and `replace``domain-fragment` verbs, and `s:` to reference the situational configuration schema.
201
+
* For example, use `d:` to reference `config.xml` beans and attributes, `f:` for `add` and `replace``domain-fragment` verbs, and `s:` to reference the situational configuration schema.
202
202
* Avoid specifying the domain name stanza, as this may cause some overrides to be ignored (for example, server-template scoped overrides).
203
203
* When overriding modules:
204
204
* It is a best practice to use XML namespace abbreviations `jms:`, `jdbc:`, and `wldf:` respectively for JMS, JDBC, and WLDF (diagnostics) module override files.
@@ -269,7 +269,7 @@ The following `jdbc-testDS.xml` override template demonstrates setting the URL,
269
269
* Create a directory containing (A) a set of situational configuration templates for overriding the MBean properties you want to replace and (B) a `version.txt` file.
270
270
* This directory must not contain any other files.
271
271
* The `version.txt` file must contain exactly the string `2.0`.
272
-
* Note: This version.txt file must stay `2.0` even when you are updating your templates from a previous deployment.
272
+
* Note: This version.txt file must stay `2.0` even when you are updating your templates from a previous deployment.
273
273
* Templates must not override the settings listed in [Unsupported overrides](#unsupported-overrides).
274
274
* Templates must be formatted and named as per [Override template names and syntax](#override-template-names-and-syntax).
275
275
* Templates can embed macros that reference environment variables or Kubernetes secrets. See [Override template macros](#override-template-macros).
@@ -297,8 +297,8 @@ The following `jdbc-testDS.xml` override template demonstrates setting the URL,
297
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.
298
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).
299
299
* To stop all running WebLogic Server pods in your domain, apply a changed resource, and then start/restart the domain:
300
-
* Set your domain resource `serverStartPolicy` to `NEVER`, wait, and apply your latest domain resource with the `serverStartPolicy` restored back to `ALWAYS` or `IF_NEEDED` (See [Starting and stopping servers]({{< relref "/userguide/managing-domains/domain-lifecycle/startup/_index.md#starting-and-stopping-servers" >}}).)
301
-
* Or delete your domain resource, wait, and apply your (potentially changed) domain resource.
300
+
* Set your domain resource `serverStartPolicy` to `NEVER`, wait, and apply your latest domain resource with the `serverStartPolicy` restored back to `ALWAYS` or `IF_NEEDED` (See [Starting and stopping servers]({{< relref "/userguide/managing-domains/domain-lifecycle/startup/_index.md#starting-and-stopping-servers" >}}).)
301
+
* Or delete your domain resource, wait, and apply your (potentially changed) domain resource.
302
302
* See [Debugging](#debugging) for ways to check if the situational configuration is taking effect or if there are errors.
303
303
304
304
Example domain resource YAML:
@@ -329,18 +329,18 @@ Incorrectly formatted override files may be accepted without warnings or errors
329
329
330
330
* If WebLogic pods do not come up at all, then:
331
331
* In the domain's namespace, see if you can find a job named `DOMAIN_UID-introspect-domain-job` and a corresponding pod named something like `DOMAIN_UID-introspect-domain-job-xxxx`. If so, examine:
* This line indicates a situational configuration file has been loaded.
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.
343
-
* Note: The following exception may show up in your server logs when overriding JDBC modules. It is not expected to affect runtime behavior, and can be ignored (a fix is pending for them):
339
+
* The only WebLogic Server log lines that match should look something like:
* This line indicates a situational configuration file has been loaded.
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.
343
+
* Note: The following exception may show up in your server logs when overriding JDBC modules. It is not expected to affect runtime behavior, and can be ignored (a fix is pending for them):
344
344
```
345
345
java.lang.NullPointerException
346
346
at weblogic.management.provider.internal.situationalconfig.SituationalConfigManagerImpl.registerListener(SituationalConfigManagerImpl.java:227)
@@ -350,8 +350,8 @@ Incorrectly formatted override files may be accepted without warnings or errors
350
350
...
351
351
```
352
352
* Look in your `DOMAIN_HOME/optconfig` directory.
353
-
* This directory, or a subdirectory within this directory, should contain each of your custom situational configuration 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.
353
+
* This directory, or a subdirectory within this directory, should contain each of your custom situational configuration 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.
355
355
356
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.
357
357
* The `domain config` value should reflect the original value in your domain home configuration.
@@ -384,23 +384,23 @@ Incorrectly formatted override files may be accepted without warnings or errors
384
384
* The introspector job's pod:
385
385
* Mounts the Kubernetes configuration map and secrets specified via the operator domain resource `configOverrides`, `webLogicCredentialsSecret`, and `configOverrideSecrets` fields.
386
386
* Reads the mounted situational configuration templates from the configuration map and expands them to create the actual situational configuration files for the domain:
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}`).
390
-
* It returns expanded situational configuration files to the operator.
391
-
* It reports any errors when attempting expansion to the operator.
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}`).
390
+
* It returns expanded situational configuration files to the operator.
391
+
* It reports any errors when attempting expansion to the operator.
392
392
* The operator runtime:
393
393
* Reads the expanded situational configuration files and/or errors from the introspector.
394
394
* And, if the introspector reported no errors, it:
395
-
* Puts situational configuration files in a configuration map named `DOMAIN_UID-weblogic-domain-introspect-cm`.
396
-
* Mounts this configuration map into the WebLogic Server pods.
397
-
* Starts the WebLogic Server pods.
395
+
* Puts situational configuration files in a configuration map named `DOMAIN_UID-weblogic-domain-introspect-cm`.
396
+
* Mounts this configuration map into the WebLogic Server pods.
397
+
* Starts the WebLogic Server pods.
398
398
* Otherwise, if the introspector reported errors, it:
399
-
* Logs warning, error, or severe messages.
400
-
* Will not start WebLogic Server pods.
399
+
* Logs warning, error, or severe messages.
400
+
* Will not start WebLogic Server pods.
401
401
* The `startServer.sh` script in the WebLogic Server pods:
402
402
* Copies the expanded situational configuration files to a special location where the WebLogic runtime can find them:
403
-
* `config.xml` overrides are copied to the `optconfig` directory in its domain home.
404
-
* Module overrides are copied to the `optconfig/jdbc`, `optconfig/jms`, or `optconfig/diagnostics` directory.
403
+
* `config.xml` overrides are copied to the `optconfig` directory in its domain home.
404
+
* Module overrides are copied to the `optconfig/jdbc`, `optconfig/jms`, or `optconfig/diagnostics` directory.
405
405
* Deletes any situational configuration files in the `optconfig` directory that do not have corresponding template files in the configuration map.
406
406
* WebLogic Servers read their overrides from their domain home's `optconfig` directory.
*[Common mistakes and solutions](#common-mistakes-and-solutions)
19
19
20
+
Note that the operator Helm chart is available from the GitHub chart repository, see [Alternatively, install the operator Helm chart from GitHub chart repository](../../installation/#alternatively-install-the-operator-helm-chart-from-github-chart-repository).
21
+
20
22
#### Useful Helm operations
21
23
22
24
Show the available operator configuration parameters and their default values:
Copy file name to clipboardExpand all lines: integration-tests/README.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,14 @@ Basic Use Cases described above are verified in all the domain configurations. A
86
86
| Server pods restarted by changing includeServerOutInPodLog | Verify admin and managed server pods being restarted by property change: includeServerOutInPodLog: true --> includeServerOutInPodLog: false |
87
87
| Server pods restarted by changing logHomeEnable | Verify admin and managed server pods being restarted by property change: logHomeEnabled: true --> logHomeEnabled: false |
88
88
89
+
Configuration Overrides Usecases
89
90
91
+
| Override | Usecase |
92
+
| --- | --- |
93
+
| Configuration override | Override the administration server properties `connect-timeout`, `max-message-size`, `restart-max`, `debug-server-life-cycle` and `debug-jmx-core` debug flags. Also T3Channel public address using Kubernetes secret. The override is verified by JMX client connecting to the serverConfig MBean tree and the values are checked against the expected values. The test client connects to the overridden T3 public address and port to connect to the MBean servers |
94
+
| JDBC Resource Override | Override JDBC connection pool properties; `initialCapacity`, `maxCapacity`, `test-connections-on-reserve`, `connection-harvest-max-count`, `inactive-connection-timeout-seconds`. Override the JDBC driver parameters like data source `URL`, `DB``user` and `password` using kubernetes secret. The test verifies the overridden functionality datasource `URL`, `user`, `password` by getting the data source connection and running DDL statement it is connected to. |
95
+
| JMS Resource Override | Override UniformDistributedTopic Delivery Failure Parameters, `redelivery-limit` and `expiration-policy`. The JMX test client verifies the serverConfig MBean tree for the expected delivery failure parameters, `redelivery-limit` and `expiration-policy`. |
96
+
| WLDF Resource Override | Override `wldf-instrumentation-monitor` and `harvester` in a diagnostics module. The test client verifies the new instrumentation monitors/harvesters set by getting the WLDF resource from serverConfig tree with expected values. |
0 commit comments