Skip to content

Commit aa00314

Browse files
Tom Barnesrjeberhard
authored andcommitted
further emphasize need to restart domain after changes
1 parent 90ad461 commit aa00314

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

site/config-overrides.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ You can use overrides to customize domains as they are moved from QA to producti
3333
* Set your domain resource `configOverrides` to the name of this configuration map.
3434
* Create Kubernetes secrets that contain template macro values.
3535
* Set your domain `configOverrideSecrets` to reference the aforementioned secrets.
36-
* Stop all running WebLogic server pods in your domain. (See [Server Lifecycle](server-lifecycle.md).)
36+
* Stop all running WebLogic Server pods in your domain. (See [Server Lifecycle](server-lifecycle.md).)
3737
* Start or restart your domain. (See [Server Lifecycle](server-lifecycle.md).)
3838

39-
For a detailed walk-through of these steps, see [Step-by-step guide](#step-by-step-guide).
39+
For a detailed walk-through of these steps, see the [Step-by-step guide](#step-by-step-guide).
4040

4141
## How do overrides work during runtime?
4242

43-
* When a domain is first deployed, or is restarted after shutting down all WebLogic server pods, the operator will:
43+
* When a domain is first deployed, or is restarted after shutting down all the WebLogic Server pods, the operator will:
4444
* Resolve any macros in your override templates.
4545
* Place expanded override templates in the `optconfig` directory located in each WebLogic domain home directory.
4646
* When the WebLogic Servers start, they will:
4747
* Automatically load the override files from the `optconfig` directory.
4848
* Use the override values in the override files instead of the values specified in their `config.xml` or system resource XML files.
4949

50-
For a detailed walk-through of the runtime flow, see [Internal design flow](#internal-design-flow).
50+
For a detailed walk-through of the runtime flow, see the [Internal design flow](#internal-design-flow).
5151

5252
---
5353
# Prerequisites
@@ -171,7 +171,7 @@ Two types of macros are supported `environment variable macros` and `secret macr
171171

172172
* Secret macros have the syntax `${secret:SECRETNAME.SECRETKEY}` and `${secret:SECRETNAME.SECRETKEY:encrypt}`.
173173

174-
The secret macro `SECRETNAME` field must reference the name of a Kubernetes secret, and the `SECRETKEY` field must reference a key within that secret. For example, if you have created a secret named `dbuser` with a key named `username` that contains the value `scott`, then the macro `${secret:dbuser.username}` will be replaced with the word `scott` before the template is copied into its WebLogic server pod.
174+
The secret macro `SECRETNAME` field must reference the name of a Kubernetes secret, and the `SECRETKEY` field must reference a key within that secret. For example, if you have created a secret named `dbuser` with a key named `username` that contains the value `scott`, then the macro `${secret:dbuser.username}` will be replaced with the word `scott` before the template is copied into its WebLogic Server pod.
175175

176176
**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.**
177177

@@ -259,13 +259,13 @@ The following `jdbc-testDS.xml` override template demonstrates setting the URL,
259259
* Configure the names of each secret in domain CR.
260260
* If the secret contains the WebLogic admin `username` and `password` keys, set the domain CR `webLogicCredentialsSecret` field.
261261
* For all other secrets, add them to domain CR `configOverrideSecrets` field.
262-
* Stop all running WebLogic server pods in your domain. (See [Server Lifecycle](server-lifecycle.md).)
262+
* Stop all running WebLogic Server pods in your domain. (See [Server Lifecycle](server-lifecycle.md).)
263263
* Start or restart your domain. (See [Server Lifecycle](server-lifecycle.md).)
264264
* See [Debugging](#debugging) for ways to check if the situational configuration is taking effect or if there are errors.
265265
266-
**IMPORTANT: Custom override changes, 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.**
266+
**IMPORTANT: Custom override changes, 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.**
267267
268-
**IMPORTANT: Incorrectly formatted override files are 'somewhat' silently ignored. WebLogic Servers log errors or warnings when they detect an incorrectly formatted configuration override template file, but will still boot, and will skip overriding. So it is important to make sure template files are correct in a QA environment by checking your WebLogic pod logs for situational configuration errors and warnings, before attempting to use them in production.**
268+
**IMPORTANT: Incorrectly formatted override files are 'somewhat' silently ignored. WebLogic Servers log errors or warnings when they detect an incorrectly formatted configuration override template file, but will still boot, and will skip overriding. So it is important to make sure that the template files are correct in a QA environment by checking your WebLogic pod logs for situational configuration errors and warnings, before attempting to use them in production.**
269269
270270
271271
Example domain resource yaml:
@@ -328,9 +328,9 @@ spec:
328328
-Dweblogic.debug.DebugSituationalConfigDumpXml=true
329329
```
330330
331-
**IMPORTANT: Custom override changes, 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.**
331+
**IMPORTANT: Custom override changes, 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.**
332332
333-
**IMPORTANT: Incorrectly formatted override files are 'somewhat' silently ignored. WebLogic Servers log errors or warnings when they detect an incorrectly formatted configuration override template file, but will still boot, and will skip overriding. So it is important to make sure template files are correct in a QA environment by checking your WebLogic pod logs for situational configuration errors and warnings, before attempting to use them in production.**
333+
**IMPORTANT: Incorrectly formatted override files are 'somewhat' silently ignored. WebLogic Servers log errors or warnings when they detect an incorrectly formatted configuration override template file, but will still boot, and will skip overriding. So it is important to make sure that the template files are correct in a QA environment by checking your WebLogic pod logs for situational configuration errors and warnings, before attempting to use them in production.**
334334
335335
---
336336
# Internal design flow

0 commit comments

Comments
 (0)