Skip to content

Commit 7ef7674

Browse files
markxnelsonmarkxnelson
committed
doc edits for lifecycle
1 parent 2a86990 commit 7ef7674

File tree

1 file changed

+92
-93
lines changed

1 file changed

+92
-93
lines changed

‎site/server-lifecycle.md

Lines changed: 92 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,63 @@
1-
# Starting, Stopping and Restarting Servers
1+
# Starting, stopping, and restarting servers
22

3-
This document describes how the user can start, stop and restart the domain's servers.
3+
This document describes how you can start, stop, and restart the domain's servers.
44

55
## Overview
66

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

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.
10+
To start, stop, or restart servers, modify these properties on the domain resource
11+
(for example, by using `kubectl` or the Kubernetes REST API). The operator will notice the changes and apply them.
1312

14-
## Starting and Stopping Servers
13+
## Starting and stopping servers
1514

16-
The "serverStartPolicy" property on domain resource controls which servers should be running.
15+
The `serverStartPolicy` property on the domain resource controls which servers should be running.
1716
The operator runtime monitors this property and creates or deletes the corresponding server pods.
1817

19-
### "serverStartPolicy" Rules
18+
### `serverStartPolicy` rules
2019

21-
"serverStartPolicy" can be specified at the domain, cluster and server levels. Each level supports a different set of values:
20+
You can specify the `serverStartPolicy` property at the domain, cluster, and server levels. Each level supports a different set of values.
2221

23-
#### Available serverStartPolicy Values
22+
#### Available `serverStartPolicy` values
2423
| Level | Default Value | Supported Values |
2524
| --- | --- | --- |
26-
| Domain | IF_NEEDED | IF_NEEDED, ADMIN_ONLY, NEVER |
27-
| Cluster | IF_NEEDED | IF_NEEDED, NEVER |
28-
| Server | IF_NEEDED | IF_NEEDED, ALWAYS, NEVER |
25+
| Domain | `IF_NEEDED` | `IF_NEEDED`, `ADMIN_ONLY`, `NEVER` |
26+
| Cluster | `IF_NEEDED` | `IF_NEEDED`, `NEVER` |
27+
| Server | `IF_NEEDED` | `IF_NEEDED`, `ALWAYS`, `NEVER` |
2928

30-
#### Admin Server Start/Stop Rules
29+
#### Administration Server start and stop rules
3130
| Domain | Admin Server | Started / Stopped |
3231
| --- | --- | --- |
33-
| NEVER | any value | Stopped |
34-
| ADMIN_ONLY, IF_NEEDED | NEVER | Stopped |
35-
| ADMIN_ONLY, IF_NEEDED | IF_NEEDED, ALWAYS | Started |
32+
| `NEVER` | any value | Stopped |
33+
| `ADMIN_ONLY`, `IF_NEEDED` | `NEVER` | Stopped |
34+
| `ADMIN_ONLY`, `IF_NEEDED` | `IF_NEEDED`, `ALWAYS` | Started |
3635

37-
#### Standalone Managed Server Start/Stop Rules
36+
#### Standalone Managed Server start and stop rules
3837
| Domain | Standalone Server | Started / Stopped |
3938
| --- | --- | --- |
40-
| ADMIN_ONLY, NEVER | any value | Stopped |
41-
| IF_NEEDED | NEVER | Stopped |
42-
| IF_NEEDED | IF_NEEDED, ALWAYS | Started |
39+
| `ADMIN_ONLY`, `NEVER` | any value | Stopped |
40+
| `IF_NEEDED` | `NEVER` | Stopped |
41+
| `IF_NEEDED` | `IF_NEEDED`, `ALWAYS` | Started |
4342

