Skip to content

Commit 30d3439

Browse files
update to develop branch
1 parent 0b05f28 commit 30d3439

File tree

1 file changed

+18
-17
lines changed
  • docs-source/content/userguide/managing-domains/configoverrides

1 file changed

+18
-17
lines changed

docs-source/content/userguide/managing-domains/configoverrides/_index.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,21 +61,21 @@ For a detailed walk-through of the runtime flow, see the [Internal design flow](
6161

6262
* 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).
6363

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.
6565

6666
---
6767
### Typical overrides
6868

6969
Typical attributes for overrides include:
7070

7171
* User names, passwords, and URLs for:
72-
* JDBC datasources
72+
* JDBC data sources
7373
* JMS bridges, foreign servers, and SAF
7474
* Network channel public addresses:
7575
* For remote RMI clients (T3, JMS, EJB, JTA)
7676
* For remote WLST clients
7777
* Debugging
78-
* Tuning (`MaxMessageSize`, etc.)
78+
* Tuning (`MaxMessageSize`, and such)
7979

8080
---
8181
### Unsupported overrides
@@ -187,13 +187,14 @@ The secret macro `SECRETNAME` field must reference the name of a Kubernetes secr
187187
**Check each item below to ensure custom situational configuration takes effect:**
188188

189189
* 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.
190191
* See [Override template samples](#override-template-samples) for examples.
191192
* 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.
193194
* 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.
195196
* 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.
197198
* See the `public-address` stanza in [Override template samples](#override-template-samples) for an example.
198199
* When overriding `config.xml`:
199200
* 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,
274275
* Templates can embed macros that reference environment variables or Kubernetes secrets. See [Override template macros](#override-template-macros).
275276
* Create a Kubernetes configuration map from the directory of templates.
276277
* 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.
278279
* For example, assuming `./mydir` contains your `version.txt` and situation configuration template files:
279280
```
280281
kubectl -n MYNAMESPACE create cm MYCMNAME --from-file ./mydir
@@ -283,15 +284,15 @@ The following `jdbc-testDS.xml` override template demonstrates setting the URL,
283284
* Create any Kubernetes secrets referenced by a template 'secret macro'.
284285
* 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/.
285286
* 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.
287288
* For example:
288289
```
289290
kubectl -n MYNAMESPACE create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
290291
kubectl -n MYNAMESPACE label secret my-secret weblogic.domainUID=DOMAIN_UID
291292
```
292293
* Configure the name of the configuration map in the domain CR `configOverrides` field.
293294
* 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.
295296
* 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).
296297
* 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.
297298
* 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:
322323
---
323324
### Debugging
324325
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.
326327
327328
* Make sure you've followed each step in the [Step-by-step guide](#step-by-step-guide).
328329
@@ -335,7 +336,7 @@ Incorrectly formatted override files may be accepted without warnings or errors,
335336
336337
* If WebLogic pods do start, then:
337338
* 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:
339340
* `<Dec 14, 2018 12:20:47 PM UTC> <Info> <Management> <BEA-141330> <Loading situational configuration file: /shared/domains/domain1/optconfig/custom-situational-config.xml>`
340341
* This line indicates a situational configuration file has been loaded.
341342
* 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,
350351
```
351352
* Look in your `DOMAIN_HOME/optconfig` directory.
352353
* 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.
354355
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.
356357
* The `domain config` value should reflect the original value in your domain home configuration.
357358
* The `server config` value should reflect the overridden value.
358359
* 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,
373374
-Dweblogic.debug.DebugSituationalConfigDumpXml=true
374375
```
375376
376-
* 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.
377378
378379
379380
---
@@ -383,9 +384,9 @@ Incorrectly formatted override files may be accepted without warnings or errors,
383384
* The introspector job's pod:
384385
* Mounts the Kubernetes configuration map and secrets specified via the operator domain resource `configOverrides`, `webLogicCredentialsSecret`, and `configOverrideSecrets` fields.
385386
* 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}`).
389390
* It returns expanded situational configuration files to the operator.
390391
* It reports any errors when attempting expansion to the operator.
391392
* The operator runtime:

0 commit comments

Comments
 (0)