This document is an overview of managing WebLogic domains and clusters in Kubernetes.
Domain resources reference WebLogic domain configuration, a WebLogic install, images, and anything else necessary to run the domain. Beginning with operator 4.0, WebLogic clusters that are within a WebLogic domain configuration may optionally be associated with a Cluster resource in addition to a Domain resource. For more information, see Domain and Cluster resources.
You can locate a WebLogic domain either on a persistent volume (Domain on PV), inside the container only (Model in Image), or in an image (Domain in Image). For an explanation of each, see Choose a domain home source type. For examples of each, see the WebLogic Kubernetes Operator samples.
The Domain in Image domain home source type is deprecated in WebLogic Kubernetes Operator version 4.0. Oracle recommends that you choose either Domain on PV or Model in Image, depending on your needs.
If you want to create your own container images, for example, to choose a specific set of patches or to create a domain with a specific configuration or applications deployed, then you can create the domain custom resource manually to deploy your domain. This process is documented in this sample.
NOTE: After you are familiar with the basics, it is recommended to review important considerations and resource name restrictions.
You can modify the WebLogic domain configuration for Domain on PV, Domain in Image, and Model in Image before deploying a Domain YAML file:
When the domain is on a persistent volume, you can use WLST or WDT to change the configuration.
For Domain in Image and Domain on PV, you can use Configuration overrides.
Configuration overrides allow changing a configuration without modifying its original config.xml or system resource XML files, and supports
parameterizing overrides so that you can inject values into them from Kubernetes Secrets. For example, you can inject database user names, passwords,
and URLs that are stored in a secret. However, note the scenarios for which configuration overrides are not supported.
For Model in Image, you use Runtime Updates.
You can perform lifecycle operations on WebLogic Servers, clusters, or domains. This includes starting, stopping, and rolling domains, clusters, or individual servers, plus detecting failures and tuning retry behavior. See Domain life cycle.
The operator lets you initiate scaling of clusters in various ways:
kubectl to edit a Cluster resourcescale commandsSee Domain life cycle scaling.
The operator generates Kubernetes events at key points during domain processing. For more information, see Domain events.
To access the domain using WLST, console, T3, or a load balancer, or to export Prometheus-compatible metrics, see Access and monitor domains.
To tune log file location and rotation, see Log Files.
To export operator or domain log files, see the Elastic Stack examples.
Kubernetes requires that the names of some resource types follow the DNS label standard as defined in DNS Label Names and RFC 1123. This requirement restricts the characters that are allowed in the names of these resources, and also limits the length of these names to no more than 63 characters.
The following is a list of such Kubernetes resources that the operator generates when a domain resource is deployed, including how their names are constructed.
<domainUID>-<introspectorJobNameSuffix>. The default suffix is -introspector, which can be overridden using the operator’s Helm configuration introspectorJobNameSuffix (see WebLogic domain management).<domainUID>-<serverName>.<domainUID>-cluster-<clusterName>.<domainUID>-<adminServerName>-<externalServiceNameSuffix>. The default suffix is -ext, which can be overridden using the operator’s Helm configuration externalServiceNameSuffix (see WebLogic domain management).The operator puts in place certain validation checks and conversions to prevent these resources from violating Kubernetes restrictions.
A-Z, a-z, 0-9, -, or _, and must start and end with an alphanumeric character. Note that when generating pod and service names, the operator will convert configured names to lowercase and substitute a hyphen (-) for each underscore (_).domainUID is required to be no more than 45 characters.When a domain resource or WebLogic domain configuration violates the limits, the domain startup will fail, and actual validation errors are reported in the domain resource’s status.
Be aware of the following important considerations for WebLogic domains running in Kubernetes:
Domain Home Location: The WebLogic domain home location is determined by the Domain YAML file domainHome, if specified; otherwise, a default location is determined by the domainHomeSourceType setting.
domainHome field is not specified and domainHomeSourceType is Image (the default), then the operator will assume that the domain home is a directory under /u01/oracle/user_projects/domains/, and report an error if no domain is found or more than one domain is found.domainHome field is not specified and domainHomeSourceType is PersistentVolume, then the operator will assume that the domain home is /shared/domains/DOMAIN_UID.domainHome field is not specified and the domainHomeSourceType is FromModel, then the operator will assume that the domain home is /u01/domains/DOMAIN_UID.Oracle strongly recommends storing an image containing a WebLogic domain home (domainHomeSourceType is Image)
as private in the registry (for example, Oracle Cloud Infrastructure Registry, GitHub Container Registry, and such).
A container image that contains a WebLogic domain has sensitive information including
keys and credentials that are used to access external resources (for example, the data source password).
For more information, see
WebLogic domain in container image protection.
Log File Locations: The operator can automatically override WebLogic Server, domain, and introspector log locations.
This occurs if the Domain logHomeEnabled field is explicitly set to true, or if logHomeEnabled isn’t set
and domainHomeSourceType is set to PersistentVolume. When overriding, the log location will be the location specified by the logHome setting.
For additional log file tuning information, see Log files.
Listen Address Overrides: The operator will automatically override all WebLogic domain default,
SSL, admin, or custom channel listen addresses (using Configuration overrides). These will become domainUID followed by a
hyphen and then the server name, all lowercase, and underscores converted to hyphens. For example, if domainUID=domain1 and
the WebLogic Server name is Admin_Server, then its listen address becomes domain1-admin-server.
Domain, Cluster, Server, and Network-Access-Point Names: WebLogic domain, cluster, server, and network-access-point (channel)
names must contain only the characters A-Z, a-z, 0-9, -, or _, and must be kept to a reasonable length. This ensures that they can
be safely used to form resource names that meet Kubernetes resource and DNS1123 naming requirements. For more details,
see Meet Kubernetes resource name restrictions.
Node Ports: If you choose to expose any WebLogic channels outside the Kubernetes cluster using a NodePort, for example, the
administration port or a T3 channel to allow WLST access, you need to ensure that you allocate each channel a
unique port number across the entire Kubernetes cluster. If you expose the administration port in each WebLogic domain in
the Kubernetes cluster, then each one must have a different port number. This is required because NodePorts are used to
expose channels outside the Kubernetes cluster.
Exposing administrative, RMI, or T3 capable channels using a Kubernetes NodePort
can create an insecure configuration. In general, only HTTP protocols should be made available externally and this exposure
is usually accomplished by setting up an external load balancer that can access internal (non-NodePort) services.
For more information, see WebLogic T3 and administrative channels.
Host Path Persistent Volumes: If using a hostPath persistent volume, then it must be available on all worker nodes in the cluster and have read/write/many permissions for all container/pods in the WebLogic Server deployment. Be aware
that many cloud provider’s volume providers may not support volumes across availability zones. You may want to use NFS or a clustered file system to work around this limitation.
Security Note: The USER_MEM_ARGS environment variable defaults to -Djava.security.egd=file:/dev/./urandom in all WebLogic Server pods and the WebLogic introspection job. It can be explicitly set to another value in your Domain or Cluster YAML file using the env attribute under the serverPod configuration.
JVM Memory and Java Option Arguments: The following environment variables can be used to customize the JVM memory and Java options for both the WebLogic Server Managed Servers and Node Manager instances:
JAVA_OPTIONS - Java options for starting WebLogic ServerUSER_MEM_ARGS - JVM memory arguments for starting WebLogic ServerNODEMGR_JAVA_OPTIONS - Java options for starting a Node Manager instanceNODEMGR_MEM_ARGS - JVM memory arguments for starting a Node Manager instanceFor more information, see JVM memory and Java option environment variables.
The following features are not certified or supported in this release:
For up-to-date information about the features of WebLogic Server that are supported in Kubernetes environments, see My Oracle Support Doc ID 2349228.1.