A Domain resource describes the configuration, logging, images, and lifecycle of a WebLogic domain, including Java options, environment variables, additional Pod content, and the ability to explicitly start, stop, or restart its members. The Domain resource references its Cluster resources using .spec.clusters.
| Name | Type | Description |
|---|---|---|
apiVersion |
string | The API version defines the versioned schema of this Domain. Required. |
kind |
string | The type of the REST resource. Must be "Domain". Required. |
metadata |
Object Meta | The resource metadata. Must include the name and namespace. Required. |
spec |
Domain Spec | The specification of the operation of the WebLogic domain. Required. |
status |
Domain Status | The current status of the operation of the WebLogic domain. Updated automatically by the operator. |
The specification of the operation of the WebLogic domain. Required.
| Name | Type | Description |
|---|---|---|
adminServer |
Admin Server | Lifecycle options for the Administration Server, including Java options, environment variables, additional Pod content, and which channels or network access points should be exposed using a NodePort Service. |
clusters |
Array of Local Object Reference | References to Cluster resources that describe the lifecycle options for all of the Managed Server members of a WebLogic cluster, including Java options, environment variables, additional Pod content, and the ability to explicitly start, stop, or restart cluster members. The Cluster resource must describe a cluster that already exists in the WebLogic domain configuration. |
configuration |
Configuration | Models and overrides affecting the WebLogic domain configuration. |
dataHome |
string | An optional directory in a server's container for data storage of default and custom file stores. If dataHome is not specified or its value is either not set or empty, then the data storage directories are determined from the WebLogic domain configuration. |
domainHome |
string | The directory containing the WebLogic domain configuration inside the container. Defaults to /shared/domains/ if domainHomeSourceType is PersistentVolume. Defaults to /u01/oracle/user_projects/domains/ if domainHomeSourceType is Image. Defaults to /u01/domains/ if domainHomeSourceType is FromModel. |
domainHomeSourceType |
string | Domain home file system source type: Legal values: Image, PersistentVolume, FromModel. Image indicates that the domain home file system is present in the container image specified by the image field. PersistentVolume indicates that the domain home file system is located on a persistent volume. FromModel indicates that the domain home file system will be created and managed by the operator based on a WDT domain model. Defaults to Image, unless configuration.model is set, in which case the default is FromModel. |
domainUID |
string | Domain unique identifier. It is recommended that this value be unique to assist in future work to identify related domains in active-passive scenarios across data centers; however, it is only required that this value be unique within the namespace, similarly to the names of Kubernetes resources. This value is distinct and need not match the domain name from the WebLogic domain configuration. Defaults to the value of metadata.name. |
failureRetryIntervalSeconds |
integer | The wait time in seconds before the start of the next retry after a Severe failure. Defaults to 120. |
failureRetryLimitMinutes |
integer | The time in minutes before the operator will stop retrying Severe failures. Defaults to 1440. |
fluentbitSpecification |
Fluentbit Specification | Automatic fluent-bit sidecar injection. If specified, the operator will deploy a sidecar container alongside each WebLogic Server instance that runs the fluent-bit, Optionally, the introspector job pod can be enabled to deploy with the fluent-bit sidecar container. WebLogic Server instances that are already running when the fluentbitSpecification field is created or deleted, will not be affected until they are restarted. When any given server is restarted for another reason, such as a change to the restartVersion, then the newly created pod will have the fluent-bit sidecar or not, as appropriate |
fluentdSpecification |
Fluentd Specification | Automatic fluentd sidecar injection. If specified, the operator will deploy a sidecar container alongside each WebLogic Server instance that runs the fluentd, Optionally, the introspector job pod can be enabled to deploy with the fluentd sidecar container. WebLogic Server instances that are already running when the fluentdSpecification field is created or deleted, will not be affected until they are restarted. When any given server is restarted for another reason, such as a change to the restartVersion, then the newly created pod will have the fluentd sidecar or not, as appropriate |
httpAccessLogInLogHome |
Boolean | Specifies whether the server HTTP access log files will be written to the same directory specified in logHome. Otherwise, server HTTP access log files will be written to the directory configured in the WebLogic domain configuration. Defaults to true. |
image |
string | The WebLogic Server image; required when domainHomeSourceType is Image or FromModel; otherwise, defaults to container-registry.oracle.com/middleware/weblogic:12.2.1.4. |
imagePullPolicy |
string | The image pull policy for the WebLogic Server image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
imagePullSecrets |
Array of Local Object Reference | A list of image pull Secrets for the WebLogic Server image. |
includeServerOutInPodLog |
Boolean | Specifies whether the server .out file will be included in the Pod's log. Defaults to true. |
introspector |
Introspector | Lifecycle options for the Introspector Job Pod, including Java options, environment variables, and resources. |
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. The introspectVersion value must be a valid label value in Kubernetes. See also domains.spec.configuration.overrideDistributionStrategy. |
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. |
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.See also domains.spec.logHomeLayout. |
logHomeEnabled |
Boolean | Specifies whether the log home folder is enabled. Defaults to true if domainHomeSourceType is PersistentVolume; false, otherwise. |
logHomeLayout |
string | Control how log files under logHome are organized when logHome is set and logHomeEnabled is true. Flat specifies that all files are kept directly in the logHome root directory. ByServers specifies that domain log files and introspector.out are at the logHome root level, all other files are organized under the respective server name logs directory logHome/servers/<server name>/logs. Defaults to ByServers. |
managedServers |
Array of 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. |
maxClusterConcurrentShutdown |
integer | 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. |
maxClusterConcurrentStartup |
integer | The maximum number of cluster member Managed Server instances that the operator will start in parallel for a given cluster, if maxConcurrentStartup is not specified for a specific cluster under the clusters field. A value of 0 means there is no configured limit. Defaults to 0. |
maxClusterUnavailable |
integer | The maximum number of cluster members that can be temporarily unavailable. You can override this default on a per cluster basis by setting the cluster's maxUnavailable field. Defaults to 1. |
monitoringExporter |
Monitoring Exporter Specification | Automatic deployment and configuration of the WebLogic Monitoring Exporter. If specified, the operator will deploy a sidecar container alongside each WebLogic Server instance that runs the exporter. WebLogic Server instances that are already running when the monitoringExporter field is created or deleted, will not be affected until they are restarted. When any given server is restarted for another reason, such as a change to the restartVersion, then the newly created pod will have the exporter sidecar or not, as appropriate. See https://github.com/oracle/weblogic-monitoring-exporter. |
replaceVariablesInJavaOptions |
Boolean | Specifies whether the operator will replace the environment variables in the Java options in certain situations, such as when the JAVA_OPTIONS are specified using a config map. Defaults to false. |
replicas |
integer | The default number of cluster member Managed Server instances to start for each WebLogic cluster in the domain configuration, unless replicas is specified for that cluster under the clusters field. For each cluster, the operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as "managed-server10" come after "managed-server9". The operator will then start Managed Servers from the sorted list, up to the replicas count, unless specific Managed Servers are specified as starting in their entry under the managedServers field. In that case, the specified Managed Servers will be started and then additional cluster members will be started, up to the replicas count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their entries under managedServers, then a cluster may have more cluster members running than its replicas count. Defaults to 1. |
restartVersion |
string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
serverPod |
Server Pod | Customization affecting the generation of Pods for WebLogic Server instances. |
serverService |
Server Service | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
serverStartPolicy |
string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are AdminOnly, Never, or IfNeeded. Defaults to IfNeeded. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. |
webLogicCredentialsSecret |
Local Object Reference | Reference to a Kubernetes Secret that contains the user name and password needed to boot a WebLogic Server under the username and password fields. |
The current status of the operation of the WebLogic domain. Updated automatically by the operator.
| Name | Type | Description |
|---|---|---|
clusters |
Array of Cluster Status | Status of WebLogic clusters in this domain. |
conditions |
Array of Domain Condition | Current service state of the domain. |
failedIntrospectionUid |
string | Unique ID of the last failed introspection job. |
initialFailureTime |
DateTime | RFC 3339 date and time at which a currently failing domain started automatic retries. |
introspectJobFailureCount |
integer | Non-zero if the introspector job fails for any reason. You can configure an introspector job retry limit for jobs that log script failures using the Operator tuning parameter 'domainPresenceFailureRetryMaxCount' (default 5). You cannot configure a limit for other types of failures, such as a Domain resource reference to an unknown secret name; in which case, the retries are unlimited. |
lastFailureTime |
DateTime | RFC 3339 date and time at which a currently failing domain last experienced a Severe failure. |
message |
string | A human readable message indicating details about why the domain is in this condition. |
observedGeneration |
integer | The Domain resource generation observed by the WebLogic operator. This value will match the 'domain.metadata.generation' when the 'domain.status' correctly reflects the latest resource changes. |
reason |
string | A brief CamelCase message indicating details about why the domain is in this state. |
replicas |
integer | The number of running cluster member Managed Servers in the WebLogic cluster if there is exactly one cluster defined in the domain configuration and where the replicas field is set at the spec level rather than for the specific cluster under clusters. This field is provided to support use of Kubernetes scaling for this limited use case. |
servers |
Array of Server Status | Status of WebLogic Servers in this domain. |
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. |
| Name | Type | Description |
|---|---|---|
adminChannelPortForwardingEnabled |
Boolean | When this flag is enabled, the operator updates the domain's WebLogic configuration for its Administration Server to have an admin protocol NetworkAccessPoint with a 'localhost' address for each existing admin protocol capable port. This allows external Administration Console and WLST 'T3' access when using the 'kubectl port-forward' pattern. Defaults to true. |
adminService |
Admin Service | Customization affecting the generation of a NodePort Service for the Administration Server used to expose specific channels or network access points outside the Kubernetes cluster. See also domains.spec.adminServer.serverService for configuration affecting the generation of the ClusterIP Service. |
restartVersion |
string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
serverPod |
Server Pod | Customization affecting the generation of Pods for WebLogic Server instances. |
serverService |
Server Service | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
serverStartPolicy |
string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are Always, Never, or IfNeeded. Defaults to IfNeeded. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. |
| Name | Type | Description |
|---|---|---|
initializeDomainOnPV |
Initialize Domain On PV | Configuration to initialize a WebLogic Domain on persistent volume (Domain on PV) and initialize related resources such as a persistent volume and a persistent volume claim. If specified, the operator will perform these one-time initialization steps only if the domain and resources do not already exist. The operator will not recreate or update the domain and resources when they already exist. For more information, see https://oracle.github.io/weblogic-kubernetes-operator/managing-domains/choosing-a-model/ and https://oracle.github.io/weblogic-kubernetes-operator/managing-domains/domain-on-pv |
introspectorJobActiveDeadlineSeconds |
integer | The introspector job timeout value in seconds. If this field is specified, then the operator's ConfigMap data.introspectorJobActiveDeadlineSeconds value is ignored. Defaults to 120 seconds. |
model |
Model | Model in image model files and properties. |
opss |
Opss | Settings for OPSS security for the Model in Image JRF Domain. This field is deprecated, and will be removed in a future release. For JRF domain on PV initialization, use configuration.initializeDomainOnPV.domain.opss section for configuring OPSS security settings. |
overrideDistributionStrategy |
string | Determines how updated configuration overrides are distributed to already running WebLogic Server instances following introspection when the domainHomeSourceType is PersistentVolume or Image. Configuration overrides are generated during introspection from Secrets, the overridesConfigMap field, and WebLogic domain topology. Legal values are Dynamic, which means that the operator will distribute updated configuration overrides dynamically to running servers, and OnRestart, which means that servers will use updated configuration overrides only after the server's next restart. The selection of OnRestart will not cause servers to restart when there are updated configuration overrides available. See also domains.spec.introspectVersion. Defaults to Dynamic. |
overridesConfigMap |
string | The name of the ConfigMap for WebLogic configuration overrides. |
secrets |
Array of string | A list of names of the Secrets for WebLogic configuration overrides or model. |
| Name | Type | Description |
|---|---|---|
containerArgs |
Array of string | (Optional) The Fluentbit sidecar container spec's args. Default is: [ -c, /etc/fluent-bit.conf ] if not specified |
containerCommand |
Array of string | (Optional) The Fluentbit sidecar container spec's command. Default is not set if not specified |
elasticSearchCredentials |
string | Fluentbit elastic search credentials. A Kubernetes secret in the same namespace of the domain. It must contains 4 keys: elasticsearchhost - ElasticSearch Host Service Address, elasticsearchport - Elastic Search Service Port, elasticsearchuser - Elastic Search Service User Name, elasticsearchpassword - Elastic Search User Password |
env |
Array of Env Var | A list of environment variables to set in the fluentbit container. See kubectl explain pods.spec.containers.env. |
fluentbitConfiguration |
string | The Fluentbit configuration text, specify your own custom fluentbit configuration. |
image |
string | The Fluentbit container image name. Defaults to fluent/fluentd-kubernetes-daemonset:v1.16.1-debian-elasticsearch7-1.2 |
imagePullPolicy |
string | The image pull policy for the Fluentbit sidecar container image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
parserConfiguration |
string | The Fluentbit parser configuration text, specify your own custom fluentbit configuration. |
resources |
Resource Requirements | Memory and CPU minimum requirements and limits for the fluentbit container. See kubectl explain pods.spec.containers.resources. |
volumeMounts |
Array of Volume Mount | Volume mounts for fluentbit container |
watchIntrospectorLogs |
Boolean | Fluentbit will watch introspector logs |
| Name | Type | Description |
|---|---|---|
containerArgs |
Array of string | (Optional) The Fluentd sidecar container spec's args. Default is: [ -c, /etc/fluentd.conf ] if not specified |
containerCommand |
Array of string | (Optional) The Fluentd sidecar container spec's command. Default is not set if not specified |
elasticSearchCredentials |
string | Fluentd elastic search credentials. A Kubernetes secret in the same namespace of the domain. It must contains 4 keys: elasticsearchhost - ElasticSearch Host Service Address, elasticsearchport - Elastic Search Service Port, elasticsearchuser - Elastic Search Service User Name, elasticsearchpassword - Elastic Search User Password |
env |
Array of Env Var | A list of environment variables to set in the fluentd container. See kubectl explain pods.spec.containers.env. |
fluentdConfiguration |
string | The fluentd configuration text, specify your own custom fluentd configuration. |
image |
string | The Fluentd container image name. Defaults to fluent/fluentd-kubernetes-daemonset:v1.16.1-debian-elasticsearch7-1.2 |
imagePullPolicy |
string | The image pull policy for the Fluentd sidecar container image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
resources |
Resource Requirements | Memory and CPU minimum requirements and limits for the fluentd container. See kubectl explain pods.spec.containers.resources. |
volumeMounts |
Array of Volume Mount | Volume mounts for fluentd container |
watchIntrospectorLogs |
Boolean | Fluentd will watch introspector logs |
| Name | Type | Description |
|---|---|---|
serverPod |
Introspector Job Pod | Customization affecting the generation of the Introspector Job Pod. |
| Name | Type | Description |
|---|---|---|
restartVersion |
string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
serverName |
string | The name of the Managed Server. This name must match the name of a Managed Server instance or of a dynamic cluster member name from a server template already defined in the WebLogic domain configuration. Required. |
serverPod |
Server Pod | Customization affecting the generation of Pods for WebLogic Server instances. |
serverService |
Server Service | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
serverStartPolicy |
string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are Always, Never, or IfNeeded. Defaults to IfNeeded. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. |
| Name | Type | Description |
|---|---|---|
configuration |
Map | The configuration for the WebLogic Monitoring Exporter. If WebLogic Server instances are already running and have the monitoring exporter sidecar container, then changes to this field will be propagated to the exporter without requiring the restart of the WebLogic Server instances. |
image |
string | The WebLogic Monitoring Exporter sidecar container image name. Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.2.1 |
imagePullPolicy |
string | The image pull policy for the WebLogic Monitoring Exporter sidecar container image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
port |
integer | The port exposed by the WebLogic Monitoring Exporter running in the sidecar container. Defaults to 8080. The port value must not conflict with a port used by any WebLogic Server instance, including the ports of built-in channels or network access points (NAPs). |
resources |
Resource Requirements | Memory and CPU minimum requirements and limits for the Monitoring exporter sidecar. See kubectl explain pods.spec.containers.resources. |
| Name | Type | Description |
|---|---|---|
affinity |
Affinity | The Pod's scheduling constraints. More info: https://oracle.github.io/weblogic-kubernetes-operator/faq/node-heating/. See kubectl explain pods.spec.affinity. |
annotations |
Map | The annotations to be added to generated resources. |
containers |
Array of Container | Additional containers to be included in the server Pod. See kubectl explain pods.spec.containers. |
containerSecurityContext |
Security Context | Container-level security attributes. Will override any matching Pod-level attributes. See kubectl explain pods.spec.containers.securityContext. If no value is specified for this field, the operator will use default content for container-level securityContext. More info: https://oracle.github.io/weblogic-kubernetes-operator/security/domain-security/pod-and-container/. |
env |
Array of Env Var | A list of environment variables to set in the container running a WebLogic Server instance. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables. See kubectl explain pods.spec.containers.env. |
envFrom |
Array of Env From Source | List of sources to populate environment variables in the container running a WebLogic Server instance. The sources include either a config map or a secret. The operator will not expand the dependent variables in the 'envFrom' source. More details: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#define-an-environment-variable-for-a-container. Also see: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables. |
hostAliases |
Array of Host Alias | HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. |
initContainers |
Array of Container | Initialization containers to be included in the server Pod. See kubectl explain pods.spec.initContainers. |
labels |
Map | The labels to be added to generated resources. The label names must not start with "weblogic.". |
livenessProbe |
Probe | Settings for the liveness probe associated with a WebLogic Server instance. If not specified, the operator will create a probe that executes a script provided by the operator. The operator will also fill in any missing tuning-related fields, if they are unspecified. Tuning-related fields will be inherited from the domain and cluster scopes unless a more specific scope defines a different action, such as a different script to execute. |
maxPendingWaitTimeSeconds |
integer | The maximum time in seconds that the operator waits for a WebLogic Server pod to reach the running state before it considers the pod failed. Defaults to 5 minutes. |
maxReadyWaitTimeSeconds |
integer | The maximum time in seconds that the operator waits for a WebLogic Server pod to reach the ready state before it considers the pod failed. Defaults to 1800 seconds. |
nodeName |
string | NodeName is a request to schedule this Pod onto a specific Node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits the resource requirements. See kubectl explain pods.spec.nodeName. |
nodeSelector |
Map | Selector which must match a Node's labels for the Pod to be scheduled on that Node. See kubectl explain pods.spec.nodeSelector. |
podSecurityContext |
Pod Security Context | Pod-level security attributes. See kubectl explain pods.spec.securityContext. If no value is specified for this field, the operator will use default content for the pod-level securityContext. More info: https://oracle.github.io/weblogic-kubernetes-operator/security/domain-security/pod-and-container/. |
priorityClassName |
string | If specified, indicates the Pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be the default or zero, if there is no default. See kubectl explain pods.spec.priorityClassName. |
readinessGates |
Array of Pod Readiness Gate | If specified, all readiness gates will be evaluated for Pod readiness. A Pod is ready when all its containers are ready AND all conditions specified in the readiness gates have a status equal to "True". More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md. |
readinessProbe |
Probe | Settings for the readiness probe associated with a WebLogic Server instance. If not specified, the operator will create an HTTP probe accessing the /weblogic/ready path. If an HTTP probe is specified then the operator will fill in path, port, and scheme, if they are missing. The operator will also fill in any missing tuning-related fields if they are unspecified. Tuning-related fields will be inherited from the domain and cluster scopes unless a more specific scope defines a different action, such as a different HTTP path to access. |
resources |
Resource Requirements | Memory and CPU minimum requirements and limits for the WebLogic Server instance. See kubectl explain pods.spec.containers.resources. |
restartPolicy |
string | Restart policy for all containers within the Pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy. See kubectl explain pods.spec.restartPolicy. |
runtimeClassName |
string | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this Pod. If no RuntimeClass resource matches the named class, the Pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://github.com/kubernetes/community/blob/master/keps/sig-node/0014-runtime-class.md This is an alpha feature and may change in the future. See kubectl explain pods.spec.runtimeClassName. |
schedulerName |
string | If specified, the Pod will be dispatched by the specified scheduler. If not specified, the Pod will be dispatched by the default scheduler. See kubectl explain pods.spec.schedulerName. |
serviceAccountName |
string | Name of the ServiceAccount to be used to run this Pod. If it is not set, default ServiceAccount will be used. The ServiceAccount has to exist at the time the Pod is created. See kubectl explain pods.spec.serviceAccountName. |
shutdown |
Shutdown | Configures how the operator should shut down the server instance. |
startupProbe |
Probe | Settings for the startup probe associated with a WebLogic Server instance. If not specified, the operator will not create a default startup probe. |
tolerations |
Array of Toleration | If specified, the Pod's tolerations. See kubectl explain pods.spec.tolerations. |
topologySpreadConstraints |
Array of Topology Spread Constraint | TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. |
volumeMounts |
Array of Volume Mount | Additional volume mounts for the container running a WebLogic Server instance. See kubectl explain pods.spec.containers.volumeMounts. |
volumes |
Array of Volume | Additional volumes to be created in the server Pod. See kubectl explain pods.spec.volumes. |
| Name | Type | Description |
|---|---|---|
annotations |
Map | The annotations to be added to generated resources. |
labels |
Map | The labels to be added to generated resources. The label names must not start with "weblogic.". |
precreateService |
Boolean | If true, the operator will create ClusterIP Services even for WebLogic Server instances without running Pods. |
| Name | Type | Description |
|---|---|---|
clusterName |
string | WebLogic cluster name. |
conditions |
Array of Cluster Condition | Current service state of the cluster. |
labelSelector |
string | Label selector that can be used to discover Pods associated with WebLogic managed servers belonging to this cluster. Must be set to work with HorizontalPodAutoscaler. |
maximumReplicas |
integer | The maximum number of cluster members. |
minimumReplicas |
integer | The minimum number of cluster members. |
observedGeneration |
integer | The Cluster resource generation observed by the WebLogic operator. If the Cluster resource exists, then this value will match the 'cluster.metadata.generation' when the 'cluster.status' correctly reflects the latest cluster resource changes. |
readyReplicas |
integer | The number of ready cluster members. |
replicas |
integer | The number of currently running cluster members. |
replicasGoal |
integer | The requested number of cluster members. Cluster members will be started by the operator if this value is larger than zero. |
| Name | Type | Description |
|---|---|---|
failureInfo |
Domain Condition Failure Info | Details about the failure. This field will only be set when the condition type is Failed. |
lastTransitionTime |
DateTime | Last time the condition transitioned from one status to another. |
message |
string | Human-readable message indicating details about last transition. |
reason |
string | Unique, one-word, CamelCase reason for the condition's last transition. |
severity |
string | The severity of the failure. Can be Fatal, Severe or Warning. |
status |
string | The status of the condition. Can be True, False, Unknown. |
type |
string | The type of the condition. Valid types are Completed, Available, Failed, Rolling, and ConfigChangesPendingRestart. |
| Name | Type | Description |
|---|---|---|
clusterName |
string | WebLogic cluster name, if the server is a member of a cluster. |
health |
Server Health | Current status and health of a specific WebLogic Server instance. |
nodeName |
string | Name of Node that is hosting the Pod containing this WebLogic Server instance. |
podPhase |
string | Phase of the WebLogic Server pod. Possible values are: Pending, Succeeded, Failed, Running, or Unknown. |
podReady |
string | Status of the WebLogic Server pod's Ready condition if the pod is in Running phase, otherwise Unknown. Possible values are: True, False or Unknown. |
serverName |
string | WebLogic Server instance name. |
state |
string | Current state of this WebLogic Server instance. |
stateGoal |
string | Desired state of this WebLogic Server instance. Values are RUNNING, ADMIN, or SHUTDOWN. |
| Name | Type | Description |
|---|---|---|
annotations |
Map | Annotations to associate with the Administration Server's NodePort Service, if it is created. |
channels |
Array of Channel | Specifies which of the Administration Server's WebLogic channels should be exposed outside the Kubernetes cluster via a NodePort Service, along with the port for each channel. If not specified, the Administration Server's NodePort Service will not be created. |
labels |
Map | Labels to associate with the Administration Server's NodePort Service, if it is created. |
| Name | Type | Description |
|---|---|---|
domain |
Domain On PV | Describes the configuration for creating an initial WebLogic Domain in persistent volume (Domain in PV). The operator will not recreate or update the domain if it already exists. Required. |
persistentVolume |
Persistent Volume | An optional field that describes the configuration to create a PersistentVolume for Domain on PV domain. Omit this section if you have manually created a persistent volume. The operator will perform this one-time create operation only if the persistent volume does not already exist. The operator will not recreate or update the PersistentVolume when it exists. More info: https://oracle.github.io/weblogic-kubernetes-operator/managing-domains/domain-on-pv-initialization#pv |
persistentVolumeClaim |
Persistent Volume Claim | An optional field that describes the configuration for creating a PersistentVolumeClaim for Domain on PV. PersistentVolumeClaim is a user's request for and claim to a persistent volume. The operator will perform this one-time create operation only if the persistent volume claim does not already exist. Omit this section if you have manually created a persistent volume claim. If specified, the name must match one of the volumes under serverPod.volumes and the domain home must reside in the mount path of the volume using this claim. More info: https://oracle.github.io/weblogic-kubernetes-operator/managing-domains/domain-on-pv-initialization#pvc |
runDomainInitContainerAsRoot |
Boolean | Specifies whether the operator will run the domain initialization init container in the introspector job as root. This may be needed in some environments to create the domain home directory on PV. Defaults to false. |
setDefaultSecurityContextFsGroup |
Boolean | Specifies whether the operator will set the default 'fsGroup' in the introspector job pod security context. This is needed to create the domain home directory on PV in some environments. If the 'fsGroup' is specified as part of 'spec.introspector.serverPod.podSecurityContext', then the operator will use that 'fsGroup' instead of the default 'fsGroup'. Defaults to true. |
waitForPvcToBind |
Boolean | Specifies whether the operator will wait for the PersistentVolumeClaim to be bound before proceeding with the domain creation. Defaults to true. |
| Name | Type | Description |
|---|---|---|
auxiliaryImages |
Array of Auxiliary Image | Optionally, use auxiliary images to provide Model in Image model, application archive, and WebLogic Deploy Tooling files. This is a useful alternative for providing these files without requiring modifications to the pod's base image domain.spec.image. This feature internally uses a Kubernetes emptyDir volume and Kubernetes init containers to share the files from the additional images with the pod. |
auxiliaryImageVolumeMedium |
string | The emptyDir volume medium. This is an advanced setting that rarely needs to be configured. Defaults to unset, which means the volume's files are stored on the local node's file system for the life of the pod. |
auxiliaryImageVolumeMountPath |
string | The auxiliary image volume mount path. This is an advanced setting that rarely needs to be configured. Defaults to /aux, which means the emptyDir volume will be mounted at /aux path in the WebLogic-Server container within every pod. The defaults for modelHome and wdtInstallHome will start with the new mount path, and files from sourceModelHome and sourceWDTInstallHome will be copied to the new default locations. |
auxiliaryImageVolumeSizeLimit |
string | The emptyDir volume size limit. This is an advanced setting that rarely needs to be configured. Defaults to unset. |
configMap |
string | Name of a ConfigMap containing the WebLogic Deploy Tooling model. |
domainType |
string | WebLogic Deploy Tooling domain type. Legal values: WLS, RestrictedJRF, JRF. Defaults to WLS. |
modelHome |
string | Location of the WebLogic Deploy Tooling model home. Defaults to /u01/wdt/models if no spec.configuration.model.AuxiliaryImages are specified, and to /aux/models otherwise. NOTE: if modelHome is set to a non-default value, then model files in all specified spec.configuration.model.AuxiliaryImages are ignored. |
onlineUpdate |
Online Update | Online update option for Model In Image dynamic update. |
runtimeEncryptionSecret |
string | Runtime encryption secret. Required when domainHomeSourceType is set to FromModel. |
wdtInstallHome |
string | Location of the WebLogic Deploy Tooling installation. Defaults to /u01/wdt/weblogic-deploy if no spec.configuration.model.AuxiliaryImages are specified, and to /aux/weblogic-deploy otherwise. NOTE: if wdtInstallHome is set to a non-default value, then the WDT install in any specified spec.configuration.model.AuxiliaryImages is ignored. |
| Name | Type | Description |
|---|---|---|
walletFileSecret |
string | Name of a Secret containing the OPSS key wallet file, which must be in a key named walletFile. Use this to allow a JRF domain to reuse its schemas in the RCU database. This allows you to specify a wallet file that was obtained from the domain home after the domain was booted for the first time. |
walletPasswordSecret |
string | Name of a Secret containing the OPSS key passphrase, which must be in a key named walletPassword. Used to encrypt and decrypt the wallet that is used for accessing the domain's schemas in its RCU database. The password must have a minimum length of eight characters and contain alphabetic characters combined with numbers or special characters. |
| Name | Type | Description |
|---|---|---|
env |
Array of Env Var | A list of environment variables to set in the Introspector Job Pod container. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables. See kubectl explain pods.spec.containers.env. |
envFrom |
Array of Env From Source | List of sources to populate environment variables in the Introspector Job Pod container. The sources include either a config map or a secret. The operator will not expand the dependent variables in the 'envFrom' source. More details: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#define-an-environment-variable-for-a-container. Also see: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables. |
podSecurityContext |
Pod Security Context | Pod-level security attributes. See kubectl explain pods.spec.securityContext. If no value is specified for this field, the operator will use default content for the pod-level securityContext. More info: https://oracle.github.io/weblogic-kubernetes-operator/security/domain-security/pod-and-container/. |
resources |
Resource Requirements | Memory and CPU minimum requirements and limits for the Introspector Job Pod. See kubectl explain pods.spec.containers.resources. |
| Name | Type | Description |
|---|---|---|
ignoreSessions |
Boolean | For graceful shutdown only, indicates to ignore pending HTTP sessions during in-flight work handling. Defaults to false. |
shutdownType |
string | Specifies how the operator will shut down server instances. Legal values are Graceful and Forced. Defaults to Graceful. |
skipWaitingCohEndangeredState |
Boolean | For graceful shutdown only, set to true to skip waiting for Coherence Cache Cluster service MBean HAStatus in safe state before shutdown. By default, the operator will wait until it is safe to shutdown the Coherence Cache Cluster. Defaults to false. |
timeoutSeconds |
integer | For graceful shutdown only, number of seconds to wait before aborting in-flight work and shutting down the server. Defaults to 30 seconds. |
waitForAllSessions |
Boolean | For graceful shutdown only, set to true to wait for all HTTP sessions during in-flight work handling; false to wait for non-persisted HTTP sessions only. Defaults to false. |
| Name | Type | Description |
|---|---|---|
lastTransitionTime |
DateTime | Last time the condition transitioned from one status to another. |
message |
string | Human-readable message indicating details about last transition. |
status |
string | The status of the condition. Can be True, False. |
type |
string | The type of the condition. Valid types are Completed, Available, Failed, and Rolling. |
| Name | Type | Description |
|---|---|---|
introspectImage |
string | The image used by the introspector when the Failed condition occurred. |
introspectVersion |
string | The introspectVersion set when the Failed condition occurred. |
restartVersion |
string | The restartVersion set when the Failed condition occurred. |
| Name | Type | Description |
|---|---|---|
activationTime |
DateTime | RFC 3339 date and time at which the server started. |
overallHealth |
string | Server health of this WebLogic Server instance. 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 the overloaded state. |
subsystems |
Array of Subsystem Health | Status of unhealthy subsystems, if any. |
| Name | Type | Description |
|---|---|---|
channelName |
string | Name of the channel. The "default" value refers to the Administration Server's default channel, which is configured using the ServerMBean's ListenPort. The "default-secure" value refers to the Administration Server's default secure channel, which is configured using the ServerMBean's SSLMBean's ListenPort. The "default-admin" value refers to the Administration Server's default administrative channel, which is configured using the DomainMBean's AdministrationPort. Otherwise, provide the name of one of the Administration Server's network access points, which is configured using the ServerMBean's NetworkAccessMBeans. The "default", "default-secure", and "default-admin" channels may not be specified here when using Istio. |
nodePort |
integer | 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. |
| Name | Type | Description |
|---|---|---|
createIfNotExists |
string | Specifies if the operator should create only the domain or the domain with RCU (for JRF-based domains). Legal values: Domain, DomainAndRCU. Defaults to Domain. |
domainCreationConfigMap |
string | Name of a ConfigMap containing the WebLogic Deploy Tooling model. |
domainCreationImages |
Array of Domain Creation Image | Domain creation images containing WebLogic Deploy Tooling model, application archive, and WebLogic Deploy Tooling installation files. These files will be used to create the domain during introspection. This feature internally uses a Kubernetes emptyDir volume and Kubernetes init containers to share the files from the additional images |
domainType |
string | WebLogic Deploy Tooling domain type. Known values are: WLS, RestrictedJRF, JRF. Defaults to JRF. |
opss |
Opss | Settings for OPSS security. |
| Name | Type | Description |
|---|---|---|
metadata |
Object Meta | The PersistentVolume metadata. Must include the name field. Required. |
spec |
Persistent Volume Spec | The specification of a persistent volume for Domain on PV domain. Required. This section provides a subset of fields in standard Kubernetes PersistentVolume specifications. |
| Name | Type | Description |
|---|---|---|
metadata |
Object Meta | The PersistentVolumeClaim metadata. Must include the name field. Required. |
spec |
Persistent Volume Claim Spec | The specifications of a persistent volume claim for Domain on PV domain. Required. This section provides a subset of fields in standard Kubernetes PersistentVolumeClaim specifications. |
| Name | Type | Description |
|---|---|---|
image |
string | The auxiliary image containing Model in Image model files, application archive files, and/or WebLogic Deploying Tooling installation files. Required. |
imagePullPolicy |
string | The image pull policy for the container image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
sourceModelHome |
string | The source location of the WebLogic Deploy Tooling model home within the auxiliary image that will be made available in the /aux/models directory of the WebLogic Server container in all pods. Defaults to /auxiliary/models. If the value is set to None or no files are found at the default location, then the source directory is ignored. If specifying multiple auxiliary images with model files in their respective sourceModelHome directories, then model files are merged. |
sourceWDTInstallHome |
string | The source location of the WebLogic Deploy Tooling installation within the auxiliary image that will be made available in the /aux/weblogic-deploy directory of the WebLogic Server container in all pods. Defaults to /auxiliary/weblogic-deploy. If the value is set to None or no files are found at the default location, then the source directory is ignored. When specifying multiple auxiliary images, ensure that only one of the images supplies a WDT install home; if more than one WDT install home is provided, then the domain deployment will fail. |
| Name | Type | Description |
|---|---|---|
enabled |
Boolean | Enable online update. Default is 'false'. |
onNonDynamicChanges |
string | Controls behavior when non-dynamic WebLogic configuration changes are detected during an online update. Non-dynamic changes are changes that require a domain restart to take effect. Valid values are 'CommitUpdateOnly' and 'CommitUpdateAndRoll'. Defaults to CommitUpdateOnly. If set to 'CommitUpdateOnly' and any non-dynamic changes are detected, then all changes will be committed, dynamic changes will take effect immediately, the domain will not automatically restart (roll), and any non-dynamic changes will become effective on a pod only if the pod is later restarted. If set to 'CommitUpdateAndRoll' and any non-dynamic changes are detected, then all changes will be committed, dynamic changes will take effect immediately, the domain will automatically restart (roll), and non-dynamic changes will take effect on each pod once the pod restarts. For more information, see the runtime update section of the Model in Image user guide. |
wdtTimeouts |
WDT Timeouts |
| Name | Type | Description |
|---|---|---|
health |
string | Server health of this WebLogic Server instance. |
subsystemName |
string | Name of subsystem providing symptom information. |
symptoms |
Array of string | Symptoms provided by the reporting subsystem. |
| Name | Type | Description |
|---|---|---|
image |
string | The domain creation image containing model files, application archive files, and/or WebLogic Deploying Tooling installation files to create the domain in persistent volume. Required. |
imagePullPolicy |
string | The image pull policy for the container image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
sourceModelHome |
string | The source location of the WebLogic Deploy Tooling model home within the domain image. Defaults to /auxiliary/models. If the value is set to None or no files are found at the default location, then the source directory is ignored. If specifying multiple domain images with model files in their respective sourceModelHome directories, then model files are merged. |
sourceWDTInstallHome |
string | The source location of the WebLogic Deploy Tooling installation within the domain creation image. Defaults to /auxiliary/weblogic-deploy. If the value is set to None or no files are found at the default location, then the source directory is ignored. When specifying multiple domain images, ensure that only one of the images supplies a WDT install home; if more than one WDT install home is provided, then the domain deployment will fail. |
| Name | Type | Description |
|---|---|---|
capacity |
Map | Capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
hostPath |
Host Path Volume Source | HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath. Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. |
nfs |
NFS Volume Source | nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs. Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. |
persistentVolumeReclaimPolicy |
string | PersistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming |
storageClassName |
string | StorageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. |
| Name | Type | Description |
|---|---|---|
resources |
V 1 Volume Resource Requirements | Resources represents the minimum resources the volume should have. More info https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources. ResourceRequirements describes the compute resource requirements. |
storageClassName |
string | StorageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. |
volumeName |
string | VolumeName is the binding reference to the PersistentVolume backing this claim. |
| Name | Type | Description |
|---|---|---|
activateTimeoutMillis |
integer | WDT activate WebLogic configuration changes timeout in milliseconds. Default: 180000. |
connectTimeoutMillis |
integer | WDT connect to WebLogic admin server timeout in milliseconds. Default: 120000. |
deployTimeoutMillis |
integer | WDT application or library deployment timeout in milliseconds. Default: 180000. |
redeployTimeoutMillis |
integer | WDT application or library redeployment timeout in milliseconds. Default: 180000. |
setServerGroupsTimeoutMillis |
integer | WDT set server groups timeout for extending a JRF domain configured cluster in milliseconds. Default: 180000. |
startApplicationTimeoutMillis |
integer | WDT application start timeout in milliseconds. Default: 180000. |
stopApplicationTimeoutMillis |
integer | WDT application stop timeout in milliseconds. Default: 180000. |
undeployTimeoutMillis |
integer | WDT application or library undeployment timeout in milliseconds. Default: 180000. |
VolumeResourceRequirements describes the storage resource requirements for a volume.
| Name | Type | Description |
|---|---|---|
limits |
Map | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
requests |
Map | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |