Skip to content

Commit 5930d82

Browse files
author
Tom Barnes
authored
minor doc updates: logHome and dataHome usage (#2308)
1 parent a100ac8 commit 5930d82

File tree

6 files changed

+12
-7
lines changed

6 files changed

+12
-7
lines changed

documentation/domains/Domain.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@
325325
"$ref": "#/definitions/AdminServer"
326326
},
327327
"logHome": {
328-
"description": "The directory in a server\u0027s container in which to store the domain, Node Manager, server logs, server *.out, introspector .out, and optionally HTTP access log files if `httpAccessLogInLogHome` is true. Ignored if `logHomeEnabled` is false.",
328+
"description": "The directory in a server\u0027s container in which to store the domain, Node Manager, server logs, server *.out, introspector .out, and optionally HTTP access log files if `httpAccessLogInLogHome` is true. Default is `/shared/logs/DOMAIN-UID`. Ignored if `logHomeEnabled` is false.",
329329
"type": "string"
330330
},
331331
"includeServerOutInPodLog": {

documentation/domains/Domain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The specification of the operation of the WebLogic domain. Required.
3232
| `includeServerOutInPodLog` | Boolean | Specifies whether the server .out file will be included in the Pod's log. Defaults to true. |
3333
| `introspectVersion` | string | Changes to this field cause the operator to repeat its introspection of the WebLogic domain configuration. Repeating introspection is required for the operator to recognize changes to the domain configuration, such as adding a new WebLogic cluster or Managed Server instance, to regenerate configuration overrides, or to regenerate the WebLogic domain home when the `domainHomeSourceType` is FromModel. Introspection occurs automatically, without requiring change to this field, when servers are first started or restarted after a full domain shut down. For the FromModel `domainHomeSourceType`, introspection also occurs when a running server must be restarted because of changes to any of the fields listed here: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#properties-that-cause-servers-to-be-restarted. See also `domains.spec.configuration.overrideDistributionStrategy`. |
3434
| `livenessProbeCustomScript` | string | Full path of an optional liveness probe custom script for WebLogic Server instance pods. The existing liveness probe script `livenessProbe.sh` will invoke this custom script after the existing script performs its own checks. This element is optional and is for advanced usage only. Its value is not set by default. If the custom script fails with non-zero exit status, then pod will fail the liveness probe and Kubernetes will restart the container. If the script specified by this element value is not found, then it is ignored. |
35-
| `logHome` | string | The directory in a server's container in which to store the domain, Node Manager, server logs, server *.out, introspector .out, and optionally HTTP access log files if `httpAccessLogInLogHome` is true. Ignored if `logHomeEnabled` is false. |
35+
| `logHome` | string | The directory in a server's container in which to store the domain, Node Manager, server logs, server *.out, introspector .out, and optionally HTTP access log files if `httpAccessLogInLogHome` is true. Default is `/shared/logs/DOMAIN-UID`. Ignored if `logHomeEnabled` is false. |
3636
| `logHomeEnabled` | Boolean | Specifies whether the log home folder is enabled. Defaults to true if `domainHomeSourceType` is PersistentVolume; false, otherwise. |
3737
| `managedServers` | array of [Managed Server](#managed-server) | Lifecycle options for individual Managed Servers, including Java options, environment variables, additional Pod content, and the ability to explicitly start, stop, or restart a named server instance. The `serverName` field of each entry must match a Managed Server that already exists in the WebLogic domain configuration or that matches a dynamic cluster member based on the server template. |
3838
| `maxClusterConcurrentShutdown` | number | The default maximum number of WebLogic Server instances that a cluster will shut down in parallel when it is being partially shut down by lowering its replica count. You can override this default on a per cluster basis by setting the cluster's `maxConcurrentShutdown` field. A value of 0 means there is no limit. Defaults to 1. |

documentation/staging/content/userguide/managing-domains/configoverrides/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ See [overrides distribution](#overrides-distribution) for a discussion of distri
105105
* Domain topology (cluster members)
106106
* Network channel listen address, port, and enabled configuration
107107
* Server and domain log locations
108+
* Default or custom file store directories when `domain.spec.dataHome` is set
108109
* Node Manager related configuration
109110
* Changing any existing MBean name
110111
* Adding or removing a module (for example, a JDBC module)
@@ -120,7 +121,8 @@ See [overrides distribution](#overrides-distribution) for a discussion of distri
120121
* Dynamic cluster size
121122
* Default, SSL, and Admin channel `Enabled`, listen address, and port
122123
* Network Access Point (custom channel), listen address, or port
123-
* Server and domain log locations -- use the `logHome` domain setting instead
124+
* Server and domain log locations -- use the `domain.spec.logHome` setting instead and ensure that `domain.spec.logHomeEnabled` is set to true
125+
* Default or custom file store directories when `domain.spec.dataHome` is set
124126
* Node Manager access credentials
125127
* Any existing MBean name (for example, you cannot change the domain name)
126128

kubernetes/crd/domain-crd.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ apiVersion: apiextensions.k8s.io/v1
55
kind: CustomResourceDefinition
66
metadata:
77
annotations:
8-
weblogic.sha256: 184901e2753d12d5468f58f1e072d45ee257655d557ec30a4cdd0554c36d804a
8+
weblogic.sha256: de883bb3d965b09f91bc60c21481d6d61f441ac6ddf9952a9189f85eb887b507
99
name: domains.weblogic.oracle
1010
spec:
1111
group: weblogic.oracle
@@ -2943,7 +2943,8 @@ spec:
29432943
description: The directory in a server's container in which to store
29442944
the domain, Node Manager, server logs, server *.out, introspector
29452945
.out, and optionally HTTP access log files if `httpAccessLogInLogHome`
2946-
is true. Ignored if `logHomeEnabled` is false.
2946+
is true. Default is `/shared/logs/DOMAIN-UID`. Ignored if `logHomeEnabled`
2947+
is false.
29472948
type: string
29482949
includeServerOutInPodLog:
29492950
description: Specifies whether the server .out file will be included

kubernetes/crd/domain-v1beta1-crd.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ apiVersion: apiextensions.k8s.io/v1beta1
55
kind: CustomResourceDefinition
66
metadata:
77
annotations:
8-
weblogic.sha256: 184901e2753d12d5468f58f1e072d45ee257655d557ec30a4cdd0554c36d804a
8+
weblogic.sha256: de883bb3d965b09f91bc60c21481d6d61f441ac6ddf9952a9189f85eb887b507
99
name: domains.weblogic.oracle
1010
spec:
1111
group: weblogic.oracle
@@ -2937,7 +2937,8 @@ spec:
29372937
description: The directory in a server's container in which to store
29382938
the domain, Node Manager, server logs, server *.out, introspector
29392939
.out, and optionally HTTP access log files if `httpAccessLogInLogHome`
2940-
is true. Ignored if `logHomeEnabled` is false.
2940+
is true. Default is `/shared/logs/DOMAIN-UID`. Ignored if `logHomeEnabled`
2941+
is false.
29412942
type: string
29422943
includeServerOutInPodLog:
29432944
description: Specifies whether the server .out file will be included

operator/src/main/java/oracle/kubernetes/weblogic/domain/model/DomainSpec.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ public class DomainSpec extends BaseConfiguration {
100100
"The directory in a server's container in which to store the domain, Node Manager, server logs, "
101101
+ "server *.out, introspector .out, and optionally HTTP access log files "
102102
+ "if `httpAccessLogInLogHome` is true. "
103+
+ "Default is `/shared/logs/DOMAIN-UID`. "
103104
+ "Ignored if `logHomeEnabled` is false.")
104105
private String logHome;
105106

0 commit comments

Comments
 (0)