Skip to content

Commit d0ae4a1

Browse files
rjeberhardrjeberhard
committed
Update generated domain doc
1 parent 7438ed3 commit d0ae4a1

File tree

4 files changed

+174
-53
lines changed

4 files changed

+174
-53
lines changed

‎docs/domains/Domain.json

Lines changed: 48 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@
3232
"IF_NEEDED"
3333
]
3434
},
35-
"restartVersion": {
36-
"description": "If present, every time this value is updated the operator will restart the required servers.",
37-
"type": "string"
38-
},
3935
"adminService": {
4036
"description": "Configures which of the admin server\u0027s WebLogic admin channels should be exposed outside the Kubernetes cluster via a node port service.",
4137
"$ref": "#/definitions/AdminService"
38+
},
39+
"restartVersion": {
40+
"description": "If present, every time this value is updated the operator will restart the required servers.",
41+
"type": "string"
4242
}
4343
}
4444
},
@@ -51,6 +51,14 @@
5151
"items": {
5252
"$ref": "#/definitions/Channel"
5353
}
54+
},
55+
"annotations": {
56+
"description": "Annotations to associate with the external channel service",
57+
"$ref": "#/definitions/Map"
58+
},
59+
"labels": {
60+
"description": "Labels to associate with the external channel service",
61+
"$ref": "#/definitions/Map"
5462
}
5563
}
5664
},
@@ -348,14 +356,14 @@
348356
"description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
349357
"$ref": "#/definitions/KubernetesResource"
350358
},
351-
"serverPod": {
352-
"description": "Configuration affecting server pods",
353-
"$ref": "#/definitions/ServerPod"
354-
},
355359
"serverName": {
356360
"description": "The name of the server. Required",
357361
"type": "string"
358362
},
363+
"serverPod": {
364+
"description": "Configuration affecting server pods",
365+
"$ref": "#/definitions/ServerPod"
366+
},
359367
"serverStartPolicy": {
360368
"description": "The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED.",
361369
"type": "string",
@@ -434,21 +442,13 @@
434442
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
435443
}
436444
},
437-
"annotations": {
438-
"description": "The annotations to be attached to generated resources.",
439-
"$ref": "#/definitions/Map"
440-
},
441445
"resources": {
442446
"description": "Memory and cpu minimum requirements and limits for the server.",
443447
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements"
444448
},
445-
"readinessProbe": {
446-
"description": "Settings for the readiness probe associated with a server.",
447-
"$ref": "#/definitions/ProbeTuning"
448-
},
449-
"containerSecurityContext": {
450-
"description": "Container-level security attributes. Will override any matching pod-level attributes.",
451-
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext"
449+
"annotations": {
450+
"description": "The annotations to be attached to generated resources.",
451+
"$ref": "#/definitions/Map"
452452
},
453453
"env": {
454454
"description": "A list of environment variables to add to a server",
@@ -457,10 +457,6 @@
457457
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
458458
}
459459
},
460-
"labels": {
461-
"description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
462-
"$ref": "#/definitions/Map"
463-
},
464460
"nodeSelector": {
465461
"description": "Selector which must match a node\u0027s labels for the pod to be scheduled on that node.",
466462
"$ref": "#/definitions/Map"
@@ -471,6 +467,32 @@
471467
"items": {
472468
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
473469
}
470+
},
471+
"labels": {
472+
"description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
473+
"$ref": "#/definitions/Map"
474+
},
475+
"readinessProbe": {
476+
"description": "Settings for the readiness probe associated with a server.",
477+
"$ref": "#/definitions/ProbeTuning"
478+
},
479+
"containers": {
480+
"description": "Additional containers to be included in the server pod.",
481+
"type": "array",
482+
"items": {
483+
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
484+
}
485+
},
486+
"containerSecurityContext": {
487+
"description": "Container-level security attributes. Will override any matching pod-level attributes.",
488+
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext"
489+
},
490+
"initContainers": {
491+
"description": "Initialization containers",
492+
"type": "array",
493+
"items": {
494+
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
495+
}
474496
}
475497
}
476498
},
@@ -526,7 +548,7 @@
526548
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
527549
},
528550
"apiVersion": {
529-
"description": "The API version for the Domain. Must be \u0027weblogic.oracle/v2\u0027.",
551+
"description": "The API version for the Domain.",
530552
"type": "string"
531553
},
532554
"kind": {
@@ -543,7 +565,7 @@
543565
}
544566
},
545567
"required": [
546-
"spec",
547-
"metadata"
568+
"metadata",
569+
"spec"
548570
]
549571
}

‎docs/domains/Domain.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Domain represents a WebLogic domain and how it will be realized in the Kubernete
44

