Skip to content

Latest commit

 

History

History
231 lines (180 loc) · 8.35 KB

server-lifecycle.md

File metadata and controls

231 lines (180 loc) · 8.35 KB
Raw

Starting, stopping, and restarting servers

This document describes how you can start, stop, and restart the domain's servers.

Overview

There are properties on the domain resource that specify which servers should be running and which servers should be restarted.

To start, stop, or restart servers, modify these properties on the domain resource (for example, by using kubectl or the Kubernetes REST API). The operator will notice the changes and apply them.

Starting and stopping servers

The serverStartPolicy property on the domain resource controls which servers should be running. The operator runtime monitors this property and creates or deletes the corresponding server pods.

serverStartPolicy rules

You can specify the serverStartPolicy property at the domain, cluster, and server levels. Each level supports a different set of values.

Available serverStartPolicy values

Level Default Value Supported Values
Domain IF_NEEDED IF_NEEDED, ADMIN_ONLY, NEVER
Cluster IF_NEEDED IF_NEEDED, NEVER
Server IF_NEEDED IF_NEEDED, ALWAYS, NEVER

Administration Server start and stop rules

Domain Admin Server Started / Stopped
NEVER any value Stopped
ADMIN_ONLY, IF_NEEDED NEVER Stopped
ADMIN_ONLY, IF_NEEDED IF_NEEDED, ALWAYS Started

Standalone Managed Server start and stop rules

Domain Standalone Server Started / Stopped
ADMIN_ONLY, NEVER any value Stopped
IF_NEEDED NEVER Stopped
IF_NEEDED IF_NEEDED, ALWAYS Started

Clustered Managed Server start and stop rules

Domain Cluster Clustered Server Started / Stopped
ADMIN_ONLY, NEVER any value any value Stopped
IF_NEEDED NEVER any value Stopped
IF_NEEDED IF_NEEDED NEVER Stopped
IF_NEEDED IF_NEEDED ALWAYS Started
IF_NEEDED IF_NEEDED IF_NEEDED Started if needed to get to the cluster's replicas count

Note: Servers configured as ALWAYS count toward the cluster's replicas count.

Note: If more servers are configured as ALWAYS than the cluster's replicas count, they will all be started and the replicas count will be ignored.

Common scenarios

Normal running state

Normally, the Administration Server, all of the standalone Managed Servers, and enough Managed Servers in each cluster to satisfy its replicas count, should be started. In this case, the domain resource does not need to specify serverStartPolicy, or list any clusters or servers, but it does need to specify a replicas count.

For example:

   domain:
     spec:
       image: ...
       replicas: 10

Shut down all the servers

Sometimes you need to completely shut down the domain (for example, take it out of service).

   domain:
     spec:
       serverStartPolicy: "NEVER"
       ...

Only start the Administration Server

Sometimes you want to start the Administration Server only, that is, take the domain out of service but leave the Administration Server running so that you can administer the domain.

   domain:
     spec:
       serverStartPolicy: "ADMIN_ONLY"
       ...

Shut down a cluster

To shut down a cluster (for example, take it out of service), add it to the domain resource and set its serverStartPolicy to NEVER.

   domain:
     spec:
       clusters:
       - clusterName: "cluster1"
         serverStartPolicy: "NEVER"
       ...

Shut down a specific standalone server

To shut down a specific standalone server, add it to the domain resource and set its serverStartPolicy to NEVER.

   domain:
     spec:
       managedServers:
       - serverName: "server1"
         serverStartPolicy: "NEVER"
       ...

Force a specific clustered Managed Server to start

Normally, all of the Managed Servers in a cluster are identical and it doesn't matter which ones are running as long as the operator starts enough of them to get to the cluster's replicas count. However, sometimes some of the Managed Servers are different (for example, support some extra services that the other servers in the cluster use) and need to always be started.

This is done by adding the server to the domain resource and setting its serverStartPolicy to ALWAYS.

   domain:
     spec:
       managedServers:
       - serverName: "cluster1_server1"
         serverStartPolicy: "ALWAYS"
       ...

Note: The server will count toward the cluster's replicas count. Also, if you configure more than the replicas servers count to ALWAYS, they will all be started, even though the replicas count will be exceeded.

Restarting servers

The operator runtime automatically recreates (restarts) server pods when properties on the domain resource that affect server pods change (such as image, volumes, and env). The restartVersion property on the domain resource lets you force the operator to restart a set of server pods.

The operator runtime does rolling restarts of clustered servers so that service is maintained.

Properties that cause servers to be restarted

The operator will restart servers when any of the follow properties on the domain resource that affect the server are changed:

  • annotations
  • containerSecurityContext
  • domainHome
  • domainHomeInImage
  • env
  • image
  • imagePullPolicy
  • imagePullSecrets
  • includeServerOutInPodLog
  • labels
  • logHomeEnabled
  • logHome
  • livenessProbe
  • nodeSelector
  • podSecurityContext
  • readinessProbe
  • resources
  • restartVersion
  • serverStartState
  • volumes
  • volumeMounts

Rolling restarts

Clustered servers that need to be restarted are gradually restarted (for example, rolling restarted) so that the cluster is not taken out of service and in-flight work can be migrated to other servers in the cluster.

The maxUnavailable property on the domain resource determines how many of the cluster's servers may be taken out of service at a time when doing a rolling restart. It can be specified at the domain and cluster levels and defaults to 1 (that is, by default, clustered servers are restarted one at a time).

Using restartVersion to force the operator to restart servers

The restartVersion property lets you force the operator to restart servers.

It's basically a user-specified string that gets added to new server pods (as a label) so that the operator can tell which servers need to be restarted. If the value is different, then the server pod is old and needs to be restarted. If the value matches, then the server pod has already been restarted.

Each time you want to restart some servers, you need to set restartVersion to a different string (the particular value doesn't matter).

The operator will notice the new value and restart the affected servers (using the same mechanisms as when other properties that affect the server pods are changed, including doing rolling restarts of clustered servers).

The restartVersion property can be specified at the domain, cluster, and server levels. A server will be restarted if any of these three values change.

Note: The servers will also be restarted if restartVersion is removed from the domain resource (for example, if you had previously specified a value to cause a restart, then you remove that value after the previous restart has completed).

Common scenarios

Restart all the servers in the domain

Set restartVersion at the domain level to a new value.

   domain:
     spec:
       restartVersion: "domainV1"
       ...

Restart all the servers in the cluster

Set restartVersion at the cluster level to a new value.

   domain:
     spec:
       clusters:
       - clusterName : "cluster1"
         restartVersion: "cluster1V1"
         maxUnavailable: 2
       ...

Restart the Administration Server

Set restartVersion at the adminServer level to a new value.

   domain:
     spec:
       adminServer:
         restartVersion: "adminV1"
       ...

Restart a standalone or clustered Managed Server

Set restartVersion at the managedServer level to a new value.

   domain:
     spec:
       managedServers:
       - serverName: "standalone_server1"
         restartVersion: "v1"
       - serverName: "cluster1_server1"
         restartVersion: "v1"
       ...