Skip to content

Commit 3be2db5

Browse files
markxnelsonmarkxnelson
committed
archive domain schema for 2.2.1
1 parent bb50814 commit 3be2db5

16 files changed

+2455
-0
lines changed

‎docs/v2.2.1/domains/Domain.json

Lines changed: 614 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/v2.2.1/domains/Domain.md

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
### Domain
2+
3+
Domain represents a WebLogic domain and how it will be realized in the Kubernetes cluster.
4+
5+
| Name | Type | Description |
6+
| --- | --- | --- |
7+
| `apiVersion` | string | The API version for the Domain. |
8+
| `kind` | string | The type of resource. Must be 'Domain'. |
9+
| `metadata` | [Object Meta](k8s1.13.5.md#object-meta) | The domain meta-data. Must include the name and namespace. |
10+
| `spec` | [Domain Spec](#domain-spec) | The specification of the domain. Required |
11+
| `status` | [Domain Status](#domain-status) | The current status of the domain. Updated by the operator. |
12+
13+
### Domain Spec
14+
15+
DomainSpec is a description of a domain.
16+
17+
| Name | Type | Description |
18+
| --- | --- | --- |
19+
| `adminServer` | [Admin Server](#admin-server) | Configuration for the admin server. |
20+
| `clusters` | array of [Cluster](#cluster) | Configuration for the clusters. |
21+
| `configOverrides` | string | The name of the config map for optional WebLogic configuration overrides. |
22+
| `configOverrideSecrets` | array of string | A list of names of the secrets for optional WebLogic configuration overrides. |
23+
| `domainHome` | string | 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 |
24+
| `domainHomeInImage` | Boolean | True if this domain's home is defined in the docker image for the domain. Defaults to true. |
25+
| `domainUID` | string | Domain unique identifier. Must be unique across the Kubernetes cluster. Not required. Defaults to the value of metadata.name |
26+
| `image` | string | The WebLogic Docker image; required when domainHomeInImage is true; otherwise, defaults to container-registry.oracle.com/middleware/weblogic:12.2.1.3. |
27+
| `imagePullPolicy` | string | 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. |
28+
| `imagePullSecrets` | array of [Local Object Reference](k8s1.13.5.md#local-object-reference) | A list of image pull secrets for the WebLogic Docker image. |
29+
| `includeServerOutInPodLog` | Boolean | If true (the default), the server .out file will be included in the pod's stdout. |
30+
| `logHome` | string | The in-pod name of the directory in which to store the domain, node manager, server logs, and server *.out files |
31+
| `logHomeEnabled` | Boolean | Specified whether the log home folder is enabled. Not required. Defaults to true if domainHomeInImage is false. Defaults to false if domainHomeInImage is true. |
32+
| `managedServers` | array of [Managed Server](#managed-server) | Configuration for the managed servers. |
33+
| `replicas` | number | The number of managed servers to run in any cluster that does not specify a replica count. |
34+
| `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
35+
| `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
36+
| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
37+
| `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are ADMIN_ONLY, NEVER, or IF_NEEDED. |
38+
| `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
39+
| `webLogicCredentialsSecret` | [Secret Reference](k8s1.13.5.md#secret-reference) | 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. |
40+
41+
### Domain Status
42+
43+
DomainStatus represents information about the status of a domain. Status may trail the actual state of a system.
44+
45+
| Name | Type | Description |
46+
| --- | --- | --- |
47+
| `conditions` | array of [Domain Condition](#domain-condition) | Current service state of domain. |
48+
| `message` | string | A human readable message indicating details about why the domain is in this condition. |
49+
| `reason` | string | A brief CamelCase message indicating details about why the domain is in this state. |
50+
| `replicas` | number | 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. |
51+
| `servers` | array of [Server Status](#server-status) | Status of WebLogic servers in this domain. |
52+
| `startTime` | DateTime | 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. |
53+
54+
### Admin Server
55+
56+
AdminServer represents the operator configuration for the admin server.
57+
58+
| Name | Type | Description |
59+
| --- | --- | --- |
60+
| `adminService` | [Admin Service](#admin-service) | Configures which of the admin server's WebLogic admin channels should be exposed outside the Kubernetes cluster via a node port service. |
61+
| `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
62+
| `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
63+
| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
64+
| `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED. |
65+
| `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
66+
67+
### Cluster
68+
69+
An element representing a cluster in the domain configuration.
70+
71+
| Name | Type | Description |
72+
| --- | --- | --- |
73+
| `clusterName` | string | The name of this cluster. Required |
74+
| `clusterService` | [Kubernetes Resource](#kubernetes-resource) | Customization affecting ClusterIP Kubernetes services for WebLogic cluster. |
75+
| `maxUnavailable` | number | The maximum number of cluster members that can be temporarily unavailable. Defaults to 1. |
76+
| `replicas` | number | The number of managed servers to run in this cluster. |
77+
| `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
78+
| `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
79+
| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
80+
| `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are NEVER, or IF_NEEDED. |
81+
| `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
82+
83+
### Managed Server
84+
85+
ManagedServer represents the operator configuration for a single managed server.
86+
87+
| Name | Type | Description |
88+
| --- | --- | --- |
89+
| `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
90+
| `serverName` | string | The name of the server. Required |
91+
| `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
92+
| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
93+
| `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED. |
94+
| `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
95+
96+
### Server Pod
97+
98+
ServerPod describes the configuration for a Kubernetes pod for a server.
99+
100+
| Name | Type | Description |
101+
| --- | --- | --- |
102+
| `annotations` | Map | The annotations to be attached to generated resources. |
103+
| `containers` | array of [Container](k8s1.13.5.md#container) | Additional containers to be included in the server pod. |
104+
| `containerSecurityContext` | [Security Context](k8s1.13.5.md#security-context) | Container-level security attributes. Will override any matching pod-level attributes. |
105+
| `env` | array of [Env Var](k8s1.13.5.md#env-var) | A list of environment variables to add to a server |
106+
| `initContainers` | array of [Container](k8s1.13.5.md#container) | Initialization containers |
107+
| `labels` | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
108+
| `livenessProbe` | [Probe Tuning](#probe-tuning) | Settings for the liveness probe associated with a server. |
109+
| `nodeSelector` | Map | Selector which must match a node's labels for the pod to be scheduled on that node. |
110+
| `podSecurityContext` | [Pod Security Context](k8s1.13.5.md#pod-security-context) | Pod-level security attributes. |
111+
| `readinessProbe` | [Probe Tuning](#probe-tuning) | Settings for the readiness probe associated with a server. |
112+
| `resources` | [Resource Requirements](k8s1.13.5.md#resource-requirements) | Memory and cpu minimum requirements and limits for the server. |
113+
| `shutdown` | [Shutdown](#shutdown) | Configures how the operator should shutdown the server instance. |
114+
| `volumeMounts` | array of [Volume Mount](k8s1.13.5.md#volume-mount) | Additional volume mounts for the server pod. |
115+
| `volumes` | array of [Volume](k8s1.13.5.md#volume) | Additional volumes to be created in the server pod. |
116+
117+
### Server Service
118+
119+
| Name | Type | Description |
120+
| --- | --- | --- |
121+
| `annotations` | Map | The annotations to be attached to generated resources. |
122+
| `labels` | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
123+
| `precreateService` | Boolean | If true, operator will create server services even for server instances without running pods. |
124+
125+
### Domain Condition
126+
127+
| Name | Type | Description |
128+
| --- | --- | --- |
129+
| `lastProbeTime` | DateTime | Last time we probed the condition. |
130+
| `lastTransitionTime` | DateTime | Last time the condition transitioned from one status to another. |
131+
| `message` | string | Human-readable message indicating details about last transition. |
132+
| `reason` | string | Unique, one-word, CamelCase reason for the condition's last transition. |
133+
| `status` | string | Status is the status of the condition. Can be True, False, Unknown. Required |
134+
| `type` | string | The type of the condition. Valid types are Progressing, Available, and Failed. Required |
135+
136+
### Server Status
137+
138+
| Name | Type | Description |
139+
| --- | --- | --- |
140+
| `clusterName` | string | WebLogic cluster name, if the server is part of a cluster. |
141+
| `health` | [Server Health](#server-health) | Current status and health of a specific WebLogic server. |
142+
| `nodeName` | string | Name of node that is hosting the Pod containing this WebLogic server. |
143+
| `serverName` | string | WebLogic server name. Required |
144+
| `state` | string | Current state of this WebLogic server. Required |
145+
146+
### Admin Service
147+
148+
| Name | Type | Description |
149+
| --- | --- | --- |
150+
| `annotations` | Map | Annotations to associate with the external channel service |
151+
| `channels` | array of [Channel](#channel) | 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. |
152+
| `labels` | Map | Labels to associate with the external channel service |
153+
154+
### Kubernetes Resource
155+
156+
| Name | Type | Description |
157+
| --- | --- | --- |
158+
| `annotations` | Map | The annotations to be attached to generated resources. |
159+
| `labels` | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
160+
161+
### Probe Tuning
162+
163+
| Name | Type | Description |
164+
| --- | --- | --- |
165+
| `initialDelaySeconds` | number | The number of seconds before the first check is performed |
166+
| `periodSeconds` | number | The number of seconds between checks |
167+
| `timeoutSeconds` | number | The number of seconds with no response that indicates a failure |
168+
169+
### Shutdown
170+
171+
Shutdown describes the configuration for shutting down a server instance.
172+
173+
| Name | Type | Description |
174+
| --- | --- | --- |
175+
| `ignoreSessions` | Boolean | For graceful shutdown only, indicates to ignore pending HTTP sessions during in-flight work handling. Not required. Defaults to false. |
176+
| `shutdownType` | string | Tells the operator how to shutdown server instances. Not required. Defaults to graceful shutdown. |
177+
| `timeoutSeconds` | number | For graceful shutdown only, number of seconds to wait before aborting in-flight work and shutting down the server. Not required. Defaults to 30 seconds. |
178+
179+
### Server Health
180+
181+
| Name | Type | Description |
182+
| --- | --- | --- |
183+
| `activationTime` | DateTime | RFC 3339 date and time at which the server started. |
184+
| `overallHealth` | string | Server health of this WebLogic server. If the value is "Not available", the operator has failed to read the health. If the value is "Not available (possibly overloaded)", the operator has failed to read the health of the server possibly due to the server is in overloaded state |
185+
| `subsystems` | array of [Subsystem Health](#subsystem-health) | Status of unhealthy subsystems, if any. |
186+
187+
### Channel
188+
189+
Describes a single channel used by the admin server.
190+
191+
| Name | Type | Description |
192+
| --- | --- | --- |
193+
| `channelName` | string | Name of channel.<br/>'default' refers to the admin server's default channel (configured via the ServerMBean's ListenPort) <br/>'default-secure' refers to the admin server's default secure channel (configured via the ServerMBean's SSLMBean's ListenPort) <br/>'default-admin' refers to the admin server's default administrative channel (configured via the DomainMBean's AdministrationPort) <br/>Otherwise, the name is the name of one of the admin server's network access points (configured via the ServerMBean's NetworkAccessMBeans). |
194+
| `nodePort` | number | 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. |
195+
196+
### Subsystem Health
197+
198+
| Name | Type | Description |
199+
| --- | --- | --- |
200+
| `health` | string | Server health of this WebLogic server. Required |
201+
| `subsystemName` | string | Name of subsystem providing symptom information. Required |
202+
| `symptoms` | array of string | Symptoms provided by the reporting subsystem. |

‎docs/v2.2.1/domains/favicon-16x16.png

445 Bytes
Loading

‎docs/v2.2.1/domains/favicon-32x32.png

1.11 KB
Loading

0 commit comments

Comments
 (0)