Skip to content

Commit 082819f

Browse files
committed
Improve docs
1 parent c64b769 commit 082819f

File tree

1 file changed

+37
-20
lines changed

1 file changed

+37
-20
lines changed

site/server-lifecycle.md

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ This document describes how the user can start, stop and restart the domain's se
44

55
## Overview
66

7+
There are properties on the domain resource that specify which servers should be running
8+
and which servers should be restarted.
9+
10+
To start, stop or restart servers, the should user modify these properties on the domain resource
11+
(e.g. using kubectl or the Kubernetes REST api). The operator will notice the changes
12+
and apply them.
13+
714
### Starting and Stopping Servers
815

916
The "serverStartPolicy" property on domain resource controls which servers should be running.
@@ -20,31 +27,42 @@ By default, the servers are restarted one at a time.
2027

2128
## Starting and Stopping Servers
2229

30+
The "serverStartPolicy" property determine which servers should be running.
31+
2332
### "serverStartPolicy" Rules
2433

25-
The "serverStartPolicy" property determine which servers should be running.
34+
"serverStartPolicy" can be specified at the domain, cluster and server levels. Each level supports a different set of values:
35+
36+
#### Available serverStartPolicy Values
37+
| Level | Default Value | Supported Value |
38+
| --- | --- | --- |
39+
| Domain | IF_NEEDED | IF_NEEDED, ADMIN_ONLY, NEVER |
40+
| Cluster | IF_NEEDED | IF_NEEDED, NEVER |
41+
| Server | IF_NEEDED | IF_NEEDED, ALWAYS, NEVER |
2642

27-
It can be specified at the domain, cluster and server levels. Each level supports a different set of values:
28-
* domain: "NEVER", "IF_NEEDED", "ADMIN_ONLY", defaults to "IF_NEEDED"
29-
* cluster: "NEVER", "IF_NEEDED", defaults to "IF_NEEDED"
30-
* server: "NEVER", "IF_NEEDED", "ALWAYS", defaults to "IF_NEEDED"
43+
#### Admin Server Rules
44+
| Domain | Admin Server | Should Run |
45+
| NEVER | IF_NEEDED, ALWAYS, NEVER | no |
46+
| ADMIN_ONLY, IF_NEEDED | NEVER | no |
47+
| ADMIN_ONLY, IF_NEEDED | IF_NEEDED, ALWAYS | yes |
3148

32-
The admin server will be started if:
33-
* the domain is "ADMIN_ONLY" or "IF_NEEDED" (i.e. not "NEVER")
34-
* AND
35-
* the adminServer is "ALWAYS" or "IF_NEEDED" (i.e. not "NEVER")
49+
#### Standalone Managed Server Rules
50+
| Domain | Standalone Server | Should Run |
51+
| ADMIN_ONLY, NEVER | IF_NEEDED, ALWAYS, NEVER | no |
52+
| IF_NEEDED | NEVER | no |
53+
| IF_NEEDED | IF_NEEDED, ALWAYS | yes |
3654

37-
A stand alone managed server will be started if:
38-
* the domain is "IF_NEEDED" (i.e. not "NEVER" or "ADMIN_ONLY")
39-
* AND
40-
* the server is "ALWAYS" or "IF_NEEDED" (i.e. not "NEVER")
55+
#### Clustered Managed Server Rules
56+
| Domain | Cluster | Clustered Server | Should Run |
57+
| ADMIN_ONLY, NEVER | IF_NEEDED, NEVER | IF_NEEDED, ALWAYS, NEVER | no |
58+
| IF_NEEDED | NEVER | IF_NEEDED, ALWAYS, NEVER | no |
59+
| IF_NEEDED | IF_NEEDED | NEVER | no |
60+
| IF_NEEDED | IF_NEEDED | ALWAYS | yes |
61+
| IF_NEEDED | IF_NEEDED | IF_NEEDED | started if needed to get to the cluster's "replicas" count |
4162

42-
A clustered managed server will be started if:
43-
* the domain is "IF_NEEDED" (i.e. not "NEVER" or "ADMIN_ONLY")
44-
* AND
45-
* the cluster is "IF_NEEDED" (I.e. not "NEVER")
46-
* AND
47-
* the server is "ALWAYS", or if the server is "IF_NEEDED" and the operator needs to start it to get to the cluster's "replicas" count
63+
Note: servers configured as ALWAYS count towards the cluster's "replicas" count.
64+
65+
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.
4866

4967
### Common Scenarios
5068

@@ -115,4 +133,3 @@ This is done by adding the server to the domain resource and settings its "serve
115133
```
116134

117135
Note: the server will count towards the cluster's "replicas" count. Also, if the user configures more than "replicas" servers to "ALWAYS", they will all be started, even though "replicas" will be exceeded.
118-

0 commit comments

Comments
 (0)