Skip to content

Commit 46484af

Browse files
Tom Barnesrjeberhard
authored andcommitted
Custom overrides doc update.
1 parent fae6838 commit 46484af

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

site/config-overrides.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You can use overrides to customize domains as they are moved from QA to producti
3131
* Override templates (also known as situational configuration templates), with names and syntax as described in [Override template names and syntax](#override-template-names-and-syntax).
3232
* A file named `version.txt` that contains the string `2.0`.
3333
* Set your domain resource `configOverrides` to the name of this configuration map.
34-
* If templates leverage 'secret macros':
34+
* If templates leverage `secret macros`:
3535
* Create Kubernetes secrets that contain template macro values.
3636
* Set your domain `configOverrideSecrets` to reference the aforementioned secrets.
3737
* Stop all running WebLogic Server pods in your domain. (See [Server Lifecycle](server-lifecycle.md).)
@@ -81,7 +81,7 @@ Typical attributes for overrides include:
8181
* Network channel listen address, port, and enabled configuration
8282
* Server and domain log locations
8383
* Node Manager related configuration
84-
* Changing any existing mbean name
84+
* Changing any existing MBean name
8585

8686
**Specifically, do not use custom overrides for:**
8787

@@ -95,7 +95,7 @@ Typical attributes for overrides include:
9595
* Network Access Point (custom channel), listen address, or port
9696
* Server and domain log locations -- use the `logHome` domain setting instead
9797
* Node Manager access credentials
98-
* Any existing mbean name (for example, you cannot change the domain name)
98+
* Any existing MBean name (for example, you cannot change the domain name)
9999

100100
Note that it's OK, even expected, to override Network Access Point `public` or `external` addresses and ports.
101101

@@ -167,7 +167,7 @@ _`wldf-MODULENAME.xml`_
167167

168168
The operator supports embedding macros within override templates. This helps make your templates flexibly handle multiple use cases, such as specifying a different URL, user name, and password for a different deployment.
169169

170-
Two types of macros are supported `environment variable macros` and `secret macros`:
170+
Two types of macros are supported, `environment variable macros` and `secret macros`:
171171

172172
* Environment variable macros have the syntax `${env:ENV-VAR-NAME}`, where the supported environment variables include `DOMAIN_UID`, `DOMAIN_NAME`, `DOMAIN_HOME`, and `LOG_HOME`.
173173

@@ -184,15 +184,15 @@ The secret macro `SECRETNAME` field must reference the name of a Kubernetes secr
184184
* Reference the name of the current bean and each parent bean in any hierarchy you override.
185185
* See [Override template samples](#override-template-samples) for examples.
186186
* Use situational config `replace` and `add` verbs as follows:
187-
* 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.
187+
* 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.
188188
* See the `server-debug` stanza in [Override template samples](#override-template-samples) below for an example.
189-
* If you are adding a new attribute to an existing bean in the domain home config.xml, the attribute needs an `add` verb.
189+
* If you are adding a new attribute to an existing bean in the domain home `config.xml`, the attribute needs an `add` verb.
190190
* See the `max-message-size` stanza in [Override template samples](#override-template-samples) below for an example.
191-
* If you are changing the value of an existing attribute within a domain home config.xml, the attribute needs a `replace` verb.
191+
* If you are changing the value of an existing attribute within a domain home `config.xml`, the attribute needs a `replace` verb.
192192
* See the `public-address` stanza in [Override template samples](#override-template-samples) below for an example.
193193
* When overriding `config.xml`, XML namespace `xmlns` abbreviations must be exactly as specified.
194-
* When overriding config.xml, the XML namespace (`xmlns:` in the XML) must be exactly as specified in [Override template schemas](#override-template-schemas).
195-
* 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+
* When overriding `config.xml`, the XML namespace (`xmlns:` in the XML) must be exactly as specified in [Override template schemas](#override-template-schemas).
195+
* 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 config schema.
196196
* It is a best practice to use XML namespace abbreviations `jms:`, `jdbc:`, and `wldf:` respectively for JMS, JDBC, and WLDF module override files.
197197

198198
## Override template samples
@@ -231,7 +231,7 @@ The following `config.xml` override file demonstrates:
231231

232232
### Overriding a data source module
233233

234-
The following `jdbc-testDS.xml` override template demonstrates setting the URL, user name, and password-encrypted fields of a JDBC module named `testDS` via secret macros. The generated situational configuration that replaces the macros with secret values will be located in the `DOMAIN_HOME/optconfig/jdbc` directory. The `password-encrypted` field will be populated with an encrypted value because it uses a secret macro with an `:encrypt` suffix. The secret is named `dbsecret` and contains three keys: `url`, `username`, and `password`.
234+
The following `jdbc-testDS.xml` override template demonstrates setting the URL, user name, and password-encrypted fields of a JDBC module named `testDS` via `secret macros`. The generated situational configuration that replaces the macros with secret values will be located in the `DOMAIN_HOME/optconfig/jdbc` directory. The `password-encrypted` field will be populated with an encrypted value because it uses a secret macro with an `:encrypt` suffix. The secret is named `dbsecret` and contains three keys: `url`, `username`, and `password`.
235235

236236

237237
```
@@ -285,11 +285,11 @@ The following `jdbc-testDS.xml` override template demonstrates setting the URL,
285285
* Configure the name of the configuration map in the domain CR `configOverrides` field.
286286
* Configure the names of each secret in domain CR.
287287
* If the secret contains the WebLogic admin `username` and `password` keys, set the domain CR `webLogicCredentialsSecret` field.
288-
* For all other secrets, add them to 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).
288+
* 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).
289289
* 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.
290-
* 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 you existing domain resource (if you haven't changed it).
290+
* 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).
291291
* To stop all running WebLogic Server pods in your domain, apply a changed resource, and then start/restart the domain:
292-
* Set your domain resource serverRestartPolicy to NEVER, wait, and apply your latest domain resource with the serverRestartPolicy restored back to ALWAYS or IF_NEEDED (see [Server Lifecycle](server-lifecycle.md).)
292+
* Set your domain resource `serverRestartPolicy` to `NEVER`, wait, and apply your latest domain resource with the `serverRestartPolicy` restored back to `ALWAYS` or `IF_NEEDED` (see [Server Lifecycle](server-lifecycle.md).)
293293
* Or delete your domain resource, wait, and apply your (potentially changed) domain resource.
294294
* See [Debugging](#debugging) for ways to check if the situational configuration is taking effect or if there are errors.
295295
@@ -319,14 +319,14 @@ Incorrectly formatted override files may be accepted without warnings or errors,
319319
320320
* Make sure you've followed each step in the [Step-by-step guide](#step-by-step-guide).
321321
322-
* If WL pods do not come up at all, then:
322+
* If WebLogic pods do not come up at all, then:
323323
* 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:
324324
* `kubectl -n MYDOMAINNAMESPACE describe job INTROSPECTJOBNAME`
325325
* `kubectl -n MYDOMAINNAMESPACE logs INTROSPECTPODNAME`
326326
* Check your operator log for Warning/Error/Severe messages.
327327
* `kubectl -n MYOPERATORNAMESPACE logs OPERATORPODNAME`
328328
329-
* If WL pods do start, then:
329+
* If WebLogic pods do start, then:
330330
* Search your Administration Server pod's `kubectl log` for the keyword `situational`, for example `kubectl logs MYADMINPOD | grep -i situational`.
331331
* The only WebLogic Server log lines that match should look something like like:
332332
* `<Dec 14, 2018 12:20:47 PM UTC> <Info> <Management> <BEA-141330> <Loading situational configuration file: /shared/domains/domain1/optconfig/custom-situational-config.xml>`

0 commit comments

Comments
 (0)