Skip to content

Commit 96b485f

Browse files
rjeberhardrjeberhard
authored
Merge pull request #782 from oracle/domain-update-status
Domain status schema in CRD
2 parents b8c2740 + 837d8c9 commit 96b485f

File tree

25 files changed

+386
-241
lines changed

25 files changed

+386
-241
lines changed

‎docs/domains/Domain.json

Lines changed: 53 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
]
3232
},
3333
"restartVersion": {
34-
"description": "If present, every time this value is updated the operator will restart the required servers",
34+
"description": "If present, every time this value is updated the operator will restart the required servers.",
3535
"type": "string"
3636
},
3737
"adminService": {
@@ -68,10 +68,6 @@
6868
"channelName"
6969
]
7070
},
71-
"Chronology": {
72-
"type": "object",
73-
"properties": {}
74-
},
7571
"Cluster": {
7672
"type": "object",
7773
"properties": {
@@ -93,7 +89,7 @@
9389
"minimum": 1
9490
},
9591
"replicas": {
96-
"description": "The number of managed servers to run in this cluster",
92+
"description": "The number of managed servers to run in this cluster.",
9793
"type": "number",
9894
"minimum": 0
9995
},
@@ -118,7 +114,7 @@
118114
]
119115
},
120116
"restartVersion": {
121-
"description": "If present, every time this value is updated the operator will restart the required servers",
117+
"description": "If present, every time this value is updated the operator will restart the required servers.",
122118
"type": "string"
123119
}
124120
},
@@ -127,38 +123,34 @@
127123
]
128124
},
129125
"DateTime": {
130-
"type": "object",
131-
"properties": {
132-
"iChronology": {
133-
"$ref": "#/definitions/Chronology"
134-
},
135-
"iMillis": {
136-
"type": "number"
137-
}
138-
},
139-
"required": [
140-
"iMillis"
141-
]
126+
"format": "date-time",
127+
"type": "string"
142128
},
143129
"DomainCondition": {
144130
"type": "object",
145131
"properties": {
146132
"reason": {
133+
"description": "Unique, one-word, CamelCase reason for the condition\u0027s last transition.",
147134
"type": "string"
148135
},
149136
"lastTransitionTime": {
137+
"description": "Last time the condition transitioned from one status to another.",
150138
"$ref": "#/definitions/DateTime"
151139
},
152140
"message": {
141+
"description": "Human-readable message indicating details about last transition.",
153142
"type": "string"
154143
},
155144
"type": {
145+
"description": "Type is the type of the condition. Currently, valid types are Progressing, Available, and Failure. Required",
156146
"type": "string"
157147
},
158148
"lastProbeTime": {
149+
"description": "Last time we probed the condition.",
159150
"$ref": "#/definitions/DateTime"
160151
},
161152
"status": {
153+
"description": "Status is the status of the condition. Can be True, False, Unknown. Required",
162154
"type": "string"
163155
}
164156
}
@@ -175,11 +167,11 @@
175167
]
176168
},
177169
"image": {
178-
"description": "The Weblogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3",
170+
"description": "The Weblogic Docker image; required when domainHomeInImage is true; otherwise, defaults to store/oracle/weblogic:12.2.1.3.",
179171
"type": "string"
180172
},
181173
"imagePullPolicy": {
182-
"description": "The image pull policy for the WebLogic Docker image. Legal values are Always, Never and IfNotPresent. Defaults to Always if image ends in :latest, IfNotPresent otherwise",
174+
"description": "The image pull policy for the WebLogic Docker image. Legal values are Always, Never and IfNotPresent. Defaults to Always if image ends in :latest, IfNotPresent otherwise.",
183175
"type": "string",
184176
"enum": [
185177
"Always",
@@ -188,7 +180,7 @@
188180
]
189181
},
190182
"replicas": {
191-
"description": "The number of managed servers to run in any cluster that does not specify a replica count",
183+
"description": "The number of managed servers to run in any cluster that does not specify a replica count.",
192184
"type": "number",
193185
"minimum": 0
194186
},
@@ -207,12 +199,12 @@
207199
}
208200
},
209201
"domainHomeInImage": {
210-
"description": "True if this domain\u0027s home is defined in the docker image for the domain. Defaults to true",
202+
"description": "True if this domain\u0027s home is defined in the docker image for the domain. Defaults to true.",
211203
"type": "boolean"
212204
},
213205
"domainUID": {
214206
"pattern": "^[a-z0-9_.]{1,253}$",
215-
"description": "Domain unique identifier. Must be unique across the Kubernetes cluster. (Not required)Defaults to the value of metadata.name",
207+
"description": "Domain unique identifier. Must be unique across the Kubernetes cluster. Not required. Defaults to the value of metadata.name",
216208
"type": "string"
217209
},
218210
"serverStartPolicy": {
@@ -225,7 +217,7 @@
225217
]
226218
},
227219
"restartVersion": {
228-
"description": "If present, every time this value is updated the operator will restart the required servers",
220+
"description": "If present, every time this value is updated the operator will restart the required servers.",
229221
"type": "string"
230222
},
231223
"configOverrides": {
@@ -237,19 +229,19 @@
237229
"$ref": "#/definitions/KubernetesResource"
238230
},
239231
"domainHome": {
240-
"description": "The folder for the Weblogic Domain. (Not required)Defaults to /shared/domains/domains/domainUID if domainHomeInImage is falseDefaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
232+
"description": "The folder for the Weblogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
241233
"type": "string"
242234
},
243235
"logHomeEnabled": {
244-
"description": "Specified whether the log home folder is enabled (Not required). Defaults to true if domainHomeInImage is false. Defaults to false if domainHomeInImage is true. ",
236+
"description": "Specified whether the log home folder is enabled. Not required. Defaults to true if domainHomeInImage is false. Defaults to false if domainHomeInImage is true. ",
245237
"type": "boolean"
246238
},
247239
"webLogicCredentialsSecret": {
248240
"description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namepace, that holds the username and password needed to boot WebLogic Server under the \u0027username\u0027 and \u0027password\u0027 fields.",
249241
"$ref": "#/definitions/V1SecretReference"
250242
},
251243
"adminServer": {
252-
"description": "Configuration for the admin server",
244+
"description": "Configuration for the admin server.",
253245
"$ref": "#/definitions/AdminServer"
254246
},
255247
"serverPod": {
@@ -261,18 +253,18 @@
261253
"type": "string"
262254
},
263255
"includeServerOutInPodLog": {
264-
"description": "If true (the default), the server .out file will be included in the pod\u0027s stdout",
256+
"description": "If true (the default), the server .out file will be included in the pod\u0027s stdout.",
265257
"type": "boolean"
266258
},
267259
"managedServers": {
268-
"description": "Configuration for the managed servers",
260+
"description": "Configuration for the managed servers.",
269261
"type": "array",
270262
"items": {
271263
"$ref": "#/definitions/ManagedServer"
272264
}
273265
},
274266
"clusters": {
275-
"description": "Configuration for the clusters",
267+
"description": "Configuration for the clusters.",
276268
"type": "array",
277269
"items": {
278270
"$ref": "#/definitions/Cluster"
@@ -284,28 +276,34 @@
284276
"type": "object",
285277
"properties": {
286278
"reason": {
279+
"description": "A brief CamelCase message indicating details about why the domain is in this state.",
287280
"type": "string"
288281
},
289282
"servers": {
283+
"description": "Status of WebLogic servers in this domain.",
290284
"type": "array",
291285
"items": {
292286
"$ref": "#/definitions/ServerStatus"
293287
}
294288
},
295289
"replicas": {
290+
"description": "The number of running managed servers in the WebLogic cluster if there is only one cluster in the domain and where the cluster does not explicitly configure its replicas in a cluster specification.",
296291
"type": "number",
297292
"minimum": 0
298293
},
299294
"startTime": {
295+
"description": "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.",
300296
"$ref": "#/definitions/DateTime"
301297
},
302298
"conditions": {
299+
"description": "Current service state of domain.",
303300
"type": "array",
304301
"items": {
305302
"$ref": "#/definitions/DomainCondition"
306303
}
307304
},
308305
"message": {
306+
"description": "A human readable message indicating details about why the domain is in this condition.",
309307
"type": "string"
310308
}
311309
}
@@ -343,7 +341,7 @@
343341
"$ref": "#/definitions/ServerPod"
344342
},
345343
"serverName": {
346-
"description": "The name of the server. Required.",
344+
"description": "The name of the server. Required",
347345
"type": "string"
348346
},
349347
"serverStartPolicy": {
@@ -356,7 +354,7 @@
356354
]
357355
},
358356
"restartVersion": {
359-
"description": "If present, every time this value is updated the operator will restart the required servers",
357+
"description": "If present, every time this value is updated the operator will restart the required servers.",
360358
"type": "string"
361359
}
362360
},
@@ -389,12 +387,15 @@
389387
"type": "object",
390388
"properties": {
391389
"overallHealth": {
390+
"description": "Server health of this WebLogic server.",
392391
"type": "string"
393392
},
394393
"activationTime": {
394+
"description": "RFC 3339 date and time at which the server started.",
395395
"$ref": "#/definitions/DateTime"
396396
},
397397
"subsystems": {
398+
"description": "Status of unhealthy subsystems, if any.",
398399
"type": "array",
399400
"items": {
400401
"$ref": "#/definitions/SubsystemHealth"
@@ -406,15 +407,15 @@
406407
"type": "object",
407408
"properties": {
408409
"livenessProbe": {
409-
"description": "Settings for the liveness probe associated with a server",
410+
"description": "Settings for the liveness probe associated with a server.",
410411
"$ref": "#/definitions/ProbeTuning"
411412
},
412413
"podSecurityContext": {
413-
"description": "Pod-level security attributes",
414+
"description": "Pod-level security attributes.",
414415
"$ref": "#/definitions/V1PodSecurityContext"
415416
},
416417
"volumes": {
417-
"description": "Additional volumes to be created in the server pod",
418+
"description": "Additional volumes to be created in the server pod.",
418419
"type": "array",
419420
"items": {
420421
"$ref": "#/definitions/V1Volume"
@@ -425,15 +426,15 @@
425426
"$ref": "#/definitions/Map"
426427
},
427428
"resources": {
428-
"description": "Memory and cpu minimum requirements and limits for the server",
429+
"description": "Memory and cpu minimum requirements and limits for the server.",
429430
"$ref": "#/definitions/V1ResourceRequirements"
430431
},
431432
"readinessProbe": {
432-
"description": "Settings for the readiness probe associated with a server",
433+
"description": "Settings for the readiness probe associated with a server.",
433434
"$ref": "#/definitions/ProbeTuning"
434435
},
435436
"containerSecurityContext": {
436-
"description": "Container-level security attributes. Will override any matching pod-level attributes",
437+
"description": "Container-level security attributes. Will override any matching pod-level attributes.",
437438
"$ref": "#/definitions/V1SecurityContext"
438439
},
439440
"env": {
@@ -452,7 +453,7 @@
452453
"$ref": "#/definitions/Map"
453454
},
454455
"volumeMounts": {
455-
"description": "Additional volume mounts for the server pod",
456+
"description": "Additional volume mounts for the server pod.",
456457
"type": "array",
457458
"items": {
458459
"$ref": "#/definitions/V1VolumeMount"
@@ -464,18 +465,23 @@
464465
"type": "object",
465466
"properties": {
466467
"nodeName": {
468+
"description": "Name of node that is hosting the Pod containing this WebLogic server.",
467469
"type": "string"
468470
},
469471
"clusterName": {
472+
"description": "WebLogic cluster name, if the server is part of a cluster.",
470473
"type": "string"
471474
},
472475
"serverName": {
476+
"description": "WebLogic server name. Required",
473477
"type": "string"
474478
},
475479
"health": {
480+
"description": "Current status and health of a specific WebLogic server.",
476481
"$ref": "#/definitions/ServerHealth"
477482
},
478483
"state": {
484+
"description": "Current state of this WebLogic server. Required",
479485
"type": "string"
480486
}
481487
}
@@ -484,15 +490,18 @@
484490
"type": "object",
485491
"properties": {
486492
"symptoms": {
493+
"description": "Symptoms provided by the reporting subsystem.",
487494
"type": "array",
488495
"items": {
489496
"type": "string"
490497
}
491498
},
492499
"health": {
500+
"description": "Server health of this WebLogic server. Required",
493501
"type": "string"
494502
},
495503
"subsystemName": {
504+
"description": "Name of subsystem providing symptom information. Required",
496505
"type": "string"
497506
}
498507
}
@@ -1631,18 +1640,19 @@
16311640
"$ref": "#/definitions/V1ObjectMeta"
16321641
},
16331642
"apiVersion": {
1634-
"description": "The API version for the Domain. Must be \u0027weblogic.oracle/v2\u0027",
1643+
"description": "The API version for the Domain. Must be \u0027weblogic.oracle/v2\u0027.",
16351644
"type": "string"
16361645
},
16371646
"kind": {
1638-
"description": "The type of resource. Must be \u0027Domain\u0027",
1647+
"description": "The type of resource. Must be \u0027Domain\u0027.",
16391648
"type": "string"
16401649
},
16411650
"spec": {
1642-
"description": "The actual specification of the domain. Required.",
1651+
"description": "The specification of the domain. Required",
16431652
"$ref": "#/definitions/DomainSpec"
16441653
},
16451654
"status": {
1655+
"description": "The current status of the domain. Updated by the operator.",
16461656
"$ref": "#/definitions/DomainStatus"
16471657
}
16481658
},

0 commit comments

Comments
 (0)