Skip to content

Commit 31eb6f3

Browse files
Tom Barnesrjeberhard
authored andcommitted
Custom overrides doc update.
1 parent 0c7a82d commit 31eb6f3

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

site/config-overrides.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [Override template names](#override-template-names)
1111
* [Override template schemas](#override-template-schemas)
1212
* [Override template macros](#override-template-macros)
13+
* [Override template syntax special requirements](#override-template-syntax-special-requirements)
1314
* [Override template samples](#override-template-samples)
1415
* [Step-by-step guide](#step-by-step-guide)
1516
* [Debugging](#debugging)
@@ -51,7 +52,7 @@ For a detailed walk-through of the runtime flow, see the [Internal design flow](
5152
---
5253
# Prerequisites
5354

54-
* A WebLogic domain home must contain any situational configuration XML file in its existing `optconfig` directory that was not put 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).
55+
* 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).
5556

5657
* If you want to override a JDBC, JMS, or WLDF module, the original module must be located in your domain home `config/jdbc`, `config/jms`, and `config/wldf` directory, respectively. These are the default locations for these types of modules.
5758

@@ -103,25 +104,6 @@ The behavior when using an unsupported override is undefined.
103104

104105
Overrides leverage a built-in WebLogic feature called "Configuration Overriding" which is often informally called "Situational Configuration." Situational configuration consists of XML formatted files that closely resemble the structure of WebLogic `config.xml` and system resource module XML files. In addition, the attribute fields in these files can embed `add`, `replace`, and `delete` verbs to specify the desired override action for the field.
105106

106-
## Override template check-list
107-
108-
**Check each item below to ensure custom situational configuration takes effect:**
109-
110-
* Follow each step in the [Step-by-step guide](#step-by-step-guide)
111-
* Reference the name of the current bean and each parent bean in any hierarchy you override.
112-
* See [Override template samples](#override-template-samples) for examples.
113-
* Use situational config `replace` and `add` verbs as follows:
114-
* 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.
115-
* See the `server-debug` stanza in [Override template samples](#override-template-samples) below for an example.
116-
* If you are adding a new attribute to an existing bean in the domain home config.xml, the attribute needs an `add` verb.
117-
* See the `max-message-size` stanza in [Override template samples](#override-template-samples) below for an example.
118-
* If you are changing the value of an existing attribute within a domain home config.xml, the attribute needs a `replace` verb.
119-
* See the `public-address` stanza in [Override template samples](#override-template-samples) below for an example.
120-
* When overriding `config.xml`, XML namespace `xmlns` abbreviations must be exactly as specified.
121-
* When overriding config.xml, the XML namespace (`xmlns:` in the XML) must be exactly as specified in [Override template schemas](#override-template-schemas).
122-
* E.g. use `d:` to reference config.xml beans and attributes, `f:` for `add` and `replace` `domain-fragment` verbs, and `s:` to reference the situational config schema.
123-
* It is a best practice to use XML namespace abbreviations `jms:`, `jdbc:`, and `wldf:` respectively for JMS, JDBC, and WLDF module override files.
124-
125107
## Override template names
126108

127109
The operator requires a different file name format for override templates than WebLogic's built-in situational configuration feature. It converts the names to the format required by situational configuration when it moves the templates to the domain home `optconfig` directory. The following table describes the format:
@@ -146,7 +128,7 @@ _`config.xml`_
146128
xmlns:f="http://xmlns.oracle.com/weblogic/domain-fragment"
147129
xmlns:s="http://xmlns.oracle.com/weblogic/situational-config">
148130
...
149-
</domain>
131+
</d:domain>
150132
```
151133

152134
_`jdbc-MODULENAME.xml`_
@@ -193,6 +175,24 @@ The secret macro `SECRETNAME` field must reference the name of a Kubernetes secr
193175

194176
**SECURITY NOTE: Use the `:encrypt` suffix in a secret macro to encrypt its replacement value with the WebLogic WLST `encrypt` command (instead of leaving it at its plain text value). This is useful for overriding MBean attributes that expect encrypted values, such as the `password-encrypted` field of a data source, and is also useful for ensuring that a custom override situational configuration file the operator places in the domain home does not expose passwords in plain-text.**
195177

178+
## Override template syntax special requirements
179+
180+
**Check each item below to ensure custom situational configuration takes effect:**
181+
182+
* Reference the name of the current bean and each parent bean in any hierarchy you override.
183+
* See [Override template samples](#override-template-samples) for examples.
184+
* Use situational config `replace` and `add` verbs as follows:
185+
* 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.
186+
* See the `server-debug` stanza in [Override template samples](#override-template-samples) below for an example.
187+
* If you are adding a new attribute to an existing bean in the domain home config.xml, the attribute needs an `add` verb.
188+
* See the `max-message-size` stanza in [Override template samples](#override-template-samples) below for an example.
189+
* If you are changing the value of an existing attribute within a domain home config.xml, the attribute needs a `replace` verb.
190+
* See the `public-address` stanza in [Override template samples](#override-template-samples) below for an example.
191+
* When overriding `config.xml`, XML namespace `xmlns` abbreviations must be exactly as specified.
192+
* When overriding config.xml, the XML namespace (`xmlns:` in the XML) must be exactly as specified in [Override template schemas](#override-template-schemas).
193+
* E.g. use `d:` to reference config.xml beans and attributes, `f:` for `add` and `replace` `domain-fragment` verbs, and `s:` to reference the situational config schema.
194+
* It is a best practice to use XML namespace abbreviations `jms:`, `jdbc:`, and `wldf:` respectively for JMS, JDBC, and WLDF module override files.
195+
196196
## Override template samples
197197

198198
Here are some sample template override files.

0 commit comments

Comments
 (0)