Skip to content

Commit 3ac94bd

Browse files
alai8alai8
committed
Merge branch 'develop' into owls-71360
2 parents fcfc477 + 575f72a commit 3ac94bd

File tree

21 files changed

+697
-2326
lines changed

21 files changed

+697
-2326
lines changed

‎docs/domains/Domain.json

Lines changed: 9 additions & 1136 deletions
Large diffs are not rendered by default.

‎docs/domains/Domain.md

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
### Domain
2+
3+
| Name | Description |
4+
| --- | --- |
5+
| apiVersion | The API version for the Domain. Must be 'weblogic.oracle/v2'. |
6+
| kind | The type of resource. Must be 'Domain'. |
7+
| metadata | The domain meta-data. Must include the name and namespace. |
8+
| spec | The specification of the domain. Required. See section 'Domain Spec' |
9+
| status | The current status of the domain. Updated by the operator. See section 'Domain Status' |
10+
11+
### Domain Spec
12+
13+
| Name | Description |
14+
| --- | --- |
15+
| adminServer | Configuration for the admin server. See section 'Admin Server' |
16+
| clusters | Configuration for the clusters. See section 'Cluster' |
17+
| configOverrides | The name of the config map for optional WebLogic configuration overrides. |
18+
| configOverrideSecrets | A list of names of the secrets for optional WebLogic configuration overrides. |
19+
| domainHome | The folder for the Weblogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true. |
20+
| domainHomeInImage | True if this domain's home is defined in the docker image for the domain. Defaults to true. |
21+
| domainUID | Domain unique identifier. Must be unique across the Kubernetes cluster. Not required. Defaults to the value of metadata.name. |
22+
| image | The Weblogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3. |
23+
| imagePullPolicy | The image pull policy for the WebLogic Docker image. Legal values are Always, Never and IfNotPresent. Defaults to Always if image ends in :latest, IfNotPresent otherwise. |
24+
| imagePullSecrets | A list of image pull secrets for the WebLogic Docker image. |
25+
| includeServerOutInPodLog | If true (the default), the server .out file will be included in the pod's stdout. |
26+
| logHome | The in-pod name of the directory in which to store the domain, node manager, server logs, and server *.out files. |
27+
| logHomeEnabled | Specified whether the log home folder is enabled. Not required. Defaults to true if domainHomeInImage is false. Defaults to false if domainHomeInImage is true. |
28+
| managedServers | Configuration for the managed servers. See section 'Managed Server' |
29+
| replicas | The number of managed servers to run in any cluster that does not specify a replica count. |
30+
| restartVersion | If present, every time this value is updated the operator will restart the required servers. |
31+
| serverPod | Configuration affecting server pods. See section 'Server Pod' |
32+
| serverService | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. See section 'Kubernetes Resource' |
33+
| serverStartPolicy | The strategy for deciding whether to start a server. Legal values are ADMIN_ONLY, NEVER, or IF_NEEDED. |
34+
| serverStartState | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
35+
| webLogicCredentialsSecret | The name of a pre-created Kubernetes secret, in the domain's namepace, that holds the username and password needed to boot WebLogic Server under the 'username' and 'password' fields. |
36+
37+
### Domain Status
38+
39+
| Name | Description |
40+
| --- | --- |
41+
| conditions | Current service state of domain. See section 'Domain Condition' |
42+
| message | A human readable message indicating details about why the domain is in this condition. |
43+
| reason | A brief CamelCase message indicating details about why the domain is in this state. |
44+
| replicas | The number of running managed servers in the WebLogic cluster if there is only one cluster in the domain and where the cluster does not explicitly configure its replicas in a cluster specification. |
45+
| servers | Status of WebLogic servers in this domain. See section 'Server Status' |
46+
| startTime | RFC 3339 date and time at which the operator started the domain. This will be when the operator begins processing and will precede when the various servers or clusters are available. |
47+
48+
### Admin Server
49+
50+
| Name | Description |
51+
| --- | --- |
52+
| adminService | Configures which of the admin server's WebLogic admin channels should be exposed outside the Kubernetes cluster via a node port service. See section 'Admin Service' |
53+
| restartVersion | If present, every time this value is updated the operator will restart the required servers. |
54+
| serverPod | Configuration affecting server pods. See section 'Server Pod' |
55+
| serverService | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. See section 'Kubernetes Resource' |
56+
| serverStartPolicy | The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED. |
57+
| serverStartState | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
58+
59+
### Cluster
60+
61+
| Name | Description |
62+
| --- | --- |
63+
| clusterName | The name of this cluster. Required. |
64+
| clusterService | Customization affecting ClusterIP Kubernetes services for WebLogic cluster. See section 'Kubernetes Resource' |
65+
| maxUnavailable | The maximum number of cluster members that can be temporarily unavailable. Defaults to 1. |
66+
| replicas | The number of managed servers to run in this cluster. |
67+
| restartVersion | If present, every time this value is updated the operator will restart the required servers. |
68+
| serverPod | Configuration affecting server pods. See section 'Server Pod' |
69+
| serverService | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. See section 'Kubernetes Resource' |
70+
| serverStartPolicy | The strategy for deciding whether to start a server. Legal values are NEVER, or IF_NEEDED. |
71+
| serverStartState | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
72+
73+
### Managed Server
74+
75+
| Name | Description |
76+
| --- | --- |
77+
| restartVersion | If present, every time this value is updated the operator will restart the required servers. |
78+
| serverName | The name of the server. Required. |
79+
| serverPod | Configuration affecting server pods. See section 'Server Pod' |
80+
| serverService | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. See section 'Kubernetes Resource' |
81+
| serverStartPolicy | The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED. |
82+
| serverStartState | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
83+
84+
### Server Pod
85+
86+
| Name | Description |
87+
| --- | --- |
88+
| annotations | The annotations to be attached to generated resources. |
89+
| containerSecurityContext | Container-level security attributes. Will override any matching pod-level attributes. |
90+
| env | A list of environment variables to add to a server. |
91+
| labels | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
92+
| livenessProbe | Settings for the liveness probe associated with a server. See section 'Probe Tuning' |
93+
| nodeSelector | Selector which must match a node's labels for the pod to be scheduled on that node. |
94+
| podSecurityContext | Pod-level security attributes. |
95+
| readinessProbe | Settings for the readiness probe associated with a server. See section 'Probe Tuning' |
96+
| resources | Memory and cpu minimum requirements and limits for the server. |
97+
| volumeMounts | Additional volume mounts for the server pod. |
98+
| volumes | Additional volumes to be created in the server pod. |
99+
100+
### Kubernetes Resource
101+
102+
| Name | Description |
103+
| --- | --- |
104+
| annotations | The annotations to be attached to generated resources. |
105+
| labels | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
106+
107+
### Domain Condition
108+
109+
| Name | Description |
110+
| --- | --- |
111+
| lastProbeTime | Last time we probed the condition. |
112+
| lastTransitionTime | Last time the condition transitioned from one status to another. |
113+
| message | Human-readable message indicating details about last transition. |
114+
| reason | Unique, one-word, CamelCase reason for the condition's last transition. |
115+
| status | Status is the status of the condition. Can be True, False, Unknown. Required. |
116+
| type | Type is the type of the condition. Currently, valid types are Progressing, Available, and Failure. Required. |
117+
118+
### Server Status
119+
120+
| Name | Description |
121+
| --- | --- |
122+
| clusterName | WebLogic cluster name, if the server is part of a cluster. |
123+
| health | Current status and health of a specific WebLogic server. See section 'Server Health' |
124+
| nodeName | Name of node that is hosting the Pod containing this WebLogic server. |
125+
| serverName | WebLogic server name. Required. |
126+
| state | Current state of this WebLogic server. Required. |
127+
128+
### Admin Service
129+
130+
| Name | Description |
131+
| --- | --- |
132+
| channels | Specifies which of the admin server's WebLogic channels should be exposed outside the Kubernetes cluster via a node port service, along with the node port for each channel. If not specified, the admin server's node port service will not be created. See section 'Channel' |
133+
134+
### Probe Tuning
135+
136+
| Name | Description |
137+
| --- | --- |
138+
| initialDelaySeconds | The number of seconds before the first check is performed. |
139+
| periodSeconds | The number of seconds between checks. |
140+
| timeoutSeconds | The number of seconds with no response that indicates a failure. |
141+
142+
### Server Health
143+
144+
| Name | Description |
145+
| --- | --- |
146+
| activationTime | RFC 3339 date and time at which the server started. |
147+
| overallHealth | Server health of this WebLogic server. |
148+
| subsystems | Status of unhealthy subsystems, if any. See section 'Subsystem Health' |
149+
150+
### Channel
151+
152+
| Name | Description |
153+
| --- | --- |
154+
| channelName | Name of channel. default' refers to the admin server's default channel (configured via the ServerMBean's ListenPort) 'default-secure' refers to the admin server's default secure channel (configured via the ServerMBean's SSLMBean's ListenPort) 'default-admin' refers to the admin server's default administrative channel (configured via the DomainMBean's AdministrationPort) Otherwise, the name is the name of one of the admin server's network access points (configured via the ServerMBean's NetworkAccessMBeans). |
155+
| nodePort | Specifies the port number used to access the WebLogic channel outside of the Kubernetes cluster. If not specified, defaults to the port defined by the WebLogic channel. |
156+
157+
### Subsystem Health
158+
159+
| Name | Description |
160+
| --- | --- |
161+
| health | Server health of this WebLogic server. Required. |
162+
| subsystemName | Name of subsystem providing symptom information. Required. |
163+
| symptoms | Symptoms provided by the reporting subsystem. |

0 commit comments

Comments
 (0)