44-
#### Clustered Managed Server Start/Stop Rules
43+
#### Clustered Managed Server start and stop rules
4544
| Domain | Cluster | Clustered Server | Started / Stopped |
4645
| --- | --- | --- | --- |
47-
| ADMIN_ONLY, NEVER | any value | any value | Stopped |
48-
| IF_NEEDED | NEVER | any value | Stopped |
49-
| IF_NEEDED | IF_NEEDED | NEVER | Stopped |
50-
| IF_NEEDED | IF_NEEDED | ALWAYS | Started |
51-
| IF_NEEDED | IF_NEEDED | IF_NEEDED | Started if needed to get to the cluster's "replicas" count |
46+
| `ADMIN_ONLY`, `NEVER` | any value | any value | Stopped |
47+
| `IF_NEEDED` | `NEVER` | any value | Stopped |
48+
| `IF_NEEDED` | `IF_NEEDED` | `NEVER` | Stopped |
49+
| `IF_NEEDED` | `IF_NEEDED` | `ALWAYS` | Started |
50+
| `IF_NEEDED` | `IF_NEEDED` | `IF_NEEDED` | Started if needed to get to the cluster's `replicas` count |
5251

53-
Note: servers configured as ALWAYS count towards the cluster's "replicas" count.
52+
**Note**: Servers configured as `ALWAYS` count toward the cluster's `replicas` count.
5453

55-
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.
54+
**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.
5655

57-
### Common Scenarios
56+
### Common scenarios
5857

59-
#### Normal Running State
60-
Normally, the admin server, all of the stand alone managed servers, and enough managed servers in each cluster to satisfy its "replicas" count should be started.
61-
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.
58+
#### Normal running state
59+
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.
60+
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.
6261

6362
For example:
6463
```
@@ -68,26 +67,26 @@ For example:
6867
replicas: 10
6968
```
7069

71-
#### Shut Down All the Servers
72-
Sometimes the user needs to completely shut down the domain (i.e. take it out of service).
70+
#### Shut down all the servers
71+
Sometimes you need to completely shut down the domain (for example, take it out of service).
7372
```
7473
domain:
7574
spec:
7675
serverStartPolicy: "NEVER"
7776
...
7877
```
7978

80-
#### Only Start the Admin Server
81-
Sometimes the user wants to only start the admin server, that is, take the domain out of service but leave the admin server running so that the user can administer the domain.
79+
#### Only start the Administration Server
80+
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.
8281
```
8382
domain:
8483
spec:
8584
serverStartPolicy: "ADMIN_ONLY"
8685
...
8786
```
8887

89-
#### Shut Down A Cluster
90-
To shut down a cluster (i.e. take it out of service), add it to the domain resource and set its "serverStartPolicy" to "NEVER".
88+
#### Shut down a cluster
89+
To shut down a cluster (for example, take it out of service), add it to the domain resource and set its `serverStartPolicy` to `NEVER`.
9190
```
9291
domain:
9392
spec:
@@ -97,8 +96,8 @@ To shut down a cluster (i.e. take it out of service), add it to the domain resou
9796
...
9897
```
9998

100-
#### Shut Down a Specific Stand Alone Server
101-
To shut down a specific stand alone server, add it to the domain resource and set its "serverStartPolicy" to "NEVER"
99+
#### Shut down a specific standalone server
100+
To shut down a specific standalone server, add it to the domain resource and set its `serverStartPolicy` to `NEVER`.
102101
```
103102
domain:
104103
spec:
@@ -108,11 +107,11 @@ To shut down a specific stand alone server, add it to the domain resource and se
108107
...
109108
```
110109

111-
#### Force a Specific Clustered Managed Server To Start
112-
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 to get to the cluster's "replicas" count.
113-
However, sometimes some of the managed servers are different (e.g support some extra services that the other servers in the cluster use) and need to always to started.
110+
#### Force a specific clustered Managed Server to start
111+
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.
112+
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.
114113

115-
This is done by adding the server to the domain resource and settings its "serverStartPolicy" to "ALWAYS".
114+
This is done by adding the server to the domain resource and setting its `serverStartPolicy` to `ALWAYS`.
116115
```
117116
domain:
118117
spec:
@@ -122,67 +121,67 @@ This is done by adding the server to the domain resource and settings its "serve
122121
...
123122
```
124123

125-
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.
124+
**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.
126125

127-
## Restarting Servers
126+
## Restarting servers
128127

