Skip to content

Commit f7d3152

Browse files
authored
Merge pull request #977 from oracle/rmarano
updates
2 parents ad74cff + f78a836 commit f7d3152

File tree

2 files changed

+31
-29
lines changed
  • docs-source/content/userguide

2 files changed

+31
-29
lines changed

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

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -188,17 +188,17 @@ The secret macro `SECRETNAME` field must reference the name of a Kubernetes secr
188188

189189
* Reference the name of the current bean and each parent bean in any hierarchy you override.
190190
* 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.
192192
* Use situational config `replace` and `add` verbs as follows:
193193
* 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.
195195
* 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.
197197
* If you are changing the value of an existing attribute within a domain home `config.xml`, then the attribute needs a `replace` verb.
198198
* See the `public-address` stanza in [Override template samples](#override-template-samples) for an example.
199199
* When overriding `config.xml`:
200200
* 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.
202202
* Avoid specifying the domain name stanza, as this may cause some overrides to be ignored (for example, server-template scoped overrides).
203203
* When overriding modules:
204204
* 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,
269269
* 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.
270270
* This directory must not contain any other files.
271271
* 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.
273273
* Templates must not override the settings listed in [Unsupported overrides](#unsupported-overrides).
274274
* Templates must be formatted and named as per [Override template names and syntax](#override-template-names-and-syntax).
275275
* 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,
297297
* 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.
298298
* 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).
299299
* 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.
302302
* See [Debugging](#debugging) for ways to check if the situational configuration is taking effect or if there are errors.
303303
304304
Example domain resource YAML:
@@ -329,18 +329,18 @@ Incorrectly formatted override files may be accepted without warnings or errors
329329
330330
* If WebLogic pods do not come up at all, then:
331331
* 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:
332-
* `kubectl -n MYDOMAINNAMESPACE describe job INTROSPECTJOBNAME`
333-
* `kubectl -n MYDOMAINNAMESPACE logs INTROSPECTPODNAME`
332+
* `kubectl -n MYDOMAINNAMESPACE describe job INTROSPECTJOBNAME`
333+
* `kubectl -n MYDOMAINNAMESPACE logs INTROSPECTPODNAME`
334334
* Check your operator log for Warning/Error/Severe messages.
335-
* `kubectl -n MYOPERATORNAMESPACE logs OPERATORPODNAME`
335+
* `kubectl -n MYOPERATORNAMESPACE logs OPERATORPODNAME`
336336
337337
* If WebLogic pods do start, then:
338338
* Search your Administration Server pod's `kubectl log` for the keyword `situational`, for example `kubectl logs MYADMINPOD | grep -i situational`.
339-
* The only WebLogic Server log lines that match should look something like:
340-
* `<Dec 14, 2018 12:20:47 PM UTC> <Info> <Management> <BEA-141330> <Loading situational configuration file: /shared/domains/domain1/optconfig/custom-situational-config.xml>`
341-
* 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:
340+
* `<Dec 14, 2018 12:20:47 PM UTC> <Info> <Management> <BEA-141330> <Loading situational configuration file: /shared/domains/domain1/optconfig/custom-situational-config.xml>`
341+
* 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):
344344
```
345345
java.lang.NullPointerException
346346
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
350350
...
351351
```
352352
* 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.
355355
356356
* 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.
357357
* 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
384384
* The introspector job's pod:
385385
* Mounts the Kubernetes configuration map and secrets specified via the operator domain resource `configOverrides`, `webLogicCredentialsSecret`, and `configOverrideSecrets` fields.
386386
* 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.
392392
* The operator runtime:
393393
* Reads the expanded situational configuration files and/or errors from the introspector.
394394
* 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.
398398
* 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.
401401
* The `startServer.sh` script in the WebLogic Server pods:
402402
* 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.
405405
* Deletes any situational configuration files in the `optconfig` directory that do not have corresponding template files in the configuration map.
406406
* WebLogic Servers read their overrides from their domain home's `optconfig` directory.

docs-source/content/userguide/managing-operators/using-the-operator/using-helm.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ description: "Useful Helm operations"
1717
* [Debugging options](#debugging-options)
1818
* [Common mistakes and solutions](#common-mistakes-and-solutions)
1919

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+
2022
#### Useful Helm operations
2123

2224
Show the available operator configuration parameters and their default values:

0 commit comments

Comments
 (0)