55
| Name | Type | Description |
66
| --- | --- | --- |
7-
| apiVersion | string | The API version for the Domain. Must be 'weblogic.oracle/v2'. |
7+
| apiVersion | string | The API version for the Domain. |
88
| kind | string | The type of resource. Must be 'Domain'. |
99
| metadata | [Object Meta](k8s1.9.0.md#object-meta) | The domain meta-data. Must include the name and namespace. |
1010
| spec | [Domain Spec](#domain-spec) | The specification of the domain. Required |
@@ -100,8 +100,10 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
100100
| Name | Type | Description |
101101
| --- | --- | --- |
102102
| annotations | Map | The annotations to be attached to generated resources. |
103+
| containers | array of [Container](k8s1.9.0.md#container) | Additional containers to be included in the server pod. |
103104
| containerSecurityContext | [Security Context](k8s1.9.0.md#security-context) | Container-level security attributes. Will override any matching pod-level attributes. |
104105
| env | array of [Env Var](k8s1.9.0.md#env-var) | A list of environment variables to add to a server |
106+
| initContainers | array of [Container](k8s1.9.0.md#container) | Initialization containers |
105107
| labels | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
106108
| livenessProbe | [Probe Tuning](#probe-tuning) | Settings for the liveness probe associated with a server. |
107109
| nodeSelector | Map | Selector which must match a node's labels for the pod to be scheduled on that node. |
@@ -143,7 +145,9 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
143145

144146
| Name | Type | Description |
145147
| --- | --- | --- |
148+
| annotations | Map | Annotations to associate with the external channel service |
146149
| channels | array of [Channel](#channel) | Specifies which of the admin server's WebLogic channels should be exposed outside the Kubernetes cluster via a node port service, along with the node port for each channel. If not specified, the admin server's node port service will not be created. |
150+
| labels | Map | Labels to associate with the external channel service |
147151

148152
### Probe Tuning
149153

‎docs/domains/index.html

Lines changed: 48 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -836,16 +836,16 @@
836836
}
837837
],
838838
"required": [
839-
"spec",
840-
"metadata"
839+
"metadata",
840+
"spec"
841841
],
842842
"properties": {
843843
"metadata": {
844844
"description": "The domain meta-data. Must include the name and namespace.",
845845
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
846846
},
847847
"apiVersion": {
848-
"description": "The API version for the Domain. Must be \u0027weblogic.oracle/v2\u0027.",
848+
"description": "The API version for the Domain.",
849849
"type": "string"
850850
},
851851
"kind": {
@@ -952,13 +952,13 @@
952952
"IF_NEEDED"
953953
]
954954
},
955-
"restartVersion": {
956-
"description": "If present, every time this value is updated the operator will restart the required servers.",
957-
"type": "string"
958-
},
959955
"adminService": {
960956
"description": "Configures which of the admin server\u0027s WebLogic admin channels should be exposed outside the Kubernetes cluster via a node port service.",
961957
"$ref": "#/definitions/AdminService"
958+
},
959+
"restartVersion": {
960+
"description": "If present, every time this value is updated the operator will restart the required servers.",
961+
"type": "string"
962962
}
963963
}
964964
},
@@ -971,6 +971,14 @@
971971
"items": {
972972
"$ref": "#/definitions/Channel"
973973
}
974+
},
975+
"annotations": {
976+
"description": "Annotations to associate with the external channel service",
977+
"$ref": "#/definitions/Map"
978+
},
979+
"labels": {
980+
"description": "Labels to associate with the external channel service",
981+
"$ref": "#/definitions/Map"
974982
}
975983
}
976984
},
@@ -1268,14 +1276,14 @@
12681276
"description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
12691277
"$ref": "#/definitions/KubernetesResource"
12701278
},
1271-
"serverPod": {
1272-
"description": "Configuration affecting server pods",
1273-
"$ref": "#/definitions/ServerPod"
1274-
},
12751279
"serverName": {
12761280
"description": "The name of the server. Required",
12771281
"type": "string"
12781282
},
1283+
"serverPod": {
1284+
"description": "Configuration affecting server pods",
1285+
"$ref": "#/definitions/ServerPod"
1286+
},
12791287
"serverStartPolicy": {
12801288
"description": "The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED.",
12811289
"type": "string",
@@ -1354,21 +1362,13 @@
13541362
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
13551363
}
13561364
},
1357-
"annotations": {
1358-
"description": "The annotations to be attached to generated resources.",
1359-
"$ref": "#/definitions/Map"
1360-
},
13611365
"resources": {
13621366
"description": "Memory and cpu minimum requirements and limits for the server.",
13631367
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements"
13641368
},
1365-
"readinessProbe": {
1366-
"description": "Settings for the readiness probe associated with a server.",
1367-
"$ref": "#/definitions/ProbeTuning"
1368-
},
1369-
"containerSecurityContext": {
1370-
"description": "Container-level security attributes. Will override any matching pod-level attributes.",
1371-
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext"
1369+
"annotations": {
1370+
"description": "The annotations to be attached to generated resources.",
1371+
"$ref": "#/definitions/Map"
13721372
},
13731373
"env": {
13741374
"description": "A list of environment variables to add to a server",
@@ -1377,10 +1377,6 @@
13771377
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
13781378
}
13791379
},
1380-
"labels": {
1381-
"description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
1382-
"$ref": "#/definitions/Map"
1383-
},
13841380
"nodeSelector": {
13851381
"description": "Selector which must match a node\u0027s labels for the pod to be scheduled on that node.",
13861382
"$ref": "#/definitions/Map"
@@ -1391,6 +1387,32 @@
13911387
"items": {
13921388
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
13931389
}
1390+
},
1391+
"labels": {
1392+
"description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
1393+
"$ref": "#/definitions/Map"
1394+
},
1395+
"readinessProbe": {
1396+
"description": "Settings for the readiness probe associated with a server.",
1397+
"$ref": "#/definitions/ProbeTuning"
1398+
},
1399+
"containers": {
1400+
"description": "Additional containers to be included in the server pod.",
1401+
"type": "array",
1402+
"items": {
1403+
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
1404+
}
1405+
},
1406+
"containerSecurityContext": {
1407+
"description": "Container-level security attributes. Will override any matching pod-level attributes.",
1408+
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext"
1409+
},
1410+
"initContainers": {
1411+
"description": "Initialization containers",
1412+
"type": "array",
1413+
"items": {
1414+
"$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.9.0/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
1415+
}
13941416
}
13951417
}
13961418
},

0 commit comments

Comments
 (0)