129-
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").
130-
The "restartVersion" property on the domain resource lets the user force the operator to restart a set of server pods.
128+
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`).
129+
The `restartVersion` property on the domain resource lets you force the operator to restart a set of server pods.
131130

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

134-
### Properties that Cause Servers To Be Restarted
135-
The operator will restart servers when any of the follow properties on the domain resource that affect the server are changed:
136-
* annotations
137-
* containerSecurityContext
138-
* domainHome
139-
* domainHomeInImage
140-
* env
141-
* image
142-
* imagePullPolicy
143-
* imagePullSecrets
144-
* includeServerOutInPodLog
145-
* labels
146-
* logHomeEnabled
147-
* logHome
148-
* livenessProbe
149-
* podSecurityContext
150-
* readinessProbe
151-
* restartVersion
152-
* serverStartState
153-
* volumes
154-
* volumeMounts
155-
156-
Note: the operator does not restart affected servers when `nodeSelector` or `resources` is changed on the domain resource.
157-
In these cases, the user can use `restartVersion` to force the operator to restart the servers.
158-
159-
### Rolling Restarts
160-
161-
Clustered servers that need to be restarted are gradually restarted (i.e. '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.
162-
163-
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.
133+
### Properties that cause servers to be restarted
134+
The operator will restart servers when any of the follow properties on the domain resource that affect the server, are changed:
135+
* `annotations`
136+
* `containerSecurityContext`
137+
* `domainHome`
138+
* `domainHomeInImage`
139+
* `env`
140+
* `image`
141+
* `imagePullPolicy`
142+
* `imagePullSecrets`
143+
* `includeServerOutInPodLog`
144+
* `labels`
145+
* `logHomeEnabled`
146+
* `logHome`
147+
* `livenessProbe`
148+
* `podSecurityContext`
149+
* `readinessProbe`
150+
* `restartVersion`
151+
* `serverStartState`
152+
* `volumes`
153+
* `volumeMounts`
154+
155+
**Note**: The operator does not restart affected servers when `nodeSelector` or `resources` is changed on the domain resource.
156+
In these cases, you can use `restartVersion` to force the operator to restart the servers.
157+
158+
### Rolling restarts
159+
160+
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.
161+
162+
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.
164163
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).
165164

166-
### Using restartVersion to Force the Operator to Restart Servers
165+
### Using `restartVersion` to force the operator to restart servers
167166

168-
The "restartVersion" property lets users force the operator to restart servers.
167+
The `restartVersion` property lets you force the operator to restart servers.
169168

170169
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.
171170
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.
172171

173-
Each time the user wants to restart some servers, the user needs to set "restartVersion" to a different string (the particular value doesn't matter).
172+
Each time you want to restart some servers, you need to set `restartVersion` to a different string (the particular value doesn't matter).
174173

175174
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).
176175

177-
"restartVersion" can be specified at the domain, cluster and server levels. A server will be restarted if any of these three values change.
176+
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.
178177

179-
Note: the servers will also be restarted if restartVersion is removed from the domain resource (for example, if the user had previously specified a value to cause a restart then the user removes that value after the previous restart has completed).
178+
**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).
180179

181-
### Common Scenarios
180+
### Common scenarios
182181

183-
#### Restart All the Servers in the Domain
182+
#### Restart all the servers in the domain
184183

185-
Set "restartVersion" at the domain level to a new value.
184+
Set `restartVersion` at the domain level to a new value.
186185

187186
```
188187
domain:
@@ -191,9 +190,9 @@ Set "restartVersion" at the domain level to a new value.
191190
...
192191
```
193192

194-
#### Restart All the Servers in the Cluster
193+
#### Restart all the servers in the cluster
195194

196-
Set "restartVersion" at the cluster level to a new value.
195+
Set `restartVersion` at the cluster level to a new value.
197196

198197
```
199198
domain:
@@ -205,9 +204,9 @@ Set "restartVersion" at the cluster level to a new value.
205204
...
206205
```
207206

208-
#### Restart the Admin Server
207+
#### Restart the Administration Server
209208

210-
Set "restartVersion" at the adminServer level to a new value.
209+
Set `restartVersion` at the `adminServer` level to a new value.
211210

212211
```
213212
domain:
@@ -217,9 +216,9 @@ Set "restartVersion" at the adminServer level to a new value.
217216
...
218217
```
219218

220-
#### Restart a Standalone or Clustered Manged Server
219+
#### Restart a standalone or clustered Managed Server
221220

222-
Set "restartVersion" at the managedServer level to a new value.
221+
Set `restartVersion` at the `managedServer` level to a new value.
223222

224223
```
225224
domain:

0 commit comments

Comments
 